Update an export option for a project budget version

patch

/fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/ExportOptions/{ExportOptionId}

Request

Path Parameters
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Burdened Cost: Effective Multiplier
    Multiplier used to calculate the burdened costs. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Burdened Cost: Standard Multiplier
    Standard multiplier derived from the burden schedule for calculating burdened cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Burdened Cost: Standard Rate
    Standard rate derived from the rate schedule for calculating the burdened cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Display currency conversion attributes and amounts in multiple transaction currencies
    Indicates whether to display the currency conversion attributes and amounts in multiple transaction currencies if the plan type allows planning in multiple transaction currencies.
  • Title: Burdened Cost: Effective Rate
    User entered rate for calculating the burdened cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Raw Cost: Effective Rate
    User entered rate for calculating the raw cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Effective Revenue Rate
    User entered rate for calculating revenue. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: From Date
    From date of the budget line. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Margin Percentage
    Margin expressed as a percentage. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Planning Currency
    Currency used for planning in the budget line. This value is always set to true and the attribute is exported.
  • Title: Planning Resource
    Resource used for financial planning in budgets. This value is always set to true and the attribute is exported.
  • Title: Project Currency Conversion: Cost Date
    Date that's used as a cost conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Cost Date Type
    Date type that's used as a cost conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Cost Rate
    Cost rate used when converting the amounts to project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Cost Rate Type
    The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Revenue Date
    Date that's used as a revenue conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Revenue Date Type
    Date type that's used as a revenue conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Revenue Rate
    Revenue rate used when converting the amounts to project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Revenue Rate Type
    The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Cost Date
    Date that's used as a cost conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Cost Date Type
    Date type that's used as a cost conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Cost Rate
    Cost rate used when converting the amounts to project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Cost Rate Type
    The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Revenue Date
    Date that's used as a revenue conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Revenue Date Type
    Date type that's used as a revenue conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Revenue Rate
    Revenue rate used when converting the amounts to project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Revenue Rate Type
    The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Resource Class
    Resource class associated with the budget line. This value is always set to true and the attribute is exported.
  • Title: Spread Curve
    Spread curve associated with the budget line. This value is always set to true and the attribute is exported.
  • Title: Raw Cost: Standard Rate
    Rate derived from the rate schedule for calculating raw cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Revenue: Standard Rate
    Rate derived from the rate schedule for calculating revenue. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Task Name
    Name assigned to a task. This value is always set to true and the attribute is exported.
  • Title: Task Number
    Number of the task. This value is always set to true and the attribute is exported.
  • Title: To Date
    End date of the budget line. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Burdened Cost: Total
    Total burdened costs incurred on the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Burdened Cost in Project Currency: Total
    Total burdened costs incurred on the project, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Burdened Cost in Project Ledger Currency: Total
    Total burdened costs incurred on the project, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Total Margin
    Total margin (difference between revenue and cost) in a project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Margin in Project Currency: Total
    Total margin in the project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Margin in Project Ledger Currency: Total
    Total margin in the project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Quantity: Total
    Total quantity of resource effort that's required to complete a task or project, including labor and equipment. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Raw Cost: Total
    Total cost directly attributable to the work performed. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Raw Cost in Project Currency: Total
    Total raw costs that are directly attributable to the work performed in the current budget, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Raw Cost in Project Ledger Currency: Total
    Total raw costs that are directly attributable to the work performed, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Revenue: Total
    Total planned revenue that's associated with the accounting period or a plan line in the budget. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Revenue in Project Currency: Total
    Total planned revenue that's associated with the accounting period or a financial plan line in the budget, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Revenue in Project Ledger Currency: Total
    Total planned revenue that's associated with the accounting period or a financial plan line in the budget, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : projectBudgets-PlanningOptions-ExportOptions-item-response
Type: object
Show Source
  • Title: Burdened Cost: Effective Multiplier
    Multiplier used to calculate the burdened costs. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Burdened Cost: Standard Multiplier
    Standard multiplier derived from the burden schedule for calculating burdened cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Burdened Cost: Standard Rate
    Standard rate derived from the rate schedule for calculating the burdened cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Display currency conversion attributes and amounts in multiple transaction currencies
    Indicates whether to display the currency conversion attributes and amounts in multiple transaction currencies if the plan type allows planning in multiple transaction currencies.
  • Title: Burdened Cost: Effective Rate
    User entered rate for calculating the burdened cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Raw Cost: Effective Rate
    User entered rate for calculating the raw cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Effective Revenue Rate
    User entered rate for calculating revenue. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Export Options ID
    Read Only: true
    Identifier of the project budget version export options.
  • Title: From Date
    From date of the budget line. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Links
  • Title: Margin Percentage
    Margin expressed as a percentage. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Planning Currency
    Currency used for planning in the budget line. This value is always set to true and the attribute is exported.
  • Title: Planning Resource
    Resource used for financial planning in budgets. This value is always set to true and the attribute is exported.
  • Title: Project Currency Conversion: Cost Date
    Date that's used as a cost conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Cost Date Type
    Date type that's used as a cost conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Cost Rate
    Cost rate used when converting the amounts to project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Cost Rate Type
    The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Revenue Date
    Date that's used as a revenue conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Revenue Date Type
    Date type that's used as a revenue conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Revenue Rate
    Revenue rate used when converting the amounts to project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Currency Conversion: Revenue Rate Type
    The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Cost Date
    Date that's used as a cost conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Cost Date Type
    Date type that's used as a cost conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Cost Rate
    Cost rate used when converting the amounts to project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Cost Rate Type
    The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Revenue Date
    Date that's used as a revenue conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Revenue Date Type
    Date type that's used as a revenue conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Revenue Rate
    Revenue rate used when converting the amounts to project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Project Ledger Currency Conversion: Revenue Rate Type
    The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Resource Class
    Resource class associated with the budget line. This value is always set to true and the attribute is exported.
  • Title: Spread Curve
    Spread curve associated with the budget line. This value is always set to true and the attribute is exported.
  • Title: Raw Cost: Standard Rate
    Rate derived from the rate schedule for calculating raw cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Revenue: Standard Rate
    Rate derived from the rate schedule for calculating revenue. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Task Name
    Name assigned to a task. This value is always set to true and the attribute is exported.
  • Title: Task Number
    Number of the task. This value is always set to true and the attribute is exported.
  • Title: To Date
    End date of the budget line. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Burdened Cost: Total
    Total burdened costs incurred on the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Burdened Cost in Project Currency: Total
    Total burdened costs incurred on the project, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Burdened Cost in Project Ledger Currency: Total
    Total burdened costs incurred on the project, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Total Margin
    Total margin (difference between revenue and cost) in a project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Margin in Project Currency: Total
    Total margin in the project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Margin in Project Ledger Currency: Total
    Total margin in the project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Quantity: Total
    Total quantity of resource effort that's required to complete a task or project, including labor and equipment. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Raw Cost: Total
    Total cost directly attributable to the work performed. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Raw Cost in Project Currency: Total
    Total raw costs that are directly attributable to the work performed in the current budget, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Raw Cost in Project Ledger Currency: Total
    Total raw costs that are directly attributable to the work performed, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Revenue: Total
    Total planned revenue that's associated with the accounting period or a plan line in the budget. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Revenue in Project Currency: Total
    Total planned revenue that's associated with the accounting period or a financial plan line in the budget, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Revenue in Project Ledger Currency: Total
    Total planned revenue that's associated with the accounting period or a financial plan line in the budget, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
  • Title: Unit of Measure
    Read Only: true
    Unit of measure for a resource. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export.
Back to Top