Jump to

• Request
• Response

Get all planning options

get

/fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions

Request

Path Parameters

• PlanVersionId(required): integer(int64)
  Identifier of the project budget version.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
    Finder Variables:
    • PlanningOptionId
• 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:
  

  • AmountScale; string; The scale on which amounts are displayed on the user interface. For example, if you select to view amounts in 1000s, the $100,000,000 amount is displayed as 100,000.
  • AssignTaskResourceInSingleCurrencyFlag; boolean; Indicates whether a budget line is enabled for assigning resources in a single currency for a task.
  • BillRateDerivationDate; string; The date that is used as the basis for deriving rates for calculating revenue amounts.
  • BillRateDerivationDateType; string; The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating revenue amounts.
  • BurdenScheduleCostOptions; string; A set of burden multipliers that is maintained for use across projects. Also referred to as a standard burden schedule.
  • CalendarType; string; The type of calendar, such as accounting calendar or project accounting calendar, used for entering and displaying periodic financial information.
  • CostDateTypeForConversionInPC; string; Date type that is used as a cost conversion attribute for project currency.
  • CostDateTypeForConversionInPLC; string; Date type that is used as a cost conversion attribute for project ledger currency.
  • CostFixedDateForConversionInPC; string; The date that is used to derive rates for calculating planned costs for project currency.
  • CostFixedDateForConversionInPLC; string; The date that is used to derive rates for calculating planned costs for project ledger currency.
  • CostRateDerivationDate; string; The date that is used as the basis for deriving rates for calculating cost amounts.
  • CostRateDerivationDateType; string; The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating cost amounts.
  • CostRateTypeForConversionInPC; string; Cost rate type that is used as a cost conversion attribute for project currency.
  • CostRateTypeForConversionInPLC; string; Cost rate type that is used as a cost conversion attribute for project ledger currency.
  • CurrencyType; string; Indicates whether the project currency or the project ledger currency is used for displaying amounts when reviewing budget amounts.
  • CurrentPlanningPeriod; string; Current planning period that drives the display of the periodic information. It can be the project accounting period or accounting period depending on the selected calendar type. This value is not applicable when the calendar type is set to NONE.
  • DateTypeForCostConversion; string; Date type that is used as a cost conversion attribute for planning currencies.
  • DateTypeForRevenueConversion; string; Date type that is used as a revenue conversion attribute for planning currencies.
  • DefaultReportingOption; string; Indicates whether cost or revenue quantity is used for reporting quantity when planning for cost and revenue in a separate budget version. By default, it is set to Cost when planning amounts are cost only or cost and revenue together. When the planning amounts are revenue only, it is set to Revenue.
  • DesignateAsApprovedCostBudgetFlag; boolean; Indicates whether a financial plan type is an approved cost budget.
  • DesignateAsApprovedRevenueBudgetFlag; boolean; Indicates whether a financial plan type is an approved revenue budget.
  • EnableBudgetaryControls; string; Indicates whether a financial plan type is eligible for integration with budgetary controls. A value of Y indicates that the attribute is selected. A value of N means that the attribute is not selected.
  • FixedDateForCostConversion; string; The date that is used to derive rates for calculating planned costs for planning currencies.
  • FixedDateForRevenueConversion; string; The date that is used to derive rates for calculating planned revenue for planning currencies.
  • JobCostOptions; string; Rate schedule used for the calculation of cost amounts for jobs.
  • JobRevenueOptions; string; Rate schedule used for the calculation of revenue amounts for jobs.
  • MaintainManualSpreadOnDateChanges; string; Indicates whether the periodic planning is retained in the plan version on plan line date modifications. A value of Y indicates that the attribute is selected. A value of N means that the attribute is not selected.
  • MultipleTransactionCurrencies; string; Indicates that the plan can use multiple transaction currencies. A value of Y indicates that the attribute is selected. A value of N means that the attribute is not selected.
  • NonlaborResourceCostOptions; string; Rate schedule used for the calculation of cost amounts for non-labor resources.
  • NonlaborResourceRevenueOptions; string; Rate schedule used for the calculation of revenue amounts for non-labor resources.
  • PeriodProfile; string; Defines how time periods are grouped and displayed when editing budget versions.
  • PersonCostOptions; string; Rate schedule used for the calculation of cost amounts for named persons.
  • PersonRevenueOptions; string; Rate schedule used for the calculation of revenue amounts for named persons.
  • PlanningLevel; string; Level of the budget at which amounts can be entered.
  • PlanningOptionId; integer; Unique identifier of the summary level planning option in the project budget version.
  • PlanningResourceBreakdownStructure; string; Planning resource breakdown structure associated with the project.
  • ProjectCurrency; string; Currency for the project.
  • ProjectLedgerCurrency; string; Project ledger currency for the project.
  • ProjectRoleCostOptions; string; Rate schedule used for the calculation of cost amounts for project role.
  • ProjectRoleRevenueOptions; string; Rate schedule used for the calculation of cost amounts for project role.
  • RateDerivationDate; string; The date that is used as the basis for deriving rates for calculating amounts on a none time phase budget version.
  • RateDerivationDateType; string; The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating amounts on a none time phase budget version.
  • RateTypeForCostConversion; string; Cost rate type that is used as a cost conversion attribute for planning currencies.
  • RateTypeForRevenueConversion; string; Revenue rate type that is used as a revenue conversion attribute for planning currencies.
  • ReportCost; string; Determines the cost amount types that are used to calculate and report margins on budgets.
  • ResourceClassCostOptions; string; 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; Rate schedule used for the calculation of revenue amounts for resource classes. This is used for revenue calculation when rates are unavailable in rate schedules for named persons, jobs, or non-labor resources.
  • RetainOverrideRatesFromSourceFlag; boolean; Indicates whether user specified cost and revenue rates from the source must be retained when generating the target budget version.
  • RevenueDateTypeForConversionInPC; string; Date type that is used as a revenue conversion attribute for project currency.
  • RevenueDateTypeForConversionInPLC; string; Date type that is used as a revenue conversion attribute for project ledger currency.
  • RevenueFixedDateForConversionInPC; string; The date that is used to derive rates for calculating planned revenue for project currency.
  • RevenueFixedDateForConversionInPLC; string; The date that is used to derive rates for calculating planned revenue for project ledger currency.
  • RevenueGenerationMethod; string; Determines whether budget revenue is calculated based on quantity and rates, event amounts, or the spread ratio specified for tasks.
  • RevenueRateTypeForConversionInPC; string; Revenue rate type that is used as a revenue conversion attribute for project currency.
  • RevenueRateTypeForConversionInPLC; string; Revenue rate type that is used as a revenue conversion attribute for project ledger currency.
  • UsePlanningRatesFlag; boolean; Enables utilization of planning rates for resources and resource classes when calculating budget amounts.
• 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:
  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.

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 : projectBudgets-PlanningOptions

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/projectBudgets-PlanningOptions-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

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

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 : projectBudgets-PlanningOptions-item-response

Type: object

Show Source

• AmountScale: string
  Title: Amount Scale

  Maximum Length: 255

  The scale on which amounts are displayed on the user interface. For example, if you select to view amounts in 1000s, the $100,000,000 amount is displayed as 100,000.
• AmountTypes: array Amount Types
  Title: Amount Types

  The Amount Type resource is used to select the cost and revenue items to include in a financial plan type.
• AssignTaskResourceInSingleCurrencyFlag: boolean
  Title: Assign Resource in Single Currency for a Task

  Indicates whether a budget line is enabled for assigning resources in a single currency for a task.
• BillRateDerivationDate: string (date-time)
  Title: Bill Rate Derivation Date

  The date that is used as the basis for deriving rates for calculating revenue amounts.
• BillRateDerivationDateType: string
  Title: Bill Rate Derivation Date Type

  Maximum Length: 255

  The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating revenue amounts.
• BudgetaryControlSettings: array Budgetary Control Settings
  Title: Budgetary Control Settings

  The Budgetary Control Setting resource is used to view and update project and top resource control levels.
• BurdenScheduleCostOptions: string
  Title: Burden Schedule

  Maximum Length: 255

  A set of burden multipliers that is maintained for use across projects. Also referred to as a standard burden schedule.
• 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.
• CostDateTypeForConversionInPC: string
  Title: Project Currency Conversion: Cost Date Type

  Maximum Length: 255

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

  Maximum Length: 255

  Date type that is used as a cost conversion attribute for project ledger currency.
• CostFixedDateForConversionInPC: string (date-time)
  Title: Project Currency Conversion: Cost Fixed Date

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

  The date that is used to derive rates for calculating planned costs for project ledger currency.
• CostRateDerivationDate: string (date-time)
  Title: Cost Rate Derivation Date

  The date that is used as the basis for deriving rates for calculating cost amounts.
• CostRateDerivationDateType: string
  Title: Cost Rate Derivation Date Type

  Maximum Length: 255

  The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating cost amounts.
• CostRateTypeForConversionInPC: string
  Title: Project Currency Conversion: Cost Rate Type

  Maximum Length: 255

  Cost rate type that is used as a cost conversion attribute for project currency.
• CostRateTypeForConversionInPLC: string
  Title: Project Ledger Currency Conversion: Cost Rate Type

  Maximum Length: 255

  Cost rate type that is used as a cost conversion attribute for project ledger currency.
• CurrencyType: string
  Title: Currency Type

  Maximum Length: 255

  Indicates whether the project currency or the project ledger currency is used for displaying amounts when reviewing budget amounts.
• 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 is not applicable when the calendar type is set to NONE.
• DateTypeForCostConversion: string
  Title: Date Type for Cost Conversion

  Maximum Length: 255

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

  Maximum Length: 255

  Date type that is used as a revenue conversion attribute for planning currencies.
• DefaultReportingOption: string
  Title: Default Reporting Option

  Read Only: true

  Maximum Length: 255

  Indicates whether cost or revenue quantity is used for reporting quantity when planning for cost and revenue in a separate budget version. By default, it is set to Cost when planning amounts are cost only or cost and revenue together. When the planning amounts are revenue only, it is set to Revenue.
• DesignateAsApprovedCostBudgetFlag: boolean
  Title: Designate as approved cost budget

  Read Only: true

  Indicates whether a financial plan type is an approved cost budget.
• DesignateAsApprovedRevenueBudgetFlag: boolean
  Title: Designate as approved revenue budget

  Read Only: true

  Indicates whether a financial plan type is an approved revenue budget.
• EnableBudgetaryControls: string
  Title: Enable Budgetary Controls

  Read Only: true

  Maximum Length: 1

  Indicates whether a financial plan type is eligible for integration with budgetary controls. A value of Y indicates that the attribute is selected. A value of N means that the attribute is not selected.
• ExportOptions: array Export Options
  Title: Export Options

  The Export Option resource is used to select the planning options attributes to export.
• FixedDateForCostConversion: string (date-time)
  Title: Fixed Date for Cost Conversion

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

  The date that is used to derive rates for calculating planned revenue for planning currencies.
• JobCostOptions: string
  Title: Job Cost Options

  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 used for the 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: 255

  Indicates whether the periodic planning is retained in the plan version on plan line date modifications. A value of Y indicates that the attribute is selected. A value of N means that the attribute is not selected.
• MultipleTransactionCurrencies: string
  Title: Multiple Transaction Currencies

  Maximum Length: 255

  Indicates that the plan can use multiple transaction currencies. A value of Y indicates that the attribute is selected. A value of N means that the attribute is not selected.
• 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

  Maximum Length: 255

  Rate schedule used for the 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 budget 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 used for the calculation of revenue amounts for named persons.
• PlanningCurrencies: array Planning Currencies
  Title: Planning Currencies

  The Planning Currency resource is used to view, create, update, and delete project and planning currencies.
• PlanningLevel: string
  Title: Planning Level

  Maximum Length: 255

  Level of the budget at which amounts can be entered.
• PlanningOptionId: integer (int64)
  Title: Planning Option ID

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

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

  Maximum Length: 255

  Planning resource breakdown structure associated with the project.
• 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 used for the calculation of cost amounts for project role.
• RateDerivationDate: string (date-time)
  Title: Rate Derivation Date

  The date that is used as the basis for deriving rates for calculating amounts on a none time phase budget version.
• RateDerivationDateType: string
  Title: Rate Derivation Date Type

  Maximum Length: 255

  The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating amounts on a none time phase budget version.
• RateTypeForCostConversion: string
  Title: Rate Type for Cost Conversion

  Maximum Length: 255

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

  Maximum Length: 255

  Revenue rate type that is used as a revenue conversion attribute for planning currencies.
• ReportCost: string
  Title: Report Cost

  Maximum Length: 255

  Determines the cost amount types that are used to calculate and report margins on budgets.
• 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 used for the calculation of revenue amounts for resource classes. This is used for revenue calculation when rates are unavailable in rate schedules for named persons, jobs, or non-labor resources.
• RetainOverrideRatesFromSourceFlag: boolean
  Title: Retain override rates from source

  Indicates whether user specified cost and revenue rates from the source must be retained when generating the target budget version.
• RevenueDateTypeForConversionInPC: string
  Title: Project Currency Conversion: Revenue Date Type

  Maximum Length: 255

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

  Maximum Length: 255

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

  The date that is used to derive rates for calculating planned revenue for project currency.
• RevenueFixedDateForConversionInPLC: string (date-time)
  Title: Project Ledger Currency Conversion: Revenue Fixed Date

  The date that is used to derive rates for calculating planned revenue for project ledger currency.
• RevenueGenerationMethod: string
  Title: Revenue Generation Method

  Maximum Length: 255

  Determines whether budget revenue is calculated based on quantity and rates, event amounts, or the spread ratio specified for tasks.
• RevenueRateTypeForConversionInPC: string
  Title: Project Currency Conversion: Revenue Rate Type

  Maximum Length: 255

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

  Maximum Length: 255

  Revenue rate type that is used as a revenue conversion attribute for project ledger currency.
• UsePlanningRatesFlag: boolean
  Title: Use Planning Rates

  Enables utilization of planning rates for resources and resource classes when calculating budget 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.

{
    "type":"object",
    "properties":{
        "CostRateDerivationDate":{
            "title":"Cost Rate Derivation Date",
            "type":"string",
            "description":"The date that is used as the basis for deriving rates for calculating cost amounts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RateTypeForRevenueConversion":{
            "title":"Rate Type for Revenue Conversion",
            "maxLength":255,
            "type":"string",
            "description":"Revenue rate type that is used as a revenue conversion attribute for planning currencies.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningResourceBreakdownStructure":{
            "title":"Planning Resource Breakdown Structure",
            "maxLength":255,
            "type":"string",
            "description":"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
        },
        "FixedDateForRevenueConversion":{
            "title":"Fixed Date for Revenue Conversion",
            "type":"string",
            "description":"The date that is used to derive rates for calculating planned revenue for planning currencies.",
            "format":"date-time",
            "nullable":true,
            "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,
            "x-queryable":true
        },
        "DesignateAsApprovedCostBudgetFlag":{
            "title":"Designate as approved cost budget",
            "type":"boolean",
            "description":"Indicates whether a financial plan type is an approved cost budget.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExportOptions":{
            "title":"Export Options",
            "type":"array",
            "description":"The Export Option resource is used to select the planning options attributes to export.",
            "items":{
                "$ref":"#/components/schemas/projectBudgets-PlanningOptions-ExportOptions-item-response"
            },
            "x-cardinality":"1"
        },
        "CostRateTypeForConversionInPC":{
            "title":"Project Currency Conversion: Cost Rate Type",
            "maxLength":255,
            "type":"string",
            "description":"Cost rate type that is used as a cost conversion attribute for project currency.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CostRateDerivationDateType":{
            "title":"Cost Rate Derivation Date Type",
            "maxLength":255,
            "type":"string",
            "description":"The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating cost amounts.",
            "nullable":true,
            "x-queryable":true
        },
        "DateTypeForCostConversion":{
            "title":"Date Type for Cost Conversion",
            "maxLength":255,
            "type":"string",
            "description":"Date type that is used as a cost conversion attribute for planning currencies.",
            "nullable":true,
            "x-queryable":true
        },
        "RevenueRateTypeForConversionInPLC":{
            "title":"Project Ledger Currency Conversion: Revenue Rate Type",
            "maxLength":255,
            "type":"string",
            "description":"Revenue rate type that is used as a revenue conversion attribute for project ledger currency.",
            "nullable":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",
            "type":"boolean",
            "description":"Enables utilization of planning rates for resources and resource classes when calculating budget amounts.",
            "nullable":true,
            "x-queryable":true
        },
        "CostDateTypeForConversionInPC":{
            "title":"Project Currency Conversion: Cost Date Type",
            "maxLength":255,
            "type":"string",
            "description":"Date type that is used as a cost conversion attribute for project currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ReportCost":{
            "title":"Report Cost",
            "maxLength":255,
            "type":"string",
            "description":"Determines the cost amount types that are used to calculate and report margins on budgets.",
            "nullable":true,
            "x-queryable":true
        },
        "FixedDateForCostConversion":{
            "title":"Fixed Date for Cost Conversion",
            "type":"string",
            "description":"The date that is used to derive rates for calculating planned costs for planning currencies.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "BudgetaryControlSettings":{
            "title":"Budgetary Control Settings",
            "type":"array",
            "description":"The Budgetary Control Setting resource is used to view and update project and top resource control levels.",
            "items":{
                "$ref":"#/components/schemas/projectBudgets-PlanningOptions-BudgetaryControlSettings-item-response"
            }
        },
        "RevenueDateTypeForConversionInPLC":{
            "title":"Project Ledger Currency Conversion: Revenue Date Type",
            "maxLength":255,
            "type":"string",
            "description":"Date type that is used as a revenue conversion attribute for project ledger currency.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignTaskResourceInSingleCurrencyFlag":{
            "title":"Assign Resource in Single Currency for a Task",
            "type":"boolean",
            "description":"Indicates whether a budget line is enabled for assigning resources in a single currency for a task.",
            "nullable":true,
            "x-queryable":true
        },
        "MaintainManualSpreadOnDateChanges":{
            "title":"Maintain manual spread on date changes",
            "maxLength":255,
            "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 means that the attribute is not selected.",
            "nullable":true,
            "x-queryable":true
        },
        "RateDerivationDate":{
            "title":"Rate Derivation Date",
            "type":"string",
            "description":"The date that is used as the basis for deriving rates for calculating amounts on a none time phase budget version.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RevenueFixedDateForConversionInPC":{
            "title":"Project Currency Conversion: Revenue Fixed Date",
            "type":"string",
            "description":"The date that is used to derive rates for calculating planned revenue for project currency.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AmountScale":{
            "title":"Amount Scale",
            "maxLength":255,
            "type":"string",
            "description":"The scale on which amounts are displayed on the user interface. For example, if you select to view amounts in 1000s, the $100,000,000 amount is displayed as 100,000.",
            "nullable":true,
            "x-queryable":true
        },
        "NonlaborResourceRevenueOptions":{
            "title":"Nonlabor Resource",
            "maxLength":255,
            "type":"string",
            "description":"Rate schedule used for the calculation of revenue amounts for non-labor resources.",
            "nullable":true,
            "x-queryable":true
        },
        "RevenueRateTypeForConversionInPC":{
            "title":"Project Currency Conversion: Revenue Rate Type",
            "maxLength":255,
            "type":"string",
            "description":"Revenue rate type that is used as a revenue conversion attribute for project currency.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyType":{
            "title":"Currency Type",
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the project currency or the project ledger currency is used for displaying amounts when reviewing budget amounts.",
            "nullable":true,
            "x-queryable":true
        },
        "CostRateTypeForConversionInPLC":{
            "title":"Project Ledger Currency Conversion: Cost Rate Type",
            "maxLength":255,
            "type":"string",
            "description":"Cost rate type that is used as a cost conversion attribute for project ledger currency.",
            "nullable":true,
            "x-queryable":true
        },
        "JobRevenueOptions":{
            "title":"Job Revenue Options",
            "maxLength":255,
            "type":"string",
            "description":"Rate schedule used for the calculation of revenue amounts for jobs.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceClassRevenueOptions":{
            "title":"Resource Class Revenue Options",
            "maxLength":255,
            "type":"string",
            "description":"Rate schedule used for the calculation of revenue amounts for resource classes. This is used for revenue calculation when rates are unavailable in rate schedules for named persons, jobs, or non-labor resources.",
            "nullable":true,
            "x-queryable":true
        },
        "AmountTypes":{
            "title":"Amount Types",
            "type":"array",
            "description":"The Amount Type resource is used to select the cost and revenue items to include in a financial plan type.",
            "items":{
                "$ref":"#/components/schemas/projectBudgets-PlanningOptions-AmountTypes-item-response"
            },
            "x-cardinality":"1"
        },
        "DateTypeForRevenueConversion":{
            "title":"Date Type for Revenue Conversion",
            "maxLength":255,
            "type":"string",
            "description":"Date type that is used as a revenue conversion attribute for planning currencies.",
            "nullable":true,
            "x-queryable":true
        },
        "RateDerivationDateType":{
            "title":"Rate Derivation Date Type",
            "maxLength":255,
            "type":"string",
            "description":"The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating amounts on a none time phase budget version.",
            "nullable":true,
            "x-queryable":true
        },
        "CostFixedDateForConversionInPLC":{
            "title":"Project Ledger Currency Conversion: Cost Fixed Date",
            "type":"string",
            "description":"The date that is used to derive rates for calculating planned costs for project ledger currency.",
            "format":"date-time",
            "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 project budget version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevenueFixedDateForConversionInPLC":{
            "title":"Project Ledger Currency Conversion: Revenue Fixed Date",
            "type":"string",
            "description":"The date that is used to derive rates for calculating planned revenue for project ledger currency.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectRoleRevenueOptions":{
            "title":"Project Role Revenue Options",
            "maxLength":255,
            "type":"string",
            "description":"Rate schedule used for the calculation of cost amounts for project role.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultReportingOption":{
            "title":"Default Reporting Option",
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether cost or revenue quantity is used for reporting quantity when planning for cost and revenue in a separate budget version. By default, it is set to Cost when planning amounts are cost only or cost and revenue together. When the planning amounts are revenue only, it is set to Revenue.",
            "nullable":true,
            "readOnly":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 is not 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/projectBudgets-PlanningOptions-PlanningCurrencies-item-response"
            }
        },
        "MultipleTransactionCurrencies":{
            "title":"Multiple Transaction Currencies",
            "maxLength":255,
            "type":"string",
            "description":"Indicates that the plan can use multiple transaction currencies. A value of Y indicates that the attribute is selected. A value of N means that the attribute is not selected.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodProfile":{
            "title":"Period Profile",
            "maxLength":255,
            "type":"string",
            "description":"Defines how time periods are grouped and displayed when editing budget 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
        },
        "RetainOverrideRatesFromSourceFlag":{
            "title":"Retain override rates from source",
            "type":"boolean",
            "description":"Indicates whether user specified cost and revenue rates from the source must be retained when generating the target budget version.",
            "nullable":true,
            "x-queryable":true
        },
        "DesignateAsApprovedRevenueBudgetFlag":{
            "title":"Designate as approved revenue budget",
            "type":"boolean",
            "description":"Indicates whether a financial plan type is an approved revenue budget.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningLevel":{
            "title":"Planning Level",
            "maxLength":255,
            "type":"string",
            "description":"Level of the budget at which amounts can be entered.",
            "nullable":true,
            "x-queryable":true
        },
        "RevenueDateTypeForConversionInPC":{
            "title":"Project Currency Conversion: Revenue Date Type",
            "maxLength":255,
            "type":"string",
            "description":"Date type that is used as a revenue conversion attribute for project currency.",
            "nullable":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 used for the calculation of revenue amounts for named persons.",
            "nullable":true,
            "x-queryable":true
        },
        "RateTypeForCostConversion":{
            "title":"Rate Type for Cost Conversion",
            "maxLength":255,
            "type":"string",
            "description":"Cost rate type that is 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 project budget versions.",
            "items":{
                "$ref":"#/components/schemas/projectBudgets-PlanningOptions-PlanningOptionsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "BurdenScheduleCostOptions":{
            "title":"Burden Schedule",
            "maxLength":255,
            "type":"string",
            "description":"A set of burden multipliers that is maintained for use across projects. Also referred to as a standard burden schedule.",
            "nullable":true,
            "x-queryable":true
        },
        "RevenueGenerationMethod":{
            "title":"Revenue Generation Method",
            "maxLength":255,
            "type":"string",
            "description":"Determines whether budget revenue is calculated based on quantity and rates, event amounts, or the spread ratio specified for tasks.",
            "nullable":true,
            "x-queryable":true
        },
        "BillRateDerivationDate":{
            "title":"Bill Rate Derivation Date",
            "type":"string",
            "description":"The date that is used as the basis for deriving rates for calculating revenue amounts.",
            "format":"date-time",
            "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
        },
        "BillRateDerivationDateType":{
            "title":"Bill Rate Derivation Date Type",
            "maxLength":255,
            "type":"string",
            "description":"The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating revenue amounts.",
            "nullable":true,
            "x-queryable":true
        },
        "CostFixedDateForConversionInPC":{
            "title":"Project Currency Conversion: Cost Fixed Date",
            "type":"string",
            "description":"The date that is used to derive rates for calculating planned costs for project currency.",
            "format":"date-time",
            "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
        },
        "CostDateTypeForConversionInPLC":{
            "title":"Project Ledger Currency Conversion: Cost Date Type",
            "maxLength":255,
            "type":"string",
            "description":"Date type that is used as a cost conversion attribute for project ledger currency.",
            "nullable":true,
            "x-queryable":true
        },
        "EnableBudgetaryControls":{
            "title":"Enable Budgetary Controls",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a financial plan type is eligible for integration with budgetary controls. A value of Y indicates that the attribute is selected. A value of N means that the attribute is not selected.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Amount Types

Type: array

Title: Amount Types

The Amount Type resource is used to select the cost and revenue items to include in a financial plan type.

Show Source

• Array of: object projectBudgets-PlanningOptions-AmountTypes-item-response

{
    "title":"Amount Types",
    "type":"array",
    "description":"The Amount Type resource is used to select the cost and revenue items to include in a financial plan type.",
    "items":{
        "$ref":"#/components/schemas/projectBudgets-PlanningOptions-AmountTypes-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Budgetary Control Settings

Type: array

Title: Budgetary Control Settings

The Budgetary Control Setting resource is used to view and update project and top resource control levels.

Show Source

• Array of: object projectBudgets-PlanningOptions-BudgetaryControlSettings-item-response

{
    "title":"Budgetary Control Settings",
    "type":"array",
    "description":"The Budgetary Control Setting resource is used to view and update project and top resource control levels.",
    "items":{
        "$ref":"#/components/schemas/projectBudgets-PlanningOptions-BudgetaryControlSettings-item-response"
    }
}

Nested Schema : Export Options

Type: array

Title: Export Options

The Export Option resource is used to select the planning options attributes to export.

Show Source

• Array of: object projectBudgets-PlanningOptions-ExportOptions-item-response

{
    "title":"Export Options",
    "type":"array",
    "description":"The Export Option resource is used to select the planning options attributes to export.",
    "items":{
        "$ref":"#/components/schemas/projectBudgets-PlanningOptions-ExportOptions-item-response"
    },
    "x-cardinality":"1"
}

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 projectBudgets-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/projectBudgets-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 project budget versions.

Show Source

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

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

Nested Schema : projectBudgets-PlanningOptions-AmountTypes-item-response

Type: object

Show Source

• AmountTypeId: integer (int64)
  Title: Amount Type ID

  Identifier of the project budget version amoun types.
• BillRateFlag: boolean
  Title: Bill rate

  Indicates whether the revenue rate is editable.
• BurdenedCostFlag: boolean
  Title: Burdened Cost

  Indicates whether the burdened cost amounts for a budget version are editable.
• BurdenedCostRateFlag: boolean
  Title: Burdened Cost Rate

  Indicates whether the burdened cost rate is editable.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QuantityFlag: boolean
  Title: Quantity

  Indicates whether the quantity for a budget version is editable.
• RawCostFlag: boolean
  Title: Raw Cost

  Indicates whether the raw cost amounts for a budget version are editable.
• RawCostRateFlag: boolean
  Title: Raw Cost Rate

  Indicates whether the raw cost rate is editable.
• RevenueFlag: boolean
  Title: Revenue

  Indicates whether the revenue for a budget version is editable.

{
    "type":"object",
    "properties":{
        "RawCostRateFlag":{
            "title":"Raw Cost Rate",
            "type":"boolean",
            "description":"Indicates whether the raw cost rate is editable.",
            "nullable":true,
            "x-queryable":true
        },
        "BurdenedCostRateFlag":{
            "title":"Burdened Cost Rate",
            "type":"boolean",
            "description":"Indicates whether the burdened cost rate is editable.",
            "nullable":true,
            "x-queryable":true
        },
        "BillRateFlag":{
            "title":"Bill rate",
            "type":"boolean",
            "description":"Indicates whether the revenue rate is editable.",
            "nullable":true,
            "x-queryable":true
        },
        "RawCostFlag":{
            "title":"Raw Cost",
            "type":"boolean",
            "description":"Indicates whether the raw cost amounts for a budget version are editable.",
            "nullable":true,
            "x-queryable":true
        },
        "RevenueFlag":{
            "title":"Revenue",
            "type":"boolean",
            "description":"Indicates whether the revenue for a budget version is editable.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "QuantityFlag":{
            "title":"Quantity",
            "type":"boolean",
            "description":"Indicates whether the quantity for a budget version is editable.",
            "nullable":true,
            "x-queryable":true
        },
        "BurdenedCostFlag":{
            "title":"Burdened Cost",
            "type":"boolean",
            "description":"Indicates whether the burdened cost amounts for a budget version are editable.",
            "nullable":true,
            "x-queryable":true
        },
        "AmountTypeId":{
            "title":"Amount Type ID",
            "type":"integer",
            "description":"Identifier of the project budget version amoun types.",
            "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 : 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 : projectBudgets-PlanningOptions-BudgetaryControlSettings-item-response

Type: object

Show Source

• BudgetaryControlSettingId: integer (int64)
  Title: Budgetary Control Setting ID

  Identifier of the budgetary control settings for the project budget.
• ControlBudget: string
  Title: Control Budget

  Maximum Length: 255

  Name of the control budget.
• ControlLevel: string
  Title: Control Level

  Maximum Length: 255

  The budgetary control level for the budget version.
• DefaultRateType: string
  Title: Default Rate Type

  Maximum Length: 255

  The default rate type for budgetary control for the budget version.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TolerancePercentage: number
  Title: Tolerance Percentage

  The budgetary control level tolerance percentage.

{
    "type":"object",
    "properties":{
        "BudgetaryControlSettingId":{
            "title":"Budgetary Control Setting ID",
            "type":"integer",
            "description":"Identifier of the budgetary control settings for the project budget.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ControlBudget":{
            "title":"Control Budget",
            "maxLength":255,
            "type":"string",
            "description":"Name of the control budget.",
            "nullable":true,
            "x-queryable":true
        },
        "ControlLevel":{
            "title":"Control Level",
            "maxLength":255,
            "type":"string",
            "description":"The budgetary control level for the budget version.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultRateType":{
            "title":"Default Rate Type",
            "maxLength":255,
            "type":"string",
            "description":"The default rate type for budgetary control for the budget version.",
            "nullable":true,
            "x-queryable":true
        },
        "TolerancePercentage":{
            "title":"Tolerance Percentage",
            "type":"number",
            "description":"The budgetary control level tolerance percentage.",
            "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 : projectBudgets-PlanningOptions-ExportOptions-item-response

Type: object

Show Source

• BurdenedCostEffectiveMultiplier: string
  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.
• BurdenedCostStandardMultiplier: string
  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.
• BurdenedCostStandardRate: string
  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.
• DisplayRatesAndAmountsInMultipleTransactionCurrenciesFlag: boolean
  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.
• EffectiveBurdenedCostRate: string
  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.
• EffectiveRawCostRate: string
  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.
• EffectiveRevenueRate: string
  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.
• ExportOptionId: integer
  Title: Export Options ID

  Read Only: true

  Identifier of the project budget version export options.
• FromDate: string
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• MarginPercentage: string
  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.
• PlanningCurrency: string
  Title: Planning Currency

  Currency used for planning in the budget line. This value is always set to true and the attribute is exported.
• PlanningResource: string
  Title: Planning Resource

  Resource used for financial planning in budgets. This value is always set to true and the attribute is exported.
• ProjectCurrencyConversionCostDate: string
  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.
• ProjectCurrencyConversionCostDateType: string
  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.
• ProjectCurrencyConversionCostRate: string
  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.
• ProjectCurrencyConversionCostRateType: string
  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.
• ProjectCurrencyConversionRevenueDate: string
  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.
• ProjectCurrencyConversionRevenueDateType: string
  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.
• ProjectCurrencyConversionRevenueRate: string
  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.
• ProjectCurrencyConversionRevenueRateType: string
  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.
• ProjectLedgerCurrencyConversionCostDate: string
  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.
• ProjectLedgerCurrencyConversionCostDateType: string
  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.
• ProjectLedgerCurrencyConversionCostRate: string
  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.
• ProjectLedgerCurrencyConversionCostRateType: string
  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.
• ProjectLedgerCurrencyConversionRevenueDate: string
  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.
• ProjectLedgerCurrencyConversionRevenueDateType: string
  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.
• ProjectLedgerCurrencyConversionRevenueRate: string
  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.
• ProjectLedgerCurrencyConversionRevenueRateType: string
  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.
• ResourceClass: string
  Title: Resource Class

  Resource class associated with the budget line. This value is always set to true and the attribute is exported.
• SpreadCurve: string
  Title: Spread Curve

  Spread curve associated with the budget line. This value is always set to true and the attribute is exported.
• StandardRawCostRate: string
  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.
• StandardRevenueRate: string
  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.
• TaskName: string
  Title: Task Name

  Name assigned to a task. This value is always set to true and the attribute is exported.
• TaskNumber: string
  Title: Task Number

  Number of the task. This value is always set to true and the attribute is exported.
• ToDate: string
  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.
• TotalBurdenedCost: string
  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.
• TotalBurdenedCostInProjectCurrency: string
  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.
• TotalBurdenedCostInProjectLedgerCurrency: string
  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.
• TotalMargin: string
  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.
• TotalMarginInProjectCurrency: string
  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.
• TotalMarginInProjectLedgerCurrency: string
  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.
• TotalQuantity: string
  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.
• TotalRawCost: string
  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.
• TotalRawCostInProjectCurrency: string
  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.
• TotalRawCostInProjectLedgerCurrency: string
  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.
• TotalRevenue: string
  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.
• TotalRevenueInProjectCurrency: string
  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.
• TotalRevenueInProjectLedgerCurrency: string
  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.
• UnitOfMeasure: string
  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.

{
    "type":"object",
    "properties":{
        "TotalRevenueInProjectCurrency":{
            "title":"Revenue in Project Currency: Total",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCurrencyConversionCostDate":{
            "title":"Project Currency Conversion: Cost Date",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ExportOptionId":{
            "title":"Export Options ID",
            "type":"integer",
            "description":"Identifier of the project budget version export options.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectCurrencyConversionCostRateType":{
            "title":"Project Currency Conversion: Cost Rate Type",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningResource":{
            "title":"Planning Resource",
            "type":"string",
            "description":"Resource used for financial planning in budgets. This value is always set to true and the attribute is exported.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectLedgerCurrencyConversionRevenueRate":{
            "title":"Project Ledger Currency Conversion: Revenue Rate",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BurdenedCostStandardMultiplier":{
            "title":"Burdened Cost: Standard Multiplier",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceClass":{
            "title":"Resource Class",
            "type":"string",
            "description":"Resource class associated with the budget line. This value is always set to true and the attribute is exported.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalRawCostInProjectCurrency":{
            "title":"Raw Cost in Project Currency: Total",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectLedgerCurrencyConversionRevenueDate":{
            "title":"Project Ledger Currency Conversion: Revenue Date",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCurrencyConversionRevenueDate":{
            "title":"Project Currency Conversion: Revenue Date",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCurrencyConversionRevenueDateType":{
            "title":"Project Currency Conversion: Revenue Date Type",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCurrencyConversionCostDateType":{
            "title":"Project Currency Conversion: Cost Date Type",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectLedgerCurrencyConversionRevenueDateType":{
            "title":"Project Ledger Currency Conversion: Revenue Date Type",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectLedgerCurrencyConversionCostRateType":{
            "title":"Project Ledger Currency Conversion: Cost Rate Type",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayRatesAndAmountsInMultipleTransactionCurrenciesFlag":{
            "title":"Display currency conversion attributes and amounts in multiple transaction currencies",
            "type":"boolean",
            "description":"Indicates whether to display the currency conversion attributes and amounts in multiple transaction currencies if the plan type allows planning in multiple transaction currencies.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectLedgerCurrencyConversionCostDateType":{
            "title":"Project Ledger Currency Conversion: Cost Date Type",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "StandardRawCostRate":{
            "title":"Raw Cost: Standard Rate",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskName":{
            "title":"Task Name",
            "type":"string",
            "description":"Name assigned to a task. This value is always set to true and the attribute is exported.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalRevenue":{
            "title":"Revenue: Total",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectLedgerCurrencyConversionCostDate":{
            "title":"Project Ledger Currency Conversion: Cost Date",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "StandardRevenueRate":{
            "title":"Revenue: Standard Rate",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalMarginInProjectCurrency":{
            "title":"Margin in Project Currency: Total",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalMargin":{
            "title":"Total Margin",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalRawCostInProjectLedgerCurrency":{
            "title":"Raw Cost in Project Ledger Currency: Total",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveRevenueRate":{
            "title":"Effective Revenue Rate",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SpreadCurve":{
            "title":"Spread Curve",
            "type":"string",
            "description":"Spread curve associated with the budget line. This value is always set to true and the attribute is exported.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalBurdenedCost":{
            "title":"Burdened Cost: Total",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "BurdenedCostStandardRate":{
            "title":"Burdened Cost: Standard Rate",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCurrencyConversionRevenueRateType":{
            "title":"Project Currency Conversion: Revenue Rate Type",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalRawCost":{
            "title":"Raw Cost: Total",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectLedgerCurrencyConversionRevenueRateType":{
            "title":"Project Ledger Currency Conversion: Revenue Rate Type",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCurrencyConversionRevenueRate":{
            "title":"Project Currency Conversion: Revenue Rate",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveRawCostRate":{
            "title":"Raw Cost: Effective Rate",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalQuantity":{
            "title":"Quantity: Total",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveBurdenedCostRate":{
            "title":"Burdened Cost: Effective Rate",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalMarginInProjectLedgerCurrency":{
            "title":"Margin in Project Ledger Currency: Total",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalBurdenedCostInProjectLedgerCurrency":{
            "title":"Burdened Cost in Project Ledger Currency: Total",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "type":"string",
            "description":"Number of the task. This value is always set to true and the attribute is exported.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCurrencyConversionCostRate":{
            "title":"Project Currency Conversion: Cost Rate",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "BurdenedCostEffectiveMultiplier":{
            "title":"Burdened Cost: Effective Multiplier",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCurrency":{
            "title":"Planning Currency",
            "type":"string",
            "description":"Currency used for planning in the budget line. This value is always set to true and the attribute is exported.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalRevenueInProjectLedgerCurrency":{
            "title":"Revenue in Project Ledger Currency: Total",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectLedgerCurrencyConversionCostRate":{
            "title":"Project Ledger Currency Conversion: Cost Rate",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "MarginPercentage":{
            "title":"Margin Percentage",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalBurdenedCostInProjectCurrency":{
            "title":"Burdened Cost in Project Currency: Total",
            "type":"string",
            "description":"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.",
            "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 : projectBudgets-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 : projectBudgets-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 project budget 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 project budget 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"
    }
}

Back to Top