ControlBudget

A control budget contains structural information, such as the budget chart of accounts and budget calendar, and budgetary control validation options, such as whether a transaction with insufficient funds should be stopped or allowed to continue with or without warning and how much tolerance can be factored into the validation. Separate control budgets are used to record budget and consumption balances that are structured by different budget chart of accounts, budget calendar, or period range.

Expand all

Collapse all

Business Views

** Available for extracting data

• controlBudgetsExtract**

  A control budget contains structural information, such as the budget chart of accounts and budget calendar, and budgetary control validation options, such as whether a transaction with insufficient funds should be stopped or allowed to continue with or without warning and how much tolerance can be factored into the validation. Separate control budgets are used to record budget and consumption balances that are structured by different budget chart of accounts, budget calendar, or period range.

  Label, Plural Label

  Control Budgets, Control Budgets

  Data Source

  Read-optimized data store

  Expand all

  Collapse all

  Fields

  • allowOverridesFlag (boolean)

    Indicates whether the override is allowed for the control budget.

    Label

    Overrides Allowed Indicator

    Properties

    • creatable
    • not nullable
    • updatable
  • balanceDecreasesAllowedFlag (boolean)

    Indicates whether the budget balance can be decreased by a budget adjustment.

    Label

    Budget Decreases Allowed Indicator

    Properties

    • creatable
    • not nullable
    • updatable
  • balanceIncreasesAllowedFlag (boolean)

    Indicates whether the budget balance can be increased by a budget adjustment.

    Label

    Budget Increases Allowed Indicator

    Properties

    • creatable
    • not nullable
    • updatable
  • controlBudgetId (int64)

    The unique identifier of the control budget.

    Label

    Control Budget ID

    Properties

    • searchable
    • sortable
    • not nullable
  • createdBy (string)

    The user who created the record.

    Label

    Created By

    Properties

    • searchable
    • sortable
    • not nullable
  • description (string)

    The description of the control budget.

    Label

    Description

    Properties

    • creatable
    • searchable
    • sortable
    • updatable
  • endDate (date)

    Date on which the last period of the control budget ends.

    Label

    To Period End Date

    Properties

    • searchable
    • sortable
    • not nullable
  • endEffectivePeriodNumber (int64)

    The ending budget period of a control budget expressed as a numeric value for ease of comparison.

    Label

    To Period Number

    Properties

    • searchable
    • sortable
    • not nullable
  • endPeriodName (string)

    Ending budget period of a control budget.

    Label

    To Period

    Properties

    • creatable
    • searchable
    • sortable
    • not nullable
  • internalBudgetTypeCode (string)

    The code that indicates the type of spending control for a project control budget. For example, P_TT indicates Project and Top Task for a nonsponsored project or Award Project and Top Task for a sponsored project.

    Label

    Internal Budget Type Code

    Properties

    • creatable
    • searchable
    • sortable
    • updatable
  • maximumOverrideAmount (big-decimal)

    The maximum override amount allowed for the control budget.

    Label

    Maximum Override Amount

    Properties

    • creatable
    • searchable
    • sortable
    • updatable
  • name (string)

    The name of the control budget.

    Label

    Name

    Properties

    • creatable
    • searchable
    • sortable
    • not nullable
    • updatable
  • negativeBalancesAllowedFlag (boolean)

    Indicates whether the budget adjustment is allowed to cause negative funds available balance.

    Label

    Budget Decreases Allowed Below Funds Available Indicator

    Properties

    • creatable
    • not nullable
    • updatable
  • noOverridesNotifyFlag (boolean)

    Indicates whether the budget manager must be notified when no overrides are identified.

    Label

    Notify When No Overrides Are Available Indicator

    Properties

    • creatable
    • not nullable
    • updatable
  • originalSourceBudget (string)

    The source budget name of another control budget from which the control budget derives its budget amount. If the control budget isn't sourced from another control budget, it captures the name of its own source budget.

    Label

    Original Source Budget

    Properties

    • searchable
    • sortable
  • overridesTakenNotifyFlag (boolean)

    Indicates whether the budget manager must be notified when an override is taken.

    Label

    Notify When Override Taken Indicator

    Properties

    • creatable
    • not nullable
    • updatable
  • periodSetName (string)

    The name of the budget calendar.

    Label

    Budget Calendar

    Properties

    • searchable
    • sortable
    • not nullable
  • periodType (string)

    The period type of the budget calendar.

    Label

    Period Type

    Properties

    • searchable
    • sortable
    • not nullable
  • projectControlBudgetFlag (boolean)

    Indicates whether the control budget is for Project Management.

    Label

    Project Control Budget Indicator

    Properties

    • searchable
    • sortable
  • sourceBudget (string)

    Identifies the source of the budget data, such as the name of the budget, the identifier of another control budget, or the identifier of a project.

    Label

    Source Budget

    Properties

    • creatable
    • searchable
    • sortable
    • updatable
  • sourceControlBudget (string)

    The name of the control budget that's the source of the budget data for this control budget.

    Label

    Source Control Budget

    Properties

    • searchable
    • sortable
  • startDate (date)

    Date from when the first period of the controls budget starts.

    Label

    From Period Start Date

    Properties

    • searchable
    • sortable
    • not nullable
  • startEffectivePeriodNumber (int64)

    The beginning budget period of a control budget expressed as a numeric value for ease of comparison.

    Label

    From Period Number

    Properties

    • searchable
    • sortable
    • not nullable
  • startPeriodName (string)

    Beginning budget period of a control budget.

    Label

    From Period

    Properties

    • creatable
    • searchable
    • sortable
    • not nullable
  • timeCreated (date-time)

    The date and time when the record was created.

    Label

    Creation Date

    Properties

    • searchable
    • sortable
    • not nullable
  • timeUpdated (date-time)

    The date and time when the record was last updated.

    Label

    Last Updated Date

    Properties

    • searchable
    • sortable
    • not nullable
  • toleranceAmount (big-decimal)

    The tolerance amount of budget overage permitted by a control budget.

    Label

    Tolerance Amount

    Properties

    • creatable
    • searchable
    • sortable
    • updatable
  • tolerancePercent (big-decimal)

    The tolerance percentage of budget overage permitted by a control budget.

    Label

    Tolerance Percentage

    Properties

    • creatable
    • searchable
    • sortable
    • updatable
  • updatedBy (string)

    The user who last updated the record.

    Label

    Last Updated By

    Properties

    • searchable
    • sortable
    • not nullable

  Expand all

  Collapse all

  Reference Object

  • automatedUpdateReason (StandardLookupCode)

    The type of definition updates by an external process that causes the control budget to be unavailable for use.

    Business Object

    StandardLookupCode

    Expand all

    Collapse all

    Fields

    • lookupCode (string)

      The unique identifier of the Lookup Code.

      Label

      Lookup Code ID

      Properties

      • inherited
      • searchable
      • sortable
      • not nullable
    • lookupType (string)

      The unique identifier of the Lookup Type.

      Label

      Lookup Type ID

      Properties

      • inherited
      • searchable
      • sortable
      • not nullable

  • award (Contract)

    An award is a financial grant provided by a sponsor to a recipient organization to support research or other sponsored activities. For example, funding a hospital to research cancer.

    Business Object

    Contract

    Expand all

    Collapse all

    Fields

    • id (int64)

      The internal identifier of the contract custom child record.

      Label

      ID

      Properties

      • searchable
      • sortable
      • not nullable
    • publicIdentifier (string)

      The public unique identifier of a contract.

      Label

      Contract PUID

      Properties

      • searchable
      • sortable

  • budgetChartOfAccount (KeyFlexfieldStructureInstance)

    The key flexfield structure for the budget chart of accounts.

    Business Object

    KeyFlexfieldStructureInstance

    Expand all

    Collapse all

    Fields

    • applicationId (int64)

      The application identifier of the key flexfield.

      Label

      Application ID

      Properties

      • searchable
      • sortable
      • not nullable
    • keyFlexfieldCode (string)

      The key flexfield code of the key flexfield.

      Label

      Key Flexfield Code

      Properties

      • searchable
      • sortable
      • not nullable
    • structureInstanceId (int64)

      The unique identifier of the structure instance.

      Label

      Structure Instance ID

      Properties

      • searchable
      • sortable
      • not nullable
    • structureInstanceNumber (int64)

      The structure instance number of the structure instance.

      Label

      Structure Instance Number

      Properties

      • searchable
      • sortable
      • not nullable

  • budgetCurrency (Currency)

    The currency of the control budget.

    Business Object

    Currency

    Expand all

    Collapse all

    Fields

    • currencyCode (string)

      The currency in which an amount or a conversion rate is denominated.

      Label

      Currency Code

      Properties

      • searchable
      • sortable
      • not nullable

  • budgetManager (User)

    The budget manager who manages the control budget.

    Business Object

    User

    Expand all

    Collapse all

    Fields

    • id (int64)

      Unique identifier for the user business object.

      Label

      Id

      Properties

      • searchable
      • sortable
      • not nullable

  • budgetReleaseTimeFrame (StandardLookupCode)

    Controls the release of the budget for a specific period, allowing budget to be available for consumption either immediately or upon the opening of the designated source budget period.

    Business Object

    StandardLookupCode

    Expand all

    Collapse all

    Fields

    • lookupCode (string)

      The unique identifier of the Lookup Code.

      Label

      Lookup Code ID

      Properties

      • inherited
      • searchable
      • sortable
      • not nullable
    • lookupType (string)

      The unique identifier of the Lookup Type.

      Label

      Lookup Type ID

      Properties

      • inherited
      • searchable
      • sortable
      • not nullable

  • chartOfAccountsStructureInstance (KeyFlexfieldStructureInstance)

    The key flexfield structure instance resource is used to query the list of key flexfield structure instances.

    Business Object

    KeyFlexfieldStructureInstance

    Expand all

    Collapse all

    Fields

    • applicationId (int64)

      The application identifier of the key flexfield.

      Label

      Application ID

      Properties

      • searchable
      • sortable
      • not nullable
    • keyFlexfieldCode (string)

      The key flexfield code of the key flexfield.

      Label

      Key Flexfield Code

      Properties

      • searchable
      • sortable
      • not nullable
    • structureInstanceId (int64)

      The unique identifier of the structure instance.

      Label

      Structure Instance ID

      Properties

      • searchable
      • sortable
      • not nullable
    • structureInstanceNumber (int64)

      The structure instance number of the structure instance.

      Label

      Structure Instance Number

      Properties

      • searchable
      • sortable
      • not nullable

  • controlLevel (StandardLookupCode)

    Indicates the degree of enforcement in controlling consumption against budget such as absolute, advisory, track, and none. Track indicates that no enforcement is in place to control the consumption. None indicates that no enforcement is in place and no recording of the consumption.

    Business Object

    StandardLookupCode

    Expand all

    Collapse all

    Fields

    • lookupCode (string)

      The unique identifier of the Lookup Code.

      Label

      Lookup Code ID

      Properties

      • inherited
      • searchable
      • sortable
      • not nullable
    • lookupType (string)

      The unique identifier of the Lookup Type.

      Label

      Lookup Type ID

      Properties

      • inherited
      • searchable
      • sortable
      • not nullable

  • currencyConversionRateType (CurrencyConversionRateType)

    A currency conversion rate type defines conversion rate types such as Corporate, Daily, Period End, and Period Average. These conversion rate types are used to convert foreign currency journal amounts to ledger currency equivalents or translate and remeasure account balances to a reporting currency.

    Business Object

    CurrencyConversionRateType

    Expand all

    Collapse all

    Fields

    • conversionRateType (string)

      The rate type of the conversion rate used for the currency conversion, such as Corporate, Daily, Period End, and Period Average.

      Label

      Conversion Rate Type

      Properties

      • searchable
      • sortable
      • not nullable

  • ledger (Ledger)

    A ledger represents a record-keeping book used to track financial transactions. It serves as a central repository for all financial activities within an organization, providing a chronological and systematic account of debits, credits, and balances. Ledgers play a crucial role in financial management, budgeting, and maintaining accurate financial records, tracking expenses, revenues, assets, liabilities, and equity.

    Business Object

    Ledger

    Expand all

    Collapse all

    Fields

    • ledgerId (int64)

      The unique identifier of the ledger for which the accounting entry is created.

      Label

      Ledger ID

      Properties

      • searchable
      • sortable
      • not nullable

  • originalSourceBudgetSystem (StandardLookupCode)

    The source budget type of another control budget from which the control budget derives its budget amount. If the control budget isn't sourced from another control budget, it captures its own source budget type.

    Business Object

    StandardLookupCode

    Expand all

    Collapse all

    Fields

    • lookupCode (string)

      The unique identifier of the Lookup Code.

      Label

      Lookup Code ID

      Properties

      • inherited
      • searchable
      • sortable
      • not nullable
    • lookupType (string)

      The unique identifier of the Lookup Type.

      Label

      Lookup Type ID

      Properties

      • inherited
      • searchable
      • sortable
      • not nullable

  • processingType (StandardLookupCode)

    The control budget classification that determines the type of validations the control budget performs.

    Business Object

    StandardLookupCode

    Expand all

    Collapse all

    Fields

    • lookupCode (string)

      The unique identifier of the Lookup Code.

      Label

      Lookup Code ID

      Properties

      • inherited
      • searchable
      • sortable
      • not nullable
    • lookupType (string)

      The unique identifier of the Lookup Type.

      Label

      Lookup Type ID

      Properties

      • inherited
      • searchable
      • sortable
      • not nullable

  • project (Project)

    A project represents the effort and resources required to achieve a significant business objective within a specific time frame. Projects are used to plan, track, manage, and control both the financial aspects and the work effort required.

    Business Object

    Project

    Expand all

    Collapse all

    Fields

    • id (int64)

      Unique identifier of the project.

      Label

      Project ID

      Properties

      • searchable
      • sortable
      • not nullable

  • sourceBudgetType (StandardLookupCode)

    The type of the source budget. The valid values are Enterprise Performance Management, Project Management, Other, and so on.

    Business Object

    StandardLookupCode

    Expand all

    Collapse all

    Fields

    • lookupCode (string)

      The unique identifier of the Lookup Code.

      Label

      Lookup Code ID

      Properties

      • inherited
      • searchable
      • sortable
      • not nullable
    • lookupType (string)

      The unique identifier of the Lookup Type.

      Label

      Lookup Type ID

      Properties

      • inherited
      • searchable
      • sortable
      • not nullable

  • status (StandardLookupCode)

    Indicates the status of a control budget, such as in use, as well as various other statuses in which the control budget is unavailable for use.

    Business Object

    StandardLookupCode

    Expand all

    Collapse all

    Fields

    • lookupCode (string)

      The unique identifier of the Lookup Code.

      Label

      Lookup Code ID

      Properties

      • inherited
      • searchable
      • sortable
      • not nullable
    • lookupType (string)

      The unique identifier of the Lookup Type.

      Label

      Lookup Type ID

      Properties

      • inherited
      • searchable
      • sortable
      • not nullable

  • unitOfMeasure (UnitOfMeasure)

    The units that an application, system, or service can use with the transaction to reflect the measurement of a quantity. For example, each, box, hours, and milliliter are units used when ordering, fulfilling, and manufacturing products. The items involved in these transactions will include a numeric amount and a UOM to indicate the quantity used.

    Business Object

    UnitOfMeasure

    Expand all

    Collapse all

    Fields

    • code (string)

      User-supplied short code that identifies the unit of measure. This attribute is required.

      Label

      Code

      Properties

      • creatable
      • searchable
      • sortable
      • not nullable

Back to Top