Update a project forecast version

patch

/fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}

Request

Path Parameters
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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Administrative Code
    Identifies the action that an administrator can perform on the forecast version based on specific requirements. Not to be used in typical implementations.
  • Project Forecast Attachments
    Title: Project Forecast Attachments
    The attachments resource is used to view, create, update and delete attachments for project forecasts.
  • Title: Financial Plan Type
    Maximum Length: 240
    Name of the financial plan type used to create the forecast version.
  • Title: Locked
    Indicates if the project forecast version is locked. A value of true means that the forecast version is locked and can't be edited. A value of false means that the forecast version is not locked and can be edited. The default value while creating a project forecast version is false.
  • Planning Options
    Title: Planning Options
    The Planning Options resource is used to view the planning options configured for the project forecast version.
  • Planning Resources
    Title: Planning Resources
    The Planning Resources resource is used to view project forecast resource assignments.
  • Title: Plan Version Description
    Maximum Length: 2000
    Description of the forecast version.
  • Title: Plan Version Name
    Maximum Length: 225
    Name of the forecast version.
  • Title: Plan Version Status
    The status of the forecast version. A list of valid values is defined in the lookup type PJO_PLAN_STATUS.
  • Errors
    Title: Errors
    The Errors resource is used to view the errors in project forecasts.
Nested Schema : Project Forecast Attachments
Type: array
Title: Project Forecast Attachments
The attachments resource is used to view, create, update and delete attachments for project forecasts.
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 forecast version.
Show Source
Nested Schema : Planning Resources
Type: array
Title: Planning Resources
The Planning Resources resource is used to view project forecast resource assignments.
Show Source
Nested Schema : Errors
Type: array
Title: Errors
The Errors resource is used to view the errors in project forecasts.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Actual Amounts Through Period
    Maximum Length: 255
    The period (current, prior, or last closed) through which actual amounts are used when generating forecast amounts.
  • Title: Allow Negative ETC Calculation
    Indicates whether negative estimate-to-complete quantity can be calculated in progress. If the check box isn't enabled, and the calculated value is negative, then the estimate-to-complete quantity is set to zero.
  • 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 forecast line is enabled for assigning resources in a single currency for a task.
  • Title: Associate project costs or revenue to summary tasks
    Maximum Length: 255
    Indicates whether the incurred costs or revenue for resources are associated on the task hierarchy at the level planned.
  • 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.
  • 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: Carry Forward Unused Amounts from Past Periods
    Indicates whether unused forecast amounts can be carried over from the current or closed periods to the next open period.
  • 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
    Date that's used as a cost conversion attribute for project currency.
  • Title: Project Ledger Currency Conversion: Cost Fixed Date
    Date that's used as a cost conversion attribute 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 forecast 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: ETC Generation Source
    Maximum Length: 255
    Specifies whether the estimate-to-complete source for generating a forecast version is the financial project plan, another financial plan, or project resources.
  • 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: Forecast ETC Method
    Maximum Length: 255
    Method used to calculate estimate-to-complete values in project forecast.
  • 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.
  • Title: Maintain manual spread on date changes
    Maximum Length: 1
    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: Open Commitments
    Maximum Length: 1
    Indicates whether project costs from commitments are included when generating budgets or forecasts.
  • Title: Period Profile
    Maximum Length: 255
    Defines how time periods are grouped and displayed when editing forecast 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 forecast at which amounts can be entered.
  • Planning Options Descriptive Flexfields
    Title: Planning Options Descriptive Flexfields
    The Planning Options Descriptive Flexfields resource is used to capture, view, and update additional information for planning options in project forecast versions.
  • Title: Planning Resource Breakdown Structure
    Maximum Length: 255
    Planning resource breakdown structure associated with 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's used as the basis for deriving rates for calculating amounts on a None time phased forecast version.
  • Title: Rate Derivation Date Type
    Maximum Length: 255
    The date type, for example, the system date or a fixed date that's used as the basis for deriving rates for calculating amounts on a None time phased forecast 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: Report Cost
    Maximum Length: 255
    Determines the cost amount types that are used to calculate and report margins on forecasts.
  • 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 manually added forecast lines
    Indicates whether manually added plans lines are retained when the forecast version is regenerated.
  • Indicates whether user specified cost and revenue rates from the source must be retained when generating the target budget or forecast version.
  • Title: Retain Spread from Source
    Indicates whether the periodic planning from the source is retained in the generated forecast 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
    Date that's used as a revenue conversion attribute for project currency.
  • Title: Project Ledger Currency Conversion: Revenue Fixed Date
    Date that's used as a revenue conversion attribute for project ledger currency.
  • Title: Revenue Generation Method
    Maximum Length: 255
    Determines whether forecast 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 forecast 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 : 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
The Planning Options Descriptive Flexfields resource is used to capture, view, and update additional information for planning options in project forecast versions.
Show Source
Nested Schema : projectForecasts-PlanningOptions-AmountTypes-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Burdened Cost: Actual Amounts
    Maximum Length: 1
    Actual burdened cost amounts 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: Actual Amounts
    Maximum Length: 1
    Actual 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: Actual Amounts
    Maximum Length: 1
    Actual 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: Margin: Actual Amounts
    Maximum Length: 1
    Difference between actual project-related costs and actual revenue amounts. 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: Actual Amounts
    Maximum Length: 1
    Difference between actual project-related costs and actual revenue amounts calculated using 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: Actual Amounts
    Maximum Length: 1
    Difference between actual project-related costs and actual revenue amounts calculated using 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: Actual Amounts
    Maximum Length: 1
    Actual quantity of resource effort spent on 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: Actual Amounts
    Maximum Length: 1
    Actual cost amounts 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: Raw Cost in Project Currency: Actual Amounts
    Maximum Length: 1
    Actual cost amounts 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: Raw Cost in Project Ledger Currency: Actual Amounts
    Maximum Length: 1
    Actual cost amounts 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: Revenue: Actual Amounts
    Maximum Length: 1
    Actual revenue that's associated with the accounting period or a plan line in the forecast. 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: Actual Amounts
    Maximum Length: 1
    Actual revenue that's associated with the accounting period or a financial plan line in the forecast, 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: Actual Amounts
    Maximum Length: 1
    Actual revenue that's associated with the accounting period or a financial plan line in the forecast, 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: Burdened Cost: Effective Multiplier
    Maximum Length: 1
    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 Commitments: Supplier Invoices
    Maximum Length: 1
    Costs for supplier invoices billed against 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 Commitments in Project Currency: Supplier Invoices
    Maximum Length: 1
    Burdened costs for supplier invoices billed against 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 Commitments in Project Ledger Currency: Supplier Invoices
    Maximum Length: 1
    Burdened costs for supplier invoices billed against 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: Burdened Cost Commitments: Purchase Orders
    Maximum Length: 1
    Burdened costs for purchase orders against 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 Commitments in Project Currency: Purchase Orders
    Maximum Length: 1
    Burdened costs for purchase orders against 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 Commitments in Project Ledger Currency: Purchase Orders
    Maximum Length: 1
    Burdened costs for purchase orders against 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: Burdened Cost Commitments: Requisitions
    Maximum Length: 1
    Burdened costs for outstanding purchase requisitions against 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 Commitments in Project Currency: Requisitions
    Maximum Length: 1
    Burdened costs for outstanding purchase requisitions against 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 Commitments in Project Ledger Currency: Requisitions
    Maximum Length: 1
    Burdened costs for outstanding purchase requisitions against 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: Burdened Cost: Standard Multiplier
    Maximum Length: 1
    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
    Maximum Length: 1
    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 Commitments
    Indicates whether to display the external commitments present in the budget or forecast plan lines.
  • 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: EAC
    Maximum Length: 1
    Estimate of burdened cost amounts incurred on the project at completion. 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: EAC
    Maximum Length: 1
    Estimate of burdened costs incurred on the project at completion, 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: EAC
    Maximum Length: 1
    Estimate of burdened costs incurred on the project at completion, 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: Margin: EAC
    Maximum Length: 1
    Estimated difference between actual project-related costs and actual revenue amounts at the completion of the task or 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: EAC
    Maximum Length: 1
    Estimated difference between project-related costs and revenue amounts at the completion of the task or 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: Margin in Project Ledger Currency: EAC
    Maximum Length: 1
    Estimated difference between project-related costs and revenue amounts at the completion of the task or 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: Margin Percentage: EAC
    Maximum Length: 1
    Estimated difference between actual project-related costs and actual revenue amounts at the completion of the task or project, denoted 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: Quantity: EAC
    Maximum Length: 1
    Estimate-at-completion quantity of resource effort spent on 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: EAC
    Maximum Length: 1
    Estimate of cost amounts incurred on the project at completion. 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: EAC
    Maximum Length: 1
    Estimate of cost amounts incurred on the project at completion, 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: EAC
    Maximum Length: 1
    Estimate of cost amounts incurred on the project at completion, 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: EAC
    Maximum Length: 201
    Estimate-at-completion revenue that's associated with the accounting period or a plan line in the forecast. 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: EAC
    Maximum Length: 1
    Estimate-at-completion revenue that's associated with the accounting period or a financial plan line in the forecast, 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: EAC
    Maximum Length: 1
    Estimate-at-completion revenue that's associated with the accounting period or a financial plan line in the forecast, 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: Burdened Cost: Effective Rate
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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: Burdened Cost: ETC
    Maximum Length: 1
    Estimate of burdened cost amounts to be incurred to complete 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: ETC
    Maximum Length: 1
    Estimate of burdened costs to be incurred to complete 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: ETC
    Maximum Length: 1
    Estimate of burdened costs to be incurred to complete 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: Margin: ETC
    Maximum Length: 1
    Estimated difference between actual project-related costs and actual revenue amounts to complete the task or 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: ETC
    Maximum Length: 1
    Estimated difference between actual project-related costs and actual revenue amounts to complete the task or 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.
  • Maximum Length: 1
    Estimated difference between actual project-related costs and actual revenue amounts to complete the task or 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: Margin Percentage: ETC
    Maximum Length: 1
    Estimated difference between actual project-related costs and actual revenue amounts to complete the task or project, denoted 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: Quantity: ETC
    Maximum Length: 1
    Estimate-to-complete quantity of resource effort spent on 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: ETC
    Maximum Length: 1
    Estimate of cost amounts to be incurred to complete 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: Raw Cost in Project Currency: ETC
    Maximum Length: 1
    Estimate of cost amounts to be incurred to complete 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: Raw Cost in Project Ledger Currency: ETC
    Maximum Length: 1
    Estimate of cost amounts to be incurred to complete 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: ETC Revenue
    Maximum Length: 1
    Estimate-to-complete revenue that's associated with the accounting period or a plan line in the forecast. 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: ETC
    Maximum Length: 1
    Estimate-to-complete revenue that's associated with the accounting period or a financial plan line in the forecast, 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: ETC
    Maximum Length: 1
    Estimate-to-complete revenue that's associated with the accounting period or a financial plan line in the forecast, 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: Export Options ID
    Identifier of the project forecast version export options.
  • Title: From Date
    Maximum Length: 1
    From date of the forecast 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: Project Currency Conversion: Cost Date
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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: Quantity Commitments: Supplier Invoices
    Maximum Length: 1
    Planned quantity of supplier invoice commitments required to complete a project or task. 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 Commitments: Purchase Orders
    Maximum Length: 1
    Planned quantity of purchase order commitments required to complete a project or task. 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 Commitments: Requisitions
    Maximum Length: 1
    Planned quantity of purchase requisition commitments required to complete a project or task. 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 Commitments: Supplier Invoices
    Maximum Length: 1
    Costs from supplier invoices that are directly attributable to 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 Commitments in Project Currency: Supplier Invoices
    Maximum Length: 1
    Costs from supplier invoices that are directly attributable to work performed, 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 Commitments in Project Ledger Currency: Supplier Invoices
    Maximum Length: 1
    Costs from supplier invoices that are directly attributable to 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: Raw Cost Commitments: Purchase Orders
    Maximum Length: 1
    Purchase order costs that are directly attributable to 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 Commitments in Project Currency: Purchase Orders
    Maximum Length: 1
    Purchase order costs that are directly attributable to work performed, 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 Commitments in Project Ledger Currency: Purchase Orders
    Maximum Length: 1
    Purchase order costs that are directly attributable to 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: Raw Cost Commitments: Requisitions
    Maximum Length: 1
    Purchase requisition costs that are directly attributable to 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 Commitments in Project Currency: Requisitions
    Maximum Length: 1
    Purchase requisition costs that are directly attributable to work performed, 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 Commitments in Project Ledger Currency: Requisitions
    Maximum Length: 1
    Purchase requisition costs that are directly attributable to 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: Raw Cost: Standard Rate
    Maximum Length: 1
    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
    Maximum Length: 1
    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: To Date
    Maximum Length: 1
    End date of the forecast 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 Commitments
    Maximum Length: 1
    Total burdened costs for all commitments such as purchase order, supplier invoices, and requisitions. 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 Commitments
    Maximum Length: 1
    Total burdened costs for all commitments such as purchase order, supplier invoices, and requisitions, 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 Commitments
    Maximum Length: 1
    Total burdened costs for all commitments such as purchase order, supplier invoices, and requisitions, 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: Quantity: Total Commitments
    Maximum Length: 1
    Total commitments quantity required to complete a project or task. 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 Commitments
    Maximum Length: 1
    Total commitments incurred by 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: Raw Cost in Project Currency: Total Commitments
    Maximum Length: 1
    Total commitments incurred by the project 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 Commitments in Project Currency: Total Commitments
    Maximum Length: 1
    Total commitments incurred by the project 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
    Maximum Length: 1
    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 : projectForecasts-PlanningOptions-PlanningCurrencies-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Planning Amounts
Type: array
Title: Planning Amounts
The Planning Amounts resource is used to view project forecast resource assignment summary amounts.
Show Source
Nested Schema : schema
Type: object
Show Source
  • Maximum Length: 15
    Code that identifies the planning currency on the forecast version resource assignment.
  • Title: Burdened Cost
    Estimated cost in planning currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment.
  • Title: Quantity: EAC
    Measure of the effort planned for in the forecast version resource assignment.
  • Title: Raw Cost
    Estimated cost in planning currency at the completion of the task in the period for the forecast version resource assignment that is directly attributable to the work performed.
  • Title: Revenue: EAC
    Estimated revenue amount in planning currency recognized for the forecast version resource assignment at the completion of the task.
  • Title: Burdened Cost: Effective Rate
    Cost rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts.
  • Title: Effective ETC Rate
    Cost rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts.
  • Title: Revenue: Effective Rate
    Revenue rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective revenue rate gives the revenue.
  • Maximum Length: 1
    Indicates if the periodic planning is modified and retained for the plan line on date changes.
  • Plan Lines Descriptive Flexfields
    Title: Plan Lines Descriptive Flexfields
    The Plan Lines Descriptive Flexfields resource is used to capture and view additional information for planning amounts in project forecasts.
  • Planning Amount Details
    Title: Planning Amount Details
    The Planning Amount Details resource is used to view project forecast resource assignment periodic amounts.
Nested Schema : Plan Lines Descriptive Flexfields
Type: array
Title: Plan Lines Descriptive Flexfields
The Plan Lines Descriptive Flexfields resource is used to capture and view additional information for planning amounts in project forecasts.
Show Source
Nested Schema : Planning Amount Details
Type: array
Title: Planning Amount Details
The Planning Amount Details resource is used to view project forecast resource assignment periodic amounts.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Burdened Cost: EAC
    Estimated cost in planning currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment.
  • Title: Quantity: EAC
    Measure of the effort planned for in the forecast version resource assignment.
  • Title: Raw Cost: EAC
    Estimated cost in planning currency at the completion of the task in the period for the forecast version resource assignment that is directly attributable to the work performed.
  • Title: Revenue
    Estimated revenue amount in planning currency recognized for the forecast version resource assignment at the completion of the task.
  • Title: Burdened Cost: Effective Rate
    Cost rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts.
  • Title: Raw Cost: Effective Rate
    Cost rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts.
  • Title: Effective Revenue Rate
    Revenue rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective revenue rate gives the revenue.
  • Maximum Length: 1
    Indicates if the periodic planning is modified and retained for the plan line on date changes.
  • Title: Period
    Maximum Length: 30
    Period for which the periodic forecast amount is entered.
Nested Schema : projectForecasts-VersionErrors-item-patch-request
Type: object
Show Source
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 : projectForecasts-item-response
Type: object
Show Source
  • Title: Actual Burdened Cost in Project Currency
    Read Only: true
    The actual burdened cost incurred by the project in the project currency.
  • Title: Actual Raw Cost in Project Currency
    Read Only: true
    The actual raw cost incurred by the project in the project currency.
  • Title: Actual Revenue in Project Currency
    Read Only: true
    The actual revenue generated by the project in the project currency.
  • Title: Adjustment Percentage
    Percentage by which to adjust the forecast version amounts when copying amounts from another source.
  • Title: Administrative Code
    Identifies the action that an administrator can perform on the forecast version based on specific requirements. Not to be used in typical implementations.
  • Project Forecast Attachments
    Title: Project Forecast Attachments
    The attachments resource is used to view, create, update and delete attachments for project forecasts.
  • Title: Burdened Cost in Project Currency
    Read Only: true
    The estimated burdened cost for the project at the completion of the project in the project currency.
  • Title: Burdened Cost in Project Ledger Currency
    Read Only: true
    The estimated burdened cost for the project at the completion of the project in the project ledger currency.
  • Title: Current Baseline Budget Margin Variance
    Read Only: true
    Variance between the margins of the forecast version and the current baseline budget version.
  • Title: Current Baseline Budget Margin Variance Percentage
    Read Only: true
    Variance between the margins of the forecast version and the current baseline budget version, expressed as a percentage.
  • Title: Current Forecast Margin Variance
    Read Only: true
    Variance between the margins of the forecast version and the current forecast version.
  • Title: Current Forecast Margin Variance Percentage
    Read Only: true
    Variance between the margins of the forecast version and the current forecast version, expressed as a percentage.
  • Title: Defer Financial Plan Creation
    Default Value: Y
    Indicates that the forecast version will be created in a deferred mode. The default value is Y. A value of Y means that the forecast version will be created in a deferred mode by the Process Financial Plan Versions process. A value of N means that the forecast version will be created in real time and will be included in the response of the POST operation.
  • Title: EAC Equipment Effort
    Read Only: true
    Estimated equipment effort for the project at the completion of the project. EAC equipment effort includes both billable and nonbillable estimated equipment effort at the completion of the project.
  • Title: EAC Labor Effort
    Read Only: true
    Estimated labor effort for the project at the completion of the project. EAC labor effort includes both billable and nonbillable estimated labor effort at the completion of the project.
  • Title: ETC Burdened Cost in Project Currency
    Read Only: true
    The estimated burdened cost required to complete the project in the project currency.
  • Title: ETC Raw Cost in Project Currency
    Read Only: true
    The estimated raw cost required to complete the project in the project currency.
  • Title: ETC Start Date
    Read Only: true
    Date when the estimate to complete is intended to begin as planned on the forecast line.
  • Title: Financial Plan Type
    Maximum Length: 240
    Name of the financial plan type used to create the forecast version.
  • Title: Forecast Creation Method
    Determines whether the forecast version is generated from another plan or copied from another forecast version. A list of valid values - Copy from another source and Generate from another source - is defined in the lookup type PJO_FORECAST_CREATION_METHOD. There is no default value while creating a forecast version. You must enter either this attribute or Forecast Creation Method Code but not both while creating a forecast version.
  • Title: Forecast Creation Method Code
    Determines whether the forecast version is generated from another plan or copied from another forecast version. A list of valid values - COPY and GENERATE - is defined in the lookup type PJO_FORECAST_CREATION_METHOD. There is no default value while creating a forecast version. You must enter either this attribute or Forecast Creation Method but not both while creating a forecast version.
  • Title: Forecast Generation Source
    Determines whether the forecast version is generated from an existing forecast version based on a financial plan type or from the project plan. A list of valid values - Financial plan type and Project plan type - is defined in the lookup type PJO_PLAN_TYPE_CODE. There is no default value while creating a forecast version. You must enter either this attribute or Forecast Generation Source Code but not both while creating a forecast version.
  • Title: Forecast Generation Source Code
    Determines whether the forecast version is generated from an existing forecast version based on a financial plan type or from the project plan. A list of valid values - FINANCIAL_PLAN and PROJECT_PLAN - is defined in the lookup type PJO_PLAN_TYPE_CODE. There is no default value while creating a forecast version. You must enter either this attribute or Forecast Generation Source but not both while creating a forecast version.
  • Links
  • Title: Locked By
    Read Only: true
    Maximum Length: 255
    Name of the user who has locked the project forecast version.
  • Title: Locked
    Indicates if the project forecast version is locked. A value of true means that the forecast version is locked and can't be edited. A value of false means that the forecast version is not locked and can be edited. The default value while creating a project forecast version is false.
  • Title: Margin
    Read Only: true
    The difference between project-related costs and revenue amounts.
  • Title: Margin Percentage
    Read Only: true
    The difference between project-related costs and revenue amounts, expressed as a percentage.
  • Title: Original Baseline Budget Margin Variance
    Read Only: true
    Variance between the margins of the forecast version and the original baseline budget version.
  • Title: Original Baseline Budget Margin Variance Percentage
    Read Only: true
    Variance between the margins of the forecast version and the original baseline budget version, expressed as a percentage.
  • Title: Planning Amounts
    Maximum Length: 30
    Indicates whether a forecast version includes cost amounts, revenue amounts, or both. A list of valid values - Cost, Revenue, and Cost and revenue - is defined in the lookup type PJO_PLANNED_FOR_CODE. There is no default value while creating a forecast version. You must enter either this attribute or Forecast Generation Source but not both while creating a forecast version.
  • Title: Planning Option ID
    Read Only: true
    Identifier of the summary level planning option in the project forecast.
  • Planning Options
    Title: Planning Options
    The Planning Options resource is used to view the planning options configured for the project forecast version.
  • Planning Resources
    Title: Planning Resources
    The Planning Resources resource is used to view project forecast resource assignments.
  • Title: Plan Version Description
    Maximum Length: 2000
    Description of the forecast version.
  • Title: Forecast Version ID
    Identifier of the forecast version.
  • Title: Plan Version Name
    Maximum Length: 225
    Name of the forecast version.
  • Title: Plan Version Number
    Read Only: true
    The number of the version of the forecast.
  • Title: Plan Version Status
    The status of the forecast version. A list of valid values is defined in the lookup type PJO_PLAN_STATUS.
  • Title: Previous Forecast Margin Variance
    Read Only: true
    Variance between the margins of the forecast version and the previous forecast version.
  • Title: Previous Forecast Margin Variance Percentage
    Read Only: true
    Variance between the margins of the forecast version and the previous forecast version, expressed as a percentage.
  • Title: Project ID
    Identifier of the project for which the forecast version is created. You must enter a value for only one from among this attribute, Project Number, and Project Name but not for all three or a combination of them while creating a forecast version.
  • Title: Project Name
    Maximum Length: 240
    Name of the project for which the forecast version is created. You must enter a value for only one from among this attribute, Project ID, and Project Number but not for all three or a combination of them while creating a forecast version.
  • Title: Project Number
    Maximum Length: 25
    Number of the project for which the forecast version is created. You must enter a value for only one from among this attribute, Project ID, and Project Name but not for all three or a combination of them while creating a forecast version.
  • Title: Project Resources Status
    Status of the project resources to be used for generation. Valid values are: All and Confirmed.
  • Title: Raw Cost in Project Currency
    Read Only: true
    The estimated raw cost for the project at the completion of the project in the project currency.
  • Title: Raw Cost in Project Ledger Currency
    Read Only: true
    The estimated raw cost for the project at the completion of the project in the project ledger currency.
  • 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: Revenue in Project Currency
    Read Only: true
    The estimated revenue for the project at the completion of the project in the project currency.
  • Title: Revenue in Project Ledger Currency
    Read Only: true
    The estimated revenue for the project at the completion of the project in the project ledger currency.
  • Title: Source Plan Type
    Indicates the financial plan type or the project plan from which the forecast version is created. If the forecast generation source is entered as Project plan type, then this attribute is defaulted as project plan by the application. If the forecast generation source is entered as Financial plan type, then you must enter a value for this attribute.
  • Title: Source Plan Version ID
    Identifier of the version of the project plan, budget, or forecast used as the source for creating the forecast version.
  • Title: Source Plan Version Name
    The name of the version of the project plan, budget, or forecast used as the source for creating the forecast version.
  • Title: Source Plan Version Number
    The number of the version of the project plan, budget, or forecast used as the source for creating the forecast version.
  • Title: Source Plan Version Status
    The status of the source plan version from which the forecast version is created. A list of valid values is defined in the lookup type PJO_PLAN_STATUS.
  • Title: Total Commitments in Project Currency
    Read Only: true
    The total commitments incurred by the project in the project currency.
  • Errors
    Title: Errors
    The Errors resource is used to view the errors in project forecasts.
Nested Schema : Project Forecast Attachments
Type: array
Title: Project Forecast Attachments
The attachments resource is used to view, create, update and delete attachments for project forecasts.
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 forecast version.
Show Source
Nested Schema : Planning Resources
Type: array
Title: Planning Resources
The Planning Resources resource is used to view project forecast resource assignments.
Show Source
Nested Schema : Errors
Type: array
Title: Errors
The Errors resource is used to view the errors in project forecasts.
Show Source
Nested Schema : projectForecasts-Attachments-item-response
Type: object
Show Source
Nested Schema : projectForecasts-PlanningOptions-item-response
Type: object
Show Source
  • Title: Actual Amounts Through Period
    Maximum Length: 255
    The period (current, prior, or last closed) through which actual amounts are used when generating forecast amounts.
  • Title: Allow Negative ETC Calculation
    Indicates whether negative estimate-to-complete quantity can be calculated in progress. If the check box isn't enabled, and the calculated value is negative, then the estimate-to-complete quantity is set to zero.
  • 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 forecast line is enabled for assigning resources in a single currency for a task.
  • Title: Associate project costs or revenue to summary tasks
    Maximum Length: 255
    Indicates whether the incurred costs or revenue for resources are associated on the task hierarchy at the level planned.
  • 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.
  • 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: Carry Forward Unused Amounts from Past Periods
    Indicates whether unused forecast amounts can be carried over from the current or closed periods to the next open period.
  • 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
    Date that's used as a cost conversion attribute for project currency.
  • Title: Project Ledger Currency Conversion: Cost Fixed Date
    Date that's used as a cost conversion attribute 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 forecast 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
    Read Only: true
    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 forecast 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 Primary Cost Forecast
    Read Only: true
    Indicates whether the financial plan type is the primary cost forecast.
  • Title: Designate as Primary Revenue Forecast
    Read Only: true
    Indicates whether the financial plan type is the primary revenue forecast.
  • Title: ETC Generation Source
    Maximum Length: 255
    Specifies whether the estimate-to-complete source for generating a forecast version is the financial project plan, another financial plan, or project resources.
  • 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: Forecast ETC Method
    Maximum Length: 255
    Method used to calculate estimate-to-complete values in project forecast.
  • 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: 1
    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: Open Commitments
    Maximum Length: 1
    Indicates whether project costs from commitments are included when generating budgets or forecasts.
  • Title: Period Profile
    Maximum Length: 255
    Defines how time periods are grouped and displayed when editing forecast 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 forecast at which amounts can be entered.
  • Identifier of the summary level planning option in the project forecast version.
  • Planning Options Descriptive Flexfields
    Title: Planning Options Descriptive Flexfields
    The Planning Options Descriptive Flexfields resource is used to capture, view, and update additional information for planning options in project forecast 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's used as the basis for deriving rates for calculating amounts on a None time phased forecast version.
  • Title: Rate Derivation Date Type
    Maximum Length: 255
    The date type, for example, the system date or a fixed date that's used as the basis for deriving rates for calculating amounts on a None time phased forecast 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
    Read Only: true
    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 forecasts.
  • 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 manually added forecast lines
    Indicates whether manually added plans lines are retained when the forecast version is regenerated.
  • Indicates whether user specified cost and revenue rates from the source must be retained when generating the target budget or forecast version.
  • Title: Retain Spread from Source
    Indicates whether the periodic planning from the source is retained in the generated forecast 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
    Date that's used as a revenue conversion attribute for project currency.
  • Title: Project Ledger Currency Conversion: Revenue Fixed Date
    Date that's used as a revenue conversion attribute for project ledger currency.
  • Title: Revenue Generation Method
    Maximum Length: 255
    Determines whether forecast 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 forecast 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 : 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
The Planning Options Descriptive Flexfields resource is used to capture, view, and update additional information for planning options in project forecast versions.
Show Source
Nested Schema : projectForecasts-PlanningOptions-AmountTypes-item-response
Type: object
Show Source
Nested Schema : projectForecasts-PlanningOptions-ExportOptions-item-response
Type: object
Show Source
  • Title: Burdened Cost: Actual Amounts
    Maximum Length: 1
    Actual burdened cost amounts 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: Actual Amounts
    Maximum Length: 1
    Actual 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: Actual Amounts
    Maximum Length: 1
    Actual 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: Margin: Actual Amounts
    Maximum Length: 1
    Difference between actual project-related costs and actual revenue amounts. 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: Actual Amounts
    Maximum Length: 1
    Difference between actual project-related costs and actual revenue amounts calculated using 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: Actual Amounts
    Maximum Length: 1
    Difference between actual project-related costs and actual revenue amounts calculated using 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: Actual Amounts
    Maximum Length: 1
    Actual quantity of resource effort spent on 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: Actual Amounts
    Maximum Length: 1
    Actual cost amounts 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: Raw Cost in Project Currency: Actual Amounts
    Maximum Length: 1
    Actual cost amounts 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: Raw Cost in Project Ledger Currency: Actual Amounts
    Maximum Length: 1
    Actual cost amounts 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: Revenue: Actual Amounts
    Maximum Length: 1
    Actual revenue that's associated with the accounting period or a plan line in the forecast. 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: Actual Amounts
    Maximum Length: 1
    Actual revenue that's associated with the accounting period or a financial plan line in the forecast, 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: Actual Amounts
    Maximum Length: 1
    Actual revenue that's associated with the accounting period or a financial plan line in the forecast, 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: Burdened Cost: Effective Multiplier
    Maximum Length: 1
    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 Commitments: Supplier Invoices
    Maximum Length: 1
    Costs for supplier invoices billed against 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 Commitments in Project Currency: Supplier Invoices
    Maximum Length: 1
    Burdened costs for supplier invoices billed against 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 Commitments in Project Ledger Currency: Supplier Invoices
    Maximum Length: 1
    Burdened costs for supplier invoices billed against 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: Burdened Cost Commitments: Purchase Orders
    Maximum Length: 1
    Burdened costs for purchase orders against 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 Commitments in Project Currency: Purchase Orders
    Maximum Length: 1
    Burdened costs for purchase orders against 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 Commitments in Project Ledger Currency: Purchase Orders
    Maximum Length: 1
    Burdened costs for purchase orders against 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: Burdened Cost Commitments: Requisitions
    Maximum Length: 1
    Burdened costs for outstanding purchase requisitions against 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 Commitments in Project Currency: Requisitions
    Maximum Length: 1
    Burdened costs for outstanding purchase requisitions against 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 Commitments in Project Ledger Currency: Requisitions
    Maximum Length: 1
    Burdened costs for outstanding purchase requisitions against 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: Burdened Cost: Standard Multiplier
    Maximum Length: 1
    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
    Maximum Length: 1
    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 Commitments
    Indicates whether to display the external commitments present in the budget or forecast plan lines.
  • 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: EAC
    Maximum Length: 1
    Estimate of burdened cost amounts incurred on the project at completion. 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: EAC
    Maximum Length: 1
    Estimate of burdened costs incurred on the project at completion, 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: EAC
    Maximum Length: 1
    Estimate of burdened costs incurred on the project at completion, 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: Margin: EAC
    Maximum Length: 1
    Estimated difference between actual project-related costs and actual revenue amounts at the completion of the task or 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: EAC
    Maximum Length: 1
    Estimated difference between project-related costs and revenue amounts at the completion of the task or 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: Margin in Project Ledger Currency: EAC
    Maximum Length: 1
    Estimated difference between project-related costs and revenue amounts at the completion of the task or 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: Margin Percentage: EAC
    Maximum Length: 1
    Estimated difference between actual project-related costs and actual revenue amounts at the completion of the task or project, denoted 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: Quantity: EAC
    Maximum Length: 1
    Estimate-at-completion quantity of resource effort spent on 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: EAC
    Maximum Length: 1
    Estimate of cost amounts incurred on the project at completion. 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: EAC
    Maximum Length: 1
    Estimate of cost amounts incurred on the project at completion, 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: EAC
    Maximum Length: 1
    Estimate of cost amounts incurred on the project at completion, 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: EAC
    Maximum Length: 201
    Estimate-at-completion revenue that's associated with the accounting period or a plan line in the forecast. 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: EAC
    Maximum Length: 1
    Estimate-at-completion revenue that's associated with the accounting period or a financial plan line in the forecast, 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: EAC
    Maximum Length: 1
    Estimate-at-completion revenue that's associated with the accounting period or a financial plan line in the forecast, 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: Burdened Cost: Effective Rate
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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: Burdened Cost: ETC
    Maximum Length: 1
    Estimate of burdened cost amounts to be incurred to complete 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: ETC
    Maximum Length: 1
    Estimate of burdened costs to be incurred to complete 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: ETC
    Maximum Length: 1
    Estimate of burdened costs to be incurred to complete 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: Margin: ETC
    Maximum Length: 1
    Estimated difference between actual project-related costs and actual revenue amounts to complete the task or 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: ETC
    Maximum Length: 1
    Estimated difference between actual project-related costs and actual revenue amounts to complete the task or 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.
  • Maximum Length: 1
    Estimated difference between actual project-related costs and actual revenue amounts to complete the task or 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: Margin Percentage: ETC
    Maximum Length: 1
    Estimated difference between actual project-related costs and actual revenue amounts to complete the task or project, denoted 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: Quantity: ETC
    Maximum Length: 1
    Estimate-to-complete quantity of resource effort spent on 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: ETC
    Maximum Length: 1
    Estimate of cost amounts to be incurred to complete 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: Raw Cost in Project Currency: ETC
    Maximum Length: 1
    Estimate of cost amounts to be incurred to complete 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: Raw Cost in Project Ledger Currency: ETC
    Maximum Length: 1
    Estimate of cost amounts to be incurred to complete 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: ETC Revenue
    Maximum Length: 1
    Estimate-to-complete revenue that's associated with the accounting period or a plan line in the forecast. 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: ETC
    Maximum Length: 1
    Estimate-to-complete revenue that's associated with the accounting period or a financial plan line in the forecast, 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: ETC
    Maximum Length: 1
    Estimate-to-complete revenue that's associated with the accounting period or a financial plan line in the forecast, 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: Export Options ID
    Identifier of the project forecast version export options.
  • Title: From Date
    Maximum Length: 1
    From date of the forecast 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: Planning Currency
    Read Only: true
    Maximum Length: 1
    Currency used for planning in the forecast line. This value is always set to true and the attribute is exported.
  • Title: Planning Resource
    Read Only: true
    Maximum Length: 1
    Resource used for financial planning in the forecast line. This value is always set to true and the attribute is exported.
  • Title: Project Currency Conversion: Cost Date
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Maximum Length: 1
    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: Quantity Commitments: Supplier Invoices
    Maximum Length: 1
    Planned quantity of supplier invoice commitments required to complete a project or task. 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 Commitments: Purchase Orders
    Maximum Length: 1
    Planned quantity of purchase order commitments required to complete a project or task. 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 Commitments: Requisitions
    Maximum Length: 1
    Planned quantity of purchase requisition commitments required to complete a project or task. 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 Commitments: Supplier Invoices
    Maximum Length: 1
    Costs from supplier invoices that are directly attributable to 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 Commitments in Project Currency: Supplier Invoices
    Maximum Length: 1
    Costs from supplier invoices that are directly attributable to work performed, 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 Commitments in Project Ledger Currency: Supplier Invoices
    Maximum Length: 1
    Costs from supplier invoices that are directly attributable to 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: Raw Cost Commitments: Purchase Orders
    Maximum Length: 1
    Purchase order costs that are directly attributable to 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 Commitments in Project Currency: Purchase Orders
    Maximum Length: 1
    Purchase order costs that are directly attributable to work performed, 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 Commitments in Project Ledger Currency: Purchase Orders
    Maximum Length: 1
    Purchase order costs that are directly attributable to 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: Raw Cost Commitments: Requisitions
    Maximum Length: 1
    Purchase requisition costs that are directly attributable to 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 Commitments in Project Currency: Requisitions
    Maximum Length: 1
    Purchase requisition costs that are directly attributable to work performed, 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 Commitments in Project Ledger Currency: Requisitions
    Maximum Length: 1
    Purchase requisition costs that are directly attributable to 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: Resource Class
    Read Only: true
    Maximum Length: 1
    Resource class associated with the forecast line. This value is always set to true and the attribute is exported.
  • Title: Spread Curve
    Read Only: true
    Maximum Length: 1
    Spread curve associated with the forecast line. This value is always set to true and the attribute is exported.
  • Title: Raw Cost: Standard Rate
    Maximum Length: 1
    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
    Maximum Length: 1
    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
    Read Only: true
    Maximum Length: 1
    Name assigned to a task. This value is always set to true and the attribute is exported.
  • Title: Task Number
    Read Only: true
    Maximum Length: 1
    Number of the task. This value is always set to true and the attribute is exported.
  • Title: To Date
    Maximum Length: 1
    End date of the forecast 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 Commitments
    Maximum Length: 1
    Total burdened costs for all commitments such as purchase order, supplier invoices, and requisitions. 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 Commitments
    Maximum Length: 1
    Total burdened costs for all commitments such as purchase order, supplier invoices, and requisitions, 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 Commitments
    Maximum Length: 1
    Total burdened costs for all commitments such as purchase order, supplier invoices, and requisitions, 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: Quantity: Total Commitments
    Maximum Length: 1
    Total commitments quantity required to complete a project or task. 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 Commitments
    Maximum Length: 1
    Total commitments incurred by 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: Raw Cost in Project Currency: Total Commitments
    Maximum Length: 1
    Total commitments incurred by the project 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 Commitments in Project Currency: Total Commitments
    Maximum Length: 1
    Total commitments incurred by the project 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
    Maximum Length: 1
    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 : projectForecasts-PlanningOptions-PlanningCurrencies-item-response
Type: object
Show Source
Nested Schema : projectForecasts-PlanningOptions-PlanningOptionsDFF-item-response
Type: object
Show Source
Nested Schema : projectForecasts-PlanningResources-item-response
Type: object
Show Source
  • Links
  • Default Value: N
    Indicates whether the periodic planning is retained in the plan version on plan line date modifications.
  • Planning Amounts
    Title: Planning Amounts
    The Planning Amounts resource is used to view project forecast resource assignment summary amounts.
  • Title: Planning Element ID
    Identifier of the planning resources of the forecast version.
  • Title: Planning Dates: To Date
    The date that is planned on the financial plan for a resource to begin their assignment on a project task.
  • Title: Planning Dates: From Date
    The date that is planned on the financial plan for a resource to finish their assignment on a project task.
  • Title: Planning Resource
    Identifier of the resource breakdown structure element used to create the financial plan resource assignment.
  • Title: Resource Class
    Read Only: true
    Maximum Length: 240
    Grouping of predefined resource types to which the resource in the financial plan resource assignment belongs. A list of valid values are Labor, Equipment, Material Items, and Financial Resources.
  • Title: Resource
    Maximum Length: 240
    Name or alias of the resource included in the planning resource breakdown structure that is used to create the financial plan resource assignment.
  • Title: Task
    Identifier of the task for which a financial plan resource assignment is created. You must enter a value for only one from among this attribute, Task Name, and Task Number but not for all three or a combination of them while creating a financial plan resource assignment.
  • Title: Task Name
    Maximum Length: 255
    Name of the task for which a financial plan resource assignment is created. You must enter a value for only one from among this attribute, Task ID, and Task Number but not for all three or a combination of them while creating a financial plan resource assignment.
  • Title: Task Number
    Maximum Length: 100
    Number of the task for which a financial plan resource assignment is created. You must enter a value for only one from among this attribute, Task Name, and Task ID but not for all three or a combination of them while creating a financial plan resource assignment.
  • Title: Unit of Measure
    Read Only: true
    Unit of work that measures the quantity of effort for which the resource is planned for on the financial plan resource assignment.
Nested Schema : Planning Amounts
Type: array
Title: Planning Amounts
The Planning Amounts resource is used to view project forecast resource assignment summary amounts.
Show Source
Nested Schema : projectForecasts-PlanningResources-PlanningAmounts-item-response
Type: object
Show Source
  • Title: Actual Burdened Cost
    Read Only: true
    Actual cost incurred for the forecast version resource assignment, including raw and burden costs, in planning currency from the start of the project till the current date.
  • Title: Burdened Cost in Project Currency: Actual Amounts
    Read Only: true
    Actual cost incurred for the forecast version resource assignment, including raw and burden costs, in project currency from the start of the project till the current date.
  • Title: Burdened Cost in Project Ledger Currency: Actual Amounts
    Read Only: true
    Actual cost incurred for the forecast version resource assignment, including raw and burden costs, in project ledger currency from the start of the project till the current date.
  • Title: Burdened Cost Rate
    Read Only: true
    Actual burdened cost rate that is used to calculate the actual cost for the forecast version resource assignment that includes both raw and burden costs.
  • Title: Actual Quantity
    Read Only: true
    Actual effort for the forecast version resource assignment from the start of the project till the current date.
  • Title: Actual Raw Cost
    Read Only: true
    Actual cost incurred for the period in the forecast version resource assignment in planning currency that is directly attributable to the work performed from the start of the project till the current date.
  • Title: Raw Cost in Project Currency: Actual Amounts
    Read Only: true
    Actual cost incurred for the forecast version resource assignment in project currency that is directly attributable to the work performed from the start of the project till the current date.
  • Title: Raw Cost in Project Ledger Currency: Actual Amounts
    Read Only: true
    Actual cost incurred for the forecast version resource assignment in project ledger currency that is directly attributable to the work performed from the start of the project till the current date.
  • Read Only: true
    Rate that is used to calculate the actual cost for the forecast version resource assignment that is directly attributable to the work performed.
  • Title: Revenue: Actual Amount
    Read Only: true
    Amount of revenue recognized for the forecast version resource assignment in planning currency from the inception of the project to date.
  • Title: Revenue in Project Currency: Actual Amounts
    Read Only: true
    Amount of revenue recognized for the forecast version resource assignment in project currency from the inception of the project to date.
  • Title: Revenue in Project Ledger Currency: Actual Amount
    Read Only: true
    Amount of revenue recognized for the forecast version resource assignment in project ledger currency from the inception of the project to date.
  • Title: Actual Rate
    Read Only: true
    Rate that is used to calculate the actual revenue for the forecast version resource assignment.
  • Maximum Length: 15
    Code that identifies the planning currency on the forecast version resource assignment.
  • Title: Burdened Cost
    Estimated cost in planning currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment.
  • Title: Burdened Cost in Project Currency: EAC
    Read Only: true
    Estimated cost in project currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment.
  • Title: Burdened Cost in Project Ledger Currency: EAC
    Read Only: true
    Estimated cost in project ledger currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment.
  • Title: Burdened Cost: Total Burdened Cost Rate
    Read Only: true
    Rate that is used to calculate the actual cost for the forecast version resource assignment that includes both raw and burden costs.
  • Title: Quantity: EAC
    Measure of the effort planned for in the forecast version resource assignment.
  • Title: Raw Cost
    Estimated cost in planning currency at the completion of the task in the period for the forecast version resource assignment that is directly attributable to the work performed.
  • Title: Raw Cost in Project Currency: EAC
    Read Only: true
    Estimated cost in project ledger currency at the completion of the task for the forecast version resource assignment that is directly attributable to the work performed.
  • Title: Raw Cost in Project Ledger Currency: EAC
    Read Only: true
    Estimated cost in project ledger currency at the completion of the task for the forecast version resource assignment that is directly attributable to the work performed.
  • Title: Raw Cost: Total Raw Cost Rate
    Read Only: true
    Rate that is used to calculate the estimated cost at the completion of the task for the forecast version resource assignment that is directly attributable to the work performed.
  • Title: Revenue: EAC
    Estimated revenue amount in planning currency recognized for the forecast version resource assignment at the completion of the task.
  • Title: Revenue in Project Currency: EAC
    Read Only: true
    Estimated revenue amount in project currency recognized for the forecast version resource assignment at the completion of the task.
  • Title: Revenue in Project Ledger Currency: EAC
    Read Only: true
    Estimated revenue amount in project ledger currency recognized for the forecast version resource assignment at the completion of the task.
  • Title: Effective Rate
    Read Only: true
    Rate that is used to calculate the estimated revenue at the completion of the task for the forecast version resource assignment.
  • Title: Burdened Cost: Effective Rate
    Cost rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts.
  • Title: Effective ETC Rate
    Cost rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts.
  • Title: Revenue: Effective Rate
    Revenue rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective revenue rate gives the revenue.
  • Title: ETC Burdened Cost
    Read Only: true
    Estimated remaining cost in planning currency, including raw and burden costs, required for completion of the task by the forecast version resource assignment.
  • Title: Burdened Cost in Project Currency: ETC
    Read Only: true
    Estimated remaining cost in project currency, including raw and burden costs, required for completion of the task by the forecast version resource assignment.
  • Title: Burdened Cost in Project Ledger Currency: ETC
    Read Only: true
    Estimated remaining cost in project ledger currency, including raw and burden costs, required for completion of the task by the forecast version resource assignment.
  • Title: Quantity: ETC
    Read Only: true
    Estimated remaining effort by the forecast version resource assignment for completion.
  • Title: ETC Raw Cost
    Read Only: true
    Estimated remaining cost in planning currency required for completion of the task in the period by the forecast version resource assignment that is directly attributable to the work performed.
  • Title: Raw Cost in Project Currency: ETC
    Read Only: true
    Estimated remaining cost in project currency required for completion of the task by the forecast version resource assignment that is directly attributable to the work performed.
  • Title: Raw Cost in Project Ledger Currency: ETC
    Read Only: true
    Estimated remaining cost in project ledger currency required for completion of the task by the forecast version resource assignment that is directly attributable to the work performed.
  • Title: Revenue: ETC
    Read Only: true
    Estimated remaining revenue amount in planning currency to be recognized for the forecast version resource assignment.
  • Title: Revenue in Project Currency: ETC
    Read Only: true
    Estimated remaining revenue amount in project currency to be recognized for the forecast version resource assignment.
  • Title: Revenue in Project Ledger Currency: ETC
    Read Only: true
    Estimated remaining revenue amount in project ledger currency to be recognized for the forecast version resource assignment.
  • Links
  • Maximum Length: 1
    Indicates if the periodic planning is modified and retained for the plan line on date changes.
  • Title: Plan Line ID
    Identifier of the summary level planning amounts for a resource assignment in the forecast version.
  • Plan Lines Descriptive Flexfields
    Title: Plan Lines Descriptive Flexfields
    The Plan Lines Descriptive Flexfields resource is used to capture and view additional information for planning amounts in project forecasts.
  • Planning Amount Details
    Title: Planning Amount Details
    The Planning Amount Details resource is used to view project forecast resource assignment periodic amounts.
  • Title: Burdened Cost Commitments: Purchase Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through purchase orders in planning currency that includes both raw and burden costs.
  • Title: Burdened Cost Commitments in Project Currency: Purchase Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through purchase orders in project currency that includes both raw and burden costs.
  • Title: Burdened Cost Commitments in Project Ledger Currency: Purchase Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through purchase orders in project ledger currency that includes both raw and burden costs.
  • Title: Quantity Commitments: Purchase Orders
    Read Only: true
    Effort for the forecast version resource assignment committed through purchase orders.
  • Title: Raw Cost Commitments: Purchase Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through purchase orders in planning currency that is directly attributable to the work performed.
  • Title: Raw Cost Commitments in Project Currency: Supplier Invoices
    Read Only: true
    Cost for the forecast version resource assignment committed through purchase orders in project currency that is directly attributable to the work performed.
  • Title: Raw Cost Commitments in Project Ledger Currency: Purchase Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through purchase orders in project ledger currency that is directly attributable to the work performed.
  • Title: Burdened Cost Commitments: Requisitions
    Read Only: true
    Cost for the forecast version resource assignment committed through requisitions in planning currency that includes both raw and burden costs.
  • Title: Burdened Cost Commitments in Project Currency: Requisitions
    Read Only: true
    Cost for the forecast version resource assignment committed through requisitions in project currency that includes both raw and burden costs.
  • Title: Burdened Cost Commitments in Project Ledger Currency: Requisitions
    Read Only: true
    Cost for the forecast version resource assignment committed through requisitions in project ledger currency that includes both raw and burden costs.
  • Title: Requisitions
    Read Only: true
    Effort for the forecast version resource assignment committed through requisitions.
  • Title: Raw Cost Commitments: Requisitions
    Read Only: true
    Cost for the forecast version resource assignment committed through requisitions in planning currency that is directly attributable to the work performed.
  • Title: Raw Cost Commitments in Project Currency: Requisitions
    Read Only: true
    Cost for the forecast version resource assignment committed through requisitions in project currency that is directly attributable to the work performed.
  • Title: Raw Cost Commitments in Project Ledger Currency: Requisitions
    Read Only: true
    Cost for the forecast version resource assignment committed through requisitions in project ledger currency that is directly attributable to the work performed.
  • Title: Standard Burdened Cost Rate
    Read Only: true
    Average rate derived from the rate schedule for calculating the planned burdened cost for the forecast version resource assignment.
  • Title: Standard ETC Rate
    Read Only: true
    Rate derived from the rate schedule for calculating the planned raw cost for the forecast version resource assignment.
  • Title: Revenue: Standard Rate
    Read Only: true
    Rate derived from the rate schedule for calculating the planned revenue for the forecast version resource assignment.
  • Title: Burdened Cost Commitments: Supplier Invoices
    Read Only: true
    Cost for the forecast version resource assignment committed through supplier invoices in planning currency that includes both raw and burden costs.
  • Title: Burdened Cost Commitments in Project Currency: Supplier Invoices
    Read Only: true
    Cost for the forecast version resource assignment committed through supplier invoices in project currency that includes both raw and burden costs.
  • Title: Burdened Cost Commitments in Project Ledger Currency: Supplier Invoices
    Read Only: true
    Cost for the forecast version resource assignment committed through supplier invoices in project ledger currency that includes both raw and burden costs.
  • Title: Quantity Commitments: Supplier Invoices
    Read Only: true
    Effort for the forecast version resource assignment committed through supplier invoices.
  • Title: Raw Cost Commitments: Supplier Invoices
    Read Only: true
    Cost for the forecast version resource assignment committed through supplier invoices in planning currency that is directly attributable to the work performed.
  • Title: Raw Cost Commitments in Project Currency: Supplier Invoices
    Read Only: true
    Cost for the forecast version resource assignment committed through supplier invoices in project currency that is directly attributable to the work performed.
  • Title: Raw Cost Commitments in Project Ledger Currency: Supplier Invoices
    Read Only: true
    Cost for the forecast version resource assignment committed through supplier invoices in project ledger currency that is directly attributable to the work performed.
  • Title: Burdened Cost: Total Commitments
    Read Only: true
    Total committed cost for the forecast version resource assignment in planning currency that includes both raw and burden costs.
  • Title: Burdened Cost in Project Currency: Total Commitments
    Read Only: true
    Total committed cost for the forecast version resource assignment in project currency that includes both raw and burden costs.
  • Title: Burdened Cost in Project Ledger Currency: Total Commitments
    Read Only: true
    Total committed cost for the forecast version resource assignment in project ledger currency that includes both raw and burden costs.
  • Title: Quantity: Total Commitments
    Read Only: true
    Committed effort for the forecast version resource assignment.
  • Title: Raw Cost: Total Commitments
    Read Only: true
    Total committed cost for the forecast version resource assignment in planning currency that is directly attributable to the work performed.
  • Title: Raw Cost in Project Currency: Total Commitments
    Read Only: true
    Total committed cost for the forecast version resource assignment in project currency that is directly attributable to the work performed.
  • Title: Raw Cost in Project Ledger Currency: Total Commitments
    Read Only: true
    Total committed cost for the forecast version resource assignment in project ledger currency that is directly attributable to the work performed.
  • Title: Burdened Cost Commitments: Transfer Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through transfer orders in planning currency that includes both raw and burden costs.
  • Title: Burdened Cost Commitments in Project Currency: Transfer Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through transfer orders in project currency that includes both raw and burden costs.
  • Title: Burdened Cost Commitments in Project Ledger Currency: Transfer Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through transfer orders in project ledger currency that includes both raw and burden costs.
  • Title: Quantity Commitments: Transfer Orders
    Read Only: true
    Effort for the forecast version resource assignment committed through transfer orders.
  • Title: Raw Cost Commitments: Transfer Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through transfer orders in planning currency that is directly attributable to the work performed.
  • Title: Raw Cost Commitments in Project Currency: Transfer Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through transfer orders in project currency that is directly attributable to the work performed.
  • Title: Raw Cost Commitments in Project Ledger Currency: Transfer Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through transfer orders in project ledger currency that is directly attributable to the work performed.
Nested Schema : Plan Lines Descriptive Flexfields
Type: array
Title: Plan Lines Descriptive Flexfields
The Plan Lines Descriptive Flexfields resource is used to capture and view additional information for planning amounts in project forecasts.
Show Source
Nested Schema : Planning Amount Details
Type: array
Title: Planning Amount Details
The Planning Amount Details resource is used to view project forecast resource assignment periodic amounts.
Show Source
Nested Schema : projectForecasts-PlanningResources-PlanningAmounts-PlanLinesDFF-item-response
Type: object
Show Source
Nested Schema : projectForecasts-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-response
Type: object
Show Source
  • Title: Burdened Cost: Actual Amounts
    Read Only: true
    Actual cost incurred for the forecast version resource assignment, including raw and burden costs, in planning currency from the start of the project till the current date.
  • Title: Burdened Cost in Project Currency: Actual Amounts
    Read Only: true
    Actual cost incurred for the forecast version resource assignment, including raw and burden costs, in project currency from the start of the project till the current date.
  • Title: Burdened Cost in Project Ledger Currency: Actual Amounts
    Read Only: true
    Actual cost incurred for the forecast version resource assignment, including raw and burden costs, in project ledger currency from the start of the project till the current date.
  • Title: Burdened Cost Rate
    Read Only: true
    Actual burdened cost rate that is used to calculate the actual cost for the forecast version resource assignment that includes both raw and burden costs.
  • Title: Quantity: Actual Amount
    Read Only: true
    Actual effort for the forecast version resource assignment from the start of the project till the current date.
  • Title: Raw Cost: Actual Amount
    Read Only: true
    Actual cost incurred for the period in the forecast version resource assignment in planning currency that is directly attributable to the work performed from the start of the project till the current date.
  • Title: Raw Cost in Project Currency: Actual Amounts
    Read Only: true
    Actual cost incurred for the forecast version resource assignment in project currency that is directly attributable to the work performed from the start of the project till the current date.
  • Title: Raw Cost in Project Ledger Currency: Actual Amounts
    Read Only: true
    Actual cost incurred for the forecast version resource assignment in project ledger currency that is directly attributable to the work performed from the start of the project till the current date.
  • Title: EAC Actual Raw Cost Rate
    Read Only: true
    Rate that is used to calculate the actual cost for the forecast version resource assignment that is directly attributable to the work performed.
  • Title: Revenue: Actual Amount
    Read Only: true
    Amount of revenue recognized for the forecast version resource assignment in planning currency from the inception of the project to date.
  • Title: Revenue in Project Currency: Actual Amounts
    Read Only: true
    Amount of revenue recognized for the forecast version resource assignment in project currency from the inception of the project to date.
  • Title: Revenue in Project Ledger Currency: Actual Amounts
    Read Only: true
    Amount of revenue recognized for the forecast version resource assignment in project ledger currency from the inception of the project to date.
  • Title: Revenue Rate: Actual Amount
    Read Only: true
    Rate that is used to calculate the actual revenue for the forecast version resource assignment.
  • Title: Burdened Cost: EAC
    Estimated cost in planning currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment.
  • Title: Burdened Cost in Project Currency: EAC
    Read Only: true
    Estimated cost in project currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment.
  • Title: Burdened Cost in Project Ledger Currency: EAC
    Read Only: true
    Estimated cost in project ledger currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment.
  • Title: Burdened Cost: Total Burdened Cost Rate
    Read Only: true
    Rate that is used to calculate the actual cost for the forecast version resource assignment that includes both raw and burden costs.
  • Title: Quantity: EAC
    Measure of the effort planned for in the forecast version resource assignment.
  • Title: Raw Cost: EAC
    Estimated cost in planning currency at the completion of the task in the period for the forecast version resource assignment that is directly attributable to the work performed.
  • Title: Raw Cost in Project Currency: EAC
    Read Only: true
    Estimated cost in project ledger currency at the completion of the task for the forecast version resource assignment that is directly attributable to the work performed.
  • Title: Raw Cost in Project Ledger Currency: EAC
    Read Only: true
    Estimated cost in project ledger currency at the completion of the task for the forecast version resource assignment that is directly attributable to the work performed.
  • Title: Raw Cost: Total Raw Cost Rate
    Read Only: true
    Rate that is used to calculate the estimated cost at the completion of the task for the forecast version resource assignment that is directly attributable to the work performed.
  • Title: Revenue
    Estimated revenue amount in planning currency recognized for the forecast version resource assignment at the completion of the task.
  • Title: Revenue in Project Ledger Currency: EAC
    Read Only: true
    Estimated revenue amount in project currency recognized for the forecast version resource assignment at the completion of the task.
  • Title: Revenue in Project Ledger Currency: EAC
    Read Only: true
    Estimated revenue amount in project ledger currency recognized for the forecast version resource assignment at the completion of the task.
  • Title: Revenue Rate
    Read Only: true
    Rate that is used to calculate the estimated revenue at the completion of the task for the forecast version resource assignment.
  • Title: Burdened Cost: Effective Rate
    Cost rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts.
  • Title: Raw Cost: Effective Rate
    Cost rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts.
  • Title: Effective Revenue Rate
    Revenue rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective revenue rate gives the revenue.
  • Title: Burdened Cost: ETC
    Read Only: true
    Estimated remaining cost in planning currency, including raw and burden costs, required for completion of the task by the forecast version resource assignment.
  • Title: Burdened Cost in Project Currency: ETC
    Read Only: true
    Estimated remaining cost in project currency, including raw and burden costs, required for completion of the task by the forecast version resource assignment.
  • Title: Burdened Cost in Project Ledger Currency: ETC
    Read Only: true
    Estimated remaining cost in project ledger currency, including raw and burden costs, required for completion of the task by the forecast version resource assignment.
  • Title: Quantity: ETC
    Read Only: true
    Estimated remaining effort by the forecast version resource assignment for completion.
  • Title: Raw Cost: ETC
    Read Only: true
    Estimated remaining cost in planning currency required for completion of the task in the period by the forecast version resource assignment that is directly attributable to the work performed.
  • Title: Raw Cost in Project Currency: ETC
    Read Only: true
    Estimated remaining cost in project currency required for completion of the task by the forecast version resource assignment that is directly attributable to the work performed.
  • Title: Raw Cost in Project Ledger Currency: ETC
    Read Only: true
    Estimated remaining cost in project ledger currency required for completion of the task by the forecast version resource assignment that is directly attributable to the work performed.
  • Title: Revenue: ETC
    Read Only: true
    Estimated remaining revenue amount in planning currency to be recognized for the forecast version resource assignment.
  • Title: Previous Forecast Revenue in Project Currency: ETC
    Read Only: true
    Estimated remaining revenue amount in project currency to be recognized for the forecast version resource assignment.
  • Title: Revenue in Project Ledger Currency: ETC
    Read Only: true
    Estimated remaining revenue amount in project ledger currency to be recognized for the forecast version resource assignment.
  • Links
  • Maximum Length: 1
    Indicates if the periodic planning is modified and retained for the plan line on date changes.
  • Title: Period
    Maximum Length: 30
    Period for which the periodic forecast amount is entered.
  • Identifier of the periodic level planning amounts for a resource assignment in the forecast version.
  • Title: Burdened Cost Commitments: Purchase Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through purchase orders in planning currency that includes both raw and burden costs.
  • Title: Burdened Cost Commitments in Project Currency: Purchase Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through purchase orders in project currency that includes both raw and burden costs.
  • Title: Burdened Cost Commitments in Project Ledger Currency: Purchase Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through purchase orders in project ledger currency that includes both raw and burden costs.
  • Title: Quantity Commitments: Purchase Orders
    Read Only: true
    Effort for the forecast version resource assignment committed through purchase orders.
  • Title: Raw Cost Commitments: Purchase Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through purchase orders in planning currency that is directly attributable to the work performed.
  • Title: Raw Cost Commitments in Project Currency: Purchase Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through purchase orders in project currency that is directly attributable to the work performed.
  • Title: Raw Cost Commitments in Project Ledger Currency: Purchase Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through purchase orders in project ledger currency that is directly attributable to the work performed.
  • Title: Burdened Cost Commitments: Requisitions
    Read Only: true
    Cost for the forecast version resource assignment committed through requisitions in planning currency that includes both raw and burden costs.
  • Title: Burdened Cost Commitments in Project Currency: Requisitions
    Read Only: true
    Cost for the forecast version resource assignment committed through requisitions in project currency that includes both raw and burden costs.
  • Title: Burdened Cost Commitments in Project Ledger Currency: Requisitions
    Read Only: true
    Cost for the forecast version resource assignment committed through requisitions in project ledger currency that includes both raw and burden costs.
  • Title: Quantity Commitments: Requisitions
    Read Only: true
    Effort for the forecast version resource assignment committed through requisitions.
  • Title: Raw Cost Commitments: Requisitions
    Read Only: true
    Cost for the forecast version resource assignment committed through requisitions in planning currency that is directly attributable to the work performed.
  • Title: Raw Cost Commitments in Project Currency: Requisitions
    Read Only: true
    Cost for the forecast version resource assignment committed through requisitions in project currency that is directly attributable to the work performed.
  • Title: Raw Cost Commitments in Project Ledger Currency: Requisitions
    Read Only: true
    Cost for the forecast version resource assignment committed through requisitions in project ledger currency that is directly attributable to the work performed.
  • Title: Burdened Cost: Standard Rate
    Read Only: true
    Average rate derived from the rate schedule for calculating the planned burdened cost for the forecast version resource assignment.
  • Title: Raw Cost: Standard Rate
    Read Only: true
    Rate derived from the rate schedule for calculating the planned raw cost for the forecast version resource assignment.
  • Title: Standard Revenue Rate
    Read Only: true
    Rate derived from the rate schedule for calculating the planned revenue for the forecast version resource assignment.
  • Title: Burdened Cost Commitments: Supplier Invoices
    Read Only: true
    Cost for the forecast version resource assignment committed through supplier invoices in planning currency that includes both raw and burden costs.
  • Title: Burdened Cost Commitments in Project Currency: Supplier Invoices
    Read Only: true
    Cost for the forecast version resource assignment committed through supplier invoices in project currency that includes both raw and burden costs.
  • Title: Burdened Cost Commitments in Project Ledger Currency: Supplier Invoices
    Read Only: true
    Cost for the forecast version resource assignment committed through supplier invoices in project ledger currency that includes both raw and burden costs.
  • Title: Quantity Commitments: Supplier Invoices
    Read Only: true
    Effort for the forecast version resource assignment committed through supplier invoices.
  • Title: Raw Cost Commitments: Supplier Invoices
    Read Only: true
    Cost for the forecast version resource assignment committed through supplier invoices in planning currency that is directly attributable to the work performed.
  • Title: Raw Cost Commitments in Project Currency: Supplier Invoices
    Read Only: true
    Cost for the forecast version resource assignment committed through supplier invoices in project currency that is directly attributable to the work performed.
  • Title: Raw Cost Commitments in Project Ledger Currency: Supplier Invoices
    Read Only: true
    Cost for the forecast version resource assignment committed through supplier invoices in project ledger currency that is directly attributable to the work performed.
  • Title: Burdened Cost: Total Commitments
    Read Only: true
    Total committed cost for the forecast version resource assignment in planning currency that includes both raw and burden costs.
  • Title: Burdened Cost in Project Currency: Total Commitments
    Read Only: true
    Total committed cost for the forecast version resource assignment in project currency that includes both raw and burden costs.
  • Title: Burdened Cost in Project Ledger Currency: Total Commitments
    Read Only: true
    Total committed cost for the forecast version resource assignment in project ledger currency that includes both raw and burden costs.
  • Title: Quantity: Total Commitments
    Read Only: true
    Committed effort for the forecast version resource assignment.
  • Title: Raw Cost: Total Commitments
    Read Only: true
    Total committed cost for the forecast version resource assignment in planning currency that is directly attributable to the work performed.
  • Title: Raw Cost in Project Currency: Total Commitments
    Read Only: true
    Total committed cost for the forecast version resource assignment in project currency that is directly attributable to the work performed.
  • Title: Raw Cost in Project Ledger Currency: Total Commitments
    Read Only: true
    Total committed cost for the forecast version resource assignment in project ledger currency that is directly attributable to the work performed.
  • Title: Burdened Cost Commitments: Transfer Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through transfer orders in planning currency that includes both raw and burden costs.
  • Title: Burdened Cost Commitments in Project Currency: Transfer Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through transfer orders in project currency that includes both raw and burden costs.
  • Title: Burdened Cost Commitments in Project Ledger Currency: Transfer Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through transfer orders in project ledger currency that includes both raw and burden costs.
  • Title: Quantity Commitments: Transfer Orders
    Read Only: true
    Effort for the forecast version resource assignment committed through transfer orders.
  • Title: Raw Cost Commitments: Transfer Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through transfer orders in planning currency that is directly attributable to the work performed.
  • Title: Raw Cost Commitments in Project Currency: Transfer Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through transfer orders in project currency that is directly attributable to the work performed.
  • Title: Raw Cost Commitments in Project Ledger Currency: Transfer Orders
    Read Only: true
    Cost for the forecast version resource assignment committed through transfer orders in project ledger currency that is directly attributable to the work performed.
Nested Schema : projectForecasts-VersionErrors-item-response
Type: object
Show Source
  • Title: Rejection Type
    Read Only: true
    Maximum Length: 30
    Specifies whether a warning or error.
  • Links
  • Title: Cause
    Read Only: true
    Maximum Length: 4000
    Explanation for the reason of an error or warning message.
  • Title: Message Name
    Read Only: true
    Maximum Length: 30
    Message code for the issue encountered.
  • Title: Message Text
    Read Only: true
    Maximum Length: 240
    Error or warning that occurs or information that informs users, to know what action to take or to understand what is happening.
  • Title: Action
    Read Only: true
    Maximum Length: 4000
    States the response that end users must perform to continue and complete their tasks in response to an error or warning message.
  • Title: Additional Details
    Read Only: true
    Maximum Length: 4000
    More detailed explanation of message text that states why the message occurred.
  • Title: Period
    Read Only: true
    Maximum Length: 30
    Period for which the periodic forecast amount is entered.
  • Title: Plan Version
    Read Only: true
    Identifier of the project forecast version.
  • Title: Resource
    Read Only: true
    Maximum Length: 240
    The name of the resource used to create the forecast line.
  • Title: Task Name
    Read Only: true
    Maximum Length: 255
    Name of the task which is used to create a forecast line.
  • Title: Task Number
    Read Only: true
    Maximum Length: 100
    Number of the task which is used to create a forecast line.
  • Title: Currency
    Read Only: true
    Maximum Length: 15
    Currency code for the forecast lines.
Back to Top

Examples

The following example shows how to update a project forecast version by submitting a PATCH request on the REST resource using cURL.

curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectForecasts/10736

Request Body Example

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

{ "PlanVersionDescription": "New Forecast Version"}

Response Body Example

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

{
            "PlanVersionId": 10736,
            "PlanVersionNumber": 1,
            "PlanVersionName": "Version 9",
            "PlanVersionDescription": "New Forecast Version",
            "PlanVersionStatus": "Original Approved",
            "ForecastCreationMethod": null,
            "ForecastCreationMethodCode": null,
            "ForecastGenerationSource": null,
            "ForecastGenerationSourceCode": null,
            "SourcePlanVersionId": null,
            "SourcePlanType": null,
            "SourcePlanVersionNumber": null,
            "SourcePlanVersionName": null,
            "SourcePlanVersionStatus": null,
            "ProjectId": 999991025,
            "ProjectNumber": "SMSEG-0000000000000000026",
            "ProjectName": "SMName-000000000000000026",
            "FinancialPlanType": "PSR CostRev Forecast",
            "DeferFinancialPlanCreation": null,
            "AdministrativeCode": null,
            "LockedFlag": false,
            "LockedBy": null,
            "PlanningAmounts": "COST_AND_REV_TOGETHER",
            "AdjustmentPercentage": null,
            "RawCostInProjectCurrency": 1278040,
            "BurdenedCostInProjectCurrency": 1917060,
            "RevenueInProjectCurrency": 2556080,
            "ActualRawCostInProjectCurrency": null,
            "ActualBurdenedCostInProjectCurrency": null,
            "ActualRevenueInProjectCurrency": null,
            "TotalCommitmentsInProjectCurrency": 0,
            "ETCStartDate": null,
            "ETCRawCostInProjectCurrency": 1278040,
            "ETCBurdenedCostInProjectCurrency": 1917060,
            "RawCostInProjectLedgerCurrency": 0,
            "BurdenedCostInProjectLedgerCurrency": 0,
            "RevenueInProjectLedgerCurrency": 0,
            "EACLaborEffort": 239410,
            "EACEquipmentEffort": 0,
            "CurrentBaselineBudgetMarginVariance": 0,
            "CurrentBaselineBudgetMarginVariancePercentage": 0,
            "OriginalBaselineBudgetMarginVariance": 0,
            "OriginalBaselineBudgetMarginVariancePercentage": 0,
            "CurrentForecastMarginVariance": 0,
            "CurrentForecastMarginVariancePercentage": 0,
            "PreviousForecastMarginVariance": 0,
            "PreviousForecastMarginVariancePercentage": 0,
            "Margin": 639020,
            "MarginPercentage": 25
}
Back to Top