View Budget Transactions by Project Budget Change
get
/api/restapi/budgetChange/{budgetChangeId}/transactions
This endpoint returns budget transactions that meet the following requirements:
- The object is associated with a project budget change with an ID value that matches the value of the {budgetChangeId} path parameter.
Request
Path Parameters
-
budgetChangeId(required): integer(int64)
The system-generated identifier of a budget change.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityBudgetChangeTransaction>
Type:
array
Title:
Show Source
List<ApiEntityBudgetChangeTransaction>
-
Array of:
object ApiEntityBudgetChangeTransaction
Title:
ApiEntityBudgetChangeTransaction
Nested Schema : ApiEntityBudgetChangeTransaction
Type:
object
Title:
Show Source
ApiEntityBudgetChangeTransaction
-
action: string
Allowed Values:
[ "DELETE" ]
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.
-
budgetCbsSheetCodeId: integer
(int64)
The name of the CBS Code associated with the budget line item.
-
budgetChangeId: 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.
-
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.
-
changeMode: string
Allowed Values:
[ "AUTO", "MANUAL", "CHANGE" ]
The detailed budget change line item. -
configuredFields: array
configuredFields
The list of configured fields for a budget change transaction.
-
desiredCode: string
Minimum Length:
0
Maximum Length:60
A unique identifier for the budget item (Add Budget Line). -
itemCode: string
Maximum Length:
60
The unique identifier for the budget line 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. -
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 change 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.
204 Response
Successful operation with no content.
404 Response
The requested project budget change does not exist, or you do not have access to it.