Jump to

• Request
• Response

Create a Budget Planning Scenario

post

/api/restapi/budgetPlanningScenario

Send a request to this endpoint to create Budget Planning Scenario. An application object will be created using the JSON data provided in the request body.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityBudgetPlanningScenarioInput

Type: object

Title: ApiEntityBudgetPlanningScenarioInput

Show Source

• hidden: boolean
  Enables you to decide whether or not a scenario is hidden from other users.
• planPeriod(required): integer (int32)
  The period during which budget is allocated to projects within the plan.
  This value determines the year in which budget planning timescales start.
  You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021.
  After the planning period for a budget plan has been set it cannot be changed.
• planProjects: array planProjects
  The plan projects associated with a scenario.
• portfolioId(required): integer (int64)
  The system-generated identifier of the Capital Portfolio.
• portfolioName: string
  Maximum Length: 255

  The name of the portfolio.
• scenarioDescription: string
  Maximum Length: 4000

  The detailed summary for the plan.
  The description provides more information than short names or titles.
  It can give background information or establish a purpose for the item.
  These details help differentiate between items with similar names and are especially useful in multi-user environments.
• scenarioId: integer (int64)
  The system-generated identifier of the Budget Plan Scenario.
• scenarioName(required): string
  Maximum Length: 255

  The name of Budget Plan Scenario.
• scenarioStatus: string
  Allowed Values: [ "APPROVED", "UNDER_REVIEW", "IN_PLANNING", "UNDER_APPROVAL", "RETIRED", "SHARED", "PENDING_APPROVAL", "PENDING_SHARED", "PENDING_IN_PLANNING" ]

  The status of Budget Plan Scenario.
• targetBudgetCOR: number (double)
  The total Target Budget for the portfolio's Planning Horizon set by the portfolio manager. This is an input field, will not be a part of response.
• targetBudgetPeriods: array targetBudgetPeriods
  The phase costs of target budget.
• targetSubCurveDetails: array targetSubCurveDetails
  The target capital and expense cost details of a scenario.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityBudgetPlanningScenarioInput",
    "required":[
        "planPeriod",
        "portfolioId",
        "scenarioName"
    ],
    "type":"object",
    "properties":{
        "targetBudgetCOR":{
            "type":"number",
            "description":"The total Target Budget for the portfolio's Planning Horizon set by the portfolio manager. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "planProjects":{
            "type":"array",
            "description":"The plan projects associated with a scenario.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBudgetPlanProjectInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "targetBudgetPeriods":{
            "type":"array",
            "description":"The phase costs of target budget.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancialInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "targetSubCurveDetails":{
            "type":"array",
            "description":"The target capital and expense cost details of a scenario.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntitySubCostCurveInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "scenarioId":{
            "type":"integer",
            "description":"The system-generated identifier of the Budget Plan Scenario.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scenarioName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of Budget Plan Scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "planPeriod":{
            "type":"integer",
            "description":"The period during which budget is allocated to projects within the plan. <br />This value determines the year in which budget planning timescales start. <br />You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021. <br />After the planning period for a budget plan has been set it cannot be changed.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "portfolioName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioId":{
            "type":"integer",
            "description":"The system-generated identifier of the Capital Portfolio.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "hidden":{
            "type":"boolean",
            "description":"Enables you to decide whether or not a scenario is hidden from other users.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "scenarioStatus":{
            "type":"string",
            "description":"The status of Budget Plan Scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "APPROVED",
                "UNDER_REVIEW",
                "IN_PLANNING",
                "UNDER_APPROVAL",
                "RETIRED",
                "SHARED",
                "PENDING_APPROVAL",
                "PENDING_SHARED",
                "PENDING_IN_PLANNING"
            ]
        },
        "scenarioDescription":{
            "maxLength":"4000",
            "type":"string",
            "description":"The detailed summary for the plan. <br />The description provides more information than short names or titles. <br />It can give background information or establish a purpose for the item. <br />These details help differentiate between items with similar names and are especially useful in multi-user environments.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : planProjects

Type: array

The plan projects associated with a scenario.

Show Source

• Array of: object ApiEntityBudgetPlanProjectInput
  Title: ApiEntityBudgetPlanProjectInput

{
    "type":"array",
    "description":"The plan projects associated with a scenario.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityBudgetPlanProjectInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : targetBudgetPeriods

Type: array

The phase costs of target budget.

Show Source

• Array of: object ApiEntityScenarioPhaseFinancialInput
  Title: ApiEntityScenarioPhaseFinancialInput

{
    "type":"array",
    "description":"The phase costs of target budget.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancialInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : targetSubCurveDetails

Type: array

The target capital and expense cost details of a scenario.

Show Source

• Array of: object ApiEntitySubCostCurveInput
  Title: ApiEntitySubCostCurveInput

{
    "type":"array",
    "description":"The target capital and expense cost details of a scenario.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntitySubCostCurveInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityBudgetPlanProjectInput

Type: object

Title: ApiEntityBudgetPlanProjectInput

Show Source

• finishDate: string (date-time)
  The finish date of a plan project.
• linked: boolean
  The flag to link or unlink a project in a scenario.
• planProjectPeriods: array planProjectPeriods
  The period budgets associated with a plan project.
• planProjectSubCurveDetails: array planProjectSubCurveDetails
  The capital and expense cost details of a plan project.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier of a project.
• projectName: string
  Maximum Length: 255

  The name of a plan project associated with a scenario.
• startDate: string (date-time)
  The start date of a plan project.
• state: string
  Allowed Values: [ "SELECTED", "UNSELECTED", "FORCED_IN", "FORCED_OUT" ]

  The state of capital plan project.
• totalCOR: number (double)
  The total amount of budget for the project. This is an input field, will not be a part of response.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityBudgetPlanProjectInput",
    "type":"object",
    "properties":{
        "totalCOR":{
            "type":"number",
            "description":"The total amount of budget for the project. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "startDate":{
            "type":"string",
            "description":"The start date of a plan project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "finishDate":{
            "type":"string",
            "description":"The finish date of a plan project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "planProjectPeriods":{
            "type":"array",
            "description":"The period budgets associated with a plan project.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancialInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "planProjectSubCurveDetails":{
            "type":"array",
            "description":"The capital and expense cost details of a plan project.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntitySubCostCurveInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "state":{
            "type":"string",
            "description":"The state of capital plan project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "SELECTED",
                "UNSELECTED",
                "FORCED_IN",
                "FORCED_OUT"
            ]
        },
        "projectName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of  a plan project associated with a scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier of a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "linked":{
            "type":"boolean",
            "description":"The flag to link or unlink a project in a scenario.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : planProjectPeriods

Type: array

The period budgets associated with a plan project.

Show Source

• Array of: object ApiEntityScenarioPhaseFinancialInput
  Title: ApiEntityScenarioPhaseFinancialInput

{
    "type":"array",
    "description":"The period budgets associated with a plan project.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancialInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : planProjectSubCurveDetails

Type: array

The capital and expense cost details of a plan project.

Show Source

• Array of: object ApiEntitySubCostCurveInput
  Title: ApiEntitySubCostCurveInput

{
    "type":"array",
    "description":"The capital and expense cost details of a plan project.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntitySubCostCurveInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityScenarioPhaseFinancialInput

Type: object

Title: ApiEntityScenarioPhaseFinancialInput

Show Source

• month: integer (int32)
  The month of phase period of a target or proposed budget.
• phaseCostCOR: number (double)
  The amount of a target or proposed budget for a particular period. This is an input field, will not be a part of response.
• year: integer (int32)
  The year of phase period of a target or proposed budget.

{
    "title":"ApiEntityScenarioPhaseFinancialInput",
    "type":"object",
    "properties":{
        "year":{
            "type":"integer",
            "description":"The year of phase period of a target or proposed budget.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "month":{
            "type":"integer",
            "description":"The month of phase period of a target or proposed budget.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "phaseCostCOR":{
            "type":"number",
            "description":"The amount of a target or proposed budget for a particular period. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntitySubCostCurveInput

Type: object

Title: ApiEntitySubCostCurveInput

Show Source

• costCurvePeriods: array costCurvePeriods
  The phase wise costs of cost curve.
• costSubCurveType: string
  Allowed Values: [ "CAPITAL", "EXPENSE" ]

  The type of the cost curve.
• totalCOR: number (double)
  The total cost of the cost curve.

{
    "title":"ApiEntitySubCostCurveInput",
    "type":"object",
    "properties":{
        "costSubCurveType":{
            "type":"string",
            "description":"The type of the cost curve.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "CAPITAL",
                "EXPENSE"
            ]
        },
        "totalCOR":{
            "type":"number",
            "description":"The total cost of the cost curve.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costCurvePeriods":{
            "type":"array",
            "description":"The phase wise costs of cost curve.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancialInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : costCurvePeriods

Type: array

The phase wise costs of cost curve.

Show Source

• Array of: object ApiEntityScenarioPhaseFinancialInput
  Title: ApiEntityScenarioPhaseFinancialInput

{
    "type":"array",
    "description":"The phase wise costs of cost curve.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancialInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Examples

Select an example Create a Budget Planning Scenario

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : ApiEntityBudgetPlanningScenario

Type: object

Title: ApiEntityBudgetPlanningScenario

Show Source

• breakdownEnabled: boolean
  The setting to convey whether Capital and Expense is enabled for a portfolio.
• breakdownType: string
  Allowed Values: [ "CAPITAL", "EXPENSE" ]

  The sub-cost curve to which the existing portfolio cost data will be mapped.
• capitalPlanId: integer (int64)
  The system-generated identifier of the Capital Plan.
• capitalPlanStatus: string
  Allowed Values: [ "IN_PLANNING", "CLOSED", "APPROVED", "REVISING" ]

  The current budget status of a portfolio. The status is set based on the status of the scenarios and cannot be edited manually.
  In Planning: The portfolio is currently going through the budget planning process and contains one or more scenarios in planning. In planning is the default budget status.
  Revising: The portfolio currently has one scenario with a status of approved, and another with a status of Under Review, Shared, or Under Approval.
  Approved: The portfolio contains a scenario that has gone through the approval process and has been approved.
• createDate: string (date-time)
  The created date of the Budget Plan Scenario .
• createdBy: string
  Maximum Length: 255

  The scenario created username.
• hidden: boolean
  Enables you to decide whether or not a scenario is hidden from other users.
• lastRefreshDate: string (date-time)
  The date a refresh was last performed on the portfolio budget plan scenario.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• owner: string
  Maximum Length: 255

  The owner of Budget Plan Scenario.
• planPeriod: integer (int32)
  The period during which budget is allocated to projects within the plan.
  This value determines the year in which budget planning timescales start.
  You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021.
  After the planning period for a budget plan has been set it cannot be changed.
• planProjectLinkType: string
  Allowed Values: [ "FORECAST", "PLANNED_BUDGET" ]

  Determines if linked projects in the portfolio budget plan link to project Forecast or Planned Budget.
  Linked values will be factored into a budget plan's Proposed Budget.
  Planners can easily see the value differences between the project manager's budgets for the plan's included projects and their own budgetary plans.
  Any budget plan added to a portfolio will inherit the value of its Proposed Budget Link Setting by default.
• planProjects: array planProjects
  The plan projects associated with a scenario.
• portfolioId: integer (int64)
  The system-generated identifier of the Capital Portfolio.
• portfolioName: string
  Maximum Length: 255

  The name of the portfolio.
• projectCount: integer (int32)
  The total number of projects included in a portfolio budget plan.
• proposedBudget: number (double)
  The total Proposed Budget for the portfolio as allocated by the budget planner.
  Planners can plan proposed budgets in a bottom-up or top-down style.
  Not all projects in the portfolio need to have Planned Budgets for planners to begin planning and setting proposed budget values.
  Instead, by setting an overall plan Proposed Budget and allocating out its funds to included projects, planners can achieve top-down budget planning.
  Similarly, project Planned Budgets and Forecast values can be linked to the Proposed Budget of a budget plan, allowing planners to establish project manager's budgets as a basis for their planning.
  Becomes the portfolio's Current Approved Budget after the budget scenario is approved.
• proposedBudgetDistributed: number (double)
  The amount of proposed budget currently allocated to projects included in the portfolio's budget plan.
• proposedBudgetDistributedWorkspace1: number (double)
  The amount of proposed budget currently allocated to projects included in the portfolio's budget plan. This value is based on the workspace1 currency.
• proposedBudgetDistributedWorkspace2: number (double)
  The amount of proposed budget currently allocated to projects included in the portfolio's budget plan. This value is based on the workspace2 currency.
• proposedBudgetDistributedWorkspace3: number (double)
  The amount of proposed budget currently allocated to projects included in the portfolio's budget plan. This value is based on the workspace3 currency.
• proposedBudgetFinish: string (date-time)
  The finish date of proposed budget.
• proposedBudgetPeriods: array proposedBudgetPeriods
  The phase costs of proposed budget.
• proposedBudgetStart: string (date-time)
  The start date of proposed budget.
• proposedBudgetUnDistributed: number (double)
  The amount of a proposed budget unallocated to projects included in the portfolio's budget plan.
• proposedBudgetUnDistributedWorkspace1: number (double)
  The amount of a proposed budget unallocated to projects included in the portfolio's budget plan. This value is based on the workspace1 currency.
• proposedBudgetUnDistributedWorkspace2: number (double)
  The amount of a proposed budget unallocated to projects included in the portfolio's budget plan. This value is based on the workspace2 currency.
• proposedBudgetUnDistributedWorkspace3: number (double)
  The amount of a proposed budget unallocated to projects included in the portfolio's budget plan. This value is based on the workspace3 currency.
• proposedBudgetWorkspace1: number (double)
  The total Proposed Budget for the portfolio as allocated by the budget planner.
  Planners can plan proposed budgets in a bottom-up or top-down style.
  Not all projects in the portfolio need to have Planned Budgets for planners to begin planning and setting proposed budget values.
  Instead, by setting an overall plan Proposed Budget and allocating out its funds to included projects, planners can achieve top-down budget planning.
  Similarly, project Planned Budgets and Forecast values can be linked to the Proposed Budget of a budget plan, allowing planners to establish project manager's budgets as a basis for their planning.
  Becomes the portfolio's Current Approved Budget after the budget scenario is approved. This value is based on the workspace1 currency.
• proposedBudgetWorkspace2: number (double)
  The total Proposed Budget for the portfolio as allocated by the budget planner.
  Planners can plan proposed budgets in a bottom-up or top-down style.
  Not all projects in the portfolio need to have Planned Budgets for planners to begin planning and setting proposed budget values.
  Instead, by setting an overall plan Proposed Budget and allocating out its funds to included projects, planners can achieve top-down budget planning.
  Similarly, project Planned Budgets and Forecast values can be linked to the Proposed Budget of a budget plan, allowing planners to establish project manager's budgets as a basis for their planning.
  Becomes the portfolio's Current Approved Budget after the budget scenario is approved. This value is based on the workspace2 currency.
• proposedBudgetWorkspace3: number (double)
  The total Proposed Budget for the portfolio as allocated by the budget planner.
  Planners can plan proposed budgets in a bottom-up or top-down style.
  Not all projects in the portfolio need to have Planned Budgets for planners to begin planning and setting proposed budget values.
  Instead, by setting an overall plan Proposed Budget and allocating out its funds to included projects, planners can achieve top-down budget planning.
  Similarly, project Planned Budgets and Forecast values can be linked to the Proposed Budget of a budget plan, allowing planners to establish project manager's budgets as a basis for their planning.
  Becomes the portfolio's Current Approved Budget after the budget scenario is approved. This value is based on the workspace3 currency.
• proposedSubCurveDetails: array proposedSubCurveDetails
  The proposed capital and expense cost details of a scenario.
• scenarioDescription: string
  Maximum Length: 4000

  The detailed summary for the plan.
  The description provides more information than short names or titles.
  It can give background information or establish a purpose for the item.
  These details help differentiate between items with similar names and are especially useful in multi-user environments.
• scenarioId: integer (int64)
  The system-generated identifier of the Budget Plan Scenario.
• scenarioName: string
  Maximum Length: 255

  The name of Budget Plan Scenario.
• scenarioStatus: string
  Allowed Values: [ "APPROVED", "UNDER_REVIEW", "IN_PLANNING", "UNDER_APPROVAL", "RETIRED", "SHARED", "PENDING_APPROVAL", "PENDING_SHARED", "PENDING_IN_PLANNING" ]

  The status of Budget Plan Scenario.
• targetBudget: number (double)
  The total Target Budget for the portfolio's Planning Horizon set by the portfolio manager based on base currency.
• targetBudgetDistributed: number (double)
  The amount of target budget currently allocated to projects included in the portfolio's budget plan.
• targetBudgetDistributedWorkspace1: number (double)
  The amount of target budget currently allocated to projects included in the portfolio's budget plan. This value is based on the workspace1 currency.
• targetBudgetDistributedWorkspace2: number (double)
  The amount of target budget currently allocated to projects included in the portfolio's budget plan. This value is based on the workspace2 currency.
• targetBudgetDistributedWorkspace3: number (double)
  The amount of target budget currently allocated to projects included in the portfolio's budget plan. This value is based on the workspace3 currency.
• targetBudgetPeriods: array targetBudgetPeriods
  The phase costs of target budget.
• targetBudgetUnDistributed: number (double)
  The amount of target budget unallocated to projects included in the portfolio's budget plan.
• targetBudgetUnDistributedWorkspace1: number (double)
  The amount of target budget unallocated to projects included in the portfolio's budget plan. This value is based on the workspace1 currency.
• targetBudgetUnDistributedWorkspace2: number (double)
  The amount of target budget unallocated to projects included in the portfolio's budget plan. This value is based on the workspace2 currency.
• targetBudgetUnDistributedWorkspace3: number (double)
  The amount of target budget unallocated to projects included in the portfolio's budget plan. This value is based on the workspace3 currency.
• targetBudgetWorkspace1: number (double)
  The total Target Budget for the portfolio's Planning Horizon set by the portfolio manager based on the workspace currency. This value is based on the workspace1 currency.
• targetBudgetWorkspace2: number (double)
  The total Target Budget for the portfolio's Planning Horizon set by the portfolio manager based on the workspace currency. This value is based on the workspace2 currency.
• targetBudgetWorkspace3: number (double)
  The total Target Budget for the portfolio's Planning Horizon set by the portfolio manager based on the workspace currency. This value is based on the workspace3 currency.
• targetSubCurveDetails: array targetSubCurveDetails
  The target capital and expense cost details of a scenario.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityBudgetPlanningScenario",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "targetBudgetWorkspace2":{
            "type":"number",
            "description":"The total Target Budget for the portfolio's Planning Horizon set by the portfolio manager based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "targetBudgetWorkspace3":{
            "type":"number",
            "description":"The total Target Budget for the portfolio's Planning Horizon set by the portfolio manager based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "targetBudgetDistributed":{
            "type":"number",
            "description":"The amount of target budget currently allocated to projects included in the portfolio's budget plan.",
            "format":"double",
            "exampleSetFlag":false
        },
        "targetBudgetUnDistributed":{
            "type":"number",
            "description":"The amount of target budget unallocated to projects included in the portfolio's budget plan.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedBudget":{
            "type":"number",
            "description":"The total Proposed Budget for the portfolio as allocated by the budget planner. <br />Planners can plan proposed budgets in a bottom-up or top-down style. <br />Not all projects in the portfolio need to have Planned Budgets for planners to begin planning and setting proposed budget values. <br />Instead, by setting an overall plan Proposed Budget and allocating out its funds to included projects, planners can achieve top-down budget planning. <br />Similarly, project Planned Budgets and Forecast values can be linked to the Proposed Budget of a budget plan, allowing planners to establish project manager's budgets as a basis for their planning. <br />Becomes the portfolio's Current Approved Budget after the budget scenario is approved.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedBudgetDistributed":{
            "type":"number",
            "description":"The amount of proposed budget currently allocated to projects included in the portfolio's budget plan.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedBudgetUnDistributed":{
            "type":"number",
            "description":"The amount of a proposed budget unallocated to projects included in the portfolio's budget plan.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedBudgetStart":{
            "type":"string",
            "description":"The start date of proposed budget.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "proposedBudgetFinish":{
            "type":"string",
            "description":"The finish date of proposed budget.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "planProjects":{
            "type":"array",
            "description":"The plan projects associated with a scenario.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBudgetPlanProject",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "proposedBudgetPeriods":{
            "type":"array",
            "description":"The phase costs of proposed budget.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "targetBudgetPeriods":{
            "type":"array",
            "description":"The phase costs of target budget.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "proposedSubCurveDetails":{
            "type":"array",
            "description":"The proposed capital and expense cost details of a scenario.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntitySubCostCurve",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "targetSubCurveDetails":{
            "type":"array",
            "description":"The target capital and expense cost details of a scenario.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntitySubCostCurve",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "targetBudgetDistributedWorkspace1":{
            "type":"number",
            "description":"The amount of target budget currently allocated to projects included in the portfolio's budget plan. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "targetBudget":{
            "type":"number",
            "description":"The total Target Budget for the portfolio's Planning Horizon set by the portfolio manager based on base currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "targetBudgetWorkspace1":{
            "type":"number",
            "description":"The total Target Budget for the portfolio's Planning Horizon set by the portfolio manager based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "targetBudgetDistributedWorkspace2":{
            "type":"number",
            "description":"The amount of target budget currently allocated to projects included in the portfolio's budget plan. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "targetBudgetDistributedWorkspace3":{
            "type":"number",
            "description":"The amount of target budget currently allocated to projects included in the portfolio's budget plan. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "targetBudgetUnDistributedWorkspace1":{
            "type":"number",
            "description":"The amount of target budget unallocated to projects included in the portfolio's budget plan. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "targetBudgetUnDistributedWorkspace2":{
            "type":"number",
            "description":"The amount of target budget unallocated to projects included in the portfolio's budget plan. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "targetBudgetUnDistributedWorkspace3":{
            "type":"number",
            "description":"The amount of target budget unallocated to projects included in the portfolio's budget plan. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedBudgetWorkspace1":{
            "type":"number",
            "description":"The total Proposed Budget for the portfolio as allocated by the budget planner. <br />Planners can plan proposed budgets in a bottom-up or top-down style. <br />Not all projects in the portfolio need to have Planned Budgets for planners to begin planning and setting proposed budget values. <br />Instead, by setting an overall plan Proposed Budget and allocating out its funds to included projects, planners can achieve top-down budget planning. <br />Similarly, project Planned Budgets and Forecast values can be linked to the Proposed Budget of a budget plan, allowing planners to establish project manager's budgets as a basis for their planning. <br />Becomes the portfolio's Current Approved Budget after the budget scenario is approved. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedBudgetWorkspace2":{
            "type":"number",
            "description":"The total Proposed Budget for the portfolio as allocated by the budget planner. <br />Planners can plan proposed budgets in a bottom-up or top-down style. <br />Not all projects in the portfolio need to have Planned Budgets for planners to begin planning and setting proposed budget values. <br />Instead, by setting an overall plan Proposed Budget and allocating out its funds to included projects, planners can achieve top-down budget planning. <br />Similarly, project Planned Budgets and Forecast values can be linked to the Proposed Budget of a budget plan, allowing planners to establish project manager's budgets as a basis for their planning. <br />Becomes the portfolio's Current Approved Budget after the budget scenario is approved. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedBudgetWorkspace3":{
            "type":"number",
            "description":"The total Proposed Budget for the portfolio as allocated by the budget planner. <br />Planners can plan proposed budgets in a bottom-up or top-down style. <br />Not all projects in the portfolio need to have Planned Budgets for planners to begin planning and setting proposed budget values. <br />Instead, by setting an overall plan Proposed Budget and allocating out its funds to included projects, planners can achieve top-down budget planning. <br />Similarly, project Planned Budgets and Forecast values can be linked to the Proposed Budget of a budget plan, allowing planners to establish project manager's budgets as a basis for their planning. <br />Becomes the portfolio's Current Approved Budget after the budget scenario is approved. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedBudgetDistributedWorkspace1":{
            "type":"number",
            "description":"The amount of proposed budget currently allocated to projects included in the portfolio's budget plan. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedBudgetDistributedWorkspace2":{
            "type":"number",
            "description":"The amount of proposed budget currently allocated to projects included in the portfolio's budget plan. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedBudgetDistributedWorkspace3":{
            "type":"number",
            "description":"The amount of proposed budget currently allocated to projects included in the portfolio's budget plan. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedBudgetUnDistributedWorkspace1":{
            "type":"number",
            "description":"The amount of a proposed budget unallocated to projects included in the portfolio's budget plan. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedBudgetUnDistributedWorkspace2":{
            "type":"number",
            "description":"The amount of a proposed budget unallocated to projects included in the portfolio's budget plan. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedBudgetUnDistributedWorkspace3":{
            "type":"number",
            "description":"The amount of a proposed budget unallocated to projects included in the portfolio's budget plan. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "scenarioId":{
            "type":"integer",
            "description":"The system-generated identifier of the Budget Plan Scenario.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scenarioName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of Budget Plan Scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "planPeriod":{
            "type":"integer",
            "description":"The period during which budget is allocated to projects within the plan. <br />This value determines the year in which budget planning timescales start. <br />You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021. <br />After the planning period for a budget plan has been set it cannot be changed.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "portfolioName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioId":{
            "type":"integer",
            "description":"The system-generated identifier of the Capital Portfolio.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "owner":{
            "maxLength":"255",
            "type":"string",
            "description":"The owner of Budget Plan Scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "hidden":{
            "type":"boolean",
            "description":"Enables you to decide whether or not a scenario is hidden from other users.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "createDate":{
            "type":"string",
            "description":"The created date of the Budget Plan Scenario .",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "scenarioStatus":{
            "type":"string",
            "description":"The status of Budget Plan Scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "APPROVED",
                "UNDER_REVIEW",
                "IN_PLANNING",
                "UNDER_APPROVAL",
                "RETIRED",
                "SHARED",
                "PENDING_APPROVAL",
                "PENDING_SHARED",
                "PENDING_IN_PLANNING"
            ]
        },
        "capitalPlanId":{
            "type":"integer",
            "description":"The system-generated identifier of the Capital Plan.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "capitalPlanStatus":{
            "type":"string",
            "description":"The current budget status of a portfolio. The status is set based on the status of the scenarios and cannot be edited manually. <br />In Planning: The portfolio is currently going through the budget planning process and contains one or more scenarios in planning. In planning is the default budget status. <br />Revising: The portfolio currently has one scenario with a status of approved, and another with a status of Under Review, Shared, or Under Approval. <br />Approved: The portfolio contains a scenario that has gone through the approval process and has been approved.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "IN_PLANNING",
                "CLOSED",
                "APPROVED",
                "REVISING"
            ]
        },
        "planProjectLinkType":{
            "type":"string",
            "description":"Determines if linked projects in the portfolio budget plan link to project Forecast or Planned Budget. <br />Linked values will be factored into a budget plan's Proposed Budget. <br />Planners can easily see the value differences between the project manager's budgets for the plan's included projects and their own budgetary plans. <br />Any budget plan added to a portfolio will inherit the value of its Proposed Budget Link Setting by default.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "FORECAST",
                "PLANNED_BUDGET"
            ]
        },
        "scenarioDescription":{
            "maxLength":"4000",
            "type":"string",
            "description":"The detailed summary for the plan. <br />The description provides more information than short names or titles. <br />It can give background information or establish a purpose for the item. <br />These details help differentiate between items with similar names and are especially useful in multi-user environments.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCount":{
            "type":"integer",
            "description":"The total number of projects included in a portfolio budget plan.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "createdBy":{
            "maxLength":"255",
            "type":"string",
            "description":"The scenario created username.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "lastRefreshDate":{
            "type":"string",
            "description":"The date a refresh was last performed on the portfolio budget plan scenario.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "breakdownEnabled":{
            "type":"boolean",
            "description":"The setting to convey whether Capital and Expense is enabled for a portfolio.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "breakdownType":{
            "type":"string",
            "description":"The sub-cost curve to which the existing portfolio cost data will be mapped.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "CAPITAL",
                "EXPENSE"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : planProjects

Type: array

The plan projects associated with a scenario.

Show Source

• Array of: object ApiEntityBudgetPlanProject
  Title: ApiEntityBudgetPlanProject

{
    "type":"array",
    "description":"The plan projects associated with a scenario.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityBudgetPlanProject",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : proposedBudgetPeriods

Type: array

The phase costs of proposed budget.

Show Source

• Array of: object ApiEntityScenarioPhaseFinancial
  Title: ApiEntityScenarioPhaseFinancial

{
    "type":"array",
    "description":"The phase costs of proposed budget.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : proposedSubCurveDetails

Type: array

The proposed capital and expense cost details of a scenario.

Show Source

• Array of: object ApiEntitySubCostCurve
  Title: ApiEntitySubCostCurve

{
    "type":"array",
    "description":"The proposed capital and expense cost details of a scenario.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntitySubCostCurve",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : targetBudgetPeriods

Type: array

The phase costs of target budget.

Show Source

• Array of: object ApiEntityScenarioPhaseFinancial
  Title: ApiEntityScenarioPhaseFinancial

{
    "type":"array",
    "description":"The phase costs of target budget.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : targetSubCurveDetails

Type: array

The target capital and expense cost details of a scenario.

Show Source

• Array of: object ApiEntitySubCostCurve
  Title: ApiEntitySubCostCurve

{
    "type":"array",
    "description":"The target capital and expense cost details of a scenario.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntitySubCostCurve",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityBudgetPlanProject

Type: object

Title: ApiEntityBudgetPlanProject

Show Source

• costCurves: array costCurves
  The phase costs associated with a plan project.
• description: string
  Maximum Length: 4000

  The description of a plan project.
• distributed: number (double)
  The amount of budget currently allocated across the project timescale.
• distributedWorkspace1: number (double)
  The amount of budget currently allocated across the project timescale based on the workspace currency. This value is based on the workspace1 currency.
• distributedWorkspace2: number (double)
  The amount of budget currently allocated across the project timescale based on the workspace currency. This value is based on the workspace2 currency.
• distributedWorkspace3: number (double)
  The amount of budget currently allocated across the project timescale based on the workspace currency. This value is based on the workspace3 currency.
• finishDate: string (date-time)
  The finish date of a plan project.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• linked: boolean
  The flag to link or unlink a project in a scenario.
• planProjectPeriods: array planProjectPeriods
  The period budgets associated with a plan project.
• planProjectSubCurveDetails: array planProjectSubCurveDetails
  The capital and expense cost details of a plan project.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier of a project.
• projectName: string
  Maximum Length: 255

  The name of a plan project associated with a scenario.
• projectStatus: string
  Allowed Values: [ "PENDING", "ACCEPTED", "CHANGES_REQUESTED" ]

  The budget review status of a plan project associated with a scenario.
• startDate: string (date-time)
  The start date of a plan project.
• state: string
  Allowed Values: [ "SELECTED", "UNSELECTED", "FORCED_IN", "FORCED_OUT" ]

  The state of capital plan project.
• total: number (double)
  The total amount of budget for the project based on base currency.
• totalWorkspace1: number (double)
  The total amount of budget for the project based on the workspace currency. This value is based on the workspace1 currency.
• totalWorkspace2: number (double)
  The total amount of budget for the project based on the workspace currency. This value is based on the workspace2 currency.
• totalWorkspace3: number (double)
  The total amount of budget for the project based on the workspace currency. This value is based on the workspace3 currency.
• undistributed: number (double)
  The amount of budget currently unallocated across the project timescale.
• undistributedWorkspace1: number (double)
  The amount of budget currently unallocated across the project timescale based on the workspace currency. This value is based on the workspace1 currency.
• undistributedWorkspace2: number (double)
  The amount of budget currently unallocated across the project timescale based on the workspace currency. This value is based on the workspace2 currency.
• undistributedWorkspace3: number (double)
  The amount of budget currently unallocated across the project timescale based on the workspace currency. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityBudgetPlanProject",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "startDate":{
            "type":"string",
            "description":"The start date of a plan project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "finishDate":{
            "type":"string",
            "description":"The finish date of a plan project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "undistributed":{
            "type":"number",
            "description":"The amount of budget currently unallocated across the project timescale.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributed":{
            "type":"number",
            "description":"The amount of budget currently allocated across the project timescale.",
            "format":"double",
            "exampleSetFlag":false
        },
        "total":{
            "type":"number",
            "description":"The total amount of budget for the project based on base currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "planProjectPeriods":{
            "type":"array",
            "description":"The period budgets associated with a plan project.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "costCurves":{
            "type":"array",
            "description":"The phase costs associated with a plan project.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCostCurve",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "planProjectSubCurveDetails":{
            "type":"array",
            "description":"The capital and expense cost details of a plan project.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntitySubCostCurve",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "undistributedWorkspace1":{
            "type":"number",
            "description":"The amount of budget currently unallocated across the project timescale based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedWorkspace2":{
            "type":"number",
            "description":"The amount of budget currently unallocated across the project timescale based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedWorkspace3":{
            "type":"number",
            "description":"The amount of budget currently unallocated across the project timescale based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedWorkspace1":{
            "type":"number",
            "description":"The amount of budget currently allocated across the project timescale based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedWorkspace2":{
            "type":"number",
            "description":"The amount of budget currently allocated across the project timescale based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedWorkspace3":{
            "type":"number",
            "description":"The amount of budget currently allocated across the project timescale based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace1":{
            "type":"number",
            "description":"The total amount of budget for the project based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace2":{
            "type":"number",
            "description":"The total amount of budget for the project based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace3":{
            "type":"number",
            "description":"The total amount of budget for the project based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "state":{
            "type":"string",
            "description":"The state of capital plan project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "SELECTED",
                "UNSELECTED",
                "FORCED_IN",
                "FORCED_OUT"
            ]
        },
        "description":{
            "maxLength":"4000",
            "type":"string",
            "description":"The description of a plan project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of  a plan project associated with a scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier of a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectStatus":{
            "type":"string",
            "description":"The budget review status of a plan project associated with a scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PENDING",
                "ACCEPTED",
                "CHANGES_REQUESTED"
            ]
        },
        "linked":{
            "type":"boolean",
            "description":"The flag to link or unlink a project in a scenario.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : costCurves

Type: array

The phase costs associated with a plan project.

Show Source

• Array of: object ApiEntityCostCurve
  Title: ApiEntityCostCurve

{
    "type":"array",
    "description":"The phase costs associated with a plan project.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCostCurve",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : planProjectPeriods

Type: array

The period budgets associated with a plan project.

Show Source

• Array of: object ApiEntityScenarioPhaseFinancial
  Title: ApiEntityScenarioPhaseFinancial

{
    "type":"array",
    "description":"The period budgets associated with a plan project.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : planProjectSubCurveDetails

Type: array

The capital and expense cost details of a plan project.

Show Source

• Array of: object ApiEntitySubCostCurve
  Title: ApiEntitySubCostCurve

{
    "type":"array",
    "description":"The capital and expense cost details of a plan project.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntitySubCostCurve",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCostCurve

Type: object

Title: ApiEntityCostCurve

Show Source

• costCurvePeriods: array costCurvePeriods
  The phase wise costs of cost curve.
• costCurveType: string
  Maximum Length: 255

  The type of the cost curve.
• distributed: number (double)
  The distributed cost of the cost curve.
• distributedWorkspace1: number (double)
  The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace1 currency.
• distributedWorkspace2: number (double)
  The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace2 currency.
• distributedWorkspace3: number (double)
  The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace3 currency.
• finishDate: string (date-time)
  The finish date of the cost curve.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• startDate: string (date-time)
  The start date of the cost curve.
• total: number (double)
  The total cost of the cost curve based on base currency.
• totalWorkspace1: number (double)
  The total cost of the cost curve based on the workspace currency. This value is based on the workspace1 currency.
• totalWorkspace2: number (double)
  The total cost of the cost curve based on the workspace currency. This value is based on the workspace2 currency.
• totalWorkspace3: number (double)
  The total cost of the cost curve based on the workspace currency. This value is based on the workspace3 currency.
• undistributed: number (double)
  The undistributed cost of the cost curve.
• undistributedWorkspace1: number (double)
  The undistributed cost of the cost curve. This value is based on the workspace1 currency.
• undistributedWorkspace2: number (double)
  The undistributed cost of the cost curve. This value is based on the workspace2 currency.
• undistributedWorkspace3: number (double)
  The undistributed cost of the cost curve. This value is based on the workspace2 currency.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityCostCurve",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "startDate":{
            "type":"string",
            "description":"The start date of the cost curve.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "finishDate":{
            "type":"string",
            "description":"The finish date of the cost curve.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "undistributed":{
            "type":"number",
            "description":"The undistributed cost of the cost curve.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributed":{
            "type":"number",
            "description":"The distributed cost of the cost curve.",
            "format":"double",
            "exampleSetFlag":false
        },
        "total":{
            "type":"number",
            "description":"The total cost of the cost curve based on base currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedWorkspace1":{
            "type":"number",
            "description":"The undistributed cost of the cost curve. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedWorkspace2":{
            "type":"number",
            "description":"The undistributed cost of the cost curve. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedWorkspace3":{
            "type":"number",
            "description":"The undistributed cost of the cost curve. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedWorkspace1":{
            "type":"number",
            "description":"The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedWorkspace2":{
            "type":"number",
            "description":"The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedWorkspace3":{
            "type":"number",
            "description":"The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace1":{
            "type":"number",
            "description":"The total cost of the cost curve based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace2":{
            "type":"number",
            "description":"The total cost of the cost curve based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace3":{
            "type":"number",
            "description":"The total cost of the cost curve based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costCurveType":{
            "maxLength":"255",
            "type":"string",
            "description":"The type of the cost curve.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costCurvePeriods":{
            "type":"array",
            "description":"The phase wise costs of cost curve.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : costCurvePeriods

Type: array

The phase wise costs of cost curve.

Show Source

• Array of: object ApiEntityScenarioPhaseFinancial
  Title: ApiEntityScenarioPhaseFinancial

{
    "type":"array",
    "description":"The phase wise costs of cost curve.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityScenarioPhaseFinancial

Type: object

Title: ApiEntityScenarioPhaseFinancial

Show Source

• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• month: integer (int32)
  The month of phase period of a target or proposed budget.
• phaseCost: number (double)
  The amount of a target or proposed budget for a particular period based on base currency.
• phaseCostWorkspace1: number (double)
  The amount of a target or proposed budget for a particular period based on the workspace currency. This value is based on the workspace1 currency.
• phaseCostWorkspace2: number (double)
  The amount of a target or proposed budget for a particular period based on the workspace currency. This value is based on the workspace2 currency.
• phaseCostWorkspace3: number (double)
  The amount of a target or proposed budget for a particular period based on the workspace currency. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Date when the record was last updated.
• year: integer (int32)
  The year of phase period of a target or proposed budget.

{
    "title":"ApiEntityScenarioPhaseFinancial",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "year":{
            "type":"integer",
            "description":"The year of phase period of a target or proposed budget.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "month":{
            "type":"integer",
            "description":"The month of phase period of a target or proposed budget.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "phaseCost":{
            "type":"number",
            "description":"The amount of a target or proposed budget for a particular period based on base currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "phaseCostWorkspace1":{
            "type":"number",
            "description":"The amount of a target or proposed budget for a particular period based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "phaseCostWorkspace2":{
            "type":"number",
            "description":"The amount of a target or proposed budget for a particular period based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "phaseCostWorkspace3":{
            "type":"number",
            "description":"The amount of a target or proposed budget for a particular period based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntitySubCostCurve

Type: object

Title: ApiEntitySubCostCurve

Show Source

• costCurvePeriods: array costCurvePeriods
  The phase wise costs of cost curve.
• costSubCurveType: string
  Allowed Values: [ "CAPITAL", "EXPENSE" ]

  The type of the cost curve.
• distributed: number (double)
  The distributed cost of the cost curve.
• distributedWorkspace1: number (double)
  The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace1 currency.
• distributedWorkspace2: number (double)
  The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace2 currency.
• distributedWorkspace3: number (double)
  The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace3 currency.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• total: number (double)
  The total cost of the cost curve based on base currency.
• totalWorkspace1: number (double)
  The total cost of the cost curve based on the workspace currency. This value is based on the workspace1 currency.
• totalWorkspace2: number (double)
  The total cost of the cost curve based on the workspace currency. This value is based on the workspace2 currency.
• totalWorkspace3: number (double)
  The total cost of the cost curve based on the workspace currency. This value is based on the workspace3 currency.
• undistributed: number (double)
  The undistributed cost of the cost curve.
• undistributedWorkspace1: number (double)
  The undistributed cost of the cost curve. This value is based on the workspace1 currency.
• undistributedWorkspace2: number (double)
  The undistributed cost of the cost curve. This value is based on the workspace2 currency.
• undistributedWorkspace3: number (double)
  The undistributed cost of the cost curve. This value is based on the workspace2 currency.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntitySubCostCurve",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costSubCurveType":{
            "type":"string",
            "description":"The type of the cost curve.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "CAPITAL",
                "EXPENSE"
            ]
        },
        "undistributed":{
            "type":"number",
            "description":"The undistributed cost of the cost curve.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributed":{
            "type":"number",
            "description":"The distributed cost of the cost curve.",
            "format":"double",
            "exampleSetFlag":false
        },
        "total":{
            "type":"number",
            "description":"The total cost of the cost curve based on base currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedWorkspace1":{
            "type":"number",
            "description":"The undistributed cost of the cost curve. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedWorkspace2":{
            "type":"number",
            "description":"The undistributed cost of the cost curve. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedWorkspace3":{
            "type":"number",
            "description":"The undistributed cost of the cost curve. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedWorkspace1":{
            "type":"number",
            "description":"The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedWorkspace2":{
            "type":"number",
            "description":"The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedWorkspace3":{
            "type":"number",
            "description":"The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace1":{
            "type":"number",
            "description":"The total cost of the cost curve based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace2":{
            "type":"number",
            "description":"The total cost of the cost curve based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace3":{
            "type":"number",
            "description":"The total cost of the cost curve based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costCurvePeriods":{
            "type":"array",
            "description":"The phase wise costs of cost curve.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : costCurvePeriods

Type: array

The phase wise costs of cost curve.

Show Source

• Array of: object ApiEntityScenarioPhaseFinancial
  Title: ApiEntityScenarioPhaseFinancial

{
    "type":"array",
    "description":"The phase wise costs of cost curve.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

400 Response

Invalid input for the Budget Planning Scenario service. Verify the request contains valid data, then resubmit the request.

Back to Top