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

• 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.
• 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.
• 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":{
        "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":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Additional information about the program budget transfer.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programCode":{
            "maxLength":60,
            "type":"string",
            "description":"The user-specified unique identifier of a program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programBudgetTransferId":{
            "type":"integer",
            "description":"The system-generated identifier of a program budget transfer. ",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "budgetItemId":{
            "type":"integer",
            "description":"The system-generated identifier for a budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        }
    },
    "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.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• 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.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.

{
    "title":"ApiEntityProgramBudgetTransferConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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.
• 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.
• 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).
• 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.
• transferFromProgramBudgetItemId: integer (int64)
  The budget ID of the Transfer From 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":{
        "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"
            ]
        },
        "crossEntityBudgetTransactionId":{
            "type":"integer",
            "description":"The system-generated identifier for a transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetTransactionId":{
            "type":"integer",
            "description":"The system-generated identifier for a transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetTransactionCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier of the program budget line item detail.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "transferFromProgramBudgetItemId":{
            "type":"integer",
            "description":"The budget ID of the Transfer From Budget record.",
            "format":"int64",
            "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"
                }
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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
        },
        "budgetCostCategoryId":{
            "type":"integer",
            "description":"The type of cost associated with the budget line item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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 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

The cost data of a program budget transaction.

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.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• 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.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.

{
    "title":"ApiEntityProgramBudgetTransactionConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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

• 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.
• 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.
• programBudgetTransactionId: integer (int64)
  The system-generated identifier for a transaction.
• 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.

{
    "title":"ApiEntityProgramBudgetTransactionCostInput",
    "required":[
        "amountCostCOR"
    ],
    "type":"object",
    "properties":{
        "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.
• budgetItemId: integer (int64)
  A unique identifier for the budget item (Change Budget Line).
• 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.
• 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.
• transactionType: string
  Allowed Values: [ "ORIGINAL", "CHANGE", "TRANSFER" ]

  Specifies whether the budget row is an original, change, or transfer value.
• 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.
• 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.

{
    "title":"ApiEntityBudgetTransferTransactionInput",
    "required":[
        "transferFromId"
    ],
    "type":"object",
    "properties":{
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "budgetTransactionCost":{
            "description":"The cost of a budget transaction.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityBudgetTransactionCostInput"
                }
            ]
        }
    },
    "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

The cost of a budget transaction.

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

• amountCostProject: number (double)
  The amount that the budget row has changed as the result of transactions. This value is based on the project currency.
• budgetTransactionId: integer (int64)
  The system-generated identifier of a budget transaction.
• laborRateProject: number (double)
  The cost per labor hour of the budget line item detail. This value is based on the project currency.
• unitRateProject: number (double)
  The cost per Unit of Measure for the budget line item detail. This value is based on the project currency.

{
    "title":"ApiEntityBudgetTransactionCostInput",
    "type":"object",
    "properties":{
        "budgetTransactionId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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
        },
        "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
        },
        "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
        }
    },
    "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.
• 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.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• 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.

{
    "title":"ApiEntityBudgetTransactionConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "budgetTransactionConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Transaction Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnName":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column name.",
            "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"
            ]
        },
        "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"
            ]
        },
        "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 Batch Update Program Budget Transfers to Assign Configured Field

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