Jump to

• Request
• Response
• Examples

Get all financial project plan versions

get

/fscmRestApi/resources/11.13.18.05/financialProjectPlans

Request

Query Parameters

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

  • PrimaryKey: Finds the financial project plan version.
    Finder Variables:
    • PlanVersionId; integer; Identifier of the financial project plan version.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • BaselineBurdenedCostInProjectCurrency; number; Total planned cost for the project, including raw and burden costs, in project currency in the baseline financial project plan version.
  • BaselineBurdenedCostInProjectLedgerCurrency; number; Total planned cost for the project, including raw and burden costs, in project ledger currency in the baseline financial project plan version.
  • BaselineEffort; number; Measure of the effort planned in the baseline financial project plan version, expressed in hours.
  • BaselineRawCostInProjectCurrency; number; Planned cost for the project in project currency in the baseline financial project plan version that corresponds to the work performed.
  • BaselineRawCostInProjectLedgerCurrency; number; Planned cost for the project in project ledger currency in the baseline financial project plan version that corresponds to the work performed.
  • BaselineRevenueInProjectCurrency; number; Planned revenue for the project, in project currency, in the baseline financial project plan version that corresponds to the work performed.
  • BaselineRevenueInProjectLedgerCurrency; number; Planned revenue for the project, in project ledger currency, in the baseline financial project plan version that corresponds to the work performed.
  • BurdenedCostInProjectCurrency; number; Total planned cost for the project in project currency that includes both raw and burden costs.
  • BurdenedCostInProjectLedgerCurrency; number; Total planned cost for the project in project ledger currency that includes both raw and burden costs.
  • ITDActualBurdenedCostInProjectCurrency; number; Actual cost incurred for the project, including raw and burden costs, in project currency from the start date of the project till the current date.
  • ITDActualBurdenedCostInProjectLedgerCurrency; number; Actual cost incurred for the project, including raw and burden costs, in project ledger currency from the start date of the project till the current date.
  • ITDActualEffort; number; Actual effort for the project from the start of the project till the current date, expressed in hours.
  • ITDActualRawCostInProjectCurrency; number; Actual cost incurred for the project in project currency that corresponds to the work performed from the start date of the project till the current date.
  • ITDActualRawCostInProjectLedgerCurrency; number; Actual cost incurred for the project in project ledger currency that corresponds to the work performed from the start date of the project till the current date.
  • ITDActualRevenueInProjectCurrency; number; Actual revenue incurred for the project, in project currency, that corresponds to the work performed from the start date of the project till the current date.
  • ITDActualRevenueInProjectLedgerCurrency; number; Actual revenue incurred for the project, in project ledger currency, that corresponds to the work performed from the start date of the project till the current date.
  • Margin; number; The difference between costs and revenue amounts.
  • MarginPercentage; number; The difference between costs and revenue amounts, expressed as a percentage.
  • PlanVersionId; integer; Identifier of the financial project plan version.
  • PlanVersionStatus; string; Indicates the status of the financial project plan version. Valid values are Current Working, Processing, and Failed.
  • PlannedEffort; number; Measure of the effort planned for in the financial project plan version, expressed in hours.
  • ProjectId; integer; Identifier of the project for which the financial project plan is created. You must enter either Project Name or Project Number but not for all three or a combination of them while creating a financial project plan.
  • ProjectName; string; Name of the project for which the financial project plan is created. You must enter either Project ID or Project Number but not for all three or a combination of them while creating a financial project plan.
  • ProjectNumber; string; Number of the project for which the financial project plan is created. You must enter either Project ID or Project Name but not for all three or a combination of them while creating a financial project plan.
  • ProjectPlanType; string; Name of the project plan type from which the financial project plan is created.
  • RawCostInProjectCurrency; number; Planned cost for the project in project currency that corresponds to the work performed.
  • RawCostInProjectLedgerCurrency; number; Planned cost for the project in project ledger currency that corresponds to the work performed.
  • RevenueInProjectCurrency; number; The estimated revenue for the project at the completion of the project in project currency.
  • RevenueInProjectLedgerCurrency; number; The estimated revenue for the project at the completion of the project in project ledger currency.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  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".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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".
• REST-Framework-Version:
  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 : financialProjectPlans

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{ "required":[ "count", "hasMore", "limit", "links", "offset" ], "type":"object", "properties":{ "totalResults":{ "type":"integer", "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included." }, "offset":{ "type":"integer", "description":"The offset value used in the current page." }, "count":{ "type":"integer", "description":"The number of resource instances returned in the current range." }, "hasMore":{ "type":"boolean", "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false." }, "limit":{ "type":"integer", "description":"The actual paging size used by the server." }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "items":{ "title":"Items", "type":"array", "description":"The items in the collection.", "items":{ "$ref":"#/components/schemas/financialProjectPlans-item-response" } } }, "x-hints":{ "usage":"BusinessObject" } }

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object financialProjectPlans-item-response

{ "title":"Items", "type":"array", "description":"The items in the collection.", "items":{ "$ref":"#/components/schemas/financialProjectPlans-item-response" } }

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }

Nested Schema : financialProjectPlans-item-response

Type: object

Show Source

• BaselineBurdenedCostInProjectCurrency: number
  Title: Rolled-up Baseline Cost for Resource in Project Currency

  Read Only: true

  Total planned cost for the project, including raw and burden costs, in project currency in the baseline financial project plan version.
• BaselineBurdenedCostInProjectLedgerCurrency: number
  Title: Burdened Cost in Project Ledger Currency

  Read Only: true

  Total planned cost for the project, including raw and burden costs, in project ledger currency in the baseline financial project plan version.
• BaselineEffort: number
  Title: Baseline

  Read Only: true

  Measure of the effort planned in the baseline financial project plan version, expressed in hours.
• BaselineRawCostInProjectCurrency: number
  Title: Rolled-up Baseline Cost for Resource in Project Currency

  Read Only: true

  Planned cost for the project in project currency in the baseline financial project plan version that corresponds to the work performed.
• BaselineRawCostInProjectLedgerCurrency: number
  Title: Baseline Cost in Project Ledger Currency

  Read Only: true

  Planned cost for the project in project ledger currency in the baseline financial project plan version that corresponds to the work performed.
• BaselineRevenueInProjectCurrency: number
  Title: Baseline Revenue in Project Currency

  Read Only: true

  Planned revenue for the project, in project currency, in the baseline financial project plan version that corresponds to the work performed.
• BaselineRevenueInProjectLedgerCurrency: number
  Title: Baseline Revenue in Project Ledger Currency

  Read Only: true

  Planned revenue for the project, in project ledger currency, in the baseline financial project plan version that corresponds to the work performed.
• BurdenedCostInProjectCurrency: number
  Title: Burdened Cost in Project Currency: Total

  Read Only: true

  Total planned cost for the project in project currency that includes both raw and burden costs.
• BurdenedCostInProjectLedgerCurrency: number
  Title: Burdened Cost in Project Ledger Currency: Total

  Read Only: true

  Total planned cost for the project in project ledger currency that includes both raw and burden costs.
• DeferProcessing: string
  Title: Defer Processing

  Indicates that the financial project plan version will be managed in a deferred mode.
• ITDActualBurdenedCostInProjectCurrency: number
  Title: Burdened Cost in Project Currency: Total

  Read Only: true

  Actual cost incurred for the project, including raw and burden costs, in project currency from the start date of the project till the current date.
• ITDActualBurdenedCostInProjectLedgerCurrency: number
  Title: ITD Actual in Project Ledger Currency

  Read Only: true

  Actual cost incurred for the project, including raw and burden costs, in project ledger currency from the start date of the project till the current date.
• ITDActualEffort: number
  Title: ITD Actual Effort

  Read Only: true

  Actual effort for the project from the start of the project till the current date, expressed in hours.
• ITDActualRawCostInProjectCurrency: number
  Title: ITD Actual in Project Currency

  Read Only: true

  Actual cost incurred for the project in project currency that corresponds to the work performed from the start date of the project till the current date.
• ITDActualRawCostInProjectLedgerCurrency: number
  Title: ITD Actual in Project Ledger Currency

  Read Only: true

  Actual cost incurred for the project in project ledger currency that corresponds to the work performed from the start date of the project till the current date.
• ITDActualRevenueInProjectCurrency: number
  Title: ITD Actual Revenue in Project Currency

  Read Only: true

  Actual revenue incurred for the project, in project currency, that corresponds to the work performed from the start date of the project till the current date.
• ITDActualRevenueInProjectLedgerCurrency: number
  Title: ITD Actual Revenue in Project Ledger Currency

  Read Only: true

  Actual revenue incurred for the project, in project ledger currency, that corresponds to the work performed from the start date of the project till the current date.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Margin: number
  Title: Margin

  Read Only: true

  The difference between costs and revenue amounts.
• MarginPercentage: number
  Title: Margin Percentage

  Read Only: true

  The difference between costs and revenue amounts, expressed as a percentage.
• PlannedEffort: number
  Title: Project Plan Effort

  Read Only: true

  Measure of the effort planned for in the financial project plan version, expressed in hours.
• PlanningOptions: array Planning Options
  Title: Planning Options

  The Planning Options resource is used to view the planning options configured for the financial project plan version. Planning options are user-definable options, that include plan settings, rate settings, currency settings, and generation options, and are used to control planning scenarios. Financial project plan versions inherit planning options that are defined for the project plan type that's associated to the project.
• PlanVersionId: integer (int64)
  Title: Plan Version

  Identifier of the financial project plan version.
• PlanVersionStatus: string
  Title: Plan Version Status

  Read Only: true

  Indicates the status of the financial project plan version. Valid values are Current Working, Processing, and Failed.
• ProjectId: integer (int64)
  Title: Project ID

  Identifier of the project for which the financial project plan is created. You must enter either Project Name or Project Number but not for all three or a combination of them while creating a financial project plan.
• ProjectName: string
  Title: Project Name

  Read Only: true

  Maximum Length: 240

  Name of the project for which the financial project plan is created. You must enter either Project ID or Project Number but not for all three or a combination of them while creating a financial project plan.
• ProjectNumber: string
  Title: Project Number

  Read Only: true

  Maximum Length: 25

  Number of the project for which the financial project plan is created. You must enter either Project ID or Project Name but not for all three or a combination of them while creating a financial project plan.
• ProjectPlanType: string
  Title: Financial Plan Type

  Read Only: true

  Maximum Length: 240

  Name of the project plan type from which the financial project plan is created.
• RawCostInProjectCurrency: number
  Title: Raw Cost in Project Currency: Total

  Read Only: true

  Planned cost for the project in project currency that corresponds to the work performed.
• RawCostInProjectLedgerCurrency: number
  Title: Raw Cost in Project Ledger Currency: Total

  Read Only: true

  Planned cost for the project in project ledger currency that corresponds to the work performed.
• ResourceAssignments: array Resource Assignments
  Title: Resource Assignments

  The Resource Assignments resource is used to view, create, update, and delete a financial project plan resource assignment.
• RevenueInProjectCurrency: number
  Title: Revenue in Project Currency

  Read Only: true

  The estimated revenue for the project at the completion of the project in project currency.
• RevenueInProjectLedgerCurrency: number
  Title: Revenue in Project Ledger Currency

  Read Only: true

  The estimated revenue for the project at the completion of the project in project ledger currency.
• VersionErrors: array Plan Version Errors
  Title: Plan Version Errors

  The Version Errors resource is used to view the errors in a financial project plan resource assignment.

{ "type":"object", "properties":{ "ProjectName":{ "title":"Project Name", "maxLength":240, "type":"string", "description":"Name of the project for which the financial project plan is created. You must enter either Project ID or Project Number but not for all three or a combination of them while creating a financial project plan.", "nullable":false, "readOnly":true, "x-queryable":true }, "ITDActualRawCostInProjectCurrency":{ "title":"ITD Actual in Project Currency", "type":"number", "description":"Actual cost incurred for the project in project currency that corresponds to the work performed from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "RawCostInProjectLedgerCurrency":{ "title":"Raw Cost in Project Ledger Currency: Total", "type":"number", "description":"Planned cost for the project in project ledger currency that corresponds to the work performed.", "nullable":true, "readOnly":true, "x-queryable":true }, "ITDActualRevenueInProjectLedgerCurrency":{ "title":"ITD Actual Revenue in Project Ledger Currency", "type":"number", "description":"Actual revenue incurred for the project, in project ledger currency, that corresponds to the work performed from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "VersionErrors":{ "title":"Plan Version Errors", "type":"array", "description":"The Version Errors resource is used to view the errors in a financial project plan resource assignment.", "items":{ "$ref":"#/components/schemas/financialProjectPlans-VersionErrors-item-response" } }, "BaselineBurdenedCostInProjectCurrency":{ "title":"Rolled-up Baseline Cost for Resource in Project Currency", "type":"number", "description":"Total planned cost for the project, including raw and burden costs, in project currency in the baseline financial project plan version.", "nullable":true, "readOnly":true, "x-queryable":true }, "ITDActualEffort":{ "title":"ITD Actual Effort", "type":"number", "description":"Actual effort for the project from the start of the project till the current date, expressed in hours.", "nullable":true, "readOnly":true, "x-queryable":true }, "ProjectPlanType":{ "title":"Financial Plan Type", "maxLength":240, "type":"string", "description":"Name of the project plan type from which the financial project plan is created.", "nullable":false, "readOnly":true, "x-queryable":true }, "ITDActualBurdenedCostInProjectLedgerCurrency":{ "title":"ITD Actual in Project Ledger Currency", "type":"number", "description":"Actual cost incurred for the project, including raw and burden costs, in project ledger currency from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "BaselineRevenueInProjectLedgerCurrency":{ "title":"Baseline Revenue in Project Ledger Currency", "type":"number", "description":"Planned revenue for the project, in project ledger currency, in the baseline financial project plan version that corresponds to the work performed.", "nullable":true, "readOnly":true, "x-queryable":true }, "ResourceAssignments":{ "title":"Resource Assignments", "type":"array", "description":"The Resource Assignments resource is used to view, create, update, and delete a financial project plan resource assignment.", "items":{ "$ref":"#/components/schemas/financialProjectPlans-ResourceAssignments-item-response" } }, "BaselineRawCostInProjectCurrency":{ "title":"Rolled-up Baseline Cost for Resource in Project Currency", "type":"number", "description":"Planned cost for the project in project currency in the baseline financial project plan version that corresponds to the work performed.", "nullable":true, "readOnly":true, "x-queryable":true }, "ITDActualBurdenedCostInProjectCurrency":{ "title":"Burdened Cost in Project Currency: Total", "type":"number", "description":"Actual cost incurred for the project, including raw and burden costs, in project currency from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "RevenueInProjectCurrency":{ "title":"Revenue in Project Currency", "type":"number", "description":"The estimated revenue for the project at the completion of the project in project currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "RawCostInProjectCurrency":{ "title":"Raw Cost in Project Currency: Total", "type":"number", "description":"Planned cost for the project in project currency that corresponds to the work performed.", "nullable":true, "readOnly":true, "x-queryable":true }, "BaselineRevenueInProjectCurrency":{ "title":"Baseline Revenue in Project Currency", "type":"number", "description":"Planned revenue for the project, in project currency, in the baseline financial project plan version that corresponds to the work performed.", "nullable":true, "readOnly":true, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "BaselineRawCostInProjectLedgerCurrency":{ "title":"Baseline Cost in Project Ledger Currency", "type":"number", "description":"Planned cost for the project in project ledger currency in the baseline financial project plan version that corresponds to the work performed.", "nullable":true, "readOnly":true, "x-queryable":true }, "PlanningOptions":{ "title":"Planning Options", "type":"array", "description":"The Planning Options resource is used to view the planning options configured for the financial project plan version. Planning options are user-definable options, that include plan settings, rate settings, currency settings, and generation options, and are used to control planning scenarios. Financial project plan versions inherit planning options that are defined for the project plan type that's associated to the project.", "items":{ "$ref":"#/components/schemas/financialProjectPlans-PlanningOptions-item-response" }, "x-cardinality":"1" }, "DeferProcessing":{ "title":"Defer Processing", "type":"string", "description":"Indicates that the financial project plan version will be managed in a deferred mode.", "nullable":true, "x-queryable":false }, "PlannedEffort":{ "title":"Project Plan Effort", "type":"number", "description":"Measure of the effort planned for in the financial project plan version, expressed in hours.", "nullable":true, "readOnly":true, "x-queryable":true }, "ProjectNumber":{ "title":"Project Number", "maxLength":25, "type":"string", "description":"Number of the project for which the financial project plan is created. You must enter either Project ID or Project Name but not for all three or a combination of them while creating a financial project plan.", "nullable":false, "readOnly":true, "x-queryable":true }, "PlanVersionId":{ "title":"Plan Version", "type":"integer", "description":"Identifier of the financial project plan version.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "x-queryable":true }, "ProjectId":{ "title":"Project ID", "type":"integer", "description":"Identifier of the project for which the financial project plan is created. You must enter either Project Name or Project Number but not for all three or a combination of them while creating a financial project plan.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "x-queryable":true }, "ITDActualRawCostInProjectLedgerCurrency":{ "title":"ITD Actual in Project Ledger Currency", "type":"number", "description":"Actual cost incurred for the project in project ledger currency that corresponds to the work performed from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "BurdenedCostInProjectCurrency":{ "title":"Burdened Cost in Project Currency: Total", "type":"number", "description":"Total planned cost for the project in project currency that includes both raw and burden costs.", "nullable":true, "readOnly":true, "x-queryable":true }, "BurdenedCostInProjectLedgerCurrency":{ "title":"Burdened Cost in Project Ledger Currency: Total", "type":"number", "description":"Total planned cost for the project in project ledger currency that includes both raw and burden costs.", "nullable":true, "readOnly":true, "x-queryable":true }, "RevenueInProjectLedgerCurrency":{ "title":"Revenue in Project Ledger Currency", "type":"number", "description":"The estimated revenue for the project at the completion of the project in project ledger currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "PlanVersionStatus":{ "title":"Plan Version Status", "type":"string", "description":"Indicates the status of the financial project plan version. Valid values are Current Working, Processing, and Failed.", "nullable":true, "readOnly":true, "x-queryable":true }, "BaselineBurdenedCostInProjectLedgerCurrency":{ "title":"Burdened Cost in Project Ledger Currency", "type":"number", "description":"Total planned cost for the project, including raw and burden costs, in project ledger currency in the baseline financial project plan version.", "nullable":true, "readOnly":true, "x-queryable":true }, "MarginPercentage":{ "title":"Margin Percentage", "type":"number", "description":"The difference between costs and revenue amounts, expressed as a percentage.", "nullable":true, "readOnly":true, "x-queryable":true }, "ITDActualRevenueInProjectCurrency":{ "title":"ITD Actual Revenue in Project Currency", "type":"number", "description":"Actual revenue incurred for the project, in project currency, that corresponds to the work performed from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "BaselineEffort":{ "title":"Baseline", "type":"number", "description":"Measure of the effort planned in the baseline financial project plan version, expressed in hours.", "nullable":true, "readOnly":true, "x-queryable":true }, "Margin":{ "title":"Margin", "type":"number", "description":"The difference between costs and revenue amounts.", "nullable":true, "readOnly":true, "x-queryable":true } } }

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }

Nested Schema : Planning Options

Type: array

Title: Planning Options

The Planning Options resource is used to view the planning options configured for the financial project plan version. Planning options are user-definable options, that include plan settings, rate settings, currency settings, and generation options, and are used to control planning scenarios. Financial project plan versions inherit planning options that are defined for the project plan type that's associated to the project.

Show Source

• Array of: object financialProjectPlans-PlanningOptions-item-response

{ "title":"Planning Options", "type":"array", "description":"The Planning Options resource is used to view the planning options configured for the financial project plan version. Planning options are user-definable options, that include plan settings, rate settings, currency settings, and generation options, and are used to control planning scenarios. Financial project plan versions inherit planning options that are defined for the project plan type that's associated to the project.", "items":{ "$ref":"#/components/schemas/financialProjectPlans-PlanningOptions-item-response" }, "x-cardinality":"1" }

Nested Schema : Resource Assignments

Type: array

Title: Resource Assignments

The Resource Assignments resource is used to view, create, update, and delete a financial project plan resource assignment.

Show Source

• Array of: object financialProjectPlans-ResourceAssignments-item-response

{ "title":"Resource Assignments", "type":"array", "description":"The Resource Assignments resource is used to view, create, update, and delete a financial project plan resource assignment.", "items":{ "$ref":"#/components/schemas/financialProjectPlans-ResourceAssignments-item-response" } }

Nested Schema : Plan Version Errors

Type: array

Title: Plan Version Errors

The Version Errors resource is used to view the errors in a financial project plan resource assignment.

Show Source

• Array of: object financialProjectPlans-VersionErrors-item-response

{ "title":"Plan Version Errors", "type":"array", "description":"The Version Errors resource is used to view the errors in a financial project plan resource assignment.", "items":{ "$ref":"#/components/schemas/financialProjectPlans-VersionErrors-item-response" } }

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{ "type":"object", "properties":{ "kind":{ "title":"kind", "type":"string", "description":"The kind of the related resource.", "enum":[ "collection", "item", "describe", "other" ] }, "rel":{ "title":"relation", "type":"string", "description":"The name of the relation to the resource instance. Example: self.", "enum":[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ] }, "name":{ "title":"name", "type":"string", "description":"The name of the link to the related resource." }, "href":{ "title":"hyperlink reference", "type":"string", "description":"The URI to the related resource." }, "properties":{ "type":"object", "properties":{ "changeIndicator":{ "type":"string", "description":"Change indicator or the ETag value of the resource instance." } } } } }

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{ "type":"object", "properties":{ "changeIndicator":{ "type":"string", "description":"Change indicator or the ETag value of the resource instance." } } }

Nested Schema : financialProjectPlans-PlanningOptions-item-response

Type: object

Show Source

• AllowNegativeETCCalculationFlag: boolean
  Title: Allow Negative ETC Calculation

  Maximum Length: 1

  Indicates whether estimate-to-complete values can be lesser than zero. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
• AssociateProjectCostsToSummaryTaskAssignmentsFlag: boolean
  Title: Associate project costs to summary task assignments

  Maximum Length: 1

  Indicates whether project costs for a resource assignment from a lowest level task can be associated to a planned resource assignment on the financial project plan at a higher level in the task structure. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
• AutoApproveFlag: boolean
  Title: Automatically approve forecast

  Maximum Length: 1

  Indicates if the forecast that's created using the financial plan type is automatically approved.
• AutoBaselineFlag: boolean
  Title: Automatically designate budget version as baseline

  Maximum Length: 1

  Indicates if the budget that's created using the financial plan type is automatically set to baseline.
• AutomaticallyGenerateBudgetVersionFlag: boolean
  Title: Automatically Generate Budget Version

  Maximum Length: 1

  Indicates if a budget is being created using the financial plan type while baseline of the financial project plan. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
• AutomaticallyGenerateForecastVersionFlag: boolean
  Title: Automatically generate forecast version

  Maximum Length: 1

  Indicates if a forecast is being created using the financial plan type while publishing progress. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
• BudgetFinancialPlanType: string
  Title: Budget Financial Plan Type

  Read Only: true

  Maximum Length: 255

  The name of the financial plan type that's used to create the budget version.
• BufferForSynchronizeTaskTransactionDatesWithTaskPlannedDates: number
  Title: Buffer for Synchronize Task Transaction Dates with Task Planned Dates

  Buffer value to adjust the task transaction dates to be changed along with the task planned dates.
• BurdenScheduleCostOptions: string
  Title: Burden Schedule

  Maximum Length: 255

  A set of burden multipliers that's maintained for use across projects. Also referred to as a standard burden schedule.
• CalendarType: string
  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.
• CurrentPlanningPeriod: string
  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 isn't applicable when the calendar type is set to NONE.
• DateTypeForConversionInPC: string
  Title: Project Currency Conversion: Cost Date Type

  Maximum Length: 255

  Date type that's used as a cost conversion attribute for project currency.
• DateTypeForConversionInPLC: string
  Title: Project Ledger Currency Conversion: Cost Date Type

  Maximum Length: 255

  Date type that's used as a cost conversion attribute for project ledger currency.
• DateTypeForCostConversion: string
  Title: Date Type for Cost Conversion

  Maximum Length: 255

  Date type that's used as a cost conversion attribute for planning currencies.
• DateTypeForRevenueConversion: string
  Title: Date Type for Revenue Conversion

  Read Only: true

  Maximum Length: 255

  Date type that's used as a revenue conversion attribute for planning currencies.
• EnableCostsForPlanFlag: boolean
  Title: Enable Costs for Plan

  Maximum Length: 1

  Indicates whether resource assignments can be created on the project and allow capturing costs for the project. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
• EnableRevenueForPlanFlag: boolean
  Title: Enable Revenue for Plan

  Maximum Length: 1

  Indicates whether resource assignments can be created on the project and allow planning revenue for the project. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
• EstimateToCompleteMethod: string
  Title: Estimate to Complete Method

  Maximum Length: 30

  Calculates estimate-to-complete value for the task and task assignment. The valid values are Remaining Plan and Manual Entry.
• FixedDateForConversionInPC: string (date-time)
  Title: Project Currency Conversion: Cost Fixed Date

  The date that's used to derive conversion rates for calculating planned costs for project currency.
• FixedDateForConversionInPLC: string (date-time)
  Title: Project Ledger Currency Conversion: Cost Fixed Date

  The date that's used to derive conversion rates for calculating planned costs for project ledger currency.
• FixedDateForCostConversion: string (date-time)
  Title: Fixed Date for Cost Conversion

  The date that's used to derive conversion rates for calculating planned costs for planning currencies.
• FixedDateForRevenueConversion: string (date-time)
  Title: Fixed Date for Revenue Conversion

  The date that's used to derive rates for calculating planned revenue for planning currencies.
• ForecastFinancialPlanType: string
  Title: Forecast Financial Plan Type

  Read Only: true

  Maximum Length: 255

  The name of the financial plan type that's used to create the forecast version.
• JobCostOptions: string
  Title: Job Cost Options

  Read Only: true

  Maximum Length: 255

  Rate schedule used for the calculation of cost amounts for jobs.
• JobRevenueOptions: string
  Title: Job Revenue Options

  Maximum Length: 255

  Rate schedule that's used for calculation of revenue amounts for jobs.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaintainManualSpreadOnDateChanges: string
  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 indicates that the attribute isn't selected.
• MultipleTransactionCurrencies: string
  Title: Multiple Transaction Currencies

  Maximum Length: 1

  Indicates that the plan can use multiple transaction currencies for planning. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
• NonlaborResourceCostOptions: string
  Title: Nonlabor Resource

  Maximum Length: 255

  Rate schedule used for the calculation of cost amounts for non-labor resources.
• NonlaborResourceRevenueOptions: string
  Title: Nonlabor Resource Revenue Options

  Maximum Length: 255

  Rate schedule that's used for calculation of revenue amounts for non-labor resources.
• PeriodProfile: string
  Title: Period Profile

  Maximum Length: 255

  Defines how time periods are grouped and displayed when editing resource assignment versions.
• PersonCostOptions: string
  Title: Person Cost Options

  Maximum Length: 255

  Rate schedule used for the calculation of cost amounts for named persons.
• PersonRevenueOptions: string
  Title: Person Revenue Options

  Maximum Length: 255

  Rate schedule that's used for calculation of revenue amounts for named persons.
• PhysicalPercentCompleteCalculationMethod: string
  Title: Physical Percent Complete Calculation Method

  Maximum Length: 30

  Calculates physical percent complete at the lowest level task. The valid values are Cost, Effort, and Manual Entry.
• PlanningCurrencies: array Planning Currencies
  Title: Planning Currencies

  The Planning Currency resource is used to view, create, update, and delete project and planning currencies.
• PlanningOptionId: integer (int64)
  Title: Planning Option ID

  Unique identifier of the summary level planning option in the financial project plan version.
• PlanningOptionsDFF: array Planning Options Descriptive Flexfields
  Title: Planning Options Descriptive Flexfields

  A listing of all the descriptive flexfields available for planning options in the financial project plan version.
• PlanningResourceBreakdownStructure: string
  Title: Planning Resource Breakdown Structure

  Maximum Length: 255

  Primary planning resource breakdown structure associated with the project.
• PrimaryPhysicalPercentCompleteBasis: string
  Title: Primary Physical Percent Complete Basis

  Maximum Length: 30

  Determines the primary physical percent complete value for summary tasks. The valid values are Cost, Effort, and Manual Entry.
• ProjectCurrency: string
  Title: Project Currency

  Read Only: true

  Maximum Length: 15

  Currency for the project.
• ProjectLedgerCurrency: string
  Title: Project Ledger Currency

  Read Only: true

  Maximum Length: 15

  Project ledger currency for the project.
• ProjectRoleCostOptions: string
  Title: Project Role Cost Options

  Maximum Length: 255

  Rate schedule used for the calculation of cost amounts for project role.
• ProjectRoleRevenueOptions: string
  Title: Project Role Revenue Options

  Maximum Length: 255

  Rate schedule that's used for calculation of revenue amounts for project role.
• RateDerivationDate: string (date-time)
  Title: Rate Derivation Date

  The date that's used as the basis for deriving rates for calculating amounts on a None time-phased resource assignment version.
• RateDerivationDateType: string
  Title: Rate Derivation Date Type

  Maximum Length: 255

  The date type, such as system date or fixed date, that's used as the basis for deriving rates for calculating amounts on a None time-phased resource assignment version.
• RateTypeForConversionInPC: string
  Title: Project Currency Conversion: Cost Rate Type

  Maximum Length: 255

  Rate type that's used as a cost conversion attribute for project currency.
• RateTypeForConversionInPLC: string
  Title: Project Ledger Currency Conversion: Cost Rate Type

  Maximum Length: 255

  Rate type that's used as a cost conversion attribute for project ledger currency.
• RateTypeForCostConversion: string
  Title: Rate Type for Cost Conversion

  Maximum Length: 255

  Rate type that's used as a cost conversion attribute for planning currencies.
• RateTypeForRevenueConversion: string
  Title: Rate Type for Revenue Conversion

  Read Only: true

  Maximum Length: 255

  Revenue rate type that's used as a revenue conversion attribute for planning currencies.
• ResourceClassCostOptions: string
  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.
• ResourceClassRevenueOptions: string
  Title: Resource Class Revenue Options

  Maximum Length: 255

  Rate schedule that's used for 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.
• RevenueCalculationMethod: string
  Title: Revenue Calculation Method

  Maximum Length: 30

  Determines whether financial project plan revenue is calculated based on quantity and rates, event amounts, or the spread ratio specified for tasks.
• RevenueDateTypeForConversionInPC: string
  Title: Revenue Date Type for Conversion in Project Currency

  Read Only: true

  Maximum Length: 255

  Date type that's used as a revenue conversion attribute for project currency.
• RevenueDateTypeForConversionInPLC: string
  Title: Revenue Date Type for Conversion in Project Ledger Currency

  Read Only: true

  Maximum Length: 255

  Date type that's used as a revenue conversion attribute for project ledger currency.
• RevenueFixedDateForConversionInPC: string (date-time)
  Title: Revenue Fixed Date for Conversion in Project Currency

  The date that's used for calculating planned revenue in project currency.
• RevenueFixedDateForConversionInPLC: string (date-time)
  Title: Revenue Fixed Date for Conversion in Project Ledger Currency

  The date that's used for calculating planned revenue in project ledger currency.
• RevenueRateTypeForConversionInPC: string
  Title: Revenue Rate Type for Conversion in Project Currency

  Read Only: true

  Maximum Length: 255

  Revenue rate type that's used as a revenue conversion attribute for project currency.
• RevenueRateTypeForConversionInPLC: string
  Title: Revenue Rate Type for Conversion in Project Ledger Currency

  Read Only: true

  Maximum Length: 255

  Revenue rate type that's used as a revenue conversion attribute for project ledger currency.
• RollUpTaskDatesFlag: boolean
  Title: Roll Up Task Dates

  Maximum Length: 1

  Indicates whether summary task dates are rolled up from the lowest level task dates. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
• SetUnplannedAssignmentsAsPlannedAssignmentsFlag: boolean
  Title: Set unplanned assignments as planned assignments

  Maximum Length: 1

  Indicates whether resource assignments can be created as planned on the project on incurring costs for the project. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
• SynchronizeTaskTransactionDatesWithTaskPlannedDatesFlag: boolean
  Title: Synchronize Task Transaction Dates with Task Planned Dates

  Maximum Length: 1

  Indicates whether task transaction dates are synchronized with task planned dates. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
• ThirdPartySchedulingFlag: boolean
  Title: Third Party Scheduling

  Maximum Length: 1

  Indicates that the plan can use a third-party scheduling tool. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
• UpdatePlannedQuantityWithEACQuantityFlag: boolean
  Title: Update planned quantity with EAC quantity

  Maximum Length: 1

  Indicates whether planned values for task assignments can be updated with estimate-at-completion values while publishing progress. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.
• UsePlanningRatesFlag: boolean
  Title: Use Planning Rates

  Maximum Length: 1

  Enables utilization of planning rates for resources and resource classes when calculating resource assignment amounts.
• UseSameConversionAttributeForAllCurrencyConversionsFlag: boolean
  Title: Use Same Conversion Attribute for All Currency Conversions

  Indicates whether you can use the same currency conversion attribute for all currencies.
• UseSameDatesForTaskAssignmentsAsTaskDatesFlag: boolean
  Title: Use Same Dates for Task Assignments as Task Dates

  Maximum Length: 1

  Indicates whether you can use the same dates for the task assignments as the task dates. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.

{ "type":"object", "properties":{ "RateTypeForRevenueConversion":{ "title":"Rate Type for Revenue Conversion", "maxLength":255, "type":"string", "description":"Revenue rate type that's used as a revenue conversion attribute for planning currencies.", "nullable":true, "readOnly":true, "x-queryable":true }, "PhysicalPercentCompleteCalculationMethod":{ "title":"Physical Percent Complete Calculation Method", "maxLength":30, "type":"string", "description":"Calculates physical percent complete at the lowest level task. The valid values are Cost, Effort, and Manual Entry.", "nullable":true, "x-queryable":true }, "PlanningResourceBreakdownStructure":{ "title":"Planning Resource Breakdown Structure", "maxLength":255, "type":"string", "description":"Primary planning resource breakdown structure associated with the project.", "nullable":true, "x-queryable":true }, "PersonCostOptions":{ "title":"Person Cost Options", "maxLength":255, "type":"string", "description":"Rate schedule used for the calculation of cost amounts for named persons.", "nullable":true, "x-queryable":true }, "EstimateToCompleteMethod":{ "title":"Estimate to Complete Method", "maxLength":30, "type":"string", "description":"Calculates estimate-to-complete value for the task and task assignment. The valid values are Remaining Plan and Manual Entry.", "nullable":true, "x-queryable":true }, "RateTypeForConversionInPLC":{ "title":"Project Ledger Currency Conversion: Cost Rate Type", "maxLength":255, "type":"string", "description":"Rate type that's used as a cost conversion attribute for project ledger currency.", "nullable":true, "x-queryable":true }, "AutomaticallyGenerateForecastVersionFlag":{ "title":"Automatically generate forecast version", "maxLength":1, "type":"boolean", "description":"Indicates if a forecast is being created using the financial plan type while publishing progress. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.", "nullable":false, "x-queryable":true }, "JobCostOptions":{ "title":"Job Cost Options", "maxLength":255, "type":"string", "description":"Rate schedule used for the calculation of cost amounts for jobs.", "nullable":true, "readOnly":true, "x-queryable":true }, "FixedDateForRevenueConversion":{ "title":"Fixed Date for Revenue Conversion", "type":"string", "description":"The date that's used to derive rates for calculating planned revenue for planning currencies.", "format":"date-time", "nullable":true, "x-queryable":true }, "UseSameDatesForTaskAssignmentsAsTaskDatesFlag":{ "title":"Use Same Dates for Task Assignments as Task Dates", "maxLength":1, "type":"boolean", "description":"Indicates whether you can use the same dates for the task assignments as the task dates. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.", "nullable":false, "x-queryable":true }, "FixedDateForConversionInPC":{ "title":"Project Currency Conversion: Cost Fixed Date", "type":"string", "description":"The date that's used to derive conversion rates for calculating planned costs for project currency.", "format":"date-time", "nullable":true, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "RollUpTaskDatesFlag":{ "title":"Roll Up Task Dates", "maxLength":1, "type":"boolean", "description":"Indicates whether summary task dates are rolled up from the lowest level task dates. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.", "nullable":false, "x-queryable":true }, "DateTypeForCostConversion":{ "title":"Date Type for Cost Conversion", "maxLength":255, "type":"string", "description":"Date type that's used as a cost conversion attribute for planning currencies.", "nullable":true, "x-queryable":true }, "RevenueRateTypeForConversionInPLC":{ "title":"Revenue Rate Type for Conversion in Project Ledger Currency", "maxLength":255, "type":"string", "description":"Revenue rate type that's used as a revenue conversion attribute for project ledger currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "ResourceClassCostOptions":{ "title":"Resource Class Cost Options", "maxLength":255, "type":"string", "description":"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.", "nullable":true, "x-queryable":true }, "UsePlanningRatesFlag":{ "title":"Use Planning Rates", "maxLength":1, "type":"boolean", "description":"Enables utilization of planning rates for resources and resource classes when calculating resource assignment amounts.", "nullable":false, "x-queryable":true }, "AutoBaselineFlag":{ "title":"Automatically designate budget version as baseline", "maxLength":1, "type":"boolean", "description":"Indicates if the budget that's created using the financial plan type is automatically set to baseline.", "nullable":false, "x-queryable":true }, "BudgetFinancialPlanType":{ "title":"Budget Financial Plan Type", "maxLength":255, "type":"string", "description":"The name of the financial plan type that's used to create the budget version.", "nullable":true, "readOnly":true, "x-queryable":true }, "FixedDateForCostConversion":{ "title":"Fixed Date for Cost Conversion", "type":"string", "description":"The date that's used to derive conversion rates for calculating planned costs for planning currencies.", "format":"date-time", "nullable":true, "x-queryable":true }, "RevenueDateTypeForConversionInPLC":{ "title":"Revenue Date Type for Conversion in Project Ledger Currency", "maxLength":255, "type":"string", "description":"Date type that's used as a revenue conversion attribute for project ledger currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "EnableRevenueForPlanFlag":{ "title":"Enable Revenue for Plan", "maxLength":1, "type":"boolean", "description":"Indicates whether resource assignments can be created on the project and allow planning revenue for the project. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.", "nullable":true, "x-queryable":true }, "EnableCostsForPlanFlag":{ "title":"Enable Costs for Plan", "maxLength":1, "type":"boolean", "description":"Indicates whether resource assignments can be created on the project and allow capturing costs for the project. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.", "nullable":true, "x-queryable":true }, "MaintainManualSpreadOnDateChanges":{ "title":"Maintain manual spread on date changes", "maxLength":1, "type":"string", "description":"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 indicates that the attribute isn't selected.", "nullable":true, "x-queryable":true }, "RateDerivationDate":{ "title":"Rate Derivation Date", "type":"string", "description":"The date that's used as the basis for deriving rates for calculating amounts on a None time-phased resource assignment version.", "format":"date-time", "nullable":true, "x-queryable":true }, "RevenueFixedDateForConversionInPC":{ "title":"Revenue Fixed Date for Conversion in Project Currency", "type":"string", "description":"The date that's used for calculating planned revenue in project currency.", "format":"date-time", "nullable":true, "x-queryable":true }, "NonlaborResourceRevenueOptions":{ "title":"Nonlabor Resource Revenue Options", "maxLength":255, "type":"string", "description":"Rate schedule that's used for calculation of revenue amounts for non-labor resources.", "nullable":true, "x-queryable":true }, "RevenueRateTypeForConversionInPC":{ "title":"Revenue Rate Type for Conversion in Project Currency", "maxLength":255, "type":"string", "description":"Revenue rate type that's used as a revenue conversion attribute for project currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "SetUnplannedAssignmentsAsPlannedAssignmentsFlag":{ "title":"Set unplanned assignments as planned assignments", "maxLength":1, "type":"boolean", "description":"Indicates whether resource assignments can be created as planned on the project on incurring costs for the project. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.", "nullable":true, "x-queryable":true }, "AutomaticallyGenerateBudgetVersionFlag":{ "title":"Automatically Generate Budget Version", "maxLength":1, "type":"boolean", "description":"Indicates if a budget is being created using the financial plan type while baseline of the financial project plan. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.", "nullable":false, "x-queryable":true }, "FixedDateForConversionInPLC":{ "title":"Project Ledger Currency Conversion: Cost Fixed Date", "type":"string", "description":"The date that's used to derive conversion rates for calculating planned costs for project ledger currency.", "format":"date-time", "nullable":true, "x-queryable":true }, "UpdatePlannedQuantityWithEACQuantityFlag":{ "title":"Update planned quantity with EAC quantity", "maxLength":1, "type":"boolean", "description":"Indicates whether planned values for task assignments can be updated with estimate-at-completion values while publishing progress. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.", "nullable":false, "x-queryable":true }, "JobRevenueOptions":{ "title":"Job Revenue Options", "maxLength":255, "type":"string", "description":"Rate schedule that's used for calculation of revenue amounts for jobs.", "nullable":true, "x-queryable":true }, "RateTypeForConversionInPC":{ "title":"Project Currency Conversion: Cost Rate Type", "maxLength":255, "type":"string", "description":"Rate type that's used as a cost conversion attribute for project currency.", "nullable":true, "x-queryable":true }, "AllowNegativeETCCalculationFlag":{ "title":"Allow Negative ETC Calculation", "maxLength":1, "type":"boolean", "description":"Indicates whether estimate-to-complete values can be lesser than zero. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.", "nullable":true, "x-queryable":true }, "ResourceClassRevenueOptions":{ "title":"Resource Class Revenue Options", "maxLength":255, "type":"string", "description":"Rate schedule that's used for 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.", "nullable":true, "x-queryable":true }, "AutoApproveFlag":{ "title":"Automatically approve forecast", "maxLength":1, "type":"boolean", "description":"Indicates if the forecast that's created using the financial plan type is automatically approved.", "nullable":false, "x-queryable":true }, "DateTypeForRevenueConversion":{ "title":"Date Type for Revenue Conversion", "maxLength":255, "type":"string", "description":"Date type that's used as a revenue conversion attribute for planning currencies.", "nullable":true, "readOnly":true, "x-queryable":true }, "RateDerivationDateType":{ "title":"Rate Derivation Date Type", "maxLength":255, "type":"string", "description":"The date type, such as system date or fixed date, that's used as the basis for deriving rates for calculating amounts on a None time-phased resource assignment version.", "nullable":true, "x-queryable":true }, "RevenueCalculationMethod":{ "title":"Revenue Calculation Method", "maxLength":30, "type":"string", "description":"Determines whether financial project plan revenue is calculated based on quantity and rates, event amounts, or the spread ratio specified for tasks.", "nullable":true, "x-queryable":true }, "BufferForSynchronizeTaskTransactionDatesWithTaskPlannedDates":{ "title":"Buffer for Synchronize Task Transaction Dates with Task Planned Dates", "type":"number", "description":"Buffer value to adjust the task transaction dates to be changed along with the task planned dates.", "nullable":true, "x-queryable":true }, "ProjectCurrency":{ "title":"Project Currency", "maxLength":15, "type":"string", "description":"Currency for the project.", "nullable":false, "readOnly":true, "x-queryable":true }, "PlanningOptionId":{ "title":"Planning Option ID", "type":"integer", "description":"Unique identifier of the summary level planning option in the financial project plan version.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "x-queryable":true }, "RevenueFixedDateForConversionInPLC":{ "title":"Revenue Fixed Date for Conversion in Project Ledger Currency", "type":"string", "description":"The date that's used for calculating planned revenue in project ledger currency.", "format":"date-time", "nullable":true, "x-queryable":true }, "SynchronizeTaskTransactionDatesWithTaskPlannedDatesFlag":{ "title":"Synchronize Task Transaction Dates with Task Planned Dates", "maxLength":1, "type":"boolean", "description":"Indicates whether task transaction dates are synchronized with task planned dates. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.", "nullable":false, "x-queryable":true }, "DateTypeForConversionInPLC":{ "title":"Project Ledger Currency Conversion: Cost Date Type", "maxLength":255, "type":"string", "description":"Date type that's used as a cost conversion attribute for project ledger currency.", "nullable":true, "x-queryable":true }, "ProjectRoleRevenueOptions":{ "title":"Project Role Revenue Options", "maxLength":255, "type":"string", "description":"Rate schedule that's used for calculation of revenue amounts for project role.", "nullable":true, "x-queryable":true }, "CurrentPlanningPeriod":{ "title":"Current Planning Period", "maxLength":15, "type":"string", "description":"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 isn't applicable when the calendar type is set to NONE.", "nullable":true, "x-queryable":true }, "PlanningCurrencies":{ "title":"Planning Currencies", "type":"array", "description":"The Planning Currency resource is used to view, create, update, and delete project and planning currencies.", "items":{ "$ref":"#/components/schemas/financialProjectPlans-PlanningOptions-PlanningCurrencies-item-response" } }, "MultipleTransactionCurrencies":{ "title":"Multiple Transaction Currencies", "maxLength":1, "type":"string", "description":"Indicates that the plan can use multiple transaction currencies for planning. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.", "nullable":false, "x-queryable":true }, "PeriodProfile":{ "title":"Period Profile", "maxLength":255, "type":"string", "description":"Defines how time periods are grouped and displayed when editing resource assignment versions.", "nullable":true, "x-queryable":true }, "UseSameConversionAttributeForAllCurrencyConversionsFlag":{ "title":"Use Same Conversion Attribute for All Currency Conversions", "type":"boolean", "description":"Indicates whether you can use the same currency conversion attribute for all currencies.", "nullable":true, "x-queryable":false }, "RevenueDateTypeForConversionInPC":{ "title":"Revenue Date Type for Conversion in Project Currency", "maxLength":255, "type":"string", "description":"Date type that's used as a revenue conversion attribute for project currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "NonlaborResourceCostOptions":{ "title":"Nonlabor Resource", "maxLength":255, "type":"string", "description":"Rate schedule used for the calculation of cost amounts for non-labor resources.", "nullable":true, "x-queryable":true }, "PersonRevenueOptions":{ "title":"Person Revenue Options", "maxLength":255, "type":"string", "description":"Rate schedule that's used for calculation of revenue amounts for named persons.", "nullable":true, "x-queryable":true }, "RateTypeForCostConversion":{ "title":"Rate Type for Cost Conversion", "maxLength":255, "type":"string", "description":"Rate type that's used as a cost conversion attribute for planning currencies.", "nullable":true, "x-queryable":true }, "PlanningOptionsDFF":{ "title":"Planning Options Descriptive Flexfields", "type":"array", "description":"A listing of all the descriptive flexfields available for planning options in the financial project plan version.", "items":{ "$ref":"#/components/schemas/financialProjectPlans-PlanningOptions-PlanningOptionsDFF-item-response" }, "x-cardinality":"1" }, "ThirdPartySchedulingFlag":{ "title":"Third Party Scheduling", "maxLength":1, "type":"boolean", "description":"Indicates that the plan can use a third-party scheduling tool. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.", "nullable":false, "x-queryable":true }, "BurdenScheduleCostOptions":{ "title":"Burden Schedule", "maxLength":255, "type":"string", "description":"A set of burden multipliers that's maintained for use across projects. Also referred to as a standard burden schedule.", "nullable":true, "x-queryable":true }, "AssociateProjectCostsToSummaryTaskAssignmentsFlag":{ "title":"Associate project costs to summary task assignments", "maxLength":1, "type":"boolean", "description":"Indicates whether project costs for a resource assignment from a lowest level task can be associated to a planned resource assignment on the financial project plan at a higher level in the task structure. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected.", "nullable":true, "x-queryable":true }, "ProjectLedgerCurrency":{ "title":"Project Ledger Currency", "maxLength":15, "type":"string", "description":"Project ledger currency for the project.", "nullable":true, "readOnly":true, "x-queryable":true }, "PrimaryPhysicalPercentCompleteBasis":{ "title":"Primary Physical Percent Complete Basis", "maxLength":30, "type":"string", "description":"Determines the primary physical percent complete value for summary tasks. The valid values are Cost, Effort, and Manual Entry.", "nullable":true, "x-queryable":true }, "ForecastFinancialPlanType":{ "title":"Forecast Financial Plan Type", "maxLength":255, "type":"string", "description":"The name of the financial plan type that's used to create the forecast version.", "nullable":true, "readOnly":true, "x-queryable":true }, "DateTypeForConversionInPC":{ "title":"Project Currency Conversion: Cost Date Type", "maxLength":255, "type":"string", "description":"Date type that's used as a cost conversion attribute for project currency.", "nullable":true, "x-queryable":true }, "ProjectRoleCostOptions":{ "title":"Project Role Cost Options", "maxLength":255, "type":"string", "description":"Rate schedule used for the calculation of cost amounts for project role.", "nullable":true, "x-queryable":true }, "CalendarType":{ "title":"Calendar Type", "maxLength":255, "type":"string", "description":"The type of calendar, such as accounting calendar or project accounting calendar, used for entering and displaying periodic financial information.", "nullable":true, "x-queryable":true } } }

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }

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

• Array of: object financialProjectPlans-PlanningOptions-PlanningCurrencies-item-response

{ "title":"Planning Currencies", "type":"array", "description":"The Planning Currency resource is used to view, create, update, and delete project and planning currencies.", "items":{ "$ref":"#/components/schemas/financialProjectPlans-PlanningOptions-PlanningCurrencies-item-response" } }

Nested Schema : Planning Options Descriptive Flexfields

Type: array

Title: Planning Options Descriptive Flexfields

A listing of all the descriptive flexfields available for planning options in the financial project plan version.

Show Source

• Array of: object financialProjectPlans-PlanningOptions-PlanningOptionsDFF-item-response

{ "title":"Planning Options Descriptive Flexfields", "type":"array", "description":"A listing of all the descriptive flexfields available for planning options in the financial project plan version.", "items":{ "$ref":"#/components/schemas/financialProjectPlans-PlanningOptions-PlanningOptionsDFF-item-response" }, "x-cardinality":"1" }

Nested Schema : financialProjectPlans-PlanningOptions-PlanningCurrencies-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanningCurrencyCode: string
  Title: Planning Currency Code

  Maximum Length: 15

  Currency code for the planning currency.
• PlanningCurrencyId: integer (int64)
  Title: Planning Currency ID

  Identifier of the planning currency.

{ "type":"object", "properties":{ "PlanningCurrencyCode":{ "title":"Planning Currency Code", "maxLength":15, "type":"string", "description":"Currency code for the planning currency.", "nullable":false, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "PlanningCurrencyId":{ "title":"Planning Currency ID", "type":"integer", "description":"Identifier of the planning currency.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "x-queryable":true } } }

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }

Nested Schema : financialProjectPlans-PlanningOptions-PlanningOptionsDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Code that identifies the context for the segments of the planning options flexfields.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Name of the context for the segments of the planning options flexfields.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanningOptionId: integer (int64)
  Unique identifier of the summary level planning option in the financial project plan version.

{ "type":"object", "properties":{ "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "__FLEX_Context_DisplayValue":{ "title":"Context Segment", "type":"string", "description":"Name of the context for the segments of the planning options flexfields.", "nullable":true, "x-hints":{ "updateable":"false", "DISPLAYHINT":"Hide", "FND_ACFF_IsReadOnly":"true", "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context", "FND_ACFF_JavaType":"java.lang.String", "FND_ACFF_ListDisplayAttrName":"Name", "FND_ACFF_MaximumLength":"1024", "FND_ACFF_PreferredDisplayType":"LOV" }, "x-oj":{ "transform":{ "path":"oj-sp/common-util/flex-util", "name":"transformFlexUIHints" } }, "x-queryable":true }, "PlanningOptionId":{ "type":"integer", "description":"Unique identifier of the summary level planning option in the financial project plan version.", "format":"int64", "nullable":false, "x-hints":{ "DISPLAYHINT":"Hide", "includeInCompactView":true, "precision":18 }, "x-queryable":true }, "__FLEX_Context":{ "title":"Context Segment", "maxLength":30, "type":"string", "description":"Code that identifies the context for the segments of the planning options flexfields.", "nullable":true, "x-hints":{ "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT", "controlType":"choice", "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue", "includeInCompactView":true, "FND_ACFF_IsDiscriminator":"true", "FND_ACFF_JavaType":"java.lang.String", "FND_ACFF_MaximumLength":"1024", "FND_ACFF_PreferredDisplayType":"LOV" }, "x-oj":{ "transform":{ "path":"oj-sp/common-util/flex-util", "name":"transformFlexUIHints" } }, "x-queryable":true } } }

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }

Nested Schema : financialProjectPlans-ResourceAssignments-item-response

Type: object

Show Source

• AdministrativeCode: string
  Title: Administrative Code

  Action identifier used for administrative purpose only.
• BaselineFinishDate: string (date-time)
  Title: Baseline Finish Date

  Read Only: true

  The date that is planned on the baseline financial project plan for a resource to finish their assignment on a project task.
• BaselineStartDate: string (date-time)
  Title: Baseline Start Date

  Read Only: true

  The date that is planned on the baseline financial project plan for a resource to begin their assignment on a project task.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaintainManualSpreadOnDateChanges: string
  Default Value: N

  Indicates whether the periodic planning is retained in the plan version on plan line date modifications.
• PlanningAmounts: array Planning Amounts
  Title: Planning Amounts

  The Planning Amounts resource is used to view, create, update, and delete a financial project plan resource assignment amounts.
• PlanningElementId: integer (int64)
  Identifier of the resource assignment on the financial project plan version.
• PlanningFinishDate: string (date-time)
  Title: Planning Dates: To Date

  The date that is planned on the financial project plan for a resource to finish their assignment on a project task.
• PlanningStartDate: string (date-time)
  Title: Planning Dates: From Date

  The date that is planned on the financial project plan for a resource to begin their assignment on a project task.
• RateBasedFlag: boolean
  Title: Rate-Based Planning Resource

  Read Only: true

  Indicates if the financial project plan resource assignment is rate based.
• RbsElementId: integer (int64)
  Identifier of the resource breakdown structure element used to create the financial project plan resource assignments line.
• ResourceClass: string
  Read Only: true

  Maximum Length: 240

  Grouping of predefined resource types to which the resource in the financial project plan resource assignment belongs. A list of valid values are Labor, Equipment, Material Items, and Financial Resources.
• ResourceName: string
  Title: Resource Name

  Maximum Length: 240

  Name or alias of the resource included in the planning resource breakdown structure that is used to create the financial project plan resource assignment.
• SpreadCurve: string
  Title: Spread Curve

  Read Only: true

  Maximum Length: 240

  Name of the set of distribution factors that enables the application to automatically distribute quantity and cost for a resource on a task assignment across a range of accounting or project accounting periods.
• TaskId: integer (int64)
  Title: Task ID

  Identifier of the task for which a financial project plan resource assignment is created. You must enter either Task Name or Task Number but not for all three or a combination of them while creating a financial project plan resource assignment.
• TaskName: string
  Title: Task Name

  Maximum Length: 255

  Name of the task for which a financial project plan resource assignment is created. You must enter either Task ID or Task Number but not for all three or a combination of them while creating a financial project plan resource assignment.
• TaskNumber: string
  Title: Task Number

  Maximum Length: 100

  Number of the task for which a financial project plan resource assignment is created. You must enter either Task Name or Task ID but not for all three or a combination of them while creating a financial project plan resource assignment.
• UnitOfMeasure: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  Unit of work that measures the quantity of effort for which the resource is planned for on the financial project plan resource assignment.
• UnplannedFlag: boolean
  Title: Unplanned

  Maximum Length: 1

  Indicates if the financial project plan resource assignment is unplanned.
• UseTaskDatesAsTaskAssignmentDatesFlag: boolean
  Title: Use Task Planned Dates as Task Assignment Dates

  Indicates if the resource assignment dates on the task in the financial project plan resource assignment are the same as the task dates on the project.

{ "type":"object", "properties":{ "SpreadCurve":{ "title":"Spread Curve", "maxLength":240, "type":"string", "description":"Name of the set of distribution factors that enables the application to automatically distribute quantity and cost for a resource on a task assignment across a range of accounting or project accounting periods.", "nullable":false, "readOnly":true, "x-queryable":true }, "TaskId":{ "title":"Task ID", "type":"integer", "description":"Identifier of the task for which a financial project plan resource assignment is created. You must enter either Task Name or Task Number but not for all three or a combination of them while creating a financial project plan resource assignment.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "x-queryable":true }, "PlanningFinishDate":{ "title":"Planning Dates: To Date", "type":"string", "description":"The date that is planned on the financial project plan for a resource to finish their assignment on a project task.", "format":"date-time", "nullable":true, "x-queryable":true }, "UnitOfMeasure":{ "title":"Name", "maxLength":80, "type":"string", "description":"Unit of work that measures the quantity of effort for which the resource is planned for on the financial project plan resource assignment.", "nullable":false, "readOnly":true, "x-queryable":true }, "UseTaskDatesAsTaskAssignmentDatesFlag":{ "title":"Use Task Planned Dates as Task Assignment Dates", "type":"boolean", "description":"Indicates if the resource assignment dates on the task in the financial project plan resource assignment are the same as the task dates on the project.", "nullable":true, "x-queryable":true }, "ResourceName":{ "title":"Resource Name", "maxLength":240, "type":"string", "description":"Name or alias of the resource included in the planning resource breakdown structure that is used to create the financial project plan resource assignment.", "nullable":true, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "AdministrativeCode":{ "title":"Administrative Code", "type":"string", "description":"Action identifier used for administrative purpose only.", "nullable":true, "x-queryable":false }, "BaselineStartDate":{ "title":"Baseline Start Date", "type":"string", "description":"The date that is planned on the baseline financial project plan for a resource to begin their assignment on a project task.", "format":"date-time", "nullable":true, "readOnly":true, "x-queryable":true }, "TaskNumber":{ "title":"Task Number", "maxLength":100, "type":"string", "description":"Number of the task for which a financial project plan resource assignment is created. You must enter either Task Name or Task ID but not for all three or a combination of them while creating a financial project plan resource assignment.", "nullable":true, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "PlanningElementId":{ "type":"integer", "description":"Identifier of the resource assignment on the financial project plan version.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "x-queryable":true }, "RbsElementId":{ "type":"integer", "description":"Identifier of the resource breakdown structure element used to create the financial project plan resource assignments line.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "x-queryable":true }, "UnplannedFlag":{ "title":"Unplanned", "maxLength":1, "type":"boolean", "description":"Indicates if the financial project plan resource assignment is unplanned.", "nullable":false, "x-queryable":true }, "PlanningAmounts":{ "title":"Planning Amounts", "type":"array", "description":"The Planning Amounts resource is used to view, create, update, and delete a financial project plan resource assignment amounts.", "items":{ "$ref":"#/components/schemas/financialProjectPlans-ResourceAssignments-PlanningAmounts-item-response" } }, "TaskName":{ "title":"Task Name", "maxLength":255, "type":"string", "description":"Name of the task for which a financial project plan resource assignment is created. You must enter either Task ID or Task Number but not for all three or a combination of them while creating a financial project plan resource assignment.", "nullable":false, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "MaintainManualSpreadOnDateChanges":{ "type":"string", "description":"Indicates whether the periodic planning is retained in the plan version on plan line date modifications.", "nullable":true, "default":"N", "x-queryable":false }, "PlanningStartDate":{ "title":"Planning Dates: From Date", "type":"string", "description":"The date that is planned on the financial project plan for a resource to begin their assignment on a project task.", "format":"date-time", "nullable":true, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "BaselineFinishDate":{ "title":"Baseline Finish Date", "type":"string", "description":"The date that is planned on the baseline financial project plan for a resource to finish their assignment on a project task.", "format":"date-time", "nullable":true, "readOnly":true, "x-queryable":true }, "ResourceClass":{ "maxLength":240, "type":"string", "description":"Grouping of predefined resource types to which the resource in the financial project plan resource assignment belongs. A list of valid values are Labor, Equipment, Material Items, and Financial Resources.", "nullable":false, "readOnly":true, "x-queryable":true }, "RateBasedFlag":{ "title":"Rate-Based Planning Resource", "type":"boolean", "description":"Indicates if the financial project plan resource assignment is rate based.", "nullable":true, "readOnly":true, "x-queryable":true } } }

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }

Nested Schema : Planning Amounts

Type: array

Title: Planning Amounts

The Planning Amounts resource is used to view, create, update, and delete a financial project plan resource assignment amounts.

Show Source

• Array of: object financialProjectPlans-ResourceAssignments-PlanningAmounts-item-response

{ "title":"Planning Amounts", "type":"array", "description":"The Planning Amounts resource is used to view, create, update, and delete a financial project plan resource assignment amounts.", "items":{ "$ref":"#/components/schemas/financialProjectPlans-ResourceAssignments-PlanningAmounts-item-response" } }

Nested Schema : financialProjectPlans-ResourceAssignments-PlanningAmounts-item-response

Type: object

Show Source

• BaselineBurdenedCost: number
  Title: Baseline Burdened Cost

  Read Only: true

  Total planned cost for the baseline financial project plan resource assignment, including raw and burden costs, in planning currency.
• BaselineBurdenedCostInProjectCurrency: number
  Title: Rolled-up Baseline Cost for Resource in Project Currency

  Read Only: true

  Total planned cost for the baseline financial project plan resource assignment, including raw and burden costs, in project currency.
• BaselineBurdenedCostInProjectLedgerCurrency: number
  Title: Baseline Burdened Cost

  Read Only: true

  Total planned cost for the financial project plan resource assignment, including raw and burden costs, in project ledger currency in the baseline financial project plan version.
• BaselineCurrency: string
  Title: Baseline Currency

  Read Only: true

  Maximum Length: 30

  Currency of the rendered baseline amounts.
• BaselineQuantity: number
  Title: Baseline Quantity

  Read Only: true

  Measure of the effort planned for the resource assignment in the baseline financial project plan version, expressed in hours.
• BaselineRawCost: number
  Title: Baseline Raw Cost

  Read Only: true

  Planned cost for the project in planning currency in the baseline financial project plan version that corresponds to the work performed.
• BaselineRawCostInProjectCurrency: number
  Title: Baseline Raw Cost

  Read Only: true

  Planned cost for the baseline financial project plan resource assignment in project currency that corresponds to the work performed.
• BaselineRawCostInProjectLedgerCurrency: number
  Title: Baseline Raw Cost

  Read Only: true

  Planned cost for the baseline financial project plan resource assignment in project ledger currency that corresponds to the work performed.
• BaselineRevenue: number
  Title: Baseline Revenue

  Read Only: true

  Planned revenue for the project, in planning currency, in the baseline financial project plan version that corresponds to the work performed.
• BaselineRevenueInProjectCurrency: number
  Title: Baseline Revenue in Project Currency

  Read Only: true

  Planned revenue for the baseline financial project plan resource assignment, in project currency, that corresponds to the work performed.
• BaselineRevenueInProjectLedgerCurrency: number
  Title: Baseline Revenue in Project Ledger Currency

  Read Only: true

  Planned revenue for the baseline financial project plan resource assignment, in project ledger currency, that corresponds to the work performed.
• BurdenedCost: number
  Title: Burdened Cost

  Total planned cost for the financial project plan resource assignment in planning currency that includes both raw and burden costs.
• BurdenedCostInProjectCurrency: number
  Title: Burdened Cost in Project Currency: Total

  Read Only: true

  Total planned cost for the financial project plan resource assignment in project currency that includes both raw and burden costs.
• BurdenedCostInProjectLedgerCurrency: number
  Title: Burdened Cost in Project Ledger Currency: Total

  Read Only: true

  Total planned cost for the financial project plan resource assignment in project ledger currency that includes both raw and burden costs.
• Currency: string
  Title: Currency

  Maximum Length: 15

  Code that identifies the planning currency on the financial project plan resource assignment.
• EffectiveBurdenedCostRate: number
  Title: Average Effective Burden Cost Rate

  Cost rate that is used to calculate amounts for a financial project plan resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts.
• EffectiveRawCostRate: number
  Title: Effective Raw Cost Rate

  Cost rate that is used to calculate amounts for a financial project plan resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts.
• EffectiveRevenueRate: number
  Title: Effective Revenue Rate

  Revenue rate that's used to calculate amounts for a financial project plan resource assignment. Revenue amounts can be determined by multiplying the quantity by effective revenue rate.
• ITDActualBurdenedCost: number
  Title: ITD Actual Burdened Cost

  Read Only: true

  Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in planning currency from the start date of the project till the current date.
• ITDActualBurdenedCostInProjectCurrency: number
  Title: ITD Actual Burdened Cost

  Read Only: true

  Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project currency from the start date of the project till the current date.
• ITDActualBurdenedCostInProjectLedgerCurrency: number
  Title: ITD Actual Burdened Cost

  Read Only: true

  Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project ledger currency from the start date of the project till the current date.
• ITDActualQuantity: number
  Title: ITD Actual Quantity

  Read Only: true

  Actual effort for the financial project plan resource assignment from the start of the project till the current date, expressed in hours.
• ITDActualRawCost: number
  Title: ITD Actual Raw Cost

  Read Only: true

  Actual cost incurred for the financial project plan resource assignment in planning currency that corresponds to the work performed from the start date of the project till the current date.
• ITDActualRawCostInProjectCurrency: number
  Title: ITD Actual Raw Cost

  Read Only: true

  Actual cost incurred for the financial project plan resource assignment in project currency that corresponds to the work performed from the start date of the project till the current date.
• ITDActualRawCostInProjectLedgerCurrency: number
  Title: ITD Actual Raw Cost

  Read Only: true

  Actual cost incurred for the financial project plan resource assignment in project ledger currency that corresponds to the work performed from the start date of the project till the current date.
• ITDActualRevenue: number
  Title: ITD Actual Revenue

  Read Only: true

  Actual revenue incurred for the financial project plan resource assignment, in planning currency, that corresponds to the work performed from the start date of the project till the current date.
• ITDActualRevenueInProjectCurrency: number
  Title: ITD Actual Revenue in Project Currency

  Read Only: true

  Actual revenue incurred for the financial project plan resource assignment, in project currency, that corresponds to the work performed from the start date of the project till the current date.
• ITDActualRevenueInProjectLedgerCurrency: number
  Title: ITD Actual Revenue in Project Ledger Currency

  Read Only: true

  Actual revenue incurred for the financial project plan resource assignment, in project ledger currency, that corresponds to the work performed from the start date of the project till the current date.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualSpreadFlag: boolean
  Maximum Length: 1

  Indicates if the periodic planning is modified and retained for the plan line on date changes.
• Margin: number
  Title: Margin

  Read Only: true

  The difference between costs and revenue amounts.
• MarginPercentage: number
  Title: Margin Percentage

  Read Only: true

  The difference between costs and revenue amounts, expressed as a percentage.
• PlanLineId: integer (int64)
  Title: Plan Line ID

  Identifier of the summary level planning amounts for a resource assignment in the financial project plan.
• PlanLinesDFF: array Plan Lines Descriptive Flexfields
  Title: Plan Lines Descriptive Flexfields

  The Plan Lines descriptive flexfields resource is used to capture, view, and update additional information for planning amounts in financial project plans.
• PlannedQuantity: number
  Title: Planned Quantity

  Measure of the effort planned for in the financial project plan resource assignment, expressed in hours.
• PlanningAmountDetails: array Planning Amount Details
  Title: Planning Amount Details

  The Planning Amount Details resource is used to view, create, update, and delete a financial project plan resource assignment periodic amounts.
• RawCost: number
  Title: Raw Cost

  Planned cost for the financial project plan resource assignment in planning currency that corresponds to the work performed.
• RawCostInProjectCurrency: number
  Title: Raw Cost in Project Currency: Total

  Read Only: true

  Planned cost for the financial project plan resource assignment in project currency that corresponds to the work performed.
• RawCostInProjectLedgerCurrency: number
  Title: Raw Cost in Project Ledger Currency

  Read Only: true

  Planned cost for the financial project plan resource assignment in project ledger currency that corresponds to the work performed.
• Revenue: number
  Title: Revenue

  Planned revenue for the financial project plan resource assignment, in planning currency, that corresponds to the work performed.
• RevenueInProjectCurrency: number
  Title: Revenue in Project Currency

  Read Only: true

  Planned revenue for the financial project plan resource assignment, in project currency, that corresponds to the work performed.
• RevenueInProjectLedgerCurrency: number
  Title: Revenue in Project Ledger Currency

  Read Only: true

  Planned revenue for the financial project plan resource assignment, in project ledger currency, that corresponds to the work performed.
• StandardBurdenedCostRate: number
  Title: Standard Burdened Cost Rate

  Read Only: true

  Average rate derived from the rate schedule for calculating the planned burdened cost for the financial project plan resource assignment.
• StandardRawCostRate: number
  Title: Standard Raw Cost Rate

  Read Only: true

  Rate derived from the rate schedule for calculating the planned raw cost for the financial project plan resource assignment.
• StandardRevenueRate: number
  Title: Standard Revenue Rate

  Rate derived from the rate schedule for calculating the planned revenue for the financial project plan resource assignment.

{ "type":"object", "properties":{ "EffectiveRevenueRate":{ "title":"Effective Revenue Rate", "type":"number", "description":"Revenue rate that's used to calculate amounts for a financial project plan resource assignment. Revenue amounts can be determined by multiplying the quantity by effective revenue rate.", "nullable":true, "x-queryable":true }, "ManualSpreadFlag":{ "maxLength":1, "type":"boolean", "description":"Indicates if the periodic planning is modified and retained for the plan line on date changes.", "nullable":true, "x-queryable":true }, "ITDActualRawCostInProjectCurrency":{ "title":"ITD Actual Raw Cost", "type":"number", "description":"Actual cost incurred for the financial project plan resource assignment in project currency that corresponds to the work performed from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "RawCostInProjectLedgerCurrency":{ "title":"Raw Cost in Project Ledger Currency", "type":"number", "description":"Planned cost for the financial project plan resource assignment in project ledger currency that corresponds to the work performed.", "nullable":true, "readOnly":true, "x-queryable":true }, "RawCost":{ "title":"Raw Cost", "type":"number", "description":"Planned cost for the financial project plan resource assignment in planning currency that corresponds to the work performed.", "nullable":true, "x-queryable":true }, "PlanningAmountDetails":{ "title":"Planning Amount Details", "type":"array", "description":"The Planning Amount Details resource is used to view, create, update, and delete a financial project plan resource assignment periodic amounts.", "items":{ "$ref":"#/components/schemas/financialProjectPlans-ResourceAssignments-PlanningAmounts-PlanningAmountDetails-item-response" } }, "ITDActualRevenueInProjectLedgerCurrency":{ "title":"ITD Actual Revenue in Project Ledger Currency", "type":"number", "description":"Actual revenue incurred for the financial project plan resource assignment, in project ledger currency, that corresponds to the work performed from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "BaselineBurdenedCostInProjectCurrency":{ "title":"Rolled-up Baseline Cost for Resource in Project Currency", "type":"number", "description":"Total planned cost for the baseline financial project plan resource assignment, including raw and burden costs, in project currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "ITDActualBurdenedCostInProjectLedgerCurrency":{ "title":"ITD Actual Burdened Cost", "type":"number", "description":"Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project ledger currency from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "StandardBurdenedCostRate":{ "title":"Standard Burdened Cost Rate", "type":"number", "description":"Average rate derived from the rate schedule for calculating the planned burdened cost for the financial project plan resource assignment.", "nullable":true, "readOnly":true, "x-queryable":true }, "EffectiveRawCostRate":{ "title":"Effective Raw Cost Rate", "type":"number", "description":"Cost rate that is used to calculate amounts for a financial project plan resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts.", "nullable":true, "x-queryable":true }, "BaselineCurrency":{ "title":"Baseline Currency", "maxLength":30, "type":"string", "description":"Currency of the rendered baseline amounts.", "nullable":false, "readOnly":true, "x-queryable":true }, "BaselineRevenueInProjectLedgerCurrency":{ "title":"Baseline Revenue in Project Ledger Currency", "type":"number", "description":"Planned revenue for the baseline financial project plan resource assignment, in project ledger currency, that corresponds to the work performed.", "nullable":true, "readOnly":true, "x-queryable":true }, "BaselineRawCostInProjectCurrency":{ "title":"Baseline Raw Cost", "type":"number", "description":"Planned cost for the baseline financial project plan resource assignment in project currency that corresponds to the work performed.", "nullable":true, "readOnly":true, "x-queryable":true }, "ITDActualBurdenedCostInProjectCurrency":{ "title":"ITD Actual Burdened Cost", "type":"number", "description":"Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project currency from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "RevenueInProjectCurrency":{ "title":"Revenue in Project Currency", "type":"number", "description":"Planned revenue for the financial project plan resource assignment, in project currency, that corresponds to the work performed.", "nullable":true, "readOnly":true, "x-queryable":true }, "PlannedQuantity":{ "title":"Planned Quantity", "type":"number", "description":"Measure of the effort planned for in the financial project plan resource assignment, expressed in hours.", "nullable":true, "x-queryable":true }, "RawCostInProjectCurrency":{ "title":"Raw Cost in Project Currency: Total", "type":"number", "description":"Planned cost for the financial project plan resource assignment in project currency that corresponds to the work performed.", "nullable":true, "readOnly":true, "x-queryable":true }, "BaselineRevenueInProjectCurrency":{ "title":"Baseline Revenue in Project Currency", "type":"number", "description":"Planned revenue for the baseline financial project plan resource assignment, in project currency, that corresponds to the work performed.", "nullable":true, "readOnly":true, "x-queryable":true }, "Currency":{ "title":"Currency", "maxLength":15, "type":"string", "description":"Code that identifies the planning currency on the financial project plan resource assignment.", "nullable":false, "x-queryable":true }, "ITDActualQuantity":{ "title":"ITD Actual Quantity", "type":"number", "description":"Actual effort for the financial project plan resource assignment from the start of the project till the current date, expressed in hours.", "nullable":true, "readOnly":true, "x-queryable":true }, "EffectiveBurdenedCostRate":{ "title":"Average Effective Burden Cost Rate", "type":"number", "description":"Cost rate that is used to calculate amounts for a financial project plan resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts.", "nullable":true, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "BaselineRevenue":{ "title":"Baseline Revenue", "type":"number", "description":"Planned revenue for the project, in planning currency, in the baseline financial project plan version that corresponds to the work performed.", "nullable":true, "readOnly":true, "x-queryable":true }, "BurdenedCost":{ "title":"Burdened Cost", "type":"number", "description":"Total planned cost for the financial project plan resource assignment in planning currency that includes both raw and burden costs.", "nullable":true, "x-queryable":true }, "BaselineRawCostInProjectLedgerCurrency":{ "title":"Baseline Raw Cost", "type":"number", "description":"Planned cost for the baseline financial project plan resource assignment in project ledger currency that corresponds to the work performed.", "nullable":true, "readOnly":true, "x-queryable":true }, "BaselineBurdenedCost":{ "title":"Baseline Burdened Cost", "type":"number", "description":"Total planned cost for the baseline financial project plan resource assignment, including raw and burden costs, in planning currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "PlanLineId":{ "title":"Plan Line ID", "type":"integer", "description":"Identifier of the summary level planning amounts for a resource assignment in the financial project plan.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "x-queryable":true }, "ITDActualRawCost":{ "title":"ITD Actual Raw Cost", "type":"number", "description":"Actual cost incurred for the financial project plan resource assignment in planning currency that corresponds to the work performed from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "ITDActualBurdenedCost":{ "title":"ITD Actual Burdened Cost", "type":"number", "description":"Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in planning currency from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "BaselineRawCost":{ "title":"Baseline Raw Cost", "type":"number", "description":"Planned cost for the project in planning currency in the baseline financial project plan version that corresponds to the work performed.", "nullable":true, "readOnly":true, "x-queryable":true }, "ITDActualRevenue":{ "title":"ITD Actual Revenue", "type":"number", "description":"Actual revenue incurred for the financial project plan resource assignment, in planning currency, that corresponds to the work performed from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "ITDActualRawCostInProjectLedgerCurrency":{ "title":"ITD Actual Raw Cost", "type":"number", "description":"Actual cost incurred for the financial project plan resource assignment in project ledger currency that corresponds to the work performed from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "BaselineQuantity":{ "title":"Baseline Quantity", "type":"number", "description":"Measure of the effort planned for the resource assignment in the baseline financial project plan version, expressed in hours.", "nullable":true, "readOnly":true, "x-queryable":true }, "BurdenedCostInProjectCurrency":{ "title":"Burdened Cost in Project Currency: Total", "type":"number", "description":"Total planned cost for the financial project plan resource assignment in project currency that includes both raw and burden costs.", "nullable":true, "readOnly":true, "x-queryable":true }, "BurdenedCostInProjectLedgerCurrency":{ "title":"Burdened Cost in Project Ledger Currency: Total", "type":"number", "description":"Total planned cost for the financial project plan resource assignment in project ledger currency that includes both raw and burden costs.", "nullable":true, "readOnly":true, "x-queryable":true }, "RevenueInProjectLedgerCurrency":{ "title":"Revenue in Project Ledger Currency", "type":"number", "description":"Planned revenue for the financial project plan resource assignment, in project ledger currency, that corresponds to the work performed.", "nullable":true, "readOnly":true, "x-queryable":true }, "StandardRawCostRate":{ "title":"Standard Raw Cost Rate", "type":"number", "description":"Rate derived from the rate schedule for calculating the planned raw cost for the financial project plan resource assignment.", "nullable":true, "readOnly":true, "x-queryable":true }, "PlanLinesDFF":{ "title":"Plan Lines Descriptive Flexfields", "type":"array", "description":"The Plan Lines descriptive flexfields resource is used to capture, view, and update additional information for planning amounts in financial project plans.", "items":{ "$ref":"#/components/schemas/financialProjectPlans-ResourceAssignments-PlanningAmounts-PlanLinesDFF-item-response" }, "x-cardinality":"1" }, "BaselineBurdenedCostInProjectLedgerCurrency":{ "title":"Baseline Burdened Cost", "type":"number", "description":"Total planned cost for the financial project plan resource assignment, including raw and burden costs, in project ledger currency in the baseline financial project plan version.", "nullable":true, "readOnly":true, "x-queryable":true }, "MarginPercentage":{ "title":"Margin Percentage", "type":"number", "description":"The difference between costs and revenue amounts, expressed as a percentage.", "nullable":true, "readOnly":true, "x-queryable":true }, "ITDActualRevenueInProjectCurrency":{ "title":"ITD Actual Revenue in Project Currency", "type":"number", "description":"Actual revenue incurred for the financial project plan resource assignment, in project currency, that corresponds to the work performed from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "StandardRevenueRate":{ "title":"Standard Revenue Rate", "type":"number", "description":"Rate derived from the rate schedule for calculating the planned revenue for the financial project plan resource assignment.", "nullable":true, "x-queryable":true }, "Revenue":{ "title":"Revenue", "type":"number", "description":"Planned revenue for the financial project plan resource assignment, in planning currency, that corresponds to the work performed.", "nullable":true, "x-queryable":true }, "Margin":{ "title":"Margin", "type":"number", "description":"The difference between costs and revenue amounts.", "nullable":true, "readOnly":true, "x-queryable":true } } }

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }

Nested Schema : Plan Lines Descriptive Flexfields

Type: array

Title: Plan Lines Descriptive Flexfields

The Plan Lines descriptive flexfields resource is used to capture, view, and update additional information for planning amounts in financial project plans.

Show Source

• Array of: object financialProjectPlans-ResourceAssignments-PlanningAmounts-PlanLinesDFF-item-response

{ "title":"Plan Lines Descriptive Flexfields", "type":"array", "description":"The Plan Lines descriptive flexfields resource is used to capture, view, and update additional information for planning amounts in financial project plans.", "items":{ "$ref":"#/components/schemas/financialProjectPlans-ResourceAssignments-PlanningAmounts-PlanLinesDFF-item-response" }, "x-cardinality":"1" }

Nested Schema : Planning Amount Details

Type: array

Title: Planning Amount Details

The Planning Amount Details resource is used to view, create, update, and delete a financial project plan resource assignment periodic amounts.

Show Source

• Array of: object financialProjectPlans-ResourceAssignments-PlanningAmounts-PlanningAmountDetails-item-response

{ "title":"Planning Amount Details", "type":"array", "description":"The Planning Amount Details resource is used to view, create, update, and delete a financial project plan resource assignment periodic amounts.", "items":{ "$ref":"#/components/schemas/financialProjectPlans-ResourceAssignments-PlanningAmounts-PlanningAmountDetails-item-response" } }

Nested Schema : financialProjectPlans-ResourceAssignments-PlanningAmounts-PlanLinesDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Code that identifies the context for the segments of the plan lines flexfields.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Name of the context for the segments of the plan lines flexfields.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanLineId: integer (int64)
  Identifier of the summary level planning amounts for a plan line in the financial project plan.

{ "type":"object", "properties":{ "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "PlanLineId":{ "type":"integer", "description":"Identifier of the summary level planning amounts for a plan line in the financial project plan.", "format":"int64", "nullable":false, "x-hints":{ "DISPLAYHINT":"Hide", "includeInCompactView":true, "precision":18 }, "x-queryable":true }, "__FLEX_Context_DisplayValue":{ "title":"Context Segment", "type":"string", "description":"Name of the context for the segments of the plan lines flexfields.", "nullable":true, "x-hints":{ "updateable":"false", "DISPLAYHINT":"Hide", "FND_ACFF_IsReadOnly":"true", "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context", "FND_ACFF_JavaType":"java.lang.String", "FND_ACFF_ListDisplayAttrName":"Name", "FND_ACFF_MaximumLength":"1024", "FND_ACFF_PreferredDisplayType":"LOV" }, "x-oj":{ "transform":{ "path":"oj-sp/common-util/flex-util", "name":"transformFlexUIHints" } }, "x-queryable":true }, "__FLEX_Context":{ "title":"Context Segment", "maxLength":30, "type":"string", "description":"Code that identifies the context for the segments of the plan lines flexfields.", "nullable":true, "x-hints":{ "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT", "controlType":"choice", "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue", "includeInCompactView":true, "FND_ACFF_IsDiscriminator":"true", "FND_ACFF_JavaType":"java.lang.String", "FND_ACFF_MaximumLength":"1024", "FND_ACFF_PreferredDisplayType":"LOV" }, "x-oj":{ "transform":{ "path":"oj-sp/common-util/flex-util", "name":"transformFlexUIHints" } }, "x-queryable":true } } }

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }

Nested Schema : financialProjectPlans-ResourceAssignments-PlanningAmounts-PlanningAmountDetails-item-response

Type: object

Show Source

• BurdenedCost: number
  Title: Planned Burdened Cost

  Total planned cost for the period in the financial project plan resource assignment in planning currency that includes both raw and burden costs.
• BurdenedCostInProjectCurrency: number
  Title: Burdened Cost in Project Currency: Total

  Read Only: true

  Total planned cost for a period in the financial project plan resource assignment in project currency that includes both raw and burden costs.
• BurdenedCostInProjectLedgerCurrency: number
  Title: Burdened Cost in Project Ledger Currency: Total

  Read Only: true

  Total planned cost for a period in the financial project plan resource assignment in project ledger currency that includes both raw and burden costs.
• EffectiveBurdenedCostRate: number
  Title: Burdened Cost Rate

  Cost rate that is used to calculate amounts for a period in the financial project plan resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts.
• EffectiveRawCostRate: number
  Title: Effective Rate

  Cost rate that is used to calculate amounts for a period in the financial project plan resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts.
• EffectiveRevenueRate: number
  Title: Effective Revenue Rate

  Revenue rate that's used to calculate amounts for a period in the financial project plan resource assignment. Revenue amounts can be determined by multiplying the quantity by effective revenue rate.
• ITDActualBurdenedCost: number
  Title: ITD Actual Burdened Cost

  Read Only: true

  Actual cost incurred for the period in the financial project plan resource assignment, including raw and burden costs, in planning currency from the start date of the project till the current date.
• ITDActualBurdenedCostInProjectCurrency: number
  Title: ITD Actual Burdened Cost

  Read Only: true

  Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project currency from the start date of the project till the current date.
• ITDActualBurdenedCostInProjectLedgerCurrency: number
  Title: ITD Actual in Project Ledger Currency

  Read Only: true

  Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project ledger currency from the start date of the project till the current date.
• ITDActualQuantity: number
  Title: ITD Actual Quantity

  Read Only: true

  Actual effort for the period in the financial project plan resource assignment from the start of the project till the current date, expressed in hours.
• ITDActualRawCost: number
  Title: ITD Actual Raw Cost

  Read Only: true

  Actual cost incurred for the period in the financial project plan resource assignment in planning currency that corresponds to the work performed from the start date of the project till the current date.
• ITDActualRawCostInProjectCurrency: number
  Title: ITD Actual in Project Currency

  Read Only: true

  Actual cost incurred for the financial project plan resource assignment in project currency that corresponds to the work performed from the start date of the project till the current date.
• ITDActualRawCostInProjectLedgerCurrency: number
  Title: ITD Actual in Project Ledger Currency

  Read Only: true

  Actual cost incurred for the financial project plan resource assignment in project ledger currency that corresponds to the work performed from the start date of the project till the current date.
• ITDActualRevenue: number
  Title: ITD Actual Revenue

  Read Only: true

  Actual revenue incurred for the period in the financial project plan resource assignment, in planning currency, that corresponds to the work performed from the start date of the project till the current date.
• ITDActualRevenueInProjectCurrency: number
  Title: ITD Actual Revenue in Project Currency

  Read Only: true

  Actual revenue incurred for the period in the financial project plan resource assignment, in project currency, that corresponds to the work performed from the start date of the project till the current date.
• ITDActualRevenueInProjectLedgerCurrency: number
  Title: ITD Actual Revenue in Project Ledger Currency

  Read Only: true

  Actual revenue incurred for the period in the financial project plan resource assignment, in project ledger currency, that corresponds to the work performed from the start date of the project till the current date.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualSpreadFlag: boolean
  Maximum Length: 1

  Indicates if the periodic planning is modified and retained for the plan line on date changes.
• PeriodName: string
  Title: Period

  Maximum Length: 30

  Period for which the periodic level planning amounts are created for a resource assignment in the financial project plan.
• PlannedQuantity: number
  Title: Planned Quantity

  Measure of the effort planned for the period in the financial project plan resource assignment, expressed in hours.
• RawCost: number
  Title: Raw cost

  Planned cost for the period in the financial project plan resource assignment in planning currency that corresponds to the work performed.
• RawCostInProjectCurrency: number
  Title: Raw Cost in Project Currency: Total

  Read Only: true

  Planned cost for a period in the financial project plan resource assignment in project currency that corresponds to the work performed.
• RawCostInProjectLedgerCurrency: number
  Title: Raw Cost in Project Ledger Currency: Total

  Read Only: true

  Planned cost for a period in the financial project plan resource assignment in project ledger currency that corresponds to the work performed.
• Revenue: number
  Title: Revenue

  Planned revenue for the period in the financial project plan resource assignment, in planning currency, that corresponds to the work performed.
• RevenueInProjectCurrency: number
  Title: Revenue in Project Currency

  Read Only: true

  Planned revenue for the period in the financial project plan resource assignment, in project currency, that corresponds to the work performed.
• RevenueInProjectLedgerCurrency: number
  Title: Revenue in Project Ledger Currency

  Read Only: true

  Planned revenue for the period in the financial project plan resource assignment, in project ledger currency, that corresponds to the work performed.
• StandardBurdenedCostRate: number
  Title: Standard Burdened Cost Rate

  Read Only: true

  Average rate derived from the rate schedule for calculating the planned burdened cost for the period in the financial project plan resource assignment.
• StandardRawCostRate: number
  Title: Standard Raw Cost Rate

  Read Only: true

  Rate derived from the rate schedule for calculating the planned raw cost for the period in the financial project plan resource assignment.
• StandardRevenueRate: number
  Title: Standard Revenue Rate

  Read Only: true

  Rate derived from the rate schedule for calculating the planned revenue for a period in the financial project plan resource assignment.

{ "type":"object", "properties":{ "EffectiveRevenueRate":{ "title":"Effective Revenue Rate", "type":"number", "description":"Revenue rate that's used to calculate amounts for a period in the financial project plan resource assignment. Revenue amounts can be determined by multiplying the quantity by effective revenue rate.", "nullable":true, "x-queryable":true }, "ManualSpreadFlag":{ "maxLength":1, "type":"boolean", "description":"Indicates if the periodic planning is modified and retained for the plan line on date changes.", "nullable":true, "x-queryable":true }, "ITDActualRawCostInProjectCurrency":{ "title":"ITD Actual in Project Currency", "type":"number", "description":"Actual cost incurred for the financial project plan resource assignment in project currency that corresponds to the work performed from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "RawCostInProjectLedgerCurrency":{ "title":"Raw Cost in Project Ledger Currency: Total", "type":"number", "description":"Planned cost for a period in the financial project plan resource assignment in project ledger currency that corresponds to the work performed.", "nullable":true, "readOnly":true, "x-queryable":true }, "RawCost":{ "title":"Raw cost", "type":"number", "description":"Planned cost for the period in the financial project plan resource assignment in planning currency that corresponds to the work performed.", "nullable":true, "x-queryable":true }, "ITDActualRevenueInProjectLedgerCurrency":{ "title":"ITD Actual Revenue in Project Ledger Currency", "type":"number", "description":"Actual revenue incurred for the period in the financial project plan resource assignment, in project ledger currency, that corresponds to the work performed from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "ITDActualBurdenedCostInProjectLedgerCurrency":{ "title":"ITD Actual in Project Ledger Currency", "type":"number", "description":"Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project ledger currency from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "StandardBurdenedCostRate":{ "title":"Standard Burdened Cost Rate", "type":"number", "description":"Average rate derived from the rate schedule for calculating the planned burdened cost for the period in the financial project plan resource assignment.", "nullable":true, "readOnly":true, "x-queryable":true }, "EffectiveRawCostRate":{ "title":"Effective Rate", "type":"number", "description":"Cost rate that is used to calculate amounts for a period in the financial project plan resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts.", "nullable":true, "x-queryable":true }, "ITDActualBurdenedCostInProjectCurrency":{ "title":"ITD Actual Burdened Cost", "type":"number", "description":"Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project currency from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "RevenueInProjectCurrency":{ "title":"Revenue in Project Currency", "type":"number", "description":"Planned revenue for the period in the financial project plan resource assignment, in project currency, that corresponds to the work performed.", "nullable":true, "readOnly":true, "x-queryable":true }, "PlannedQuantity":{ "title":"Planned Quantity", "type":"number", "description":"Measure of the effort planned for the period in the financial project plan resource assignment, expressed in hours.", "nullable":true, "x-queryable":true }, "RawCostInProjectCurrency":{ "title":"Raw Cost in Project Currency: Total", "type":"number", "description":"Planned cost for a period in the financial project plan resource assignment in project currency that corresponds to the work performed.", "nullable":true, "readOnly":true, "x-queryable":true }, "ITDActualQuantity":{ "title":"ITD Actual Quantity", "type":"number", "description":"Actual effort for the period in the financial project plan resource assignment from the start of the project till the current date, expressed in hours.", "nullable":true, "readOnly":true, "x-queryable":true }, "EffectiveBurdenedCostRate":{ "title":"Burdened Cost Rate", "type":"number", "description":"Cost rate that is used to calculate amounts for a period in the financial project plan resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts.", "nullable":true, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "BurdenedCost":{ "title":"Planned Burdened Cost", "type":"number", "description":"Total planned cost for the period in the financial project plan resource assignment in planning currency that includes both raw and burden costs.", "nullable":true, "x-queryable":true }, "ITDActualRawCost":{ "title":"ITD Actual Raw Cost", "type":"number", "description":"Actual cost incurred for the period in the financial project plan resource assignment in planning currency that corresponds to the work performed from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "ITDActualBurdenedCost":{ "title":"ITD Actual Burdened Cost", "type":"number", "description":"Actual cost incurred for the period in the financial project plan resource assignment, including raw and burden costs, in planning currency from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "ITDActualRevenue":{ "title":"ITD Actual Revenue", "type":"number", "description":"Actual revenue incurred for the period in the financial project plan resource assignment, in planning currency, that corresponds to the work performed from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "ITDActualRawCostInProjectLedgerCurrency":{ "title":"ITD Actual in Project Ledger Currency", "type":"number", "description":"Actual cost incurred for the financial project plan resource assignment in project ledger currency that corresponds to the work performed from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "BurdenedCostInProjectCurrency":{ "title":"Burdened Cost in Project Currency: Total", "type":"number", "description":"Total planned cost for a period in the financial project plan resource assignment in project currency that includes both raw and burden costs.", "nullable":true, "readOnly":true, "x-queryable":true }, "BurdenedCostInProjectLedgerCurrency":{ "title":"Burdened Cost in Project Ledger Currency: Total", "type":"number", "description":"Total planned cost for a period in the financial project plan resource assignment in project ledger currency that includes both raw and burden costs.", "nullable":true, "readOnly":true, "x-queryable":true }, "RevenueInProjectLedgerCurrency":{ "title":"Revenue in Project Ledger Currency", "type":"number", "description":"Planned revenue for the period in the financial project plan resource assignment, in project ledger currency, that corresponds to the work performed.", "nullable":true, "readOnly":true, "x-queryable":true }, "StandardRawCostRate":{ "title":"Standard Raw Cost Rate", "type":"number", "description":"Rate derived from the rate schedule for calculating the planned raw cost for the period in the financial project plan resource assignment.", "nullable":true, "readOnly":true, "x-queryable":true }, "ITDActualRevenueInProjectCurrency":{ "title":"ITD Actual Revenue in Project Currency", "type":"number", "description":"Actual revenue incurred for the period in the financial project plan resource assignment, in project currency, that corresponds to the work performed from the start date of the project till the current date.", "nullable":true, "readOnly":true, "x-queryable":true }, "StandardRevenueRate":{ "title":"Standard Revenue Rate", "type":"number", "description":"Rate derived from the rate schedule for calculating the planned revenue for a period in the financial project plan resource assignment.", "nullable":true, "readOnly":true, "x-queryable":true }, "Revenue":{ "title":"Revenue", "type":"number", "description":"Planned revenue for the period in the financial project plan resource assignment, in planning currency, that corresponds to the work performed.", "nullable":true, "x-queryable":true }, "PeriodName":{ "title":"Period", "maxLength":30, "type":"string", "description":"Period for which the periodic level planning amounts are created for a resource assignment in the financial project plan.", "nullable":true, "x-queryable":true } } }

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }

Nested Schema : financialProjectPlans-VersionErrors-item-response

Type: object

Show Source

• ErrorType: string
  Title: Rejection Type

  Read Only: true

  Maximum Length: 30

  Indicates the type of the exception, for example, Error or Warning.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageCause: string
  Title: Cause

  Read Only: true

  Maximum Length: 4000

  Reason due to which the error in the financial project version occurred.
• MessageName: string
  Title: Message Name

  Read Only: true

  Maximum Length: 30

  Name that identifies the message uniquely.
• MessageText: string
  Title: Message Text

  Read Only: true

  Maximum Length: 240

  Text of the message that indicates the cause and resolution of the error.
• MessageUserAction: string
  Title: Action

  Read Only: true

  Maximum Length: 4000

  The action that you must perform to resolve the error.
• MessageUserDetails: string
  Title: Additional Details

  Read Only: true

  Maximum Length: 4000

  Additional information about the cause and resolution of the error.
• PeriodName: string
  Title: Period

  Read Only: true

  Maximum Length: 30

  Period for which errors exist in the financial project plan version.
• PlanVersionId: number
  Title: Plan Version

  Read Only: true

  Identifier of the financial project plan version.
• ResourceName: string
  Title: Resource

  Read Only: true

  Maximum Length: 240

  Name or alias name of the resource specified in the planning resource breakdown structure in the financial project plan version that has errors.
• TaskName: string
  Title: Task Name

  Read Only: true

  Maximum Length: 255

  Name of the task in the financial project plan version that has errors.
• TaskNumber: string
  Title: Task Number

  Read Only: true

  Maximum Length: 100

  Number of the task in the financial project plan version that has errors.
• TransactionCurrencyCode: string
  Title: Currency

  Read Only: true

  Maximum Length: 15

  Code that identifies the planning currency in the financial project plan version.

{ "type":"object", "properties":{ "ResourceName":{ "title":"Resource", "maxLength":240, "type":"string", "description":"Name or alias name of the resource specified in the planning resource breakdown structure in the financial project plan version that has errors.", "nullable":true, "readOnly":true, "x-queryable":true }, "PlanVersionId":{ "title":"Plan Version", "type":"number", "description":"Identifier of the financial project plan version.", "nullable":false, "readOnly":true, "x-queryable":true }, "TaskNumber":{ "title":"Task Number", "maxLength":100, "type":"string", "description":"Number of the task in the financial project plan version that has errors.", "nullable":true, "readOnly":true, "x-queryable":true }, "MessageUserDetails":{ "title":"Additional Details", "maxLength":4000, "type":"string", "description":"Additional information about the cause and resolution of the error.", "nullable":true, "readOnly":true, "x-queryable":true }, "MessageUserAction":{ "title":"Action", "maxLength":4000, "type":"string", "description":"The action that you must perform to resolve the error.", "nullable":true, "readOnly":true, "x-queryable":true }, "MessageText":{ "title":"Message Text", "maxLength":240, "type":"string", "description":"Text of the message that indicates the cause and resolution of the error.", "nullable":false, "readOnly":true, "x-queryable":true }, "TransactionCurrencyCode":{ "title":"Currency", "maxLength":15, "type":"string", "description":"Code that identifies the planning currency in the financial project plan version.", "nullable":true, "readOnly":true, "x-queryable":true }, "MessageName":{ "title":"Message Name", "maxLength":30, "type":"string", "description":"Name that identifies the message uniquely.", "nullable":false, "readOnly":true, "x-queryable":true }, "MessageCause":{ "title":"Cause", "maxLength":4000, "type":"string", "description":"Reason due to which the error in the financial project version occurred.", "nullable":true, "readOnly":true, "x-queryable":true }, "ErrorType":{ "title":"Rejection Type", "maxLength":30, "type":"string", "description":"Indicates the type of the exception, for example, Error or Warning.", "nullable":true, "readOnly":true, "x-queryable":true }, "TaskName":{ "title":"Task Name", "maxLength":255, "type":"string", "description":"Name of the task in the financial project plan version that has errors.", "nullable":false, "readOnly":true, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "PeriodName":{ "title":"Period", "maxLength":30, "type":"string", "description":"Period for which errors exist in the financial project plan version.", "nullable":true, "readOnly":true, "x-queryable":true } } }

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }

Links

adjustForRangeOfProjects

Operation: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/action/adjustForRangeOfProjects

Adjusts the financial project plan versions for a range of projects using the adjustment type and adjustment percentage.

baselineFinancialProjectPlan

Operation: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/action/baselineFinancialProjectPlan

This action will set the financial project plan to baseline. Additionally, you can create a budget version and baseline it.

baselineRangeOfFinancialProjectPlans

Operation: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/action/baselineRangeOfFinancialProjectPlans

Sets the baseline financial project plan for a range of projects. Additionally, generates a budget version and baselines it based on the budget generation option specified in the project plan type settings.

refreshRatesForRangeOfProjects

Operation: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/action/refreshRatesForRangeOfProjects

Refresh rates on financial project plan versions for a range of projects.

reprocessFailedFinancialProjectPlans

Operation: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/action/reprocessFailedFinancialProjectPlans

This action will reprocess all the financial project plan versions that failed and places them back in the Current working state.

updateActualAmountsForRangeOfProjects

Operation: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/action/updateActualAmountsForRangeOfProjects

Updates actual amounts for a range of projects.

updatePlannedAmountsFromProgressForRangeOfProjects

Operation: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/action/updatePlannedAmountsFromProgressForRangeOfProjects

Updates planned amounts from progress for a range of projects.

Back to Top

Examples

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

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

Response Body Example

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

{ "items": [ { "PlanVersionId": 4067307, "ProjectPlanType": "PSR Project Plan", "ProjectId": 100010025119098, "ProjectNumber": "PJO-M6MAT-PRJ8", "ProjectName": "PJO-M6MAT-PRJ8", "PlannedEffort": 22680, "ITDActualEffort": null, "BaselineEffort": null, "RawCostInProjectCurrency": 45360, "ITDActualRawCostInProjectCurrency": null, "BaselineRawCostInProjectCurrency": null, "BurdenedCostInProjectCurrency": 68040, "ITDActualBurdenedCostInProjectCurrency": null, "BaselineBurdenedCostInProjectCurrency": null, "RawCostInProjectLedgerCurrency": 45360, "ITDActualRawCostInProjectLedgerCurrency": null, "BaselineRawCostInProjectLedgerCurrency": null, "BurdenedCostInProjectLedgerCurrency": 68040, "ITDActualBurdenedCostInProjectLedgerCurrency": null, "BaselineBurdenedCostInProjectLedgerCurrency": null }

Back to Top