View a Program Budget Transfer
get
/api/restapi/programBudgetTransfer/{programBudgetTransferId}
This endpoint returns program budget transfers that meet the following requirements:
- The object is associated with a program budget transfer with an ID value that matches the value of the {programBudgetTransferId} path parameter.
Request
Path Parameters
-
programBudgetTransferId(required): integer(int64)
The system-generated identifier of a budget transfer.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ApiEntityProgramBudgetTransfer
Type:
object
Title:
Show Source
ApiEntityProgramBudgetTransfer
-
approveByUserId: integer
(int64)
The username of the user that approved the item.
-
approveByUserName: string
Maximum Length:
255
The name of the user who approved a program budget transfer. -
approveDate: string
(date-time)
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)
The username of the user who last made changes to the item.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
programBudgetId: integer
(int64)
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: 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)
The username of the user that rejected the item.
-
rejectByUserName: string
Maximum Length:
255
The name of the user who rejected a program budget transfer. -
rejectDate: string
(date-time)
Date the item was rejected.
-
status: string
Allowed Values:
[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]
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)
The username of the user that submitted the item.
-
submitByUserName: string
Maximum Length:
255
The name of the user who submitted a program budget transfer. -
submitDate: string
(date-time)
Date the item was submitted.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
withdrawApprovalByUserId: integer
(int64)
The username of the user that with withdrew approval of the item.
-
withdrawApprovalByUserName: string
Maximum Length:
255
The name of the user who withdrew a program budget transfer. -
withdrawApprovalDate: string
(date-time)
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.
Nested Schema : configuredFields
Type:
array
The list of configured fields for a program budget transfer.
Show Source
-
Array of:
object ApiEntityProgramBudgetTransferConfiguredFieldValue
Title:
ApiEntityProgramBudgetTransferConfiguredFieldValue
Nested Schema : programBudgetTransferTransactions
Type:
array
List of all program budget transfer transactions of a program budget transfer.
Show Source
-
Array of:
object ApiEntityProgramBudgetTransferTransaction
Title:
ApiEntityProgramBudgetTransferTransaction
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 ApiEntityBudgetTransferTransaction
Title:
ApiEntityBudgetTransferTransaction
Nested Schema : ApiEntityProgramBudgetTransferConfiguredFieldValue
Type:
object
Title:
Show Source
ApiEntityProgramBudgetTransferConfiguredFieldValue
-
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
This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
-
costValueWorkspace1: number
(double)
This holds values for Cost type configured fields in the workspace1 currency conversion.
-
costValueWorkspace2: number
(double)
This holds values for Cost type configured fields in the workspace2 currency conversion.
-
costValueWorkspace3: number
(double)
This holds values for Cost type configured fields in the workspace3 currency conversion.
-
dateValue: string
(date-time)
This holds values for Date type configured fields.
-
exceptionMessage: string
Maximum Length:
4000
Provides the error message for why the formula calculation resulted in an error. -
hasException: boolean
Determines if formula calculation hit an error calculating a value for this field.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
numberValue: number
This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
-
programBudgetTransferConfiguredFieldValueId: integer
(int64)
The system generated identifier of a Program Budget Transfer Configured Field assigned to a Program Budget Transfer.
-
programBudgetTransferId: integer
(int64)
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)
Date when the record was last updated.
Nested Schema : ApiEntityProgramBudgetTransferTransaction
Type:
object
Title:
Show Source
ApiEntityProgramBudgetTransferTransaction
-
action: stringAllowed Values:[ "DELETE" ]
Deprecated. As of 23.4.Provide value for this field during object update to delete the assigned configured field value. -
approveDate: string
(date-time)
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 cost category ID of the budget line item.
-
budgetHours: number
(double)
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
The list of configured fields for a program 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 budget transfer of an object to which the program 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 entity 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 project to program Budget Transfer, the project budget item ID has to be given in a destination transaction.
-
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
Maximum Length:
255
The name of the budget item. -
programBudgetTransactionCode: string
Maximum Length:
60
The system-generated unique identifier for the budget transaction item. -
programBudgetTransactionCost:
programBudgetTransactionCost
The cost data of a program budget transaction.
-
programBudgetTransactionId: integer
(int64)
The system-generated identifier of a budget 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
Allowed Values:
[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]
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)
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)
The cost category ID of the destination budget line item.
-
transferFromProgramBudgetItemId(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)
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)
The cost category ID of the source budget line item.
-
transferToProgramBudgetItemId: 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.
Nested Schema : configuredFields
Type:
array
The list of configured fields for a program budget transfer transaction.
Show Source
-
Array of:
object ApiEntityProgramBudgetTransactionConfiguredFieldValue
Title:
ApiEntityProgramBudgetTransactionConfiguredFieldValue
Nested Schema : programBudgetTransactionCost
The cost data of a program budget transaction.
Match All
Show Source
-
object
ApiEntityProgramBudgetTransactionCost
Title:
ApiEntityProgramBudgetTransactionCost
Nested Schema : ApiEntityProgramBudgetTransactionConfiguredFieldValue
Type:
object
Title:
Show Source
ApiEntityProgramBudgetTransactionConfiguredFieldValue
-
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
This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
-
costValueWorkspace1: number
(double)
This holds values for Cost type configured fields in the workspace1 currency conversion.
-
costValueWorkspace2: number
(double)
This holds values for Cost type configured fields in the workspace2 currency conversion.
-
costValueWorkspace3: number
(double)
This holds values for Cost type configured fields in the workspace3 currency conversion.
-
dateValue: string
(date-time)
This holds values for Date type configured fields.
-
exceptionMessage: string
Maximum Length:
4000
Provides the error message for why the formula calculation resulted in an error. -
hasException: boolean
Determines if formula calculation hit an error calculating a value for this field.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
numberValue: number
This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
-
programBudgetTransactionConfiguredFieldValueId: integer
(int64)
The system generated identifier of a Program Budget Transaction Configured Field assigned to a Program Budget Transaction.
-
programBudgetTransactionId: integer
(int64)
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)
Date when the record was last updated.
Nested Schema : ApiEntityProgramBudgetTransactionCost
Type:
object
Title:
Show Source
ApiEntityProgramBudgetTransactionCost
-
amountCost: number
(double)
The amount that the budget row has changed as the result of transactions.
-
amountCostWorkspace1: number
(double)
The amount that the budget row has changed as the result of transactions, based on the workspace1 currency.
-
amountCostWorkspace2: number
(double)
The amount that the budget row has changed as the result of transactions, based on the workspace2 currency.
-
amountCostWorkspace3: number
(double)
The amount that the budget row has changed as the result of transactions, based on the workspace3 currency.
-
currentCost: number
(double)
The current cost of the associated budget line item.
-
currentCostWorkspace1: number
(double)
The total cost of the program budget, including all transfers and changes, based on the workspace1 currency.
-
currentCostWorkspace2: number
(double)
The total cost of the program budget, including all transfers and changes, based on the workspace2 currency.
-
currentCostWorkspace3: number
(double)
The total cost of the program budget, including all transfers and changes, based on the workspace3 currency.
-
laborRate: number
(double)
The cost per labor hour of the budget line item detail.
-
laborRateWorkspace1: number
(double)
The cost per labor hour of the budget line item based on the workspace1 currency.
-
laborRateWorkspace2: number
(double)
The cost per labor hour of the budget line item based on the workspace2 currency.
-
laborRateWorkspace3: number
(double)
The cost per labor hour of the budget line item based on the workspace3 currency.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
programBudgetTransactionId: integer
(int64)
The system-generated identifier for a transaction.
-
unitRate: number
(double)
The cost per Unit of Measure for the budget line item detail.
-
unitRateWorkspace1: number
(double)
The cost per Unit of Measure for the budget line item based on the workspace1 currency.
-
unitRateWorkspace2: number
(double)
The cost per Unit of Measure for the budget line item based on the workspace3 currency.
-
unitRateWorkspace3: number
(double)
The cost per Unit of Measure for the budget line item based on the workspace2 currency.
-
updateDate: string
(date-time)
Date when the record was last updated.
Nested Schema : ApiEntityBudgetTransferTransaction
Type:
object
Title:
Show Source
ApiEntityBudgetTransferTransaction
-
action: string
Allowed Values:
[ "DELETE" ]
-
approveDate: string
(date-time)
The date the transaction was approved.
-
budgetCbsSheetCodeId: integer
(int64)
The name of the CBS Code associated with the budget line item.
-
budgetCostCategoryId: integer
(int64)
The cost category ID of the budget line item.
-
budgetHours: number
(double)
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
Maximum Length:
255
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)
The suffix of a budget transaction code.
-
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
Allowed Values:
[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]
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)
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)
The cost category ID of the destination budget line item.
-
transferFromId: 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)
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)
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.
Nested Schema : budgetTransactionCost
The cost of a budget transaction.
Match All
Show Source
-
object
ApiEntityBudgetTransactionCost
Title:
ApiEntityBudgetTransactionCost
Nested Schema : configuredFields
Type:
array
The list of configured fields for a budget transfer transaction.
Show Source
-
Array of:
object ApiEntityBudgetTransactionConfiguredFieldValue
Title:
ApiEntityBudgetTransactionConfiguredFieldValue
Nested Schema : ApiEntityBudgetTransactionCost
Type:
object
Title:
Show Source
ApiEntityBudgetTransactionCost
-
amountCost: number
(double)
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)
The amount that the budget row has changed as the result of transactions. This value is based on the workspace1 currency.
-
amountCostWorkspace2: number
(double)
The amount that the budget row has changed as the result of transactions. This value is based on the workspace2 currency.
-
amountCostWorkspace3: number
(double)
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)
The current cost of the associated budget line item. This value is based on the base currency.
-
currentCostProject: number
(double)
The current cost of the associated budget line item. This value is based on the project currency.
-
currentCostWorkspace1: number
(double)
The current cost of the associated budget line item. This value is based on the workspace1 currency.
-
currentCostWorkspace2: number
(double)
The current cost of the associated budget line item. This value is based on the workspace2 currency.
-
currentCostWorkspace3: number
(double)
The current cost of the associated budget line item. This value is based on the workspace3 currency.
-
laborRate: number
(double)
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)
The cost per labor hour of the budget line item detail. This value is based on the workspace1 currency.
-
laborRateWorkspace2: number
(double)
The cost per labor hour of the budget line item detail. This value is based on the workspace2 currency.
-
laborRateWorkspace3: number
(double)
The cost per labor hour of the budget line item detail. This value is based on the workspace3 currency.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
unitRate: number
(double)
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)
The cost per Unit of Measure for the budget line item detail. This value is based on the workspace1 currency.
-
unitRateWorkspace2: number
(double)
The cost per Unit of Measure for the budget line item detail. This value is based on the workspace2 currency.
-
unitRateWorkspace3: number
(double)
The cost per Unit of Measure for the budget line item detail. This value is based on the workspace3 currency.
-
updateDate: string
(date-time)
Date when the record was last updated.
Nested Schema : ApiEntityBudgetTransactionConfiguredFieldValue
Type:
object
Title:
Show Source
ApiEntityBudgetTransactionConfiguredFieldValue
-
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)
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
This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
-
costValueWorkspace1: number
(double)
This holds values for Cost type configured fields in the workspace1 currency conversion.
-
costValueWorkspace2: number
(double)
This holds values for Cost type configured fields in the workspace2 currency conversion.
-
costValueWorkspace3: number
(double)
This holds values for Cost type configured fields in the workspace3 currency conversion.
-
dateValue: string
(date-time)
This holds values for Date type configured fields.
-
exceptionMessage: string
Maximum Length:
4000
Provides the error message for why the formula calculation resulted in an error. -
hasException: boolean
Determines if formula calculation hit an error calculating a value for this field.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
numberValue: number
This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
-
textValue: string
Maximum Length:
4000
This holds values for Boolean, List and Text type configured fields. -
updateDate: string
(date-time)
Date when the record was last updated.
404 Response
The requested program budget transfer does not exist, or you do not have access to it.