Batch Update Project Budget Transfers
put
/api/restapi/budgetTransfer/batch
Send a request to this endpoint to update one or more project 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
Root Schema : List<ApiEntityBudgetTransferInput>
Type:
array
Title:
Show Source
List<ApiEntityBudgetTransferInput>
-
Array of:
object ApiEntityBudgetTransferInput
Title:
ApiEntityBudgetTransferInput
This entity represents a BudgetTransfer object, a unique BudgetTransfer object can be identified by the following combinations of the fields.- budgetTransferId
- budgetTransferCode,projectId
- budgetTransferCode,projectCode,workspaceCode
- budgetTransferCode,projectBudgetId
Nested Schema : ApiEntityBudgetTransferInput
Type:
object
Title:
ApiEntityBudgetTransferInput
This entity represents a BudgetTransfer object, a unique BudgetTransfer object can be identified by the following combinations of the fields.
Show Source
- budgetTransferId
- budgetTransferCode,projectId
- budgetTransferCode,projectCode,workspaceCode
- budgetTransferCode,projectBudgetId
-
approveByUserId: integer(int64)Read Only:true
Deprecated. As of 23.11.The username of the user that approved the item. -
approveByUserName: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.11.The name of the user who approved a project budget transfer. -
approveDate: string(date-time)Read Only:true
Deprecated. As of 23.11.Date the item was approved. -
budgetItemId: integer
(int64)
The system-generated identifier of a budget item.
-
budgetTransactions: array
budgetTransactions
List of all budget transactions for the project budget transfer.
-
budgetTransferCode: string
Minimum Length:
0
Maximum Length:60
The unique identifier of the project budget transfer request. -
budgetTransferId: integer
(int64)
The system-generated identifier of a budget transfer.
-
configuredFields: array
configuredFields
The list of configured fields for a budget transfer.
-
description: string
Minimum Length:
0
Maximum Length:4000
Additional information about the transaction. -
itemPrefix: stringRead Only:true
Maximum Length:60
Deprecated. As of 23.11.The prefix of a budget transfer code. -
itemSuffix: integer(int64)Read Only:true
Deprecated. As of 23.11.The suffix of a budget transfer code. -
lastModifiedById: integer(int64)Read Only:true
Deprecated. As of 23.11.The username of the user who last made changes to the item. -
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. -
projectBudgetId: integer
(int64)
The system-generated identifier of a project budget.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for a project set by the user who created the project. -
projectId(required): integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
rejectByUserId: integer(int64)Read Only:true
Deprecated. As of 23.11.The username of the user that rejected the item. -
rejectByUserName: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.11.The name of the user who rejected a project budget transfer. -
rejectDate: string(date-time)Read Only:true
Deprecated. As of 23.11.Date the item was rejected. -
status: string
Allowed Values:
[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]
The state of the project 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.11.The username of the user that submitted the item. -
submitByUserName: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.11.The name of the user who submitted a project budget transfer. -
submitDate: string(date-time)Read Only:true
Deprecated. As of 23.11.Date the item was submitted. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated. -
withdrawApprovalByUserId: integer(int64)Read Only:true
Deprecated. As of 23.11.The username of the user that with withdrew approval of the item. -
withdrawApprovalByUserName: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.11.The name of the user who withdrew a project budget transfer. -
withdrawApprovalDate: string(date-time)Read Only:true
Deprecated. As of 23.11.Date the item was withdrawn. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
Nested Schema : budgetTransactions
Type:
array
List of all budget transactions for the project 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
Nested Schema : configuredFields
Type:
array
The list of configured fields for a budget transfer.
Show Source
-
Array of:
object ApiEntityBudgetTransferConfiguredFieldValueInput
Title:
ApiEntityBudgetTransferConfiguredFieldValueInput
This entity represents a BudgetTransferConfiguredFieldValue object, a unique BudgetTransferConfiguredFieldValue object can be identified by the following combinations of the fields.- budgetTransferConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
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.
Show Source
- budgetTransactionId
-
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: stringRead 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: stringRead 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.
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
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
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.
Show Source
- budgetTransactionId
-
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.
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.
Show Source
- budgetTransactionConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
-
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: numberRead 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: stringRead Only:true
Maximum Length:4000
Deprecated. As of 23.10.Provides the error message for why the formula calculation resulted in an error. -
hasException: booleanRead 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.
Nested Schema : ApiEntityBudgetTransferConfiguredFieldValueInput
Type:
object
Title:
ApiEntityBudgetTransferConfiguredFieldValueInput
This entity represents a BudgetTransferConfiguredFieldValue object, a unique BudgetTransferConfiguredFieldValue object can be identified by the following combinations of the fields.
Show Source
- budgetTransferConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
budgetTransferConfiguredFieldValueId: integer
(int64)
The unique identifier for the Project Budget Transfer Configured Field.
-
budgetTransferId: integer
(int64)
The system-generated identifier of a budget transfer.
-
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: numberRead 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: stringRead Only:true
Maximum Length:4000
Deprecated. As of 23.10.Provides the error message for why the formula calculation resulted in an error. -
hasException: booleanRead 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.
Examples
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 Project Budget Transfer service. Verify the request contains valid data, then resubmit the request.