Jump to

• Request
• Response

Batch Update Program Budget Transfers

put

/api/restapi/programBudgetTransfer/batch

Send a request to this endpoint to update one or more program budget transfers. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityProgramBudgetTransferInput>

Type: array

Title: List<ApiEntityProgramBudgetTransferInput>

Show Source

• Array of: object ApiEntityProgramBudgetTransferInput
  Title: ApiEntityProgramBudgetTransferInput

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

  • programBudgetTransferId
  • programBudgetTransferCode,programId
  • programBudgetTransferCode,programCode,workspaceCode
  • programBudgetTransferCode,programBudgetId

{
    "title":"List<ApiEntityProgramBudgetTransferInput>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramBudgetTransferInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityProgramBudgetTransferInput

Type: object

Title: ApiEntityProgramBudgetTransferInput

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

• programBudgetTransferId
• programBudgetTransferCode,programId
• programBudgetTransferCode,programCode,workspaceCode
• programBudgetTransferCode,programBudgetId

Show Source

• approveByUserId: integer (int64)
  Read Only: true

  Deprecated. As of 23.4.
  The username of the user that approved the item.
• approveByUserName: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.4.
  The name of the user who approved a program budget transfer.
• approveDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.4.
  Date the item was approved.
• budgetItemId: integer (int64)
  The system-generated identifier for a budget.
• configuredFields: array configuredFields
  The list of configured fields for a program budget transfer.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Additional information about the program budget transfer.
• lastModifiedById: integer (int64)
  Read Only: true

  Deprecated. As of 23.4.
  The username of the user who last made changes to the item.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.4.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• programBudgetId: integer (int64)
  Read Only: true

  Deprecated. As of 23.4.
  The system-generated identifier of a program budget.
• programBudgetTransferCode: string
  Maximum Length: 60

  The unique identifier of the program budget transfer request.
• programBudgetTransferId: integer (int64)
  The system-generated identifier of a program budget transfer.
• programBudgetTransferTransactions: array programBudgetTransferTransactions
  List of all program budget transfer transactions of a program budget transfer.
• programCode: string
  Maximum Length: 60

  The user-specified unique identifier of a program.
• programId(required): integer (int64)
  The unique identifier for the program.
• projectBudgetTransferTransactions: array projectBudgetTransferTransactions
  List of all project budget transactions of a program budget transfer. This field represents the transactions which involves project budget item in a program budget transfer.
• rejectByUserId: integer (int64)
  Read Only: true

  Deprecated. As of 23.4.
  The username of the user that rejected the item.
• rejectByUserName: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.4.
  The name of the user who rejected a program budget transfer.
• rejectDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.4.
  Date the item was rejected.
• status: string
  Allowed Values: [ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]

  Deprecated. As of 23.4.
  The state of the program budget transfer request. Pending: The change request is awaiting a decision. Approved: The change request was approved. Rejected: The change request was not approved.
• submitByUserId: integer (int64)
  Read Only: true

  Deprecated. As of 23.4.
  The username of the user that submitted the item.
• submitByUserName: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.4.
  The name of the user who submitted a program budget transfer.
• submitDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.4.
  Date the item was submitted.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.4.
  Date when the record was last updated.
• withdrawApprovalByUserId: integer (int64)
  Read Only: true

  Deprecated. As of 23.4.
  The username of the user that with withdrew approval of the item.
• withdrawApprovalByUserName: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.4.
  The name of the user who withdrew a program budget transfer.
• withdrawApprovalDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.4.
  Date the item was withdrawn.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityProgramBudgetTransferInput",
    "required":[
        "programId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</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"
            ]
        },
        "status":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The state of the program budget transfer request. Pending: The change request is awaiting a decision. Approved: The change request was approved. Rejected: The change request was not approved.",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DRAFT",
                "PENDING",
                "REJECTED",
                "APPROVED"
            ]
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Additional information about the program budget transfer.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a program budget transfer.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramBudgetTransferConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "budgetItemId":{
            "type":"integer",
            "description":"The system-generated identifier for a budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "approveDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>Date the item was approved.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "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 user-specified unique identifier of a program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programBudgetId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The system-generated identifier of a program budget.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "approveByUserId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The username of the user that approved the item.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "approveByUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The name of the user who approved a program budget transfer.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "lastModifiedById":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The username of the user who last made changes to the item.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "rejectByUserId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The username of the user that rejected the item.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "rejectByUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The name of the user who rejected a program budget transfer.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "rejectDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>Date the item was rejected.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "submitByUserId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The username of the user that submitted the item.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "submitByUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The name of the user who submitted a program budget transfer.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "submitDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>Date the item was submitted.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "withdrawApprovalByUserId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The username of the user that with withdrew approval of the item.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "withdrawApprovalByUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The name of the user who withdrew a program budget transfer.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "withdrawApprovalDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>Date the item was withdrawn.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "programBudgetTransferId":{
            "type":"integer",
            "description":"The system-generated identifier of a program budget transfer. ",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetTransferCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the program budget transfer request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programBudgetTransferTransactions":{
            "type":"array",
            "description":"List of all program budget transfer transactions of a program budget transfer.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramBudgetTransferTransactionInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "projectBudgetTransferTransactions":{
            "type":"array",
            "description":"List of all project budget transactions of a program budget transfer. This field represents the transactions which involves project budget item in a program budget transfer.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBudgetTransferTransactionInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        }
    },
    "description":"This entity represents a ProgramBudgetTransfer object, a unique ProgramBudgetTransfer object can be identified by the following combinations of the fields.<ul><li>programBudgetTransferId</li><li>programBudgetTransferCode,programId</li><li>programBudgetTransferCode,programCode,workspaceCode</li><li>programBudgetTransferCode,programBudgetId</li>",
    "exampleSetFlag":false
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a program budget transfer.

Show Source

• Array of: object ApiEntityProgramBudgetTransferConfiguredFieldValueInput
  Title: ApiEntityProgramBudgetTransferConfiguredFieldValueInput

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

  • programBudgetTransferConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

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

Nested Schema : programBudgetTransferTransactions

Type: array

List of all program budget transfer transactions of a program budget transfer.

Show Source

• Array of: object ApiEntityProgramBudgetTransferTransactionInput
  Title: ApiEntityProgramBudgetTransferTransactionInput

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

  • programBudgetTransactionId

{
    "type":"array",
    "description":"List of all program budget transfer transactions of a program budget transfer.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramBudgetTransferTransactionInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : projectBudgetTransferTransactions

Type: array

List of all project budget transactions of a program budget transfer. This field represents the transactions which involves project budget item in a program budget transfer.

Show Source

• Array of: object ApiEntityBudgetTransferTransactionInput
  Title: ApiEntityBudgetTransferTransactionInput

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

  • budgetTransactionId

{
    "type":"array",
    "description":"List of all project budget transactions of a program budget transfer. This field represents the transactions which involves project budget item in a program budget transfer.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityBudgetTransferTransactionInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityProgramBudgetTransferConfiguredFieldValueInput

Type: object

Title: ApiEntityProgramBudgetTransferConfiguredFieldValueInput

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

• programBudgetTransferConfiguredFieldValueId
• 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.
• 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.
• programBudgetTransferConfiguredFieldValueId: integer (int64)
  The system generated identifier of a Program Budget Transfer Configured Field assigned to a Program Budget Transfer.
• programBudgetTransferId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The system-generated identifier of a Program Budget Transfer.
• 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":"ApiEntityProgramBudgetTransferConfiguredFieldValueInput",
    "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"
            ]
        },
        "programBudgetTransferId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The system-generated identifier of a Program Budget Transfer.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetTransferConfiguredFieldValueId":{
            "type":"integer",
            "description":"The system generated identifier of a Program Budget Transfer Configured Field assigned to a Program Budget Transfer.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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 ProgramBudgetTransferConfiguredFieldValue object, a unique ProgramBudgetTransferConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>programBudgetTransferConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramBudgetTransferTransactionInput

Type: object

Title: ApiEntityProgramBudgetTransferTransactionInput

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

• programBudgetTransactionId

Show Source

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

  Provide value for this field during object update to delete the assigned configured field value.
• approveDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.4.
  The date the transaction was approved.
• budgetCbsTemplateCodeId: integer (int64)
  The name of the CBS Code associated with the budget line item.
• budgetCostCategoryId: integer (int64)
  The type of cost associated with the budget line item.
• budgetHours: number (double)
  Read Only: true

  Deprecated. As of 23.4.
  The number of hours needed to complete the budget details line item. Calculated as Production Rate multiplied by Quantity.
• budgetTransferType: string
  Allowed Values: [ "TO", "FROM" ]

  Specifies whether the budget row is transfer from budget record or transfer to budget record.
• configuredFields: array configuredFields
  An object containing configured fields in the form of key-value pairs.
• crossEntityBudgetTransactionId: integer (int64)
  The system-generated identifier for a transaction.
• crossEntityBudgetTransferId: integer (int64)
  The system-generated identifier for a transfer.
• crossEntityTransferFromId: integer (int64)
  The budget ID of the Transfer From project budget record.
• productionRate: number (double)
  Minimum Value: 0.000010

  The number of hours per unit of measure needed to complete the budget line item.
• programBudgetItemId: integer (int64)
  A unique identifier for the budget item (Change Budget Line).
• programBudgetItemName: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.11.
  The name of the budget item.
• programBudgetTransactionCode: string
  Maximum Length: 60

  The unique identifier of the program budget line item detail.
• programBudgetTransactionCost: programBudgetTransactionCost
  The cost data of a program budget transaction.
• programBudgetTransactionId: integer (int64)
  The system-generated identifier for a transaction.
• programBudgetTransferId: integer (int64)
  This is an intermediary field that the system uses to calculate other values. It does not correspond to any field users can see in the user interface.
• quantity: number (double)
  The number of each budget line item needed to complete the work.
• status: string
  Read Only: true

  Allowed Values: [ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]

  Deprecated. As of 23.4.
  The status of the transaction. Indicates whether the transaction is approved, pending, draft, or rejected.
• transactionType: string
  Read Only: true

  Allowed Values: [ "ORIGINAL", "CHANGE", "TRANSFER" ]

  Deprecated. As of 23.4.
  Specifies whether the budget row is an original, change, or transfer value.
• transferFromCBSId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The cost code for the Transfer From Budget record.
• transferFromCostCategoryId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The category of the Transfer From Budget record.
• transferFromProgramBudgetItemId: integer (int64)
  The budget ID of the Transfer From Budget record.
• transferToCBSId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The cost code for the Transfer To Budget record.
• transferToCostCategoryId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The category of the Transfer To Budget record.
• transferToProgramBudgetItemId: integer (int64)
  The budget ID of the Transfer To Budget record.
• unitOfMeasureId: integer (int64)
  The Unit of Measure used for the budget line item detail.

{
    "title":"ApiEntityProgramBudgetTransferTransactionInput",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The status of the transaction. Indicates whether the transaction is approved, pending, draft, or rejected.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DRAFT",
                "PENDING",
                "REJECTED",
                "APPROVED"
            ]
        },
        "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"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"An object containing configured fields in the form of key-value pairs.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramBudgetTransactionConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "transactionType":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>Specifies whether the budget row is an original, change, or transfer value.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ORIGINAL",
                "CHANGE",
                "TRANSFER"
            ]
        },
        "unitOfMeasureId":{
            "type":"integer",
            "description":"The Unit of Measure used for the budget line item detail.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "quantity":{
            "type":"number",
            "description":"The number of each budget line item needed to complete the work.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "productionRate":{
            "minimum":"0.000010",
            "type":"number",
            "description":"The number of hours per unit of measure needed to complete the budget line item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "budgetHours":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The number of hours needed to complete the budget details line item. Calculated as Production Rate multiplied by Quantity.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "budgetCostCategoryId":{
            "type":"integer",
            "description":"The type of cost associated with the budget line item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "approveDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The date the transaction was approved.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "budgetCbsTemplateCodeId":{
            "type":"integer",
            "description":"The name of the CBS Code associated with the budget line item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetItemId":{
            "type":"integer",
            "description":"A unique identifier for the budget item (Change Budget Line).",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetItemName":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The name of the budget item.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programBudgetTransactionCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the program budget line item detail.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programBudgetTransactionId":{
            "type":"integer",
            "description":"The system-generated identifier for a transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetTransferId":{
            "type":"integer",
            "description":"This is an intermediary field that the system uses to calculate other values. It does not correspond to any field users can see in the user interface.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetTransferType":{
            "type":"string",
            "description":"Specifies whether the budget row is transfer from budget record or transfer to budget record.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "TO",
                "FROM"
            ]
        },
        "crossEntityBudgetTransactionId":{
            "type":"integer",
            "description":"The system-generated identifier for a transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "crossEntityBudgetTransferId":{
            "type":"integer",
            "description":"The system-generated identifier for a transfer.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "crossEntityTransferFromId":{
            "type":"integer",
            "description":"The budget ID of the Transfer From project budget record.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transferFromCBSId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost code for the Transfer From Budget record.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transferFromCostCategoryId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The category of the Transfer From Budget record.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transferFromProgramBudgetItemId":{
            "type":"integer",
            "description":"The budget ID of the Transfer From Budget record.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transferToCBSId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost code for the Transfer To Budget record.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transferToCostCategoryId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The category of the Transfer To Budget record.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transferToProgramBudgetItemId":{
            "type":"integer",
            "description":"The budget ID of the Transfer To Budget record.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetTransactionCost":{
            "description":"The cost data of a program budget transaction.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProgramBudgetTransactionCostInput"
                }
            ]
        }
    },
    "description":"This entity represents a ProgramBudgetTransferTransaction object, a unique ProgramBudgetTransferTransaction object can be identified by the following combinations of the fields.<ul><li>programBudgetTransactionId</li>",
    "exampleSetFlag":false
}

Nested Schema : configuredFields

Type: array

An object containing configured fields in the form of key-value pairs.

Show Source

• Array of: object ApiEntityProgramBudgetTransactionConfiguredFieldValueInput
  Title: ApiEntityProgramBudgetTransactionConfiguredFieldValueInput

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

  • programBudgetTransactionConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

{
    "type":"array",
    "description":"An object containing configured fields in the form of key-value pairs.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramBudgetTransactionConfiguredFieldValueInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : programBudgetTransactionCost

The cost data of a program budget transaction.

Match All

Show Source

• object ApiEntityProgramBudgetTransactionCostInput
  Title: ApiEntityProgramBudgetTransactionCostInput

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

  • programBudgetTransactionId

{
    "description":"The cost data of a program budget transaction.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityProgramBudgetTransactionCostInput"
        }
    ]
}

Nested Schema : ApiEntityProgramBudgetTransactionConfiguredFieldValueInput

Type: object

Title: ApiEntityProgramBudgetTransactionConfiguredFieldValueInput

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

• programBudgetTransactionConfiguredFieldValueId
• 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.
• 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.
• programBudgetTransactionConfiguredFieldValueId: integer (int64)
  The system generated identifier of a Program Budget Transaction Configured Field assigned to a Program Budget Transaction.
• programBudgetTransactionId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The system-generated identifier of a Program Budget Transaction.
• 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":"ApiEntityProgramBudgetTransactionConfiguredFieldValueInput",
    "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"
            ]
        },
        "programBudgetTransactionId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The system-generated identifier of a Program Budget Transaction.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetTransactionConfiguredFieldValueId":{
            "type":"integer",
            "description":"The system generated identifier of a Program Budget Transaction Configured Field assigned to a Program Budget Transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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 ProgramBudgetTransactionConfiguredFieldValue object, a unique ProgramBudgetTransactionConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>programBudgetTransactionConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramBudgetTransactionCostInput

Type: object

Title: ApiEntityProgramBudgetTransactionCostInput

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

• programBudgetTransactionId

Show Source

• amountCost: number (double)
  Read Only: true

  Deprecated. As of 23.4.
  The amount that the budget row has changed as the result of transactions.
• amountCostCOR(required): number (double)
  The amount that the budget row has changed as the result of transactions. This is an input field, will not be a part of response.
• currentCost: number (double)
  Read Only: true

  Deprecated. As of 23.4.
  The current cost of the associated budget line item.
• laborRate: number (double)
  Read Only: true

  Deprecated. As of 23.4.
  The cost per labor hour of the budget line item detail.
• laborRateCOR: number (double)
  The cost per labor hour of the budget line item. This is an input field, will not be a part of response.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.4.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• programBudgetTransactionId: integer (int64)
  The system-generated identifier for a transaction.
• unitRate: number (double)
  Read Only: true

  Deprecated. As of 23.4.
  The cost per Unit of Measure for the budget line item detail.
• unitRateCOR: number (double)
  The cost per Unit of Measure for the budget line item. This is an input field, will not be a part of response.
• updateDate: string (date-time)
  Read Only: true

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

{
    "title":"ApiEntityProgramBudgetTransactionCostInput",
    "required":[
        "amountCostCOR"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</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"
            ]
        },
        "currentCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The current cost of the associated budget line item.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "unitRate":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The cost per Unit of Measure for the budget line item detail.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "laborRate":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The cost per labor hour of the budget line item detail.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "amountCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The amount that the budget row has changed as the result of transactions.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "programBudgetTransactionId":{
            "type":"integer",
            "description":"The system-generated identifier for a transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "unitRateCOR":{
            "type":"number",
            "description":"The cost per Unit of Measure for the budget line item. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "laborRateCOR":{
            "type":"number",
            "description":"The cost per labor hour of the budget line item. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "amountCostCOR":{
            "type":"number",
            "description":"The amount that the budget row has changed as the result of transactions. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        }
    },
    "description":"This entity represents a ProgramBudgetTransactionCost object, a unique ProgramBudgetTransactionCost object can be identified by the following combinations of the fields.<ul><li>programBudgetTransactionId</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityBudgetTransferTransactionInput

Type: object

Title: ApiEntityBudgetTransferTransactionInput

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

• budgetTransactionId

Show Source

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

  Provide value for this field during object update to delete the assigned configured field value.
• approveDate: string (date-time)
  Deprecated. As of 23.11.
  The date the transaction was approved.
• budgetCbsSheetCodeId: integer (int64)
  Deprecated. As of 23.11.
  The name of the CBS Code associated with the budget line item.
• budgetCostCategoryId: integer (int64)
  Deprecated. As of 23.11.
  The cost category ID of the budget line item.
• budgetHours: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The number of hours needed to complete the budget details line item. Calculated as Production Rate multiplied by Quantity.
• budgetItemId: integer (int64)
  A unique identifier for the budget item (Change Budget Line).
• budgetItemName: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.11.
  The name of the budget item.
• budgetTransactionCost: budgetTransactionCost
  The cost of a budget transaction.
• budgetTransactionId: integer (int64)
  The system-generated identifier of a budget transaction.
• budgetTransferId: integer (int64)
  This is an intermediary field that the system uses to calculate other values. It does not correspond to any field users can see in the user interface.
• budgetTransferType: string
  Allowed Values: [ "TO", "FROM" ]

  Specifies whether the budget row is transfer from budget record or transfer to budget record.
• configuredFields: array configuredFields
  The list of configured fields for a budget transfer transaction.
• crossEntityBudgetTransactionId: integer (int64)
  The system-generated identifier of a source budget transaction which has cross entity budget item involved.
• crossEntityBudgetTransferId: integer (int64)
  The system-generated identifier of a project budget transfer of an object to which the project budget item is added in a destination transaction of a cross entity transfer.
• crossEntityTransferFromId: integer (int64)
  The system-generated identifier of a budget item added in a cross object transfer. This field is required to be provided in a destination transaction of a cross entity transfer to identify the source budget item. For example, In a program to project Project Budget Transfer, the program budget item ID has to be given in a destination transaction.
• itemCode: string
  Maximum Length: 60

  The system-generated unique identifier for the budget transaction item.
• itemCodeSuffix: integer (int64)
  Deprecated. As of 23.11.
  The suffix of a budget transaction code.
• 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.
• productionRate: number (double)
  Minimum Value: 0.000010

  The number of hours per unit of measure needed to complete the budget line item.
• quantity: number (double)
  The number of each budget line item needed to complete the work.
• status: string
  Read Only: true

  Allowed Values: [ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]

  Deprecated. As of 23.11.
  The status of the transaction. Indicates whether the transaction is approved, pending, draft, or rejected.
• transactionType: string
  Allowed Values: [ "ORIGINAL", "CHANGE", "TRANSFER" ]

  Specifies whether the budget row is an original, change, or transfer value.
• transferFromCBSId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The CBS code of the source budget line item. This identifies the CBS code of the budget line item you are transferring money from through the transfer.
• transferFromCostCategoryId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The cost category ID of the destination budget line item.
• transferFromId(required): integer (int64)
  The unique identifier for the source budget line item. This identifies the ID of the budget item item you are transferring money from through the transfer.
• transferToCBSId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The CBS code of the destination budget line item. This identifies the CBS code of the budget line item you are transferring money to through the transfer.
• transferToCostCategoryId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The cost category ID of the source budget line item.
• transferToId: integer (int64)
  The unique identifier for the destination budget line item. This identifies the ID of the budget item you are transferring money to through the transfer.
• unitOfMeasureId: integer (int64)
  The Unit of Measure used for the budget line item detail.
• updateDate: string (date-time)
  Read Only: true

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

{
    "title":"ApiEntityBudgetTransferTransactionInput",
    "required":[
        "transferFromId"
    ],
    "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"
            ]
        },
        "status":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The status of the transaction. Indicates whether the transaction is approved, pending, draft, or rejected.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DRAFT",
                "PENDING",
                "REJECTED",
                "APPROVED"
            ]
        },
        "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"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a budget transfer transaction.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBudgetTransactionConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "budgetTransactionId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "itemCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The system-generated unique identifier for the budget transaction item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "itemCodeSuffix":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The suffix of a budget transaction code.",
            "format":"int64",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transactionType":{
            "type":"string",
            "description":"Specifies whether the budget row is an original, change, or transfer value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ORIGINAL",
                "CHANGE",
                "TRANSFER"
            ]
        },
        "unitOfMeasureId":{
            "type":"integer",
            "description":"The Unit of Measure used for the budget line item detail.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetItemId":{
            "type":"integer",
            "description":"A unique identifier for the budget item (Change Budget Line).",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetItemName":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The name of the budget item.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "quantity":{
            "type":"number",
            "description":"The number of each budget line item needed to complete the work.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "productionRate":{
            "minimum":"0.000010",
            "type":"number",
            "description":"The number of hours per unit of measure needed to complete the budget line item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "budgetHours":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The number of hours needed to complete the budget details line item. Calculated as Production Rate multiplied by Quantity.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "budgetCbsSheetCodeId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The name of the CBS Code associated with the budget line item.",
            "format":"int64",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetCostCategoryId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost category ID of the budget line item.",
            "format":"int64",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "approveDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The date the transaction was approved.",
            "format":"date-time",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "budgetTransferType":{
            "type":"string",
            "description":"Specifies whether the budget row is transfer from budget record or transfer to budget record.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "TO",
                "FROM"
            ]
        },
        "crossEntityBudgetTransactionId":{
            "type":"integer",
            "description":"The system-generated identifier of a source budget transaction which has cross entity budget item involved.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "crossEntityBudgetTransferId":{
            "type":"integer",
            "description":"The system-generated identifier of a project budget transfer of an object to which the project budget item is added in a destination transaction of a cross entity transfer.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "crossEntityTransferFromId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget item added in a cross object transfer. This field is required to be provided in a destination transaction of a cross entity transfer to identify the source budget item. For example, In a program to project Project Budget Transfer, the program budget item ID has to be given in a destination transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transferFromCBSId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The CBS code of the source budget line item. This identifies the CBS code of the budget line item you are transferring money from through the transfer. ",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transferFromCostCategoryId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost category ID of the destination budget line item.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transferToCBSId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The CBS code of the destination budget line item. This identifies the CBS code of the budget line item you are transferring money to through the transfer. ",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transferToCostCategoryId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost category ID of the source budget line item.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transferToId":{
            "type":"integer",
            "description":"The unique identifier for the destination budget line item. This identifies the ID of the budget item you are transferring money to through the transfer.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transferFromId":{
            "type":"integer",
            "description":"The unique identifier for the source budget line item. This identifies the ID of the budget item item you are transferring money from through the transfer. ",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetTransferId":{
            "type":"integer",
            "description":"This is an intermediary field that the system uses to calculate other values. It does not correspond to any field users can see in the user interface.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetTransactionCost":{
            "description":"The cost of a budget transaction.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityBudgetTransactionCostInput"
                }
            ]
        },
        "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 BudgetTransferTransaction object, a unique BudgetTransferTransaction object can be identified by the following combinations of the fields.<ul><li>budgetTransactionId</li>",
    "exampleSetFlag":false
}

Nested Schema : budgetTransactionCost

The cost of a budget transaction.

Match All

Show Source

• object ApiEntityBudgetTransactionCostInput
  Title: ApiEntityBudgetTransactionCostInput

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

  • budgetTransactionId

{
    "description":"The cost of a budget transaction.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityBudgetTransactionCostInput"
        }
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a budget transfer transaction.

Show Source

• Array of: object ApiEntityBudgetTransactionConfiguredFieldValueInput
  Title: ApiEntityBudgetTransactionConfiguredFieldValueInput

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

  • budgetTransactionConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

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

Nested Schema : ApiEntityBudgetTransactionCostInput

Type: object

Title: ApiEntityBudgetTransactionCostInput

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

• budgetTransactionId

Show Source

• amountCost: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The amount that the budget row has changed as the result of transactions. This value is based on the base currency.
• amountCostProject: number (double)
  The amount that the budget row has changed as the result of transactions. This value is based on the project currency.
• amountCostWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The amount that the budget row has changed as the result of transactions. This value is based on the workspace1 currency.
• amountCostWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The amount that the budget row has changed as the result of transactions. This value is based on the workspace2 currency.
• amountCostWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The amount that the budget row has changed as the result of transactions. This value is based on the workspace3 currency.
• budgetTransactionId: integer (int64)
  The system-generated identifier of a budget transaction.
• currentCost: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The current cost of the associated budget line item. This value is based on the base currency.
• currentCostProject: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The current cost of the associated budget line item. This value is based on the project currency.
• currentCostWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The current cost of the associated budget line item. This value is based on the workspace1 currency.
• currentCostWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The current cost of the associated budget line item. This value is based on the workspace2 currency.
• currentCostWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The current cost of the associated budget line item. This value is based on the workspace3 currency.
• laborRate: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The cost per labor hour of the budget line item detail. This value is based on the base currency.
• laborRateProject: number (double)
  The cost per labor hour of the budget line item detail. This value is based on the project currency.
• laborRateWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The cost per labor hour of the budget line item detail. This value is based on the workspace1 currency.
• laborRateWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The cost per labor hour of the budget line item detail. This value is based on the workspace2 currency.
• laborRateWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The cost per labor hour of the budget line item detail. This value is based on the workspace3 currency.
• 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.
• unitRate: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The cost per Unit of Measure for the budget line item detail. This value is based on the base currency.
• unitRateProject: number (double)
  The cost per Unit of Measure for the budget line item detail. This value is based on the project currency.
• unitRateWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The cost per Unit of Measure for the budget line item detail. This value is based on the workspace1 currency.
• unitRateWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The cost per Unit of Measure for the budget line item detail. This value is based on the workspace2 currency.
• unitRateWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The cost per Unit of Measure for the budget line item detail. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Read Only: true

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

{
    "title":"ApiEntityBudgetTransactionCostInput",
    "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"
            ]
        },
        "currentCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The current cost of the associated budget line item. This value is based on the base currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "budgetTransactionId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "unitRate":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost per Unit of Measure for the budget line item detail. This value is based on the base currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "unitRateWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost per Unit of Measure for the budget line item detail. This value is based on the workspace1 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "unitRateWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost per Unit of Measure for the budget line item detail. This value is based on the workspace2 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "unitRateWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost per Unit of Measure for the budget line item detail. This value is based on the workspace3 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "unitRateProject":{
            "type":"number",
            "description":"The cost per Unit of Measure for the budget line item detail. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "laborRate":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost per labor hour of the budget line item detail. This value is based on the base currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "laborRateWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost per labor hour of the budget line item detail. This value is based on the workspace1 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "laborRateWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost per labor hour of the budget line item detail. This value is based on the workspace2 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "laborRateWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The cost per labor hour of the budget line item detail. This value is based on the workspace3 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "laborRateProject":{
            "type":"number",
            "description":"The cost per labor hour of the budget line item detail. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "currentCostWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The current cost of the associated budget line item. This value is based on the workspace1 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "currentCostWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The current cost of the associated budget line item. This value is based on the workspace2 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "currentCostWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The current cost of the associated budget line item. This value is based on the workspace3 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "currentCostProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The current cost of the associated budget line item. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "amountCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The amount that the budget row has changed as the result of transactions. This value is based on the base currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "amountCostWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The amount that the budget row has changed as the result of transactions. This value is based on the workspace1 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "amountCostWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The amount that the budget row has changed as the result of transactions. This value is based on the workspace2 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "amountCostWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The amount that the budget row has changed as the result of transactions. This value is based on the workspace3 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "amountCostProject":{
            "type":"number",
            "description":"The amount that the budget row has changed as the result of transactions. This value is based on the project currency.",
            "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"
            ]
        }
    },
    "description":"This entity represents a BudgetTransactionCost object, a unique BudgetTransactionCost object can be identified by the following combinations of the fields.<ul><li>budgetTransactionId</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityBudgetTransactionConfiguredFieldValueInput

Type: object

Title: ApiEntityBudgetTransactionConfiguredFieldValueInput

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

• budgetTransactionConfiguredFieldValueId
• 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.
• budgetTransactionConfiguredFieldValueId: integer (int64)
  The unique identifier for the Transaction Configured Field.
• budgetTransactionId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The system-generated identifier for a transaction.
• 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.
• 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.
• 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":"ApiEntityBudgetTransactionConfiguredFieldValueInput",
    "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"
            ]
        },
        "budgetTransactionConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Transaction Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetTransactionId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The system-generated identifier for a transaction.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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 BudgetTransactionConfiguredFieldValue object, a unique BudgetTransactionConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>budgetTransactionConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Examples

Select an example Batch Update Program Budget Transfers Using Program Budget Transfer IDs

Back to Top

Response

200 Response

A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"},"warnings":[{"primaryKeyName":"objectIdFieldName","uniqueFieldName":"object_code_01","uniqueFieldValue":"objectCodeFieldName","primaryKeyValue":1,"warningMessages":["warning_message_1","warning_message_2"]}]}

400 Response

Invalid input for the Program Budget Transfer service. Verify the request contains valid data, then resubmit the request.

Back to Top