Jump to

• Request
• Response

Create a Program

post

/api/restapi/program

Send a request to this endpoint to create a program. 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 : ApiEntityProgramInput

Type: object

Title: ApiEntityProgramInput

This entity represents a Program object, a unique Program object can be identified by the following combinations of the fields.

• programId
• programCode, workspaceId
• programCode, workspaceCode

Show Source

• actualFinish: string (date-time)
  The Actual Finish displays the date on which a program is considered complete.
  This value can be entered manually or can be imported.
• actualsLinkType: string
  Maximum Length: 255

  The field source for the actuals curve in cash flow.
• actualStart: string (date-time)
  The Actual Start indicates the date work on the program began.
  This value can be entered manually or can be imported.
• benefitsFinishDate: string (date-time)
  The date benefits on the program finished.
• benefitsLinkType: string
  Maximum Length: 255

  The field source for the benefit curve in cash flow.
• benefitsStartDate: string (date-time)
  The date benefits on the program began.
• breakdownCapitalForActual: boolean
  Enables you breakdown spends total into spends capital.
• breakdownCapitalForForecast: boolean
  Enables you breakdown forecast total into forecast capital.
• breakdownCapitalForPlannedBudget: boolean
  Enables you breakdown planned budget total into planned budget capital.
• breakdownExpenseForActual: boolean
  Enables you breakdown spends total into spends expense.
• breakdownExpenseForForecast: boolean
  Enables you breakdown forecast total into forecast expense.
• breakdownExpenseForPlannedBudget: boolean
  Enables you breakdown planned budget total into planned budget expense.
• businessImpact: string
  Maximum Length: 4000

  A detailed description of the business impact of the program.
• codeValues: array codeValues
  The list of code values for a program. This entity can only be used to assign codeValues or create codeValues on the fly.
• configuredFields: array configuredFields
  The list of configured fields for a program.
• createDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.5.
  The date the program was added.
• createUser: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.5.
  The user who added the program.
• description: string
  Maximum Length: 4000

  The detailed summary for the program. 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.
• evaluationMatrixId: integer (int64)
  Read Only: true

  Deprecated. As of 23.5.
  The unique identifier for the program evaluation.
• evaluationScore: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The quantitative score of a program based on the qualitative ranking of programs against different evaluation categories. This value is used by portfolio managers to prioritize programs.
• forecastFinishDate: string (date-time)
  The planned finish date of a program's remaining Forecast cost.
• forecastLinkType: string
  Maximum Length: 255

  The field source for the forecast curve in cash flow.
• forecastStartDate: string (date-time)
  The planned start date of a program's remaining Forecast cost.
• lastProgramEvaluationDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.5.
  The most recent evaluation date for the program.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• linkedObjects: array linkedObjects
  The list of projects linked to the program.
• linkForecastToSpend: boolean
  Enables you to link program Forecast data to program Actuals data.
  When linked, any updates to the program's Actuals values will automatically be applied to the program's Forecast values.
• owner: string
  Maximum Length: 255

  The manager or person responsible for the program.
• plannedBudgetLinkType: string
  Maximum Length: 255

  The field source for the planned budget curve in cash flow.
• plannedFinish: string (date-time)
  The finish date for the time phased Planned Budget of the program.
  Planned Budget cost spread will adjust when this date is changed.
• plannedStart: string (date-time)
  The start date for the time phased Planned Budget of the program.
  Planned Budget cost spread will adjust when this date is changed.
  The Program Planned Start also represents the earliest date that activities can occur within a program schedule.
• problemOrOpportunity: string
  Maximum Length: 4000

  A detailed description of the problem or opportunity the program addresses.
• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programFinancial: programFinancial
  The financial fields associated with a program.
• programId: integer (int64)
  The unique identifier for the program.
• programName(required): string
  Maximum Length: 255

  The name of the program.
• programPhaseFinancials: array programPhaseFinancials
  The program cashflow data associated with the program.
• programSettings: array programSettings
  The program settings associated with the program.
• riskMatrixId: integer (int64)
  The risk matrix assigned to the program for calculating program risk scores.
• spendEffectiveDate: string (date-time)
  The month in which an actuals value was last added to the program
• spendFinishDate: string (date-time)
  The finish date for the program actuals.
• spendStartDate: string (date-time)
  The start date for the program actuals.
• status: string
  Allowed Values: [ "PLANNED", "ACTIVE", "INACTIVE", "ON_HOLD", "COMPLETE" ]

  The current status of the program.
• statusDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.5.
  The date and time the program status was changed.
• strategicObjective: string
  Maximum Length: 4000

  A detailed description of the strategic object of the program.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• updateUser: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.5.
  The user who last modified the program
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId(required): integer (int64)
  The unique identifier of a workspace.

{
    "title":"ApiEntityProgramInput",
    "required":[
        "programName",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "owner":{
            "maxLength":"255",
            "type":"string",
            "description":"The manager or person responsible for the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "status":{
            "type":"string",
            "description":"The current status of the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PLANNED",
                "ACTIVE",
                "INACTIVE",
                "ON_HOLD",
                "COMPLETE"
            ]
        },
        "description":{
            "maxLength":"4000",
            "type":"string",
            "description":"The detailed summary for the program. 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.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "spendStartDate":{
            "type":"string",
            "description":"The start date for the program actuals.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateUser":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The user who last modified the program",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "createDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The date the program was added.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "createUser":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The user who added the program.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a program.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "codeValues":{
            "type":"array",
            "description":"The list of code values for a program. This entity can only be used to assign codeValues or create codeValues on the fly.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCodeValueProgramInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "evaluationMatrixId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The unique identifier for the program evaluation.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "plannedStart":{
            "type":"string",
            "description":"The start date for the time phased Planned Budget of the program. <br />Planned Budget cost spread will adjust when this date is changed. <br />The Program Planned Start also represents the earliest date that activities can occur within a program schedule.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "plannedFinish":{
            "type":"string",
            "description":"The finish date for the time phased Planned Budget of the program. <br />Planned Budget cost spread will adjust when this date is changed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "actualStart":{
            "type":"string",
            "description":"The Actual Start indicates the date work on the program began. <br />This value can be entered manually or can be imported.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "actualFinish":{
            "type":"string",
            "description":"The Actual Finish displays the date on which a program is considered complete. <br />This value can be entered manually or can be imported.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "problemOrOpportunity":{
            "maxLength":"4000",
            "type":"string",
            "description":"A detailed description of the problem or opportunity the program addresses.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "businessImpact":{
            "maxLength":"4000",
            "type":"string",
            "description":"A detailed description of the business impact of the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "strategicObjective":{
            "maxLength":"4000",
            "type":"string",
            "description":"A detailed description of the strategic object of the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "forecastFinishDate":{
            "type":"string",
            "description":"The planned finish date of a program's remaining Forecast cost.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "forecastStartDate":{
            "type":"string",
            "description":"The planned start date of a program's remaining Forecast cost.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "spendFinishDate":{
            "type":"string",
            "description":"The finish date for the program actuals.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "benefitsStartDate":{
            "type":"string",
            "description":"The date benefits on the program began.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "benefitsFinishDate":{
            "type":"string",
            "description":"The date benefits on the program finished.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "evaluationScore":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The quantitative score of a program based on the qualitative ranking of programs against different evaluation categories. This value is used by portfolio managers to prioritize programs.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "lastProgramEvaluationDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The most recent evaluation date for the program.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskMatrixId":{
            "type":"integer",
            "description":"The risk matrix assigned to the program for calculating program risk scores.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "spendEffectiveDate":{
            "type":"string",
            "description":"The month in which an actuals value was last added to the program ",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "linkForecastToSpend":{
            "type":"boolean",
            "description":"Enables you to link program Forecast data to program Actuals data. <br />When linked, any updates to the program's Actuals values will automatically be applied to the program's Forecast values.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "linkedObjects":{
            "type":"array",
            "description":"The list of projects linked to the program.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramLinkedObjectInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "actualsLinkType":{
            "maxLength":"255",
            "type":"string",
            "description":"The field source for the actuals curve in cash flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "forecastLinkType":{
            "maxLength":"255",
            "type":"string",
            "description":"The field source for the forecast curve in cash flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "plannedBudgetLinkType":{
            "maxLength":"255",
            "type":"string",
            "description":"The field source for the planned budget curve in cash flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "benefitsLinkType":{
            "maxLength":"255",
            "type":"string",
            "description":"The field source for the benefit curve in cash flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "statusDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The date and time the program status was changed.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "breakdownCapitalForPlannedBudget":{
            "type":"boolean",
            "description":"Enables you breakdown planned budget total into planned budget capital.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "breakdownExpenseForPlannedBudget":{
            "type":"boolean",
            "description":"Enables you breakdown planned budget total into planned budget expense.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "breakdownCapitalForActual":{
            "type":"boolean",
            "description":"Enables you breakdown spends total into spends capital.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "breakdownExpenseForActual":{
            "type":"boolean",
            "description":"Enables you breakdown spends total into spends expense.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "breakdownCapitalForForecast":{
            "type":"boolean",
            "description":"Enables you breakdown forecast total into forecast capital.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "breakdownExpenseForForecast":{
            "type":"boolean",
            "description":"Enables you breakdown forecast total into forecast expense.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "programSettings":{
            "type":"array",
            "description":"The program settings associated with the program.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramSettingInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "programPhaseFinancials":{
            "type":"array",
            "description":"The program cashflow data associated with the program.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramPhaseFinancialInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "programFinancial":{
            "description":"The financial fields associated with a program.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProgramFinancialInput"
                }
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a Program object, a unique Program object can be identified by the following combinations of the fields.<ul><li>programId</li><li>programCode, workspaceId</li><li>programCode, workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : codeValues

Type: array

The list of code values for a program. This entity can only be used to assign codeValues or create codeValues on the fly.

Show Source

• Array of: object ApiEntityCodeValueProgramInput
  Title: ApiEntityCodeValueProgramInput

  This entity represents a CodeValueProgram object, a unique CodeValueProgram object can be identified by the following combinations of the fields.

  • codeValueObjectId
  • codeTypeCode, codeValueCode
  • codeTypeId,codeValueCode
  • codeValueId
  • codeValueCode,codeTypeCode,parentId
  • codeValueCode,codeTypeId,parentId

{
    "type":"array",
    "description":"The list of code values for a program. This entity can only be used to assign codeValues or create codeValues on the fly.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCodeValueProgramInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a program.

Show Source

• Array of: object ApiEntityProgramConfiguredFieldValueInput
  Title: ApiEntityProgramConfiguredFieldValueInput

  This entity represents a ProgramConfiguredFieldValue object, a unique ProgramConfiguredFieldValue object can be identified by the following combinations of the fields.

  • configuredFieldObjectId
  • columnDefinitionId
  • columnName
  • columnLabel

{
    "type":"array",
    "description":"The list of configured fields for a program.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramConfiguredFieldValueInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : linkedObjects

Type: array

The list of projects linked to the program.

Show Source

• Array of: object ApiEntityProgramLinkedObjectInput
  Title: ApiEntityProgramLinkedObjectInput

  This entity represents a ProgramLinkedObject object, a unique ProgramLinkedObject object can be identified by the following combinations of the fields.

  • objectId, objectType

{
    "type":"array",
    "description":"The list of projects linked to the program.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramLinkedObjectInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : programFinancial

The financial fields associated with a program.

Match All

Show Source

• object ApiEntityProgramFinancialInput
  Title: ApiEntityProgramFinancialInput

{
    "description":"The financial fields associated with a program.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityProgramFinancialInput"
        }
    ]
}

Nested Schema : programPhaseFinancials

Type: array

The program cashflow data associated with the program.

Show Source

• Array of: object ApiEntityProgramPhaseFinancialInput
  Title: ApiEntityProgramPhaseFinancialInput

  This entity represents a ProgramPhaseFinancial object, a unique ProgramPhaseFinancial object can be identified by the following combinations of the fields.

  • programPhaseFinancialId

{
    "type":"array",
    "description":"The program cashflow data associated with the program.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramPhaseFinancialInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : programSettings

Type: array

The program settings associated with the program.

Show Source

• Array of: object ApiEntityProgramSettingInput
  Title: ApiEntityProgramSettingInput

{
    "type":"array",
    "description":"The program settings associated with the program.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramSettingInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCodeValueProgramInput

Type: object

Title: ApiEntityCodeValueProgramInput

This entity represents a CodeValueProgram object, a unique CodeValueProgram object can be identified by the following combinations of the fields.

• codeValueObjectId
• codeTypeCode, codeValueCode
• codeTypeId,codeValueCode
• codeValueId
• codeValueCode,codeTypeCode,parentId
• codeValueCode,codeTypeId,parentId

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide a value for this field during object update to delete code value assigned to the object.
• codeTypeCode: string
  Maximum Length: 60

  This field displays the name of a code or value.
• codeTypeId(required): integer (int64)
  The ID for the code type.
• codeValueCode(required): string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the code value.
• codeValueId: integer (int64)
  The unique identifier for the code value.
• codeValueName(required): string
  Minimum Length: 1

  Maximum Length: 255

  The name of the code value.
• codeValueObjectId: integer (int64)
  The system-generated unique identifier for the code value assignment. This value should not be provided in create operation request data, however, it is required for update requests.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• parentId: integer (int64)
  The unique identifier of a parent code value.
• programId: integer (int64)
  The unique identifier for the program.
• sequenceNumber: integer (int32)
  The number that specifies the position of the code value item within the code type list.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityCodeValueProgramInput",
    "required":[
        "codeTypeId",
        "codeValueCode",
        "codeValueName"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The number that specifies the position of the code value item within the code type list.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide a value for this field during object update to delete code value assigned to the object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The ID for the code type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "maxLength":"60",
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueObjectId":{
            "type":"integer",
            "description":"The system-generated unique identifier for the code value assignment. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a CodeValueProgram object, a unique CodeValueProgram object can be identified by the following combinations of the fields.<ul><li>codeValueObjectId</li><li>codeTypeCode, codeValueCode</li><li>codeTypeId,codeValueCode</li><li>codeValueId</li><li>codeValueCode,codeTypeCode,parentId</li><li>codeValueCode,codeTypeId,parentId</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramConfiguredFieldValueInput

Type: object

Title: ApiEntityProgramConfiguredFieldValueInput

This entity represents a ProgramConfiguredFieldValue object, a unique ProgramConfiguredFieldValue object can be identified by the following combinations of the fields.

• configuredFieldObjectId
• columnDefinitionId
• columnName
• columnLabel

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• columnDefinitionId: integer (int64)
  Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
• columnLabel: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column label.
• columnName: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column name.
• configuredFieldObjectId: integer (int64)
  The unique identifier for the Program Configured Field.
• costValue: number
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace3 currency conversion.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• exceptionMessage: string
  Read Only: true

  Maximum Length: 4000

  Deprecated. As of 23.10.
  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Read Only: true

  Deprecated. As of 23.10.
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• numberValue: number
  This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
• programId: integer (int64)
  The system-generated identifier of a Program.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityProgramConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The system-generated identifier of a Program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "configuredFieldObjectId":{
            "type":"integer",
            "description":"The unique identifier for the Program Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Provides the error message for why the formula calculation resulted in an error.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Determines if formula calculation hit an error calculating a value for this field.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        }
    },
    "description":"This entity represents a ProgramConfiguredFieldValue object, a unique ProgramConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>configuredFieldObjectId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramLinkedObjectInput

Type: object

Title: ApiEntityProgramLinkedObjectInput

This entity represents a ProgramLinkedObject object, a unique ProgramLinkedObject object can be identified by the following combinations of the fields.

• objectId, objectType

Show Source

• action: string
  Allowed Values: [ "DELETE" ]
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• objectId: integer (int64)
  The system-generated identifier of a program linked object.
• objectType: string
  Maximum Length: 255

  The type of linked object.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityProgramLinkedObjectInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "objectType":{
            "maxLength":"255",
            "type":"string",
            "description":"The type of linked object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "action":{
            "type":"string",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "objectId":{
            "type":"integer",
            "description":"The system-generated identifier of a program linked object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ProgramLinkedObject object, a unique ProgramLinkedObject object can be identified by the following combinations of the fields.<ul><li>objectId, objectType</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramFinancialInput

Type: object

Title: ApiEntityProgramFinancialInput

Show Source

• actualCapitalCostDistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The capital amount of actual expense cost allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• actualCapitalCostPresentValue: number (double)
  Deprecated. As of 23.5.
  The capital present value, also known as discounted value, of the overall program actuals.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the base currency with specified exchange rate.
• actualCapitalCostUndistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The capital amount of actual expense cost unallocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• actualCostDistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The amount of actual cost currently allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• actualCostPresentValue: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The present value, also known as discounted value, of the overall program actuals. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
• actualCostUndistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The amount of actual cost currently allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• actualExpenseCostDistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The capital amount of actual capital cost allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• actualExpenseCostPresentValue: number (double)
  Deprecated. As of 23.5.
  The expense present value, also known as discounted value, of the overall program actuals.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the base currency with specified exchange rate.
• actualExpenseCostUndistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The capital amount of actual capital cost unallocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• annualDiscountRate: number (double)
  Minimum Value: 0

  Maximum Value: 1

  The interest rate associated with the cost of an investment from your commercial bank or another funding source.
  For example, an annual growth rate of an investment such as 4.75% can be used as an annual discount rate. This rate is used when a future value is assumed and you are trying to find the required Net Present Value.
  This value can be entered manually or can be imported.
• benefits: number (double)
  Deprecated. As of 23.5.
  Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
• benefitsCOR: number (double)
  Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
  This is an input field, will not be a part of response.
• benefitsDistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The amount of benefits currently allocated across the program timescale.
• benefitsOutOfSync: boolean
  Read Only: true

  Deprecated. As of 23.11.
  Indicates whether the Benefits roll-up from projects is out of sync.
• benefitsPresentValue: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The present value, also known as the discounted value, of the overall program benefits. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
• benefitsUndistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The amount of benefits that have not been allocated across the program timescale.
• costPerfIndex: number (double)
  The measure of a program's cost efficiency.
  A value of less than 1 indicates the program is over budget, while a value greater than 1 indicates the program is under budget.
  This value can be entered manually or can be imported.
• costVariance: number (double)
  Deprecated. As of 23.5.
  The measure of cost performance on a program.
  A negative value indicates that the Actual Cost has exceeded the planned value.
  This value can be entered manually or can be imported.
• costVarianceCOR: number (double)
  The measure of cost performance on a program.
  A negative value indicates that the Actual Cost has exceeded the planned value.
  This value can be entered manually or can be imported.
  This is an input field, will not be a part of response.
• earnedValueCost: number (double)
  Deprecated. As of 23.5.
  The value of work performed on a program in reference to the approved budget for the program.
  The cost value used for the Earned Value Management of a program.
  Earned Value Management allows program managers to quantify program progress and objectively measure a program's success.
  This value can be entered manually or can be imported.
• earnedValueCostCOR: number (double)
  The value of work performed on a program in reference to the approved budget for the program.
  The cost value used for the Earned Value Management of a program.
  Earned Value Management allows program managers to quantify program progress and objectively measure a program's success.
  This value can be entered manually or can be imported.
  This is an input field, will not be a part of response.
• estAtCompleteCost: number (double)
  Deprecated. As of 23.5.
  The expected total cost of the program when the defined scope of work will be completed.
  This value can be entered manually or can be imported.
• estAtCompleteCostCOR: number (double)
  The expected total cost of the program when the defined scope of work will be completed.
  This value can be entered manually or can be imported.
  This is an input field, will not be a part of response.
• estToCompleteCost: number (double)
  Deprecated. As of 23.5.
  The estimated cost needed to complete the program.
  This value can be entered manually or can be imported.
• estToCompleteCostCOR: number (double)
  The estimated cost needed to complete the program.
  This value can be entered manually or can be imported.
  This is an input field, will not be a part of response.
• forecastCapitalCost: number (double)
  Deprecated. As of 23.5.
  The total capital estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the base currency with specified exchange rate.
• forecastCapitalCostCOR: number (double)
  The total capital estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This is an input field, will not be a part of response.
• forecastCapitalCostDistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The capital amount of forecast cost allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• forecastCapitalCostPresentValue: number (double)
  Deprecated. As of 23.5.
  The capital present value, also known as the discounted value, of the overall program forecast.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the base currency with specified exchange rate.
• forecastCapitalCostUndistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The capital amount of forecast cost unallocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• forecastCost: number (double)
  Deprecated. As of 23.5.
  The total estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
• forecastCostCOR: number (double)
  The total estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This is an input field, will not be a part of response.
• forecastCostDistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The amount of forecast cost currently allocated across the program timescale.
• forecastCostPresentValue: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The present value, also known as the discounted value, of the overall program forecast. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
• forecastCostUndistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The amount of forecast cost unallocated across the program timescale.
• forecastExpenseCost: number (double)
  Deprecated. As of 23.5.
  The total expense estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the base currency with specified exchange rate.
• forecastExpenseCostCOR: number (double)
  The total expense estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This is an input field, will not be a part of response.
• forecastExpenseCostDistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The expense amount of forecast cost allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• forecastExpenseCostPresentValue: number (double)
  Deprecated. As of 23.5.
  The expense present value, also known as the discounted value, of the overall program forecast.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the base currency with specified exchange rate.
• forecastExpenseCostUndistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The expense amount of forecast cost unallocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• forecastOutOfSync: boolean
  Read Only: true

  Deprecated. As of 23.11.
  Indicates whether the Forecast roll-up from projects is out of sync.
• intRateOfReturn: number (double)
  The quantitative measurement used to compare the profitability of program investments.
  The rate at which investors will receive returns on their investments in a program.
  This value can be entered manually or can be imported.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• netPresentValue: number (double)
  Deprecated. As of 23.5.
  The difference between the present value (PV) of the future cash flows from current investments and program costs.
  The Net Present Value accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
  Positive Net Present Value (NPV) is an indicator of programs that should be pursued.
  This value can be entered manually or can be imported.
• netPresentValueCOR: number (double)
  The difference between the Present Value (PV) of the future cash flows from current investments and program costs.
  The Net Present Value (NPV) accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
  A positive NPV is an indicator of programs that should be pursued.
  This value can be entered manually or can be imported.
  This is an input field, will not be a part of response.
• paybackPeriod: number (double)
  The estimate of the length of time that will transpire before net profits recover the initial and periodic costs of an investment to carry out the selected program.
  
  
  This value can be entered manually or can be imported.
• plannedBudget: number (double)
  Deprecated. As of 23.5.
  The planned total cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
• plannedBudgetCapital: number (double)
  Deprecated. As of 23.5.
  The planned total capital cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetCapitalCOR: number (double)
  The planned total capital cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This is an input field, will not be a part of response.
• plannedBudgetCapitalDistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The capital amount of planned budget allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetCapitalPresentValue: number (double)
  Deprecated. As of 23.5.
  The capital present value, also known as the discounted value, of the overall program planned budget.Future cash flows are discounted using the program's annual discount rate.
  Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetCapitalUndistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The capital amount of planned budget unallocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetCOR: number (double)
  The planned total cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This is an input field, will not be a part of response.
• plannedBudgetDistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The amount of planned budget allocated across the program timescale.
• plannedBudgetExpense: number (double)
  Deprecated. As of 23.5.
  The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetExpenseCOR: number (double)
  The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This is an input field, will not be a part of response.
• plannedBudgetExpenseDistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The expense amount of planned budget allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetExpensePresentValue: number (double)
  Deprecated. As of 23.5.
  The expense present value, also known as the discounted value, of the overall program planned budget.
  Future cash flows are discounted using the program's annual discount rate.
  Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetExpenseUndistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The expense amount of planned budget unallocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetOutOfSync: boolean
  Read Only: true

  Deprecated. As of 23.11.
  Indicates whether the Planned Budget roll-up from projects is out of sync.
• plannedBudgetPresentValue: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The present value, also known as the discounted value, of the overall program planned budget. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
• plannedBudgetUndistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The amount of planned budget unallocated across the program timescale.
• plannedValueCost: number (double)
  Deprecated. As of 23.5.
  The amount of approved capital spent on a scheduled portion of work on a program.
  Planned Value Cost is often used for Earned Value Management.
  This value can be entered manually or can be imported.
• plannedValueCostCOR: number (double)
  The amount of approved capital spent on a scheduled portion of work on a program.
  Planned Value Cost is often used for Earned Value Management.
  This value can be entered manually or can be imported.
  This is an input field, will not be a part of response.
• profitabilityIndex: number (double)
  The index based on the value of a program's present values divided by initial program investments.
• programId: integer (int64)
  The unique identifier for a program set by the user who created the program.
• returnOnInvestment: number (double)
  The percentage resulting from division of the expected returns of an investment by the investment costs of a program or portfolio.
  For example, a program is expected to cost 1.0 million dollars with a total benefit of 1.2 million dollars. Its Net Present Value is $200,000. The Return on Investment is 20%.
  This value can be entered manually or can be imported.
• schedPerfIndex: number (double)
  The measure of the work accomplished as a percentage of the work scheduled on a program.
  Schedule Performance Index indicates whether you are meeting earned and planned values within your program schedule.
  A value less than 1 indicates that less work was performed than was scheduled. A value greater than 1 indicates the program is ahead of schedule.
  This value can be entered manually or can be imported.
• scheduleVariance: number (double)
  Deprecated. As of 23.5.
  The measure of schedule performance on a program.
  A negative value indicates that less work was actually performed than was scheduled.
  This value can be entered manually or can be imported.
• scheduleVarianceCOR: number (double)
  The measure of schedule performance on a program.
  A negative value indicates that less work was actually performed than was scheduled.
  This value can be entered manually or can be imported.
  This is an input field, will not be a part of response.
• spendCapitalCost: number (double)
  Deprecated. As of 23.5.
  The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the base currency with specified exchange rate.
• spendCapitalCostCOR: number (double)
  The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This is an input field, will not be a part of response.
• spendCost: number (double)
  Deprecated. As of 23.5.
  The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
• spendCostCOR: number (double)
  The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This is an input field, will not be a part of response.
• spendExpenseCost: number (double)
  Deprecated. As of 23.5.
  The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the base currency with specified exchange rate.
• spendExpenseCostCOR: number (double)
  The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This is an input field, will not be a part of response.
• spendForecastVar: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The total and time phased variance between the program's Actuals and Forecast.
• spendPlannedVariance: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The total and time phased variance between the program's Actuals and Planned Budget.
• spendsOutOfSync: boolean
  Read Only: true

  Deprecated. As of 23.11.
  Indicates whether the Actuals roll-up from projects is out of sync.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• yearEndForecastCost: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  Total forecast at the end of year actuals till date, with respect to the current year.
• ytdSpendCost: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  A measurement of capital spent on a program starting from the beginning of the year up to the present date.
  YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.

{
    "title":"ApiEntityProgramFinancialInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "estToCompleteCostCOR":{
            "type":"number",
            "description":"The estimated cost needed to complete the program. <br />This value can be entered manually or can be imported. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedValueCostCOR":{
            "type":"number",
            "description":"The amount of approved capital spent on a scheduled portion of work on a program. <br />Planned Value Cost is often used for Earned Value Management. <br />This value can be entered manually or can be imported. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "scheduleVarianceCOR":{
            "type":"number",
            "description":"The measure of schedule performance on a program. <br />A negative value indicates that less work was actually performed than was scheduled. <br />This value can be entered manually or can be imported. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "netPresentValueCOR":{
            "type":"number",
            "description":"The difference between the Present Value (PV) of the future cash flows from current investments and program costs. <br />The Net Present Value (NPV) accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital. <br />A positive NPV is an indicator of programs that should be pursued. <br />This value can be entered manually or can be imported. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefitsCOR":{
            "type":"number",
            "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalCOR":{
            "type":"number",
            "description":"The planned total capital cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseCOR":{
            "type":"number",
            "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostCOR":{
            "type":"number",
            "description":"The total capital estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostCOR":{
            "type":"number",
            "description":"The total expense estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCapitalCostCOR":{
            "type":"number",
            "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendExpenseCostCOR":{
            "type":"number",
            "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCOR":{
            "type":"number",
            "description":"The planned total cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostCOR":{
            "type":"number",
            "description":"The total estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCostCOR":{
            "type":"number",
            "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costVarianceCOR":{
            "type":"number",
            "description":"The measure of cost performance on a program. <br />A negative value indicates that the Actual Cost has exceeded the planned value. <br />This value can be entered manually or can be imported. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "earnedValueCostCOR":{
            "type":"number",
            "description":"The value of work performed on a program in reference to the approved budget for the program. <br />The cost value used for the Earned Value Management of a program. <br />Earned Value Management allows program managers to quantify program progress and objectively measure a program's success. <br />This value can be entered manually or can be imported. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "estAtCompleteCostCOR":{
            "type":"number",
            "description":"The expected total cost of the program when the defined scope of work will be completed. <br />This value can be entered manually or can be imported. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedValueCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The amount of approved capital spent on a scheduled portion of work on a program. <br />Planned Value Cost is often used for Earned Value Management. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "earnedValueCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The value of work performed on a program in reference to the approved budget for the program. <br />The cost value used for the Earned Value Management of a program. <br />Earned Value Management allows program managers to quantify program progress and objectively measure a program's success. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costVariance":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The measure of cost performance on a program. <br />A negative value indicates that the Actual Cost has exceeded the planned value. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualCapitalCostDistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital amount of actual expense cost allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualExpenseCostDistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital amount of actual capital cost allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualCostDistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The amount of actual cost currently allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualCapitalCostUndistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital amount of actual expense cost unallocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualExpenseCostUndistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital amount of actual capital cost unallocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualCostUndistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The amount of actual cost currently allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetDistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The amount of planned budget allocated across the program timescale.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudget":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The planned total cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetUndistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The amount of planned budget unallocated across the program timescale.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetPresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The present value, also known as the discounted value, of the overall program planned budget. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastCostDistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The amount of forecast cost currently allocated across the program timescale.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastCostUndistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The amount of forecast cost unallocated across the program timescale.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastCostPresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The present value, also known as the discounted value, of the overall program forecast. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualCostPresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The present value, also known as discounted value, of the overall program actuals. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendForecastVar":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total and time phased variance between the program's Actuals and Forecast.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendPlannedVariance":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total and time phased variance between the program's Actuals and Planned Budget.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "yearEndForecastCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>Total forecast at the end of year actuals till date, with respect to the current year.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "ytdSpendCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>A measurement of capital spent on a program starting from the beginning of the year up to the present date. <br />YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "estAtCompleteCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The expected total cost of the program when the defined scope of work will be completed. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "estToCompleteCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The estimated cost needed to complete the program. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "scheduleVariance":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The measure of schedule performance on a program. <br />A negative value indicates that less work was actually performed than was scheduled. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "netPresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The difference between the present value (PV) of the future cash flows from current investments and program costs. <br />The Net Present Value accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital. <br />Positive Net Present Value (NPV) is an indicator of programs that should be pursued. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "benefits":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "benefitsDistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The amount of benefits currently allocated across the program timescale.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "benefitsUndistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The amount of benefits that have not been allocated across the program timescale.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "benefitsPresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The present value, also known as the discounted value, of the overall program benefits. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetCapital":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The planned total capital cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalUndistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital amount of planned budget unallocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalPresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital present value, also known as the discounted value, of the overall program planned budget.Future cash flows are discounted using the program's annual discount rate. <br />Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetExpense":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseUndistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The  expense amount of planned budget unallocated across the program timescale.  <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetExpensePresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The expense present value, also known as the discounted value, of the overall program planned budget. <br />Future cash flows are discounted using the program's annual discount rate. <br />Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastCapitalCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total capital estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastCapitalCostDistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital amount of forecast cost allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastCapitalCostUndistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital amount of forecast cost unallocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastCapitalCostPresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital present value, also known as the discounted value, of the overall program forecast. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastExpenseCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total expense estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastExpenseCostDistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The expense amount of forecast cost allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastExpenseCostUndistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The expense amount of forecast cost unallocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastExpenseCostPresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The expense present value, also known as the discounted value, of the overall program forecast. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendCapitalCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendExpenseCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualCapitalCostPresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital present value, also known as discounted value, of the overall program actuals. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualExpenseCostPresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The expense present value, also known as discounted value, of the overall program actuals. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalDistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital amount of planned budget allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseDistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The expense amount of planned budget allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for a program set by the user who created the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costPerfIndex":{
            "type":"number",
            "description":"The measure of a program's cost efficiency. <br />A value of less than 1 indicates the program is over budget, while a value greater than 1 indicates the program is under budget. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "schedPerfIndex":{
            "type":"number",
            "description":"The measure of the work accomplished as a percentage of the work scheduled on a program. <br />Schedule Performance Index indicates whether you are meeting earned and planned values within your program schedule. <br />A value less than 1 indicates that less work was performed than was scheduled. A value greater than 1 indicates the program is ahead of schedule. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "paybackPeriod":{
            "type":"number",
            "description":"The estimate of the length of time that will transpire before net profits recover the initial and periodic costs of an investment to carry out the selected program. <br /><br /><br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "profitabilityIndex":{
            "type":"number",
            "description":"The index based on the value of a program's present values divided by initial program investments.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "returnOnInvestment":{
            "type":"number",
            "description":"The percentage resulting from division of the expected returns of an investment by the investment costs of a program or portfolio. <br />For example, a program is expected to cost 1.0 million dollars with a total benefit of 1.2 million dollars. Its Net Present Value is $200,000. The Return on Investment is 20%. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetOutOfSync":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Indicates whether the Planned Budget roll-up from projects is out of sync.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "forecastOutOfSync":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Indicates whether the Forecast roll-up from projects is out of sync.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "spendsOutOfSync":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Indicates whether the Actuals roll-up from projects is out of sync.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "benefitsOutOfSync":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Indicates whether the Benefits roll-up from projects is out of sync.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "annualDiscountRate":{
            "maximum":"1",
            "minimum":"0",
            "type":"number",
            "description":"The interest rate associated with the cost of an investment from your commercial bank or another funding source. <br />For example, an annual growth rate of an investment such as 4.75% can be used as an annual discount rate. This rate is used when a future value is assumed and you are trying to find the required Net Present Value. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false
        },
        "intRateOfReturn":{
            "type":"number",
            "description":"The quantitative measurement used to compare the profitability of program investments. <br />The rate at which investors will receive returns on their investments in a program. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramPhaseFinancialInput

Type: object

Title: ApiEntityProgramPhaseFinancialInput

This entity represents a ProgramPhaseFinancial object, a unique ProgramPhaseFinancial object can be identified by the following combinations of the fields.

• programPhaseFinancialId

Show Source

• benefits: number (double)
  Deprecated. As of 23.5.
  Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
• benefitsCOR: number (double)
  Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
  This is an input field, will not be a part of response.
• forecastCapitalCost: number (double)
  Deprecated. As of 23.5.
  The total capital estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the base currency with specified exchange rate.
• forecastCapitalCostCOR: number (double)
  The total capital estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This is an input field, will not be a part of response.
• forecastCost: number (double)
  Deprecated. As of 23.5.
  The total estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
• forecastCostCOR: number (double)
  The total estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This is an input field, will not be a part of response.
• forecastExpenseCost: number (double)
  Deprecated. As of 23.5.
  The total expense estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the base currency with specified exchange rate.
• forecastExpenseCostCOR: number (double)
  The total expense estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This is an input field, will not be a part of response.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• month: integer (int32)
  The time period during which budget planning for the program takes place in months.
• phaseStartDate: string (date-time)
  The starting date for a time phase of the program life cycle.
• plannedBudget: number (double)
  Deprecated. As of 23.5.
  The planned total cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
• plannedBudgetCapital: number (double)
  Deprecated. As of 23.5.
  The planned total capital cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetCapitalCOR: number (double)
  The planned total capital cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This is an input field, will not be a part of response.
• plannedBudgetCOR: number (double)
  The planned total cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This is an input field, will not be a part of response.
• plannedBudgetExpense: number (double)
  Deprecated. As of 23.5.
  The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetExpenseCOR: number (double)
  The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This is an input field, will not be a part of response.
• programId: integer (int64)
  The unique identifier for a program set by the user who created the program.
• programPhaseFinancialId: integer (int64)
  The system-generated identifier of a progam phase financial.
• spendCapitalCost: number (double)
  Deprecated. As of 23.5.
  The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the base currency with specified exchange rate.
• spendCapitalCostCOR: number (double)
  The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This is an input field, will not be a part of response.
• spendCost: number (double)
  Deprecated. As of 23.5.
  The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
• spendCostCOR: number (double)
  The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This is an input field, will not be a part of response.
• spendExpenseCost: number (double)
  Deprecated. As of 23.5.
  The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the base currency with specified exchange rate.
• spendExpenseCostCOR: number (double)
  The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This is an input field, will not be a part of response.
• spendForecastVar: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The total and time phased variance between the program's Actuals and Forecast.
• spendPlannedVariance: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The total and time phased variance between the program's Actuals and Planned Budget.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• year: integer (int32)
  The time period during which budget planning for the program takes place in years.
• yearEndForecastCost: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  Total forecast at the end of year actuals till date, with respect to the current year.
• ytdSpendCost: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  A measurement of capital spent on a program starting from the beginning of the year up to the present date.
  YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.

{
    "title":"ApiEntityProgramPhaseFinancialInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "benefitsCOR":{
            "type":"number",
            "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalCOR":{
            "type":"number",
            "description":"The planned total capital cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseCOR":{
            "type":"number",
            "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostCOR":{
            "type":"number",
            "description":"The total capital estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostCOR":{
            "type":"number",
            "description":"The total expense estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCapitalCostCOR":{
            "type":"number",
            "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendExpenseCostCOR":{
            "type":"number",
            "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCOR":{
            "type":"number",
            "description":"The planned total cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostCOR":{
            "type":"number",
            "description":"The total estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCostCOR":{
            "type":"number",
            "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudget":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The planned total cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendForecastVar":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total and time phased variance between the program's Actuals and Forecast.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendPlannedVariance":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total and time phased variance between the program's Actuals and Planned Budget.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "yearEndForecastCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>Total forecast at the end of year actuals till date, with respect to the current year.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "ytdSpendCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>A measurement of capital spent on a program starting from the beginning of the year up to the present date. <br />YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "benefits":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetCapital":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The planned total capital cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetExpense":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastCapitalCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total capital estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastExpenseCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total expense estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendCapitalCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendExpenseCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "year":{
            "type":"integer",
            "description":"The time period during which budget planning for the program takes place in years.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "month":{
            "type":"integer",
            "description":"The time period during which budget planning for the program takes place in months.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for a program set by the user who created the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programPhaseFinancialId":{
            "type":"integer",
            "description":"The system-generated identifier of a progam phase financial.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "phaseStartDate":{
            "type":"string",
            "description":"The starting date for a time phase of the program life cycle.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ProgramPhaseFinancial object, a unique ProgramPhaseFinancial object can be identified by the following combinations of the fields.<ul><li>programPhaseFinancialId</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramSettingInput

Type: object

Title: ApiEntityProgramSettingInput

Show Source

• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• programId: integer (int64)
  The unique identifier of a program.
• programSettingId: integer (int64)
  The unique identifier of a program setting. This value should not be provided in create operation request data, however, it is required for update requests.
• settingName: string
  Minimum Length: 0

  Maximum Length: 255

  The name of a program setting.
• settingValue: string
  Minimum Length: 0

  Maximum Length: 4000

  Value of a program setting.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityProgramSettingInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier of a program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programSettingId":{
            "type":"integer",
            "description":"The unique identifier of a program setting. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "settingName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The name of a program setting.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "settingValue":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Value of a program setting.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Create a Program

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : ApiEntityProgramResponse

Type: object

Title: ApiEntityProgramResponse

Show Source

• actualFinish: string (date-time)
  The Actual Finish displays the date on which a program is considered complete.
  This value can be entered manually or can be imported.
• actualsLinkType: string
  Maximum Length: 255

  The field source for the actuals curve in cash flow.
• actualStart: string (date-time)
  The Actual Start indicates the date work on the program began.
  This value can be entered manually or can be imported.
• benefitsFinishDate: string (date-time)
  The date benefits on the program finished.
• benefitsLinkType: string
  Maximum Length: 255

  The field source for the benefit curve in cash flow.
• benefitsStartDate: string (date-time)
  The date benefits on the program began.
• breakdownCapitalForActual: boolean
  Enables you breakdown spends total into spends capital.
• breakdownCapitalForForecast: boolean
  Enables you breakdown forecast total into forecast capital.
• breakdownCapitalForPlannedBudget: boolean
  Enables you breakdown planned budget total into planned budget capital.
• breakdownExpenseForActual: boolean
  Enables you breakdown spends total into spends expense.
• breakdownExpenseForForecast: boolean
  Enables you breakdown forecast total into forecast expense.
• breakdownExpenseForPlannedBudget: boolean
  Enables you breakdown planned budget total into planned budget expense.
• businessImpact: string
  Maximum Length: 4000

  A detailed description of the business impact of the program.
• codeValues: array codeValues
  The list of code values for a program. This entity can only be used to assign codeValues or create codeValues on the fly.
• configuredFields: array configuredFields
  The list of configured fields for a program.
• createDate: string (date-time)
  The date the program was added.
• createUser: string
  Maximum Length: 255

  The user who added the program.
• description: string
  Maximum Length: 4000

  The detailed summary for the program. 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.
• evaluationMatrixId: integer (int64)
  The unique identifier for the program evaluation.
• evaluationScore: number (double)
  The quantitative score of a program based on the qualitative ranking of programs against different evaluation categories. This value is used by portfolio managers to prioritize programs.
• forecastFinishDate: string (date-time)
  The planned finish date of a program's remaining Forecast cost.
• forecastLinkType: string
  Maximum Length: 255

  The field source for the forecast curve in cash flow.
• forecastStartDate: string (date-time)
  The planned start date of a program's remaining Forecast cost.
• lastProgramEvaluationDate: string (date-time)
  The most recent evaluation date for the program.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• linkedObjects: array linkedObjects
  The list of projects linked to the program.
• linkForecastToSpend: boolean
  Enables you to link program Forecast data to program Actuals data.
  When linked, any updates to the program's Actuals values will automatically be applied to the program's Forecast values.
• owner: string
  Maximum Length: 255

  The manager or person responsible for the program.
• plannedBudgetLinkType: string
  Maximum Length: 255

  The field source for the planned budget curve in cash flow.
• plannedFinish: string (date-time)
  The finish date for the time phased Planned Budget of the program.
  Planned Budget cost spread will adjust when this date is changed.
• plannedStart: string (date-time)
  The start date for the time phased Planned Budget of the program.
  Planned Budget cost spread will adjust when this date is changed.
  The Program Planned Start also represents the earliest date that activities can occur within a program schedule.
• problemOrOpportunity: string
  Maximum Length: 4000

  A detailed description of the problem or opportunity the program addresses.
• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programFinancial: programFinancial
  The financial fields associated with a program.
• programId: integer (int64)
  The unique identifier for the program.
• programName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the program.
• programPhaseFinancials: array programPhaseFinancials
  The program cashflow data associated with the program.
• programSettings: array programSettings
  The program settings associated with the program.
• riskMatrixId: integer (int64)
  The risk matrix assigned to the program for calculating program risk scores.
• spendEffectiveDate: string (date-time)
  The month in which an actuals value was last added to the program
• spendFinishDate: string (date-time)
  The finish date for the program actuals.
• spendStartDate: string (date-time)
  The start date for the program actuals.
• status: string
  Allowed Values: [ "PLANNED", "ACTIVE", "INACTIVE", "ON_HOLD", "COMPLETE" ]

  The current status of the program.
• statusDate: string (date-time)
  The date and time the program status was changed.
• strategicObjective: string
  Maximum Length: 4000

  A detailed description of the strategic object of the program.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• updateUser: string
  Maximum Length: 255

  The user who last modified the program
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ApiEntityProgramResponse",
    "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",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "breakdownCapitalForPlannedBudget":{
            "type":"boolean",
            "description":"Enables you breakdown planned budget total into planned budget capital.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "breakdownExpenseForPlannedBudget":{
            "type":"boolean",
            "description":"Enables you breakdown planned budget total into planned budget expense.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "breakdownCapitalForActual":{
            "type":"boolean",
            "description":"Enables you breakdown spends total into spends capital.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "breakdownExpenseForActual":{
            "type":"boolean",
            "description":"Enables you breakdown spends total into spends expense.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "breakdownCapitalForForecast":{
            "type":"boolean",
            "description":"Enables you breakdown forecast total into forecast capital.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "breakdownExpenseForForecast":{
            "type":"boolean",
            "description":"Enables you breakdown forecast total into forecast expense.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "programSettings":{
            "type":"array",
            "description":"The program settings associated with the program.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramSetting",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "programPhaseFinancials":{
            "type":"array",
            "description":"The program cashflow data associated with the program.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramPhaseFinancial",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "programFinancial":{
            "description":"The financial fields associated with a program.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProgramFinancial"
                }
            ]
        },
        "owner":{
            "maxLength":"255",
            "type":"string",
            "description":"The manager or person responsible for the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "status":{
            "type":"string",
            "description":"The current status of the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PLANNED",
                "ACTIVE",
                "INACTIVE",
                "ON_HOLD",
                "COMPLETE"
            ]
        },
        "description":{
            "maxLength":"4000",
            "type":"string",
            "description":"The detailed summary for the program. 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.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "spendStartDate":{
            "type":"string",
            "description":"The start date for the program actuals.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateUser":{
            "maxLength":"255",
            "type":"string",
            "description":"The user who last modified the program",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "createDate":{
            "type":"string",
            "description":"The date the program was added.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "createUser":{
            "maxLength":"255",
            "type":"string",
            "description":"The user who added the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a program.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramConfiguredFieldValue",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "codeValues":{
            "type":"array",
            "description":"The list of code values for a program. This entity can only be used to assign codeValues or create codeValues on the fly.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCodeValueProgram",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "evaluationMatrixId":{
            "type":"integer",
            "description":"The unique identifier for the program evaluation.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "plannedStart":{
            "type":"string",
            "description":"The start date for the time phased Planned Budget of the program. <br />Planned Budget cost spread will adjust when this date is changed. <br />The Program Planned Start also represents the earliest date that activities can occur within a program schedule.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "plannedFinish":{
            "type":"string",
            "description":"The finish date for the time phased Planned Budget of the program. <br />Planned Budget cost spread will adjust when this date is changed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "actualStart":{
            "type":"string",
            "description":"The Actual Start indicates the date work on the program began. <br />This value can be entered manually or can be imported.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "actualFinish":{
            "type":"string",
            "description":"The Actual Finish displays the date on which a program is considered complete. <br />This value can be entered manually or can be imported.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "problemOrOpportunity":{
            "maxLength":"4000",
            "type":"string",
            "description":"A detailed description of the problem or opportunity the program addresses.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "businessImpact":{
            "maxLength":"4000",
            "type":"string",
            "description":"A detailed description of the business impact of the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "strategicObjective":{
            "maxLength":"4000",
            "type":"string",
            "description":"A detailed description of the strategic object of the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "forecastFinishDate":{
            "type":"string",
            "description":"The planned finish date of a program's remaining Forecast cost.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "forecastStartDate":{
            "type":"string",
            "description":"The planned start date of a program's remaining Forecast cost.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "spendFinishDate":{
            "type":"string",
            "description":"The finish date for the program actuals.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "benefitsStartDate":{
            "type":"string",
            "description":"The date benefits on the program began.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "benefitsFinishDate":{
            "type":"string",
            "description":"The date benefits on the program finished.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "evaluationScore":{
            "type":"number",
            "description":"The quantitative score of a program based on the qualitative ranking of programs against different evaluation categories. This value is used by portfolio managers to prioritize programs.",
            "format":"double",
            "exampleSetFlag":false
        },
        "lastProgramEvaluationDate":{
            "type":"string",
            "description":"The most recent evaluation date for the program.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskMatrixId":{
            "type":"integer",
            "description":"The risk matrix assigned to the program for calculating program risk scores.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "spendEffectiveDate":{
            "type":"string",
            "description":"The month in which an actuals value was last added to the program ",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "linkForecastToSpend":{
            "type":"boolean",
            "description":"Enables you to link program Forecast data to program Actuals data. <br />When linked, any updates to the program's Actuals values will automatically be applied to the program's Forecast values.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "linkedObjects":{
            "type":"array",
            "description":"The list of projects linked to the program.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramLinkedObject",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "actualsLinkType":{
            "maxLength":"255",
            "type":"string",
            "description":"The field source for the actuals curve in cash flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "forecastLinkType":{
            "maxLength":"255",
            "type":"string",
            "description":"The field source for the forecast curve in cash flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "plannedBudgetLinkType":{
            "maxLength":"255",
            "type":"string",
            "description":"The field source for the planned budget curve in cash flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "benefitsLinkType":{
            "maxLength":"255",
            "type":"string",
            "description":"The field source for the benefit curve in cash flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "statusDate":{
            "type":"string",
            "description":"The date and time the program status was changed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : codeValues

Type: array

The list of code values for a program. This entity can only be used to assign codeValues or create codeValues on the fly.

Show Source

• Array of: object ApiEntityCodeValueProgram
  Title: ApiEntityCodeValueProgram

{
    "type":"array",
    "description":"The list of code values for a program. This entity can only be used to assign codeValues or create codeValues on the fly.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCodeValueProgram",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a program.

Show Source

• Array of: object ApiEntityProgramConfiguredFieldValue
  Title: ApiEntityProgramConfiguredFieldValue

{
    "type":"array",
    "description":"The list of configured fields for a program.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramConfiguredFieldValue",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : linkedObjects

Type: array

The list of projects linked to the program.

Show Source

• Array of: object ApiEntityProgramLinkedObject
  Title: ApiEntityProgramLinkedObject

{
    "type":"array",
    "description":"The list of projects linked to the program.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramLinkedObject",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : programFinancial

The financial fields associated with a program.

Match All

Show Source

• object ApiEntityProgramFinancial
  Title: ApiEntityProgramFinancial

{
    "description":"The financial fields associated with a program.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityProgramFinancial"
        }
    ]
}

Nested Schema : programPhaseFinancials

Type: array

The program cashflow data associated with the program.

Show Source

• Array of: object ApiEntityProgramPhaseFinancial
  Title: ApiEntityProgramPhaseFinancial

{
    "type":"array",
    "description":"The program cashflow data associated with the program.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramPhaseFinancial",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : programSettings

Type: array

The program settings associated with the program.

Show Source

• Array of: object ApiEntityProgramSetting
  Title: ApiEntityProgramSetting

{
    "type":"array",
    "description":"The program settings associated with the program.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramSetting",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCodeValueProgram

Type: object

Title: ApiEntityCodeValueProgram

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide a value for this field during object update to delete code value assigned to the object.
• codeTypeCode: string
  Maximum Length: 60

  This field displays the name of a code or value.
• codeTypeId: integer (int64)
  The ID for the code type.
• codeValueCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the code value.
• codeValueId: integer (int64)
  The unique identifier for the code value.
• codeValueName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the code value.
• codeValueObjectId: integer (int64)
  The system-generated unique identifier for the code value assignment. This value should not be provided in create operation request data, however, it is required for update requests.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• parentId: integer (int64)
  The unique identifier of a parent code value.
• programId: integer (int64)
  The unique identifier for the program.
• sequenceNumber: integer (int32)
  The number that specifies the position of the code value item within the code type list.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityCodeValueProgram",
    "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"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The number that specifies the position of the code value item within the code type list.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide a value for this field during object update to delete code value assigned to the object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The ID for the code type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "maxLength":"60",
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueObjectId":{
            "type":"integer",
            "description":"The system-generated unique identifier for the code value assignment. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramConfiguredFieldValue

Type: object

Title: ApiEntityProgramConfiguredFieldValue

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• columnDefinitionId: integer (int64)
  Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
• columnLabel: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column label.
• columnName: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column name.
• configuredFieldObjectId: integer (int64)
  The unique identifier for the Program Configured Field.
• costValue: number
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueWorkspace1: number (double)
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  This holds values for Cost type configured fields in the workspace3 currency conversion.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• exceptionMessage: string
  Maximum Length: 4000

  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• numberValue: number
  This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
• programId: integer (int64)
  The system-generated identifier of a Program.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityProgramConfiguredFieldValue",
    "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"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The system-generated identifier of a Program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "configuredFieldObjectId":{
            "type":"integer",
            "description":"The unique identifier for the Program Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"Provides the error message for why the formula calculation resulted in an error.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"Determines if formula calculation hit an error calculating a value for this field.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramLinkedObject

Type: object

Title: ApiEntityProgramLinkedObject

Show Source

• action: string
  Allowed Values: [ "DELETE" ]
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• objectId: integer (int64)
  The system-generated identifier of a program linked object.
• objectType: string
  Maximum Length: 255

  The type of linked object.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityProgramLinkedObject",
    "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"
            ]
        },
        "objectType":{
            "maxLength":"255",
            "type":"string",
            "description":"The type of linked object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "action":{
            "type":"string",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "objectId":{
            "type":"integer",
            "description":"The system-generated identifier of a program linked object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramFinancial

Type: object

Title: ApiEntityProgramFinancial

Show Source

• actualCapitalCostDistributed: number (double)
  The capital amount of actual expense cost allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• actualCapitalCostDistributedWorkspace1: number (double)
  The capital amount of actual expense cost allocated across the program timescale.
  This value is based on the workspace1 currency.
• actualCapitalCostDistributedWorkspace2: number (double)
  The capital amount of actual expense cost allocated across the program timescale.
  This value is based on the workspace2 currency.
• actualCapitalCostDistributedWorkspace3: number (double)
  The capital amount of actual expense cost allocated across the program timescale.
  This value is based on the workspace3 currency.
• actualCapitalCostPresentValue: number (double)
  The capital present value, also known as discounted value, of the overall program actuals.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the base currency with specified exchange rate.
• actualCapitalCostPresentValueWorkspace1: number (double)
  The capital present value, also known as discounted value, of the overall program actuals.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace1 currency.
• actualCapitalCostPresentValueWorkspace2: number (double)
  The capital present value, also known as discounted value, of the overall program actuals.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the 2 currency.
• actualCapitalCostPresentValueWorkspace3: number (double)
  The capital present value, also known as discounted value, of the overall program actuals.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace3 currency.
• actualCapitalCostUndistributed: number (double)
  The capital amount of actual expense cost unallocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• actualCapitalCostUndistributedWorkspace1: number (double)
  The capital amount of actual expense cost unallocated across the program timescale.
  This value is based on the workspace1 currency.
• actualCapitalCostUndistributedWorkspace2: number (double)
  The capital amount of actual expense cost unallocated across the program timescale.
  This value is based on the workspace2 currency.
• actualCapitalCostUndistributedWorkspace3: number (double)
  The capital amount of actual expense cost unallocated across the program timescale.
  This value is based on the workspace3 currency.
• actualCostDistributed: number (double)
  The amount of actual cost currently allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• actualCostDistributedWorkspace1: number (double)
  The amount of actual cost currently allocated across the program timescale.
  This value is based on the workspace1 currency.
• actualCostDistributedWorkspace2: number (double)
  The amount of actual cost currently allocated across the program timescale.
  This value is based on the workspace1 currency.
• actualCostDistributedWorkspace3: number (double)
  The amount of actual cost currently allocated across the program timescale.
  This value is based on the workspace1 currency.
• actualCostPresentValue: number (double)
  The present value, also known as discounted value, of the overall program actuals. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
• actualCostPresentValueWorkspace1: number (double)
  The present value, also known as discounted value, of the overall program actuals.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace1 currency.
• actualCostPresentValueWorkspace2: number (double)
  The present value, also known as discounted value, of the overall program actuals.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace2 currency.
• actualCostPresentValueWorkspace3: number (double)
  The present value, also known as discounted value, of the overall program actuals.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace3 currency.
• actualCostUndistributed: number (double)
  The amount of actual cost currently allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• actualCostUndistributedWorkspace1: number (double)
  The amount of actual cost currently allocated across the program timescale.
  This value is based on the workspace1 currency.
• actualCostUndistributedWorkspace2: number (double)
  The amount of actual cost currently allocated across the program timescale.
  This value is based on the workspace1 currency.
• actualCostUndistributedWorkspace3: number (double)
  The amount of actual cost currently allocated across the program timescale.
  This value is based on the workspace1 currency.
• actualExpenseCostDistributed: number (double)
  The capital amount of actual capital cost allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• actualExpenseCostDistributedWorkspace1: number (double)
  The capital amount of actual capital cost allocated across the program timescale.
  This value is based on the workspace1 currency.
• actualExpenseCostDistributedWorkspace2: number (double)
  The capital amount of actual capital cost allocated across the program timescale.
  This value is based on the workspace2 currency.
• actualExpenseCostDistributedWorkspace3: number (double)
  The capital amount of actual capital cost allocated across the program timescale.
  This value is based on the workspace3 currency.
• actualExpenseCostPresentValue: number (double)
  The expense present value, also known as discounted value, of the overall program actuals.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the base currency with specified exchange rate.
• actualExpenseCostPresentValueWorkspace1: number (double)
  The expense present value, also known as discounted value, of the overall program actuals.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace1 currency.
• actualExpenseCostPresentValueWorkspace2: number (double)
  The expense present value, also known as discounted value, of the overall program actuals.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace2 currency.
• actualExpenseCostPresentValueWorkspace3: number (double)
  The expense present value, also known as discounted value, of the overall program actuals.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace3 currency.
• actualExpenseCostUndistributed: number (double)
  The capital amount of actual capital cost unallocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• actualExpenseCostUndistributedWorkspace1: number (double)
  The capital amount of actual capital cost unallocated across the program timescale.
  This value is based on the workspace1 currency.
• actualExpenseCostUndistributedWorkspace2: number (double)
  The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the workspace2 currency.
• actualExpenseCostUndistributedWorkspace3: number (double)
  The capital amount of actual capital cost unallocated across the program timescale.
  This value is based on the workspace3 currency.
• annualDiscountRate: number (double)
  Minimum Value: 0

  Maximum Value: 1

  The interest rate associated with the cost of an investment from your commercial bank or another funding source.
  For example, an annual growth rate of an investment such as 4.75% can be used as an annual discount rate. This rate is used when a future value is assumed and you are trying to find the required Net Present Value.
  This value can be entered manually or can be imported.
• benefits: number (double)
  Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
• benefitsDistributed: number (double)
  The amount of benefits currently allocated across the program timescale.
• benefitsDistributedWorkspace1: number (double)
  The amount of benefits currently allocated across the program timescale.
  This value is based on the workspace1 currency.
• benefitsDistributedWorkspace2: number (double)
  The amount of benefits currently allocated across the program timescale.
  This value is based on the workspace2 currency.
• benefitsDistributedWorkspace3: number (double)
  The amount of benefits currently allocated across the program timescale.
  This value is based on the workspace3 currency.
• benefitsOutOfSync: boolean
  Indicates whether the Benefits roll-up from projects is out of sync.
• benefitsPresentValue: number (double)
  The present value, also known as the discounted value, of the overall program benefits. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
• benefitsPresentValueWorkspace1: number (double)
  The present value, also known as the discounted value, of the overall program benefits. Future cash flows are discounted using the program's annual discount rate.
  Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace1 currency.
• benefitsPresentValueWorkspace2: number (double)
  The present value, also known as the discounted value, of the overall program benefits. Future cash flows are discounted using the program's annual discount rate.
  Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace2 currency.
• benefitsPresentValueWorkspace3: number (double)
  The present value, also known as the discounted value, of the overall program benefits. Future cash flows are discounted using the program's annual discount rate.
  Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace3 currency.
• benefitsUndistributed: number (double)
  The amount of benefits that have not been allocated across the program timescale.
• benefitsUndistributedWorkspace1: number (double)
  The amount of benefits currently unallocated across the program timescale.
  This value is based on the workspace1 currency.
• benefitsUndistributedWorkspace2: number (double)
  The amount of benefits currently unallocated across the program timescale.
  This value is based on the workspace2 currency.
• benefitsUndistributedWorkspace3: number (double)
  The amount of benefits currently unallocated across the program timescale.
  This value is based on the workspace3 currency.
• benefitsWorkspace1: number (double)
  Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
  This value is based on the workspace1 currency.
• benefitsWorkspace2: number (double)
  Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
  This value is based on the workspace2 currency.
• benefitsWorkspace3: number (double)
  Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
  This value is based on the workspace3 currency.
• costPerfIndex: number (double)
  The measure of a program's cost efficiency.
  A value of less than 1 indicates the program is over budget, while a value greater than 1 indicates the program is under budget.
  This value can be entered manually or can be imported.
• costVariance: number (double)
  The measure of cost performance on a program.
  A negative value indicates that the Actual Cost has exceeded the planned value.
  This value can be entered manually or can be imported.
• costVarianceWorkspace1: number (double)
  The measure of cost performance on a program.
  A negative value indicates that the Actual Cost has exceeded the planned value.
  This value can be entered manually or can be imported.
  This value is based on the workspace1 currency.
• costVarianceWorkspace2: number (double)
  The measure of cost performance on a program.
  A negative value indicates that the Actual Cost has exceeded the planned value.
  This value can be entered manually or can be imported.
  This value is based on the workspace2 currency.
• costVarianceWorkspace3: number (double)
  The measure of cost performance on a program.
  A negative value indicates that the Actual Cost has exceeded the planned value.
  This value can be entered manually or can be imported.
  This value is based on the workspace3 currency.
• earnedValueCost: number (double)
  The value of work performed on a program in reference to the approved budget for the program.
  The cost value used for the Earned Value Management of a program.
  Earned Value Management allows program managers to quantify program progress and objectively measure a program's success.
  This value can be entered manually or can be imported.
• earnedValueCostWorkspace1: number (double)
  The value of work performed on a program in reference to the approved budget for the program.
  The cost value used for the Earned Value Management of a program.
  Earned Value Management allows program managers to quantify program progress and objectively measure a program's success.
  This value can be entered manually or can be imported.
  This value is based on the workspace1 currency.
• earnedValueCostWorkspace2: number (double)
  The value of work performed on a program in reference to the approved budget for the program.
  The cost value used for the Earned Value Management of a program.
  Earned Value Management allows program managers to quantify program progress and objectively measure a program's success.
  This value can be entered manually or can be imported.
  This value is based on the workspace2 currency.
• earnedValueCostWorkspace3: number (double)
  The value of work performed on a program in reference to the approved budget for the program.
  The cost value used for the Earned Value Management of a program.
  Earned Value Management allows program managers to quantify program progress and objectively measure a program's success.
  This value can be entered manually or can be imported.
  This value is based on the workspace3 currency.
• estAtCompleteCost: number (double)
  The expected total cost of the program when the defined scope of work will be completed.
  This value can be entered manually or can be imported.
• estAtCompleteCostWorkspace1: number (double)
  The expected total cost of the program when the defined scope of work will be completed.
  This value can be entered manually or can be imported.
  This value is based on the workspace1 currency.
• estAtCompleteCostWorkspace2: number (double)
  The expected total cost of the program when the defined scope of work will be completed.
  This value can be entered manually or can be imported.
  This value is based on the workspace2 currency.
• estAtCompleteCostWorkspace3: number (double)
  The expected total cost of the program when the defined scope of work will be completed.
  This value can be entered manually or can be imported.
  This value is based on the workspace3 currency.
• estToCompleteCost: number (double)
  The estimated cost needed to complete the program.
  This value can be entered manually or can be imported.
• estToCompleteCostWorkspace1: number (double)
  The estimated cost needed to complete the program.
  This value can be entered manually or can be imported.
  This value is based on the workspace1 currency.
• estToCompleteCostWorkspace2: number (double)
  The estimated cost needed to complete the program.
  This value can be entered manually or can be imported.
  This value is based on the workspace2 currency.
• estToCompleteCostWorkspace3: number (double)
  The estimated cost needed to complete the program.
  This value can be entered manually or can be imported.
  This value is based on the workspace3 currency.
• forecastCapitalCost: number (double)
  The total capital estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the base currency with specified exchange rate.
• forecastCapitalCostDistributed: number (double)
  The capital amount of forecast cost allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• forecastCapitalCostDistributedWorkspace1: number (double)
  The capital amount of forecast cost allocated across the program timescale.
  This value is based on the workspace1 currency.
• forecastCapitalCostDistributedWorkspace2: number (double)
  The capital amount of forecast cost allocated across the program timescale.
  This value is based on the workspace2 currency.
• forecastCapitalCostDistributedWorkspace3: number (double)
  The capital amount of forecast cost allocated across the program timescale.
  This value is based on the workspace3 currency.
• forecastCapitalCostPresentValue: number (double)
  The capital present value, also known as the discounted value, of the overall program forecast.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the base currency with specified exchange rate.
• forecastCapitalCostPresentValueWorkspace1: number (double)
  The capital present value, also known as the discounted value, of the overall program forecast.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace1 currency.
• forecastCapitalCostPresentValueWorkspace2: number (double)
  The capital present value, also known as the discounted value, of the overall program forecast.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace2 currency.
• forecastCapitalCostPresentValueWorkspace3: number (double)
  The capital present value, also known as the discounted value, of the overall program forecast.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace3 currency.
• forecastCapitalCostUndistributed: number (double)
  The capital amount of forecast cost unallocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• forecastCapitalCostUndistributedWorkspace1: number (double)
  The capital amount of forecast cost unallocated across the program timescale.
  This value is based on the workspace1 currency.
• forecastCapitalCostUndistributedWorkspace2: number (double)
  The capital amount of forecast cost unallocated across the program timescale.
  This value is based on the workspace2 currency.
• forecastCapitalCostUndistributedWorkspace3: number (double)
  The capital amount of forecast cost unallocated across the program timescale.
  This value is based on the workspace3 currency.
• forecastCapitalCostWorkspace1: number (double)
  The total capital estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the workspace1 currency.
• forecastCapitalCostWorkspace2: number (double)
  The total capital estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the workspace2 currency.
• forecastCapitalCostWorkspace3: number (double)
  The total capital estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the workspace3 currency.
• forecastCost: number (double)
  The total estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
• forecastCostDistributed: number (double)
  The amount of forecast cost currently allocated across the program timescale.
• forecastCostDistributedWorkspace1: number (double)
  The amount of forecast cost currently allocated across the program timescale.
  This value is based on the workspace1 currency.
• forecastCostDistributedWorkspace2: number (double)
  The amount of forecast cost currently allocated across the program timescale.
  This value is based on the workspace2 currency.
• forecastCostDistributedWorkspace3: number (double)
  The amount of forecast cost currently allocated across the program timescale.
  This value is based on the workspace3 currency.
• forecastCostPresentValue: number (double)
  The present value, also known as the discounted value, of the overall program forecast. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
• forecastCostPresentValueWorkspace1: number (double)
  The present value, also known as the discounted value, of the overall program forecast.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace1 currency.
• forecastCostPresentValueWorkspace2: number (double)
  The present value, also known as the discounted value, of the overall program forecast.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace2 currency.
• forecastCostPresentValueWorkspace3: number (double)
  The present value, also known as the discounted value, of the overall program forecast.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace3 currency.
• forecastCostUndistributed: number (double)
  The amount of forecast cost unallocated across the program timescale.
• forecastCostUndistributedWorkspace1: number (double)
  The amount of forecast cost currently unallocated across the program timescale.
  This value is based on the workspace1 currency.
• forecastCostUndistributedWorkspace2: number (double)
  The amount of forecast cost currently unallocated across the program timescale.
  This value is based on the workspace2 currency.
• forecastCostUndistributedWorkspace3: number (double)
  The amount of forecast cost currently unallocated across the program timescale.
  This value is based on the workspace3 currency.
• forecastCostWorkspace1: number (double)
  The total estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the workspace1 currency.
• forecastCostWorkspace2: number (double)
  The total estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the workspace2 currency.
• forecastCostWorkspace3: number (double)
  The total estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the workspace3 currency.
• forecastExpenseCost: number (double)
  The total expense estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the base currency with specified exchange rate.
• forecastExpenseCostDistributed: number (double)
  The expense amount of forecast cost allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• forecastExpenseCostDistributedWorkspace1: number (double)
  The expense amount of forecast cost allocated across the program timescale.
  This value is based on the workspace1 currency.
• forecastExpenseCostDistributedWorkspace2: number (double)
  The expense amount of forecast cost allocated across the program timescale.
  This value is based on the workspace2 currency.
• forecastExpenseCostDistributedWorkspace3: number (double)
  The expense amount of forecast cost allocated across the program timescale.
  This value is based on the workspace3 currency.
• forecastExpenseCostPresentValue: number (double)
  The expense present value, also known as the discounted value, of the overall program forecast.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the base currency with specified exchange rate.
• forecastExpenseCostPresentValueWorkspace1: number (double)
  The expense present value, also known as the discounted value, of the overall program forecast.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace1 currency.
• forecastExpenseCostPresentValueWorkspace2: number (double)
  The expense present value, also known as the discounted value, of the overall program forecast.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace2 currency.
• forecastExpenseCostPresentValueWorkspace3: number (double)
  The expense present value, also known as the discounted value, of the overall program forecast.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace3 currency.
• forecastExpenseCostUndistributed: number (double)
  The expense amount of forecast cost unallocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• forecastExpenseCostUndistributedWorkspace1: number (double)
  The expense amount of forecast cost unallocated across the program timescale.
  This value is based on the workspace1 currency.
• forecastExpenseCostUndistributedWorkspace2: number (double)
  The expense amount of forecast cost unallocated across the program timescale.
  This value is based on the workspace2 currency.
• forecastExpenseCostUndistributedWorkspace3: number (double)
  The expense amount of forecast cost unallocated across the program timescale.
  This value is based on the workspace3 currency.
• forecastExpenseCostWorkspace1: number (double)
  The total expense estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the workspace1 currency.
• forecastExpenseCostWorkspace2: number (double)
  The total expense estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the workspace2 currency.
• forecastExpenseCostWorkspace3: number (double)
  The total expense estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the workspace3 currency.
• forecastOutOfSync: boolean
  Indicates whether the Forecast roll-up from projects is out of sync.
• intRateOfReturn: number (double)
  The quantitative measurement used to compare the profitability of program investments.
  The rate at which investors will receive returns on their investments in a program.
  This value can be entered manually or can be imported.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• netPresentValue: number (double)
  The difference between the present value (PV) of the future cash flows from current investments and program costs.
  The Net Present Value accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
  Positive Net Present Value (NPV) is an indicator of programs that should be pursued.
  This value can be entered manually or can be imported.
• netPresentValueWorkspace1: number (double)
  The difference between the Present Value (PV) of the future cash flows from current investments and program costs.
  The Net Present Value (NPV) accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
  A positive NPV is an indicator of programs that should be pursued.
  This value can be entered manually or can be imported.
  This value is based on the workspace1 currency.
• netPresentValueWorkspace2: number (double)
  The difference between the Present Value (PV) of the future cash flows from current investments and program costs.
  The Net Present Value (NPV) accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
  A positive NPV is an indicator of programs that should be pursued.
  This value can be entered manually or can be imported.
  This value is based on the workspace2 currency.
• netPresentValueWorkspace3: number (double)
  The difference between the Present Value (PV) of the future cash flows from current investments and program costs.
  The Net Present Value (NPV) accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
  A positive NPV is an indicator of programs that should be pursued.
  This value can be entered manually or can be imported.
  This value is based on the workspace3 currency.
• paybackPeriod: number (double)
  The estimate of the length of time that will transpire before net profits recover the initial and periodic costs of an investment to carry out the selected program.
  
  
  This value can be entered manually or can be imported.
• plannedBudget: number (double)
  The planned total cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
• plannedBudgetCapital: number (double)
  The planned total capital cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetCapitalDistributed: number (double)
  The capital amount of planned budget allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetCapitalDistributedWorkspace1: number (double)
  The capital amount of planned budget allocated across the program timescale.
  This value is based on the workspace1 currency.
• plannedBudgetCapitalDistributedWorkspace2: number (double)
  The capital amount of planned budget allocated across the program timescale.
  This value is based on the workspace2 currency.
• plannedBudgetCapitalDistributedWorkspace3: number (double)
  The capital amount of planned budget allocated across the program timescale.
  This value is based on the workspace3 currency.
• plannedBudgetCapitalPresentValue: number (double)
  The capital present value, also known as the discounted value, of the overall program planned budget.Future cash flows are discounted using the program's annual discount rate.
  Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetCapitalPresentValueWorkspace1: number (double)
  The capital present value, also known as the discounted value, of the overall program planned budget.Future cash flows are discounted using the program's annual discount rate.
  Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace1 currency.
• plannedBudgetCapitalPresentValueWorkspace2: number (double)
  The capital present value, also known as the discounted value, of the overall program planned budget.Future cash flows are discounted using the program's annual discount rate.
  Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace2 currency.
• plannedBudgetCapitalPresentValueWorkspace3: number (double)
  The capital present value, also known as the discounted value, of the overall program planned budget.Future cash flows are discounted using the program's annual discount rate.
  Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace3 currency.
• plannedBudgetCapitalUndistributed: number (double)
  The capital amount of planned budget unallocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetCapitalUndistributedWorkspace1: number (double)
  The capital amount of planned budget unallocated across the program timescale.
  This value is based on the workspace1 currency.
• plannedBudgetCapitalUndistributedWorkspace2: number (double)
  The capital amount of planned budget unallocated across the program timescale.
  This value is based on the workspace2 currency.
• plannedBudgetCapitalUndistributedWorkspace3: number (double)
  The capital amount of planned budget unallocated across the program timescale.
  This value is based on the workspace3 currency.
• plannedBudgetCapitalWorkspace1: number (double)
  The planned total capital cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the workspace1 currency.
• plannedBudgetCapitalWorkspace2: number (double)
  The planned total capital cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the workspace2 currency.
• plannedBudgetCapitalWorkspace3: number (double)
  The planned total capital cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the workspace3 currency.
• plannedBudgetDistributed: number (double)
  The amount of planned budget allocated across the program timescale.
• plannedBudgetDistributedWorkspace1: number (double)
  The amount of planned budget allocated across the program timescale.
  This value is based on the workspace1 currency.
• plannedBudgetDistributedWorkspace2: number (double)
  The amount of planned budget allocated across the program timescale.
  This value is based on the workspace2 currency.
• plannedBudgetDistributedWorkspace3: number (double)
  The amount of planned budget allocated across the program timescale.
  This value is based on the workspace3 currency.
• plannedBudgetExpense: number (double)
  The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetExpenseDistributed: number (double)
  The expense amount of planned budget allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetExpenseDistributedWorkspace1: number (double)
  The expense amount of planned budget allocated across the program timescale.
  This value is based on the workspace1 currency.
• plannedBudgetExpenseDistributedWorkspace2: number (double)
  The expense amount of planned budget allocated across the program timescale.
  This value is based on the workspace2 currency.
• plannedBudgetExpenseDistributedWorkspace3: number (double)
  The expense amount of planned budget allocated across the program timescale.
  This value is based on the workspace3 currency.
• plannedBudgetExpensePresentValue: number (double)
  The expense present value, also known as the discounted value, of the overall program planned budget.
  Future cash flows are discounted using the program's annual discount rate.
  Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetExpensePresentValueWorkspace1: number (double)
  The expense present value, also known as the discounted value, of the overall program planned budget.
  Future cash flows are discounted using the program's annual discount rate.
  Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace1 currency.
• plannedBudgetExpensePresentValueWorkspace2: number (double)
  The expense present value, also known as the discounted value, of the overall program planned budget.
  Future cash flows are discounted using the program's annual discount rate.
  Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace2 currency.
• plannedBudgetExpensePresentValueWorkspace3: number (double)
  The expense present value, also known as the discounted value, of the overall program planned budget.
  Future cash flows are discounted using the program's annual discount rate.
  Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace2 currency.
• plannedBudgetExpenseUndistributed: number (double)
  The expense amount of planned budget unallocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetExpenseUndistributedWorkspace1: number (double)
  The expense amount of planned budget unallocated across the program timescale.
  This value is based on the workspace1 currency.
• plannedBudgetExpenseUndistributedWorkspace2: number (double)
  The expense amount of planned budget unallocated across the program timescale.
  This value is based on the workspace2 currency.
• plannedBudgetExpenseUndistributedWorkspace3: number (double)
  The expense amount of planned budget unallocated across the program timescale.
  This value is based on the workspace3 currency.
• plannedBudgetExpenseWorkspace1: number (double)
  The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the workspace1 currency.
• plannedBudgetExpenseWorkspace2: number (double)
  The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the workspace2 currency.
• plannedBudgetExpenseWorkspace3: number (double)
  The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the workspace3 currency.
• plannedBudgetOutOfSync: boolean
  Indicates whether the Planned Budget roll-up from projects is out of sync.
• plannedBudgetPresentValue: number (double)
  The present value, also known as the discounted value, of the overall program planned budget. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
• plannedBudgetPresentValueWorkspace1: number (double)
  The present value, also known as the discounted value, of the overall program planned budget. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace1 currency.
• plannedBudgetPresentValueWorkspace2: number (double)
  The present value, also known as the discounted value, of the overall program planned budget. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace2 currency.
• plannedBudgetPresentValueWorkspace3: number (double)
  The present value, also known as the discounted value, of the overall program planned budget. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the workspace3 currency.
• plannedBudgetUndistributed: number (double)
  The amount of planned budget unallocated across the program timescale.
• plannedBudgetUndistributedWorkspace1: number (double)
  The amount of planned budget unallocated across the program timescale.
  This value is based on the workspace1 currency.
• plannedBudgetUndistributedWorkspace2: number (double)
  The amount of planned budget unallocated across the program timescale.
  This value is based on the workspace2 currency.
• plannedBudgetUndistributedWorkspace3: number (double)
  The amount of planned budget unallocated across the program timescale.
  This value is based on the workspace3 currency.
• plannedBudgetWorkspace1: number (double)
  The planned total cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the workspace1 currency.
• plannedBudgetWorkspace2: number (double)
  The planned total cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the workspace2 currency.
• plannedBudgetWorkspace3: number (double)
  The planned total cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the workspace3 currency.
• plannedValueCost: number (double)
  The amount of approved capital spent on a scheduled portion of work on a program.
  Planned Value Cost is often used for Earned Value Management.
  This value can be entered manually or can be imported.
• plannedValueCostWorkspace1: number (double)
  The amount of approved capital spent on a scheduled portion of work on a program.
  Planned Value Cost is often used for Earned Value Management.
  This value can be entered manually or can be imported.
  This value is based on the workspace1 currency.
• plannedValueCostWorkspace2: number (double)
  The amount of approved capital spent on a scheduled portion of work on a program.
  Planned Value Cost is often used for Earned Value Management.
  This value can be entered manually or can be imported.
  This value is based on the workspace2 currency.
• plannedValueCostWorkspace3: number (double)
  The amount of approved capital spent on a scheduled portion of work on a program.
  Planned Value Cost is often used for Earned Value Management.
  This value can be entered manually or can be imported.
  This value is based on the workspace3 currency.
• profitabilityIndex: number (double)
  The index based on the value of a program's present values divided by initial program investments.
• programId: integer (int64)
  The unique identifier for a program set by the user who created the program.
• returnOnInvestment: number (double)
  The percentage resulting from division of the expected returns of an investment by the investment costs of a program or portfolio.
  For example, a program is expected to cost 1.0 million dollars with a total benefit of 1.2 million dollars. Its Net Present Value is $200,000. The Return on Investment is 20%.
  This value can be entered manually or can be imported.
• schedPerfIndex: number (double)
  The measure of the work accomplished as a percentage of the work scheduled on a program.
  Schedule Performance Index indicates whether you are meeting earned and planned values within your program schedule.
  A value less than 1 indicates that less work was performed than was scheduled. A value greater than 1 indicates the program is ahead of schedule.
  This value can be entered manually or can be imported.
• scheduleVariance: number (double)
  The measure of schedule performance on a program.
  A negative value indicates that less work was actually performed than was scheduled.
  This value can be entered manually or can be imported.
• scheduleVarianceWorkspace1: number (double)
  The measure of schedule performance on a program.
  A negative value indicates that less work was actually performed than was scheduled.
  This value can be entered manually or can be imported.
  This value is based on the workspace1 currency.
• scheduleVarianceWorkspace2: number (double)
  The measure of schedule performance on a program.
  A negative value indicates that less work was actually performed than was scheduled.
  This value can be entered manually or can be imported.
  This value is based on the workspace2 currency.
• scheduleVarianceWorkspace3: number (double)
  The measure of schedule performance on a program.
  A negative value indicates that less work was actually performed than was scheduled.
  This value can be entered manually or can be imported.
  This value is based on the workspace3 currency.
• spendCapitalCost: number (double)
  The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the base currency with specified exchange rate.
• spendCapitalCostWorkspace1: number (double)
  The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the workspace1 currency.
• spendCapitalCostWorkspace2: number (double)
  The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the workspace2 currency.
• spendCapitalCostWorkspace3: number (double)
  The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the workspace3 currency.
• spendCost: number (double)
  The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
• spendCostWorkspace1: number (double)
  The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the workspace1 currency.
• spendCostWorkspace2: number (double)
  The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the workspace2 currency.
• spendCostWorkspace3: number (double)
  The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the workspace3 currency.
• spendExpenseCost: number (double)
  The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the base currency with specified exchange rate.
• spendExpenseCostWorkspace1: number (double)
  The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the workspace1 currency.
• spendExpenseCostWorkspace2: number (double)
  The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the workspace2 currency.
• spendExpenseCostWorkspace3: number (double)
  The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the workspace3 currency.
• spendForecastVar: number (double)
  The total and time phased variance between the program's Actuals and Forecast.
• spendForecastVarWorkspace1: number (double)
  The total and time phased variance between the program's Actuals and Forecast.
  This value is based on the workspace1 currency.
• spendForecastVarWorkspace2: number (double)
  The total and time phased variance between the program's Actuals and Forecast.
  This value is based on the workspace2 currency.
• spendForecastVarWorkspace3: number (double)
  The total and time phased variance between the program's Actuals and Forecast.
  This value is based on the workspace3 currency.
• spendPlannedVariance: number (double)
  The total and time phased variance between the program's Actuals and Planned Budget.
• spendPlannedVarianceWorkspace1: number (double)
  The total and time phased variance between the program's Actuals and Planned Budget.
  This value is based on the workspace1 currency.
• spendPlannedVarianceWorkspace2: number (double)
  The total and time phased variance between the program's Actuals and Planned Budget.
  This value is based on the workspace2 currency.
• spendPlannedVarianceWorkspace3: number (double)
  The total and time phased variance between the program's Actuals and Planned Budget.
  This value is based on the workspace3 currency.
• spendsOutOfSync: boolean
  Indicates whether the Actuals roll-up from projects is out of sync.
• updateDate: string (date-time)
  Date when the record was last updated.
• yearEndForecastCost: number (double)
  Total forecast at the end of year actuals till date, with respect to the current year.
• yearEndForecastCostWorkspace1: number (double)
  Total forecast at the end of year actuals till date, with respect to the current year.
  This value is based on the workspace1 currency.
• yearEndForecastCostWorkspace2: number (double)
  Total forecast at the end of year actuals till date, with respect to the current year.
  This value is based on the workspace2 currency.
• yearEndForecastCostWorkspace3: number (double)
  Total forecast at the end of year actuals till date, with respect to the current year.
  This value is based on the workspace3 currency.
• ytdSpendCost: number (double)
  A measurement of capital spent on a program starting from the beginning of the year up to the present date.
  YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.
• ytdSpendCostWorkspace1: number (double)
  A measurement of capital spent on a program starting from the beginning of the year up to the present date.
  YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.
  This value is based on the workspace1 currency.
• ytdSpendCostWorkspace2: number (double)
  A measurement of capital spent on a program starting from the beginning of the year up to the present date.
  YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.
  This value is based on the workspace2 currency.
• ytdSpendCostWorkspace3: number (double)
  A measurement of capital spent on a program starting from the beginning of the year up to the present date.
  YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.
  This value is based on the workspace3 currency.

{
    "title":"ApiEntityProgramFinancial",
    "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"
            ]
        },
        "forecastCapitalCostDistributedWorkspace1":{
            "type":"number",
            "description":"The capital amount of forecast cost allocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalDistributedWorkspace1":{
            "type":"number",
            "description":"The capital amount of planned budget allocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCapitalCostDistributedWorkspace1":{
            "type":"number",
            "description":"The capital amount of actual expense cost allocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualExpenseCostDistributedWorkspace1":{
            "type":"number",
            "description":"The capital amount of actual capital cost allocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCostDistributedWorkspace1":{
            "type":"number",
            "description":"The amount of actual cost currently allocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCapitalCostUndistributedWorkspace1":{
            "type":"number",
            "description":"The capital amount of actual expense cost unallocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualExpenseCostUndistributedWorkspace1":{
            "type":"number",
            "description":"The capital amount of actual capital cost unallocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCostUndistributedWorkspace1":{
            "type":"number",
            "description":"The amount of actual cost currently allocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCapitalCostDistributedWorkspace2":{
            "type":"number",
            "description":"The capital amount of actual expense cost allocated across the program timescale. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualExpenseCostDistributedWorkspace2":{
            "type":"number",
            "description":"The capital amount of actual capital cost allocated across the program timescale. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCostDistributedWorkspace2":{
            "type":"number",
            "description":"The amount of actual cost currently allocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCapitalCostUndistributedWorkspace2":{
            "type":"number",
            "description":"The capital amount of actual expense cost unallocated across the program timescale. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualExpenseCostUndistributedWorkspace2":{
            "type":"number",
            "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCostUndistributedWorkspace2":{
            "type":"number",
            "description":"The amount of actual cost currently allocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCapitalCostDistributedWorkspace3":{
            "type":"number",
            "description":"The capital amount of actual expense cost allocated across the program timescale. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualExpenseCostDistributedWorkspace3":{
            "type":"number",
            "description":"The capital amount of actual capital cost allocated across the program timescale. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCostDistributedWorkspace3":{
            "type":"number",
            "description":"The amount of actual cost currently allocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCapitalCostUndistributedWorkspace3":{
            "type":"number",
            "description":"The capital amount of actual expense cost unallocated across the program timescale. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualExpenseCostUndistributedWorkspace3":{
            "type":"number",
            "description":"The capital amount of actual capital cost unallocated across the program timescale. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCostUndistributedWorkspace3":{
            "type":"number",
            "description":"The amount of actual cost currently allocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetWorkspace1":{
            "type":"number",
            "description":"The planned total cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetWorkspace2":{
            "type":"number",
            "description":"The planned total cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetWorkspace3":{
            "type":"number",
            "description":"The planned total cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetDistributedWorkspace1":{
            "type":"number",
            "description":"The amount of planned budget allocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetDistributedWorkspace2":{
            "type":"number",
            "description":"The amount of planned budget allocated across the program timescale. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetDistributedWorkspace3":{
            "type":"number",
            "description":"The amount of planned budget allocated across the program timescale. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetUndistributedWorkspace1":{
            "type":"number",
            "description":"The amount of planned budget unallocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetUndistributedWorkspace2":{
            "type":"number",
            "description":"The amount of planned budget unallocated across the program timescale. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetUndistributedWorkspace3":{
            "type":"number",
            "description":"The amount of planned budget unallocated across the program timescale. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetPresentValueWorkspace1":{
            "type":"number",
            "description":"The present value, also known as the discounted value, of the overall program planned budget. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetPresentValueWorkspace2":{
            "type":"number",
            "description":"The present value, also known as the discounted value, of the overall program planned budget. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetPresentValueWorkspace3":{
            "type":"number",
            "description":"The present value, also known as the discounted value, of the overall program planned budget. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostWorkspace1":{
            "type":"number",
            "description":"The total estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostWorkspace2":{
            "type":"number",
            "description":"The total estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostWorkspace3":{
            "type":"number",
            "description":"The total estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostDistributedWorkspace1":{
            "type":"number",
            "description":"The amount of forecast cost currently allocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostDistributedWorkspace2":{
            "type":"number",
            "description":"The amount of forecast cost currently allocated across the program timescale. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostDistributedWorkspace3":{
            "type":"number",
            "description":"The amount of forecast cost currently allocated across the program timescale. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostUndistributedWorkspace1":{
            "type":"number",
            "description":"The amount of forecast cost currently unallocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostUndistributedWorkspace2":{
            "type":"number",
            "description":"The amount of forecast cost currently unallocated across the program timescale. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostUndistributedWorkspace3":{
            "type":"number",
            "description":"The amount of forecast cost currently unallocated across the program timescale. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostPresentValueWorkspace1":{
            "type":"number",
            "description":"The present value, also known as the discounted value, of the overall program forecast. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostPresentValueWorkspace2":{
            "type":"number",
            "description":"The present value, also known as the discounted value, of the overall program forecast. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostPresentValueWorkspace3":{
            "type":"number",
            "description":"The present value, also known as the discounted value, of the overall program forecast. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCostWorkspace1":{
            "type":"number",
            "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCostWorkspace2":{
            "type":"number",
            "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCostWorkspace3":{
            "type":"number",
            "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCostPresentValueWorkspace1":{
            "type":"number",
            "description":"The present value, also known as discounted value, of the overall program actuals. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCostPresentValueWorkspace2":{
            "type":"number",
            "description":"The present value, also known as discounted value, of the overall program actuals. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCostPresentValueWorkspace3":{
            "type":"number",
            "description":"The present value, also known as discounted value, of the overall program actuals. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendForecastVarWorkspace1":{
            "type":"number",
            "description":"The total and time phased variance between the program's Actuals and Forecast. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendForecastVarWorkspace2":{
            "type":"number",
            "description":"The total and time phased variance between the program's Actuals and Forecast. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendForecastVarWorkspace3":{
            "type":"number",
            "description":"The total and time phased variance between the program's Actuals and Forecast. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendPlannedVarianceWorkspace1":{
            "type":"number",
            "description":"The total and time phased variance between the program's Actuals and Planned Budget. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendPlannedVarianceWorkspace2":{
            "type":"number",
            "description":"The total and time phased variance between the program's Actuals and Planned Budget. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendPlannedVarianceWorkspace3":{
            "type":"number",
            "description":"The total and time phased variance between the program's Actuals and Planned Budget. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "yearEndForecastCostWorkspace1":{
            "type":"number",
            "description":"Total forecast at the end of year actuals till date, with respect to the current year. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "yearEndForecastCostWorkspace2":{
            "type":"number",
            "description":"Total forecast at the end of year actuals till date, with respect to the current year. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "yearEndForecastCostWorkspace3":{
            "type":"number",
            "description":"Total forecast at the end of year actuals till date, with respect to the current year. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "ytdSpendCostWorkspace1":{
            "type":"number",
            "description":"A measurement of capital spent on a program starting from the beginning of the year up to the present date. <br />YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "ytdSpendCostWorkspace2":{
            "type":"number",
            "description":"A measurement of capital spent on a program starting from the beginning of the year up to the present date. <br />YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "ytdSpendCostWorkspace3":{
            "type":"number",
            "description":"A measurement of capital spent on a program starting from the beginning of the year up to the present date. <br />YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costVarianceWorkspace1":{
            "type":"number",
            "description":"The measure of cost performance on a program. <br />A negative value indicates that the Actual Cost has exceeded the planned value. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costVarianceWorkspace2":{
            "type":"number",
            "description":"The measure of cost performance on a program. <br />A negative value indicates that the Actual Cost has exceeded the planned value. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costVarianceWorkspace3":{
            "type":"number",
            "description":"The measure of cost performance on a program. <br />A negative value indicates that the Actual Cost has exceeded the planned value. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "earnedValueCostWorkspace1":{
            "type":"number",
            "description":"The value of work performed on a program in reference to the approved budget for the program. <br />The cost value used for the Earned Value Management of a program. <br />Earned Value Management allows program managers to quantify program progress and objectively measure a program's success. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "earnedValueCostWorkspace2":{
            "type":"number",
            "description":"The value of work performed on a program in reference to the approved budget for the program. <br />The cost value used for the Earned Value Management of a program. <br />Earned Value Management allows program managers to quantify program progress and objectively measure a program's success. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "earnedValueCostWorkspace3":{
            "type":"number",
            "description":"The value of work performed on a program in reference to the approved budget for the program. <br />The cost value used for the Earned Value Management of a program. <br />Earned Value Management allows program managers to quantify program progress and objectively measure a program's success. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "estAtCompleteCostWorkspace1":{
            "type":"number",
            "description":"The expected total cost of the program when the defined scope of work will be completed. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "estAtCompleteCostWorkspace2":{
            "type":"number",
            "description":"The expected total cost of the program when the defined scope of work will be completed. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "estAtCompleteCostWorkspace3":{
            "type":"number",
            "description":"The expected total cost of the program when the defined scope of work will be completed. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "estToCompleteCostWorkspace1":{
            "type":"number",
            "description":"The estimated cost needed to complete the program. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "estToCompleteCostWorkspace2":{
            "type":"number",
            "description":"The estimated cost needed to complete the program. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "estToCompleteCostWorkspace3":{
            "type":"number",
            "description":"The estimated cost needed to complete the program. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedValueCostWorkspace1":{
            "type":"number",
            "description":"The amount of approved capital spent on a scheduled portion of work on a program. <br />Planned Value Cost is often used for Earned Value Management. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedValueCostWorkspace2":{
            "type":"number",
            "description":"The amount of approved capital spent on a scheduled portion of work on a program. <br />Planned Value Cost is often used for Earned Value Management. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedValueCostWorkspace3":{
            "type":"number",
            "description":"The amount of approved capital spent on a scheduled portion of work on a program. <br />Planned Value Cost is often used for Earned Value Management. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "scheduleVarianceWorkspace1":{
            "type":"number",
            "description":"The measure of schedule performance on a program. <br />A negative value indicates that less work was actually performed than was scheduled. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "scheduleVarianceWorkspace2":{
            "type":"number",
            "description":"The measure of schedule performance on a program. <br />A negative value indicates that less work was actually performed than was scheduled. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "scheduleVarianceWorkspace3":{
            "type":"number",
            "description":"The measure of schedule performance on a program. <br />A negative value indicates that less work was actually performed than was scheduled. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "netPresentValueWorkspace1":{
            "type":"number",
            "description":"The difference between the Present Value (PV) of the future cash flows from current investments and program costs. <br />The Net Present Value (NPV) accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital. <br />A positive NPV is an indicator of programs that should be pursued. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "netPresentValueWorkspace2":{
            "type":"number",
            "description":"The difference between the Present Value (PV) of the future cash flows from current investments and program costs. <br />The Net Present Value (NPV) accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital. <br />A positive NPV is an indicator of programs that should be pursued. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "netPresentValueWorkspace3":{
            "type":"number",
            "description":"The difference between the Present Value (PV) of the future cash flows from current investments and program costs. <br />The Net Present Value (NPV) accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital. <br />A positive NPV is an indicator of programs that should be pursued. <br />This value can be entered manually or can be imported. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefitsWorkspace1":{
            "type":"number",
            "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefitsWorkspace2":{
            "type":"number",
            "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefitsWorkspace3":{
            "type":"number",
            "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefitsDistributedWorkspace1":{
            "type":"number",
            "description":"The amount of benefits currently allocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefitsDistributedWorkspace2":{
            "type":"number",
            "description":"The amount of benefits currently allocated across the program timescale. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefitsDistributedWorkspace3":{
            "type":"number",
            "description":"The amount of benefits currently allocated across the program timescale. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefitsUndistributedWorkspace1":{
            "type":"number",
            "description":"The amount of benefits currently unallocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefitsUndistributedWorkspace2":{
            "type":"number",
            "description":"The amount of benefits currently unallocated across the program timescale. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefitsUndistributedWorkspace3":{
            "type":"number",
            "description":"The amount of benefits currently unallocated across the program timescale. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefitsPresentValueWorkspace1":{
            "type":"number",
            "description":"The present value, also known as the discounted value, of the overall program benefits. Future cash flows are discounted using the program's annual discount rate. <br />Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefitsPresentValueWorkspace2":{
            "type":"number",
            "description":"The present value, also known as the discounted value, of the overall program benefits. Future cash flows are discounted using the program's annual discount rate. <br />Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefitsPresentValueWorkspace3":{
            "type":"number",
            "description":"The present value, also known as the discounted value, of the overall program benefits. Future cash flows are discounted using the program's annual discount rate. <br />Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalWorkspace1":{
            "type":"number",
            "description":"The planned total capital cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalWorkspace2":{
            "type":"number",
            "description":"The planned total capital cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalWorkspace3":{
            "type":"number",
            "description":"The planned total capital cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalDistributedWorkspace2":{
            "type":"number",
            "description":"The capital amount of planned budget allocated across the program timescale. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalDistributedWorkspace3":{
            "type":"number",
            "description":"The capital amount of planned budget allocated across the program timescale. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalUndistributedWorkspace1":{
            "type":"number",
            "description":"The capital amount of planned budget unallocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalUndistributedWorkspace2":{
            "type":"number",
            "description":"The capital amount of planned budget unallocated across the program timescale. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalUndistributedWorkspace3":{
            "type":"number",
            "description":"The capital amount of planned budget unallocated across the program timescale. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalPresentValueWorkspace1":{
            "type":"number",
            "description":"The capital present value, also known as the discounted value, of the overall program planned budget.Future cash flows are discounted using the program's annual discount rate. <br />Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.  <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalPresentValueWorkspace2":{
            "type":"number",
            "description":"The capital present value, also known as the discounted value, of the overall program planned budget.Future cash flows are discounted using the program's annual discount rate. <br />Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.  <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalPresentValueWorkspace3":{
            "type":"number",
            "description":"The capital present value, also known as the discounted value, of the overall program planned budget.Future cash flows are discounted using the program's annual discount rate. <br />Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.  <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseWorkspace1":{
            "type":"number",
            "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseWorkspace2":{
            "type":"number",
            "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseWorkspace3":{
            "type":"number",
            "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseDistributedWorkspace1":{
            "type":"number",
            "description":"The expense amount of planned budget allocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseDistributedWorkspace2":{
            "type":"number",
            "description":"The expense amount of planned budget allocated across the program timescale. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseDistributedWorkspace3":{
            "type":"number",
            "description":"The expense amount of planned budget allocated across the program timescale. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseUndistributedWorkspace1":{
            "type":"number",
            "description":"The  expense amount of planned budget unallocated across the program timescale.  <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseUndistributedWorkspace2":{
            "type":"number",
            "description":"The  expense amount of planned budget unallocated across the program timescale.  <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseUndistributedWorkspace3":{
            "type":"number",
            "description":"The  expense amount of planned budget unallocated across the program timescale.  <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpensePresentValueWorkspace1":{
            "type":"number",
            "description":"The expense present value, also known as the discounted value, of the overall program planned budget. <br />Future cash flows are discounted using the program's annual discount rate. <br />Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpensePresentValueWorkspace2":{
            "type":"number",
            "description":"The expense present value, also known as the discounted value, of the overall program planned budget. <br />Future cash flows are discounted using the program's annual discount rate. <br />Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpensePresentValueWorkspace3":{
            "type":"number",
            "description":"The expense present value, also known as the discounted value, of the overall program planned budget. <br />Future cash flows are discounted using the program's annual discount rate. <br />Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostWorkspace1":{
            "type":"number",
            "description":"The total capital estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostWorkspace2":{
            "type":"number",
            "description":"The total capital estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostWorkspace3":{
            "type":"number",
            "description":"The total capital estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the workspace3 currency.                          ",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostDistributedWorkspace2":{
            "type":"number",
            "description":"The capital amount of forecast cost allocated across the program timescale. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostDistributedWorkspace3":{
            "type":"number",
            "description":"The capital amount of forecast cost allocated across the program timescale. <br />This value is based on the workspace3 currency.                        ",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostUndistributedWorkspace1":{
            "type":"number",
            "description":"The capital amount of forecast cost unallocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostUndistributedWorkspace2":{
            "type":"number",
            "description":"The capital amount of forecast cost unallocated across the program timescale. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostUndistributedWorkspace3":{
            "type":"number",
            "description":"The capital amount of forecast cost unallocated across the program timescale. <br />This value is based on the workspace3 currency.                          ",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostPresentValueWorkspace1":{
            "type":"number",
            "description":"The capital present value, also known as the discounted value, of the overall program forecast. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostPresentValueWorkspace2":{
            "type":"number",
            "description":"The capital present value, also known as the discounted value, of the overall program forecast. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostPresentValueWorkspace3":{
            "type":"number",
            "description":"The capital present value, also known as the discounted value, of the overall program forecast. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostWorkspace1":{
            "type":"number",
            "description":"The total expense estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostWorkspace2":{
            "type":"number",
            "description":"The total expense estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostWorkspace3":{
            "type":"number",
            "description":"The total expense estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostDistributedWorkspace1":{
            "type":"number",
            "description":"The expense amount of forecast cost allocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostDistributedWorkspace2":{
            "type":"number",
            "description":"The expense amount of forecast cost allocated across the program timescale. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostDistributedWorkspace3":{
            "type":"number",
            "description":"The expense amount of forecast cost allocated across the program timescale. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostUndistributedWorkspace1":{
            "type":"number",
            "description":"The expense amount of forecast cost unallocated across the program timescale. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostUndistributedWorkspace2":{
            "type":"number",
            "description":"The expense amount of forecast cost unallocated across the program timescale. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostUndistributedWorkspace3":{
            "type":"number",
            "description":"The expense amount of forecast cost unallocated across the program timescale. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostPresentValueWorkspace1":{
            "type":"number",
            "description":"The expense present value, also known as the discounted value, of the overall program forecast. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostPresentValueWorkspace2":{
            "type":"number",
            "description":"The expense present value, also known as the discounted value, of the overall program forecast. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostPresentValueWorkspace3":{
            "type":"number",
            "description":"The expense present value, also known as the discounted value, of the overall program forecast. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCapitalCostWorkspace1":{
            "type":"number",
            "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCapitalCostWorkspace2":{
            "type":"number",
            "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCapitalCostWorkspace3":{
            "type":"number",
            "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendExpenseCostWorkspace1":{
            "type":"number",
            "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendExpenseCostWorkspace2":{
            "type":"number",
            "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendExpenseCostWorkspace3":{
            "type":"number",
            "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCapitalCostPresentValueWorkspace1":{
            "type":"number",
            "description":"The capital present value, also known as discounted value, of the overall program actuals. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCapitalCostPresentValueWorkspace2":{
            "type":"number",
            "description":"The capital present value, also known as discounted value, of the overall program actuals. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the 2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCapitalCostPresentValueWorkspace3":{
            "type":"number",
            "description":"The capital present value, also known as discounted value, of the overall program actuals. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualExpenseCostPresentValueWorkspace1":{
            "type":"number",
            "description":"The expense present value, also known as discounted value, of the overall program actuals. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualExpenseCostPresentValueWorkspace2":{
            "type":"number",
            "description":"The expense present value, also known as discounted value, of the overall program actuals. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualExpenseCostPresentValueWorkspace3":{
            "type":"number",
            "description":"The expense present value, also known as discounted value, of the overall program actuals. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedValueCost":{
            "type":"number",
            "description":"The amount of approved capital spent on a scheduled portion of work on a program. <br />Planned Value Cost is often used for Earned Value Management. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false
        },
        "earnedValueCost":{
            "type":"number",
            "description":"The value of work performed on a program in reference to the approved budget for the program. <br />The cost value used for the Earned Value Management of a program. <br />Earned Value Management allows program managers to quantify program progress and objectively measure a program's success. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for a program set by the user who created the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costVariance":{
            "type":"number",
            "description":"The measure of cost performance on a program. <br />A negative value indicates that the Actual Cost has exceeded the planned value. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCapitalCostDistributed":{
            "type":"number",
            "description":"The capital amount of actual expense cost allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualExpenseCostDistributed":{
            "type":"number",
            "description":"The capital amount of actual capital cost allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCostDistributed":{
            "type":"number",
            "description":"The amount of actual cost currently allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCapitalCostUndistributed":{
            "type":"number",
            "description":"The capital amount of actual expense cost unallocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualExpenseCostUndistributed":{
            "type":"number",
            "description":"The capital amount of actual capital cost unallocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCostUndistributed":{
            "type":"number",
            "description":"The amount of actual cost currently allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetDistributed":{
            "type":"number",
            "description":"The amount of planned budget allocated across the program timescale.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudget":{
            "type":"number",
            "description":"The planned total cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetUndistributed":{
            "type":"number",
            "description":"The amount of planned budget unallocated across the program timescale.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetPresentValue":{
            "type":"number",
            "description":"The present value, also known as the discounted value, of the overall program planned budget. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCost":{
            "type":"number",
            "description":"The total estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostDistributed":{
            "type":"number",
            "description":"The amount of forecast cost currently allocated across the program timescale.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostUndistributed":{
            "type":"number",
            "description":"The amount of forecast cost unallocated across the program timescale.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostPresentValue":{
            "type":"number",
            "description":"The present value, also known as the discounted value, of the overall program forecast. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCost":{
            "type":"number",
            "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCostPresentValue":{
            "type":"number",
            "description":"The present value, also known as discounted value, of the overall program actuals. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendForecastVar":{
            "type":"number",
            "description":"The total and time phased variance between the program's Actuals and Forecast.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendPlannedVariance":{
            "type":"number",
            "description":"The total and time phased variance between the program's Actuals and Planned Budget.",
            "format":"double",
            "exampleSetFlag":false
        },
        "yearEndForecastCost":{
            "type":"number",
            "description":"Total forecast at the end of year actuals till date, with respect to the current year.",
            "format":"double",
            "exampleSetFlag":false
        },
        "ytdSpendCost":{
            "type":"number",
            "description":"A measurement of capital spent on a program starting from the beginning of the year up to the present date. <br />YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.",
            "format":"double",
            "exampleSetFlag":false
        },
        "estAtCompleteCost":{
            "type":"number",
            "description":"The expected total cost of the program when the defined scope of work will be completed. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false
        },
        "estToCompleteCost":{
            "type":"number",
            "description":"The estimated cost needed to complete the program. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false
        },
        "scheduleVariance":{
            "type":"number",
            "description":"The measure of schedule performance on a program. <br />A negative value indicates that less work was actually performed than was scheduled. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false
        },
        "netPresentValue":{
            "type":"number",
            "description":"The difference between the present value (PV) of the future cash flows from current investments and program costs. <br />The Net Present Value accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital. <br />Positive Net Present Value (NPV) is an indicator of programs that should be pursued. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefits":{
            "type":"number",
            "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefitsDistributed":{
            "type":"number",
            "description":"The amount of benefits currently allocated across the program timescale.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefitsUndistributed":{
            "type":"number",
            "description":"The amount of benefits that have not been allocated across the program timescale.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefitsPresentValue":{
            "type":"number",
            "description":"The present value, also known as the discounted value, of the overall program benefits. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costPerfIndex":{
            "type":"number",
            "description":"The measure of a program's cost efficiency. <br />A value of less than 1 indicates the program is over budget, while a value greater than 1 indicates the program is under budget. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "schedPerfIndex":{
            "type":"number",
            "description":"The measure of the work accomplished as a percentage of the work scheduled on a program. <br />Schedule Performance Index indicates whether you are meeting earned and planned values within your program schedule. <br />A value less than 1 indicates that less work was performed than was scheduled. A value greater than 1 indicates the program is ahead of schedule. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "paybackPeriod":{
            "type":"number",
            "description":"The estimate of the length of time that will transpire before net profits recover the initial and periodic costs of an investment to carry out the selected program. <br /><br /><br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "profitabilityIndex":{
            "type":"number",
            "description":"The index based on the value of a program's present values divided by initial program investments.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "returnOnInvestment":{
            "type":"number",
            "description":"The percentage resulting from division of the expected returns of an investment by the investment costs of a program or portfolio. <br />For example, a program is expected to cost 1.0 million dollars with a total benefit of 1.2 million dollars. Its Net Present Value is $200,000. The Return on Investment is 20%. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetOutOfSync":{
            "type":"boolean",
            "description":"Indicates whether the Planned Budget roll-up from projects is out of sync.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "forecastOutOfSync":{
            "type":"boolean",
            "description":"Indicates whether the Forecast roll-up from projects is out of sync.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "spendsOutOfSync":{
            "type":"boolean",
            "description":"Indicates whether the Actuals roll-up from projects is out of sync.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "benefitsOutOfSync":{
            "type":"boolean",
            "description":"Indicates whether the Benefits roll-up from projects is out of sync.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "annualDiscountRate":{
            "maximum":"1",
            "minimum":"0",
            "type":"number",
            "description":"The interest rate associated with the cost of an investment from your commercial bank or another funding source. <br />For example, an annual growth rate of an investment such as 4.75% can be used as an annual discount rate. This rate is used when a future value is assumed and you are trying to find the required Net Present Value. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false
        },
        "intRateOfReturn":{
            "type":"number",
            "description":"The quantitative measurement used to compare the profitability of program investments. <br />The rate at which investors will receive returns on their investments in a program. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapital":{
            "type":"number",
            "description":"The planned total capital cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalUndistributed":{
            "type":"number",
            "description":"The capital amount of planned budget unallocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalPresentValue":{
            "type":"number",
            "description":"The capital present value, also known as the discounted value, of the overall program planned budget.Future cash flows are discounted using the program's annual discount rate. <br />Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpense":{
            "type":"number",
            "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseUndistributed":{
            "type":"number",
            "description":"The  expense amount of planned budget unallocated across the program timescale.  <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpensePresentValue":{
            "type":"number",
            "description":"The expense present value, also known as the discounted value, of the overall program planned budget. <br />Future cash flows are discounted using the program's annual discount rate. <br />Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCost":{
            "type":"number",
            "description":"The total capital estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostDistributed":{
            "type":"number",
            "description":"The capital amount of forecast cost allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostUndistributed":{
            "type":"number",
            "description":"The capital amount of forecast cost unallocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostPresentValue":{
            "type":"number",
            "description":"The capital present value, also known as the discounted value, of the overall program forecast. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCost":{
            "type":"number",
            "description":"The total expense estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostDistributed":{
            "type":"number",
            "description":"The expense amount of forecast cost allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostUndistributed":{
            "type":"number",
            "description":"The expense amount of forecast cost unallocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostPresentValue":{
            "type":"number",
            "description":"The expense present value, also known as the discounted value, of the overall program forecast. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCapitalCost":{
            "type":"number",
            "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendExpenseCost":{
            "type":"number",
            "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCapitalCostPresentValue":{
            "type":"number",
            "description":"The capital present value, also known as discounted value, of the overall program actuals. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualExpenseCostPresentValue":{
            "type":"number",
            "description":"The expense present value, also known as discounted value, of the overall program actuals. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalDistributed":{
            "type":"number",
            "description":"The capital amount of planned budget allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseDistributed":{
            "type":"number",
            "description":"The expense amount of planned budget allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "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 : ApiEntityProgramPhaseFinancial

Type: object

Title: ApiEntityProgramPhaseFinancial

Show Source

• benefits: number (double)
  Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
• benefitsWorkspace1: number (double)
  Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
  This value is based on the workspace1 currency.
• benefitsWorkspace2: number (double)
  Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
  This value is based on the workspace2 currency.
• benefitsWorkspace3: number (double)
  Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
  This value is based on the workspace3 currency.
• forecastCapitalCost: number (double)
  The total capital estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the base currency with specified exchange rate.
• forecastCapitalCostWorkspace1: number (double)
  The total capital estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the workspace1 currency.
• forecastCapitalCostWorkspace2: number (double)
  The total capital estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the workspace2 currency.
• forecastCapitalCostWorkspace3: number (double)
  The total capital estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the workspace3 currency.
• forecastCost: number (double)
  The total estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
• forecastCostWorkspace1: number (double)
  The total estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the workspace1 currency.
• forecastCostWorkspace2: number (double)
  The total estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the workspace2 currency.
• forecastCostWorkspace3: number (double)
  The total estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the workspace3 currency.
• forecastExpenseCost: number (double)
  The total expense estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the base currency with specified exchange rate.
• forecastExpenseCostWorkspace1: number (double)
  The total expense estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the workspace1 currency.
• forecastExpenseCostWorkspace2: number (double)
  The total expense estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the workspace2 currency.
• forecastExpenseCostWorkspace3: number (double)
  The total expense estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  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.
• month: integer (int32)
  The time period during which budget planning for the program takes place in months.
• phaseStartDate: string (date-time)
  The starting date for a time phase of the program life cycle.
• plannedBudget: number (double)
  The planned total cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
• plannedBudgetCapital: number (double)
  The planned total capital cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetCapitalWorkspace1: number (double)
  The planned total capital cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the workspace1 currency.
• plannedBudgetCapitalWorkspace2: number (double)
  The planned total capital cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the workspace2 currency.
• plannedBudgetCapitalWorkspace3: number (double)
  The planned total capital cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the workspace3 currency.
• plannedBudgetExpense: number (double)
  The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetExpenseWorkspace1: number (double)
  The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the workspace1 currency.
• plannedBudgetExpenseWorkspace2: number (double)
  The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the workspace2 currency.
• plannedBudgetExpenseWorkspace3: number (double)
  The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the workspace3 currency.
• plannedBudgetWorkspace1: number (double)
  The planned total cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the workspace1 currency.
• plannedBudgetWorkspace2: number (double)
  The planned total cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the workspace2 currency.
• plannedBudgetWorkspace3: number (double)
  The planned total cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the workspace3 currency.
• programId: integer (int64)
  The unique identifier for a program set by the user who created the program.
• programPhaseFinancialId: integer (int64)
  The system-generated identifier of a progam phase financial.
• spendCapitalCost: number (double)
  The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the base currency with specified exchange rate.
• spendCapitalCostWorkspace1: number (double)
  The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the workspace1 currency.
• spendCapitalCostWorkspace2: number (double)
  The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the workspace2 currency.
• spendCapitalCostWorkspace3: number (double)
  The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the workspace3 currency.
• spendCost: number (double)
  The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
• spendCostWorkspace1: number (double)
  The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the workspace1 currency.
• spendCostWorkspace2: number (double)
  The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the workspace2 currency.
• spendCostWorkspace3: number (double)
  The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the workspace3 currency.
• spendExpenseCost: number (double)
  The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the base currency with specified exchange rate.
• spendExpenseCostWorkspace1: number (double)
  The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the workspace1 currency.
• spendExpenseCostWorkspace2: number (double)
  The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the workspace2 currency.
• spendExpenseCostWorkspace3: number (double)
  The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the workspace3 currency.
• spendForecastVar: number (double)
  The total and time phased variance between the program's Actuals and Forecast.
• spendForecastVarWorkspace1: number (double)
  The total and time phased variance between the program's Actuals and Forecast.
  This value is based on the workspace1 currency.
• spendForecastVarWorkspace2: number (double)
  The total and time phased variance between the program's Actuals and Forecast.
  This value is based on the workspace2 currency.
• spendForecastVarWorkspace3: number (double)
  The total and time phased variance between the program's Actuals and Forecast.
  This value is based on the workspace3 currency.
• spendPlannedVariance: number (double)
  The total and time phased variance between the program's Actuals and Planned Budget.
• spendPlannedVarianceWorkspace1: number (double)
  The total and time phased variance between the program's Actuals and Planned Budget.
  This value is based on the workspace1 currency.
• spendPlannedVarianceWorkspace2: number (double)
  The total and time phased variance between the program's Actuals and Planned Budget.
  This value is based on the workspace2 currency.
• spendPlannedVarianceWorkspace3: number (double)
  The total and time phased variance between the program's Actuals and Planned Budget.
  This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Date when the record was last updated.
• year: integer (int32)
  The time period during which budget planning for the program takes place in years.
• yearEndForecastCost: number (double)
  Total forecast at the end of year actuals till date, with respect to the current year.
• yearEndForecastCostWorkspace1: number (double)
  Total forecast at the end of year actuals till date, with respect to the current year.
  This value is based on the workspace1 currency.
• yearEndForecastCostWorkspace2: number (double)
  Total forecast at the end of year actuals till date, with respect to the current year.
  This value is based on the workspace2 currency.
• yearEndForecastCostWorkspace3: number (double)
  Total forecast at the end of year actuals till date, with respect to the current year.
  This value is based on the workspace3 currency.
• ytdSpendCost: number (double)
  A measurement of capital spent on a program starting from the beginning of the year up to the present date.
  YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.
• ytdSpendCostWorkspace1: number (double)
  A measurement of capital spent on a program starting from the beginning of the year up to the present date.
  YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.
  This value is based on the workspace1 currency.
• ytdSpendCostWorkspace2: number (double)
  A measurement of capital spent on a program starting from the beginning of the year up to the present date.
  YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.
  This value is based on the workspace2 currency.
• ytdSpendCostWorkspace3: number (double)
  A measurement of capital spent on a program starting from the beginning of the year up to the present date.
  YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.
  This value is based on the workspace3 currency.

{
    "title":"ApiEntityProgramPhaseFinancial",
    "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"
            ]
        },
        "plannedBudgetWorkspace1":{
            "type":"number",
            "description":"The planned total cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetWorkspace2":{
            "type":"number",
            "description":"The planned total cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetWorkspace3":{
            "type":"number",
            "description":"The planned total cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostWorkspace1":{
            "type":"number",
            "description":"The total estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostWorkspace2":{
            "type":"number",
            "description":"The total estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostWorkspace3":{
            "type":"number",
            "description":"The total estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCostWorkspace1":{
            "type":"number",
            "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCostWorkspace2":{
            "type":"number",
            "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCostWorkspace3":{
            "type":"number",
            "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendForecastVarWorkspace1":{
            "type":"number",
            "description":"The total and time phased variance between the program's Actuals and Forecast. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendForecastVarWorkspace2":{
            "type":"number",
            "description":"The total and time phased variance between the program's Actuals and Forecast. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendForecastVarWorkspace3":{
            "type":"number",
            "description":"The total and time phased variance between the program's Actuals and Forecast. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendPlannedVarianceWorkspace1":{
            "type":"number",
            "description":"The total and time phased variance between the program's Actuals and Planned Budget. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendPlannedVarianceWorkspace2":{
            "type":"number",
            "description":"The total and time phased variance between the program's Actuals and Planned Budget. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendPlannedVarianceWorkspace3":{
            "type":"number",
            "description":"The total and time phased variance between the program's Actuals and Planned Budget. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "yearEndForecastCostWorkspace1":{
            "type":"number",
            "description":"Total forecast at the end of year actuals till date, with respect to the current year. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "yearEndForecastCostWorkspace2":{
            "type":"number",
            "description":"Total forecast at the end of year actuals till date, with respect to the current year. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "yearEndForecastCostWorkspace3":{
            "type":"number",
            "description":"Total forecast at the end of year actuals till date, with respect to the current year. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "ytdSpendCostWorkspace1":{
            "type":"number",
            "description":"A measurement of capital spent on a program starting from the beginning of the year up to the present date. <br />YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "ytdSpendCostWorkspace2":{
            "type":"number",
            "description":"A measurement of capital spent on a program starting from the beginning of the year up to the present date. <br />YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "ytdSpendCostWorkspace3":{
            "type":"number",
            "description":"A measurement of capital spent on a program starting from the beginning of the year up to the present date. <br />YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefitsWorkspace1":{
            "type":"number",
            "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefitsWorkspace2":{
            "type":"number",
            "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefitsWorkspace3":{
            "type":"number",
            "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalWorkspace1":{
            "type":"number",
            "description":"The planned total capital cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalWorkspace2":{
            "type":"number",
            "description":"The planned total capital cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalWorkspace3":{
            "type":"number",
            "description":"The planned total capital cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseWorkspace1":{
            "type":"number",
            "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseWorkspace2":{
            "type":"number",
            "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseWorkspace3":{
            "type":"number",
            "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostWorkspace1":{
            "type":"number",
            "description":"The total capital estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostWorkspace2":{
            "type":"number",
            "description":"The total capital estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostWorkspace3":{
            "type":"number",
            "description":"The total capital estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the workspace3 currency.                          ",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostWorkspace1":{
            "type":"number",
            "description":"The total expense estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostWorkspace2":{
            "type":"number",
            "description":"The total expense estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostWorkspace3":{
            "type":"number",
            "description":"The total expense estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCapitalCostWorkspace1":{
            "type":"number",
            "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCapitalCostWorkspace2":{
            "type":"number",
            "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCapitalCostWorkspace3":{
            "type":"number",
            "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendExpenseCostWorkspace1":{
            "type":"number",
            "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendExpenseCostWorkspace2":{
            "type":"number",
            "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendExpenseCostWorkspace3":{
            "type":"number",
            "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "year":{
            "type":"integer",
            "description":"The time period during which budget planning for the program takes place in years.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "month":{
            "type":"integer",
            "description":"The time period during which budget planning for the program takes place in months.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for a program set by the user who created the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programPhaseFinancialId":{
            "type":"integer",
            "description":"The system-generated identifier of a progam phase financial.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "phaseStartDate":{
            "type":"string",
            "description":"The starting date for a time phase of the program life cycle.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "plannedBudget":{
            "type":"number",
            "description":"The planned total cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCost":{
            "type":"number",
            "description":"The total estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCost":{
            "type":"number",
            "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendForecastVar":{
            "type":"number",
            "description":"The total and time phased variance between the program's Actuals and Forecast.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendPlannedVariance":{
            "type":"number",
            "description":"The total and time phased variance between the program's Actuals and Planned Budget.",
            "format":"double",
            "exampleSetFlag":false
        },
        "yearEndForecastCost":{
            "type":"number",
            "description":"Total forecast at the end of year actuals till date, with respect to the current year.",
            "format":"double",
            "exampleSetFlag":false
        },
        "ytdSpendCost":{
            "type":"number",
            "description":"A measurement of capital spent on a program starting from the beginning of the year up to the present date. <br />YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefits":{
            "type":"number",
            "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapital":{
            "type":"number",
            "description":"The planned total capital cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpense":{
            "type":"number",
            "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCost":{
            "type":"number",
            "description":"The total capital estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCost":{
            "type":"number",
            "description":"The total expense estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCapitalCost":{
            "type":"number",
            "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendExpenseCost":{
            "type":"number",
            "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the base currency with specified exchange rate.",
            "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 : ApiEntityProgramSetting

Type: object

Title: ApiEntityProgramSetting

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.
• programId: integer (int64)
  The unique identifier of a program.
• programSettingId: integer (int64)
  The unique identifier of a program setting. This value should not be provided in create operation request data, however, it is required for update requests.
• settingName: string
  Minimum Length: 0

  Maximum Length: 255

  The name of a program setting.
• settingValue: string
  Minimum Length: 0

  Maximum Length: 4000

  Value of a program setting.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityProgramSetting",
    "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"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier of a program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programSettingId":{
            "type":"integer",
            "description":"The unique identifier of a program setting. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "settingName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The name of a program setting.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "settingValue":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Value of a program setting.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Program service.

Back to Top