1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Project Budgets

Get all project budget versions

get

/fscmRestApi/resources/11.13.18.05/projectBudgets

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • CurrentBaselineProjectBudgetFinder: Finds the current baseline project budget for the specified project and financial plan type.
      Finder Variables:
      • FinancialPlanType; string; Name of the financial plan type used to create the budget version.
      • ProjectId; integer; Identifier of the project on which the budget is created.
    • CurrentWorkingProjectBudgetFinder: Finds the current working project budget for the specified project and financial plan type.
      Finder Variables:
      • FinancialPlanType; string; Name of the financial plan type used to create the budget version.
      • ProjectId; integer; Identifier of the project on which the budget is created.
    • PrimaryKey: Finds the project budget version.
      Finder Variables:
      • PlanVersionId; integer; Identifier of the project budget version.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • FinancialPlanType; string; Name of the financial plan type used to create the budget version.
    • LockedBy; string; Name of the user who has locked the project budget version.
    • LockedFlag; boolean; Indicates if the project budget version is locked. A value of true means that the budget version is locked and can't be edited. A value of false means that the budget version is not locked and can be edited. The default value while creating an project budget version is false.
    • PlanVersionDescription; string; Description of the project budget version.
    • PlanVersionId; integer; Identifier of the project budget version.
    • PlanVersionName; string; Name of the project budget version.
    • PlanVersionNumber; integer; Number of the project budget version.
    • PlanVersionStatus; string; Status of the project budget version.
    • PlanningAmounts; string; The planning amount, either cost or revenue, that you must specify when using a financial plan type that allows creation of cost and revenue versions separately.
    • PlanningOptionId; integer; Unique identifier of the summary level planning option in the project budget.
    • ProjectId; integer; Identifier of the project on which the budget is created.
    • ProjectName; string; Name of the project on which the budget is created.
    • ProjectNumber; string; Number of the project on which the budget is created.
    • RbsVersionId; integer; Identifier of the resource breakdown structure that is attached to the project for which you can view summarized data.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : projectBudgets
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : projectBudgets-item-response
Type: object
Show Source
  • Title: Administrative Code
    Identifies the action that an administrator can perform on the budget version based on specific requirements. Not to be used in typical implementations.
  • Project Budget Attachments
    Title: Project Budget Attachments
    The Attachment resource is used to view, create, update, and delete attachments for project budgets.
  • Title: Budget Creation Method
    Code that identifies the budget creation method. A list of valid values defined in the PJO_BUDGET_CREATION_METHOD are: MANUAL, GENERATE, and COPY.
  • Title: Budget Generation Source
    Value of the financial plan type to create a budget from an existing budget. Valid values are: Financial Plan Type and Project Plan Type.
  • Title: Adjustment Percentage
    Percentage value, either positive or negative, used to adjust the existing values when creating new version values.
  • Title: Defer Financial Plan Creation
    Default Value: Y
    Indicates that the budget version will be created in a deferred mode. Valid values are Y and N. The default value is Y. A value of Y means that the budget version will be created in a deferred mode by the Process Financial Plan Versions process. A value of N means that the budget version will be created in real time and included in the response of the POST operation.
  • Title: Financial Plan Type
    Maximum Length: 240
    Name of the financial plan type used to create the budget version.
  • Links
  • Title: Locked By
    Read Only: true
    Name of the user who has locked the project budget version.
  • Title: Locked
    Indicates if the project budget version is locked. A value of true means that the budget version is locked and can't be edited. A value of false means that the budget version is not locked and can be edited. The default value while creating an project budget version is false.
  • Title: Burdened Cost in Project Currency
    Read Only: true
    Budget burdened cost amounts in project currency for the budget version.
  • Title: Raw Cost in Project Currency
    Read Only: true
    Budget raw cost amounts in project currency for the budget version.
  • Title: Revenue in Project Currency
    Read Only: true
    Budget revenue amounts in project currency for the budget version.
  • Title: Burdened Cost in Project Ledger Currency
    Read Only: true
    Budget burdened cost amounts in project ledger currency for the budget version.
  • Title: Raw Cost in Project Ledger Currency
    Read Only: true
    Budget raw cost amounts in project ledger currency of the budget version.
  • Title: Revenue in Project Ledger Currency
    Read Only: true
    Budget revenue amounts in project ledger currency for the budget version.
  • Title: Planning Amounts
    Maximum Length: 30
    The planning amount, either cost or revenue, that you must specify when using a financial plan type that allows creation of cost and revenue versions separately.
  • Title: Planning Option ID
    Read Only: true
    Unique identifier of the summary level planning option in the project budget.
  • Planning Options
    Title: Planning Options
    The Planning Options resource is used to view the planning options configured for the project budget version. Planning options are user-definable options, including plan settings, rate settings, currency settings, and generation options that are used to control planning scenarios. Budget versions inherit planning options that are defined for financial plan types.
  • Planning resource breakdown structure associated with the project.
  • Planning Resources
    Title: Planning Resources
    The Planning Resources resource is used to view, create, update, and delete a project budget line.
  • Title: Description
    Maximum Length: 2000
    Description of the project budget version.
  • Title: Budget Version ID
    Read Only: true
    Identifier of the project budget version.
  • Title: Version Name
    Maximum Length: 225
    Name of the project budget version.
  • Title: Version Number
    Read Only: true
    Number of the project budget version.
  • Title: Plan Version Status
    Status of the project budget version.
  • Identifier of the project on which the budget is created.
  • Title: Project Name
    Maximum Length: 240
    Name of the project on which the budget is created.
  • Title: Project Number
    Maximum Length: 25
    Number of the project on which the budget is created.
  • Title: Project Resources Status
    Status of the project resources to be used for generation. Valid values are: All and Confirmed.
  • Title: Resource Breakdown Structure Version ID
    Read Only: true
    Identifier of the resource breakdown structure that is attached to the project for which you can view summarized data.
  • Title: Source Plan Type
    Name of the financial plan type to create a budget from an existing budget.
  • Title: Source Plan Version
    Identifier of the source plan version. The SourcePlanVersionId attributes takes precedence over all the other attributes such as generation source, plan type, and so on.
  • Number of the source plan version.
  • Status of the source plan version when creating a budget using a financial project plan. Valid values are: Current Working and Baseline.
  • Version Errors
    Title: Version Errors
    The Version Errors resource is used to view project budget version errors.
Nested Schema : Project Budget Attachments
Type: array
Title: Project Budget Attachments
The Attachment resource is used to view, create, update, and delete attachments for project budgets.
Show Source
Nested Schema : Planning Options
Type: array
Title: Planning Options
The Planning Options resource is used to view the planning options configured for the project budget version. Planning options are user-definable options, including plan settings, rate settings, currency settings, and generation options that are used to control planning scenarios. Budget versions inherit planning options that are defined for financial plan types.
Show Source
Nested Schema : Planning Resources
Type: array
Title: Planning Resources
The Planning Resources resource is used to view, create, update, and delete a project budget line.
Show Source
Nested Schema : Version Errors
Type: array
Title: Version Errors
The Version Errors resource is used to view project budget version errors.
Show Source
Nested Schema : projectBudgets-Attachments-item-response
Type: object
Show Source
Nested Schema : projectBudgets-PlanningOptions-item-response
Type: object
Show Source
  • Title: Amount Scale
    Maximum Length: 255
    The scale on which amounts are displayed on the user interface. For example, if you select to view amounts in 1000s, the $100,000,000 amount is displayed as 100,000.
  • Amount Types
    Title: Amount Types
    The Amount Type resource is used to select the cost and revenue items to include in a financial plan type.
  • Title: Assign Resource in Single Currency for a Task
    Indicates whether a budget line is enabled for assigning resources in a single currency for a task.
  • Title: Bill Rate Derivation Date
    The date that is used as the basis for deriving rates for calculating revenue amounts.
  • Title: Bill Rate Derivation Date Type
    Maximum Length: 255
    The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating revenue amounts.
  • Budgetary Control Settings
    Title: Budgetary Control Settings
    The Budgetary Control Setting resource is used to view and update project and top resource control levels.
  • Title: Burden Schedule
    Maximum Length: 255
    A set of burden multipliers that is maintained for use across projects. Also referred to as a standard burden schedule.
  • Title: Calendar Type
    Maximum Length: 255
    The type of calendar, such as accounting calendar or project accounting calendar, used for entering and displaying periodic financial information.
  • Title: Project Currency Conversion: Cost Date Type
    Maximum Length: 255
    Date type that is used as a cost conversion attribute for project currency.
  • Title: Project Ledger Currency Conversion: Cost Date Type
    Maximum Length: 255
    Date type that is used as a cost conversion attribute for project ledger currency.
  • Title: Project Currency Conversion: Cost Fixed Date
    The date that is used to derive rates for calculating planned costs for project currency.
  • Title: Project Ledger Currency Conversion: Cost Fixed Date
    The date that is used to derive rates for calculating planned costs for project ledger currency.
  • Title: Cost Rate Derivation Date
    The date that is used as the basis for deriving rates for calculating cost amounts.
  • Title: Cost Rate Derivation Date Type
    Maximum Length: 255
    The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating cost amounts.
  • Title: Project Currency Conversion: Cost Rate Type
    Maximum Length: 255
    Cost rate type that is used as a cost conversion attribute for project currency.
  • Title: Project Ledger Currency Conversion: Cost Rate Type
    Maximum Length: 255
    Cost rate type that is used as a cost conversion attribute for project ledger currency.
  • Title: Currency Type
    Maximum Length: 255
    Indicates whether the project currency or the project ledger currency is used for displaying amounts when reviewing budget amounts.
  • Title: Current Planning Period
    Maximum Length: 15
    Current planning period that drives the display of the periodic information. It can be the project accounting period or accounting period depending on the selected calendar type. This value is not applicable when the calendar type is set to NONE.
  • Title: Date Type for Cost Conversion
    Maximum Length: 255
    Date type that is used as a cost conversion attribute for planning currencies.
  • Title: Date Type for Revenue Conversion
    Maximum Length: 255
    Date type that is used as a revenue conversion attribute for planning currencies.
  • Title: Default Reporting Option
    Read Only: true
    Maximum Length: 255
    Indicates whether cost or revenue quantity is used for reporting quantity when planning for cost and revenue in a separate budget version. By default, it is set to Cost when planning amounts are cost only or cost and revenue together. When the planning amounts are revenue only, it is set to Revenue.
  • Title: Designate as approved cost budget
    Read Only: true
    Indicates whether a financial plan type is an approved cost budget.
  • Title: Designate as approved revenue budget
    Read Only: true
    Indicates whether a financial plan type is an approved revenue budget.
  • Title: Enable Budgetary Controls
    Read Only: true
    Maximum Length: 1
    Indicates whether a financial plan type is eligible for integration with budgetary controls. A value of Y indicates that the attribute is selected. A value of N means that the attribute is not selected.
  • Export Options
    Title: Export Options
    The Export Option resource is used to select the planning options attributes to export.
  • Title: Fixed Date for Cost Conversion
    The date that is used to derive rates for calculating planned costs for planning currencies.
  • Title: Fixed Date for Revenue Conversion
    The date that is used to derive rates for calculating planned revenue for planning currencies.
  • Title: Job Cost Options
    Maximum Length: 255
    Rate schedule used for the calculation of cost amounts for jobs.
  • Title: Job Revenue Options
    Maximum Length: 255
    Rate schedule used for the calculation of revenue amounts for jobs.
  • Links
  • Title: Maintain manual spread on date changes
    Maximum Length: 255
    Indicates whether the periodic planning is retained in the plan version on plan line date modifications. A value of Y indicates that the attribute is selected. A value of N means that the attribute is not selected.
  • Title: Multiple Transaction Currencies
    Maximum Length: 255
    Indicates that the plan can use multiple transaction currencies. A value of Y indicates that the attribute is selected. A value of N means that the attribute is not selected.
  • Title: Nonlabor Resource
    Maximum Length: 255
    Rate schedule used for the calculation of cost amounts for non-labor resources.
  • Title: Nonlabor Resource
    Maximum Length: 255
    Rate schedule used for the calculation of revenue amounts for non-labor resources.
  • Title: Period Profile
    Maximum Length: 255
    Defines how time periods are grouped and displayed when editing budget versions.
  • Title: Person Cost Options
    Maximum Length: 255
    Rate schedule used for the calculation of cost amounts for named persons.
  • Title: Person Revenue Options
    Maximum Length: 255
    Rate schedule used for the calculation of revenue amounts for named persons.
  • Planning Currencies
    Title: Planning Currencies
    The Planning Currency resource is used to view, create, update, and delete project and planning currencies.
  • Title: Planning Level
    Maximum Length: 255
    Level of the budget at which amounts can be entered.
  • Title: Planning Option ID
    Unique identifier of the summary level planning option in the project budget version.
  • Planning Options Descriptive Flexfields
    Title: Planning Options Descriptive Flexfields
    A listing of all the descriptive flexfields available for planning options in project budget versions.
  • Title: Planning Resource Breakdown Structure
    Maximum Length: 255
    Planning resource breakdown structure associated with the project.
  • Title: Project Currency
    Read Only: true
    Maximum Length: 15
    Currency for the project.
  • Title: Project Ledger Currency
    Read Only: true
    Maximum Length: 15
    Project ledger currency for the project.
  • Title: Project Role Cost Options
    Maximum Length: 255
    Rate schedule used for the calculation of cost amounts for project role.
  • Title: Project Role Revenue Options
    Maximum Length: 255
    Rate schedule used for the calculation of cost amounts for project role.
  • Title: Rate Derivation Date
    The date that is used as the basis for deriving rates for calculating amounts on a none time phase budget version.
  • Title: Rate Derivation Date Type
    Maximum Length: 255
    The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating amounts on a none time phase budget version.
  • Title: Rate Type for Cost Conversion
    Maximum Length: 255
    Cost rate type that is used as a cost conversion attribute for planning currencies.
  • Title: Rate Type for Revenue Conversion
    Maximum Length: 255
    Revenue rate type that is used as a revenue conversion attribute for planning currencies.
  • Title: Report Cost
    Maximum Length: 255
    Determines the cost amount types that are used to calculate and report margins on budgets.
  • Title: Resource Class Cost Options
    Maximum Length: 255
    Rate schedule used for the calculation of cost amounts for resource classes. This is used for cost calculation when rates are unavailable in rate schedules for named persons, jobs, or non-labor resources.
  • Title: Resource Class Revenue Options
    Maximum Length: 255
    Rate schedule used for the calculation of revenue amounts for resource classes. This is used for revenue calculation when rates are unavailable in rate schedules for named persons, jobs, or non-labor resources.
  • Title: Retain override rates from source
    Indicates whether user specified cost and revenue rates from the source must be retained when generating the target budget version.
  • Title: Project Currency Conversion: Revenue Date Type
    Maximum Length: 255
    Date type that is used as a revenue conversion attribute for project currency.
  • Title: Project Ledger Currency Conversion: Revenue Date Type
    Maximum Length: 255
    Date type that is used as a revenue conversion attribute for project ledger currency.
  • Title: Project Currency Conversion: Revenue Fixed Date
    The date that is used to derive rates for calculating planned revenue for project currency.
  • Title: Project Ledger Currency Conversion: Revenue Fixed Date
    The date that is used to derive rates for calculating planned revenue for project ledger currency.
  • Title: Revenue Generation Method
    Maximum Length: 255
    Determines whether budget revenue is calculated based on quantity and rates, event amounts, or the spread ratio specified for tasks.
  • Title: Project Currency Conversion: Revenue Rate Type
    Maximum Length: 255
    Revenue rate type that is used as a revenue conversion attribute for project currency.
  • Title: Project Ledger Currency Conversion: Revenue Rate Type
    Maximum Length: 255
    Revenue rate type that is used as a revenue conversion attribute for project ledger currency.
  • Title: Use Planning Rates
    Enables utilization of planning rates for resources and resource classes when calculating budget amounts.
  • Title: Use Same Conversion Attribute for All Currency Conversions
    Indicates whether you can use the same currency conversion attribute for all currencies.
Nested Schema : Amount Types
Type: array
Title: Amount Types
The Amount Type resource is used to select the cost and revenue items to include in a financial plan type.
Show Source
Nested Schema : Budgetary Control Settings
Type: array
Title: Budgetary Control Settings
The Budgetary Control Setting resource is used to view and update project and top resource control levels.
Show Source
Nested Schema : Export Options
Type: array
Title: Export Options
The Export Option resource is used to select the planning options attributes to export.
Show Source
Nested Schema : Planning Currencies
Type: array
Title: Planning Currencies
The Planning Currency resource is used to view, create, update, and delete project and planning currencies.
Show Source
Nested Schema : Planning Options Descriptive Flexfields
Type: array
Title: Planning Options Descriptive Flexfields
A listing of all the descriptive flexfields available for planning options in project budget versions.
Show Source
Nested Schema : projectBudgets-PlanningOptions-AmountTypes-item-response
Type: object
Show Source
Nested Schema : projectBudgets-PlanningOptions-BudgetaryControlSettings-item-response
Type: object
Show Source
Nested Schema : projectBudgets-PlanningOptions-ExportOptions-item-response
Type: object
Show Source
  • Title: Burdened Cost: Effective Multiplier
    Multiplier used to calculate the burdened costs. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Burdened Cost: Standard Multiplier
    Standard multiplier derived from the burden schedule for calculating burdened cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Burdened Cost: Standard Rate
    Standard rate derived from the rate schedule for calculating the burdened cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Display currency conversion attributes and amounts in multiple transaction currencies
    Indicates whether to display the currency conversion attributes and amounts in multiple transaction currencies if the plan type allows planning in multiple transaction currencies.
  • Title: Burdened Cost: Effective Rate
    User entered rate for calculating the burdened cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Raw Cost: Effective Rate
    User entered rate for calculating the raw cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Effective Revenue Rate
    User entered rate for calculating revenue. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Export Options ID
    Read Only: true
    Identifier of the project budget version export options.
  • Title: From Date
    From date of the budget line. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Links
  • Title: Margin Percentage
    Margin expressed as a percentage. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Planning Currency
    Currency used for planning in the budget line. This value is always set to true and the attribute is exported.
  • Title: Planning Resource
    Resource used for financial planning in budgets. This value is always set to true and the attribute is exported.
  • Title: Project Currency Conversion: Cost Date
    Date that's used as a cost conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Cost Date Type
    Date type that's used as a cost conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Cost Rate
    Cost rate used when converting the amounts to project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Cost Rate Type
    The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Revenue Date
    Date that's used as a revenue conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Revenue Date Type
    Date type that's used as a revenue conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Revenue Rate
    Revenue rate used when converting the amounts to project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Revenue Rate Type
    The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Cost Date
    Date that's used as a cost conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Cost Date Type
    Date type that's used as a cost conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Cost Rate
    Cost rate used when converting the amounts to project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Cost Rate Type
    The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Revenue Date
    Date that's used as a revenue conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Revenue Date Type
    Date type that's used as a revenue conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Revenue Rate
    Revenue rate used when converting the amounts to project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Revenue Rate Type
    The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Resource Class
    Resource class associated with the budget line. This value is always set to true and the attribute is exported.
  • Title: Spread Curve
    Spread curve associated with the budget line. This value is always set to true and the attribute is exported.
  • Title: Raw Cost: Standard Rate
    Rate derived from the rate schedule for calculating raw cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Revenue: Standard Rate
    Rate derived from the rate schedule for calculating revenue. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Task Name
    Name assigned to a task. This value is always set to true and the attribute is exported.
  • Title: Task Number
    Number of the task. This value is always set to true and the attribute is exported.
  • Title: To Date
    End date of the budget line. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Burdened Cost: Total
    Total burdened costs incurred on the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Burdened Cost in Project Currency: Total
    Total burdened costs incurred on the project, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Burdened Cost in Project Ledger Currency: Total
    Total burdened costs incurred on the project, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Total Margin
    Total margin (difference between revenue and cost) in a project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Margin in Project Currency: Total
    Total margin in the project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Margin in Project Ledger Currency: Total
    Total margin in the project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Quantity: Total
    Total quantity of resource effort that's required to complete a task or project, including labor and equipment. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Raw Cost: Total
    Total cost directly attributable to the work performed. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Raw Cost in Project Currency: Total
    Total raw costs that are directly attributable to the work performed in the current budget, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Raw Cost in Project Ledger Currency: Total
    Total raw costs that are directly attributable to the work performed, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Revenue: Total
    Total planned revenue that's associated with the accounting period or a plan line in the budget. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Revenue in Project Currency: Total
    Total planned revenue that's associated with the accounting period or a financial plan line in the budget, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Revenue in Project Ledger Currency: Total
    Total planned revenue that's associated with the accounting period or a financial plan line in the budget, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Unit of Measure
    Read Only: true
    Unit of measure for a resource. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
Nested Schema : projectBudgets-PlanningOptions-PlanningCurrencies-item-response
Type: object
Show Source
Nested Schema : projectBudgets-PlanningOptions-PlanningOptionsDFF-item-response
Type: object
Show Source
Nested Schema : projectBudgets-PlanningResources-item-response
Type: object
Show Source
Nested Schema : Planning Amounts
Type: array
Title: Planning Amounts
The Planning Amounts resource is used to view, create, update, and delete periodic amounts for a budget line.
Show Source
Nested Schema : projectBudgets-PlanningResources-PlanningAmounts-item-response
Type: object
Show Source
Nested Schema : Plan Lines Descriptive Flexfields
Type: array
Title: Plan Lines Descriptive Flexfields
The Plan Lines Descriptive Flexfields resource is used to capture, view, and update additional information for planning amounts in project budgets.
Show Source
Nested Schema : Planning Amount Details
Type: array
Title: Planning Amount Details
The Planning Amount Details resource is used to view, create, and update periodic amounts for a budget line.
Show Source
Nested Schema : projectBudgets-PlanningResources-PlanningAmounts-PlanLinesDFF-item-response
Type: object
Show Source
Nested Schema : projectBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-response
Type: object
Show Source
Nested Schema : projectBudgets-VersionErrors-item-response
Type: object
Show Source
  • Title: Rejection Type
    Read Only: true
    Maximum Length: 30
    Indicates the type of the exception, for example, Error or Warning.
  • Links
  • Title: Cause
    Read Only: true
    Maximum Length: 4000
    Reason due to which the error in the budget version occurred.
  • Title: Message Name
    Read Only: true
    Maximum Length: 30
    Name that identifies the message uniquely.
  • Title: Message Text
    Read Only: true
    Maximum Length: 240
    Text of the message that indicates the cause and resolution of the error.
  • Title: Action
    Read Only: true
    Maximum Length: 4000
    The action that you must perform to resolve the error.
  • Title: Additional Details
    Read Only: true
    Maximum Length: 4000
    Additional information about the cause and resolution of the error.
  • Title: Period
    Read Only: true
    Maximum Length: 30
    Period for which errors exist in the project budget version.
  • Title: Plan Version
    Read Only: true
    Identifier of the project budget version that has errors.
  • Title: Resource
    Read Only: true
    Maximum Length: 240
    Name of the resource in the project budget version that has errors.
  • Title: Task Name
    Read Only: true
    Maximum Length: 255
    Name of the task in the project budget version that has errors.
  • Title: Task Number
    Read Only: true
    Maximum Length: 100
    Number of the task in the project budget version that has errors.
  • Title: Currency
    Read Only: true
    Maximum Length: 15
    Planning currency used in the project budget version.
Links
adjustForRangeOfProjects
Adjusts the project budget version for the range of projects using the adjustment type and adjustment percentage.
refreshRatesForRangeOfProjects
Refresh rates for the project budget version for the range of projects from the rate schedules.
reprocessFailedProjectBudgets
This action will reprocess all the project budget versions which are showing as failed and bring them back to working state.
Back to Top

Examples

The following example shows how to get all project budget versions by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBudgets

Example of Response Body

The following shows an example of the response body in JSON format.

{ "items": [ { "FinancialPlanType": "PSR CostRev Budget", "PlanningAmounts": "COST_AND_REV_TOGETHER", "PlanVersionId": 100000043678717, "PlanVersionNumber": 12, "PlanVersionName": "Version 12", "PlanVersionDescription": null, "PlanVersionStatus": "Baseline", "ProjectId": 99999, "ProjectNumber": "TM001", "ProjectName": "Rudycorp Software Install", "BudgetCreationMethod": null, "SourcePlanVersionId": null, "BudgetGenerationSource": null, "SourcePlanType": null, "SourcePlanVersionStatus": null, "SourcePlanVersionNumber": null, "CopyAdjustmentPercentage": null, "PCRawCostAmounts": 1278040, "PCBurdenedCostAmounts": 1917060, "PCRevenueAmounts": 2556080, "PFCRawCostAmounts": 1278040, "PFCBurdenedCostAmounts": 1917060, "PFCRevenueAmounts": 2556080, "DeferFinancialPlanCreation": null, "AdministrativeCode": null }
Back to Top