View a Budget Change by Code and Project
get
/primeapi/restapi/budgetChange/project/{id}/code/{code}
This endpoint returns budget changes that meet the following requirements:
- The object belongs to a project with an ID value that matches the value of the {id} path parameter.
- The object has a code that matches the value of the {code} path parameter.
Request
Path Parameters
-
code: string
The item code of a budget change.
-
id: integer(int64)
The system-generated identifier of a project.
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : ApiEntityBudgetChange
Type:
Show Source
object
-
approveByUserId(optional):
integer(int64)
Read Only:
true
The username of the user that approved the item. -
approveDate(optional):
object TimezoneSensitiveDateTime
-
budgetChangeConfiguredFields(optional):
object ApiEntityBudgetChangeConfiguredFields
-
budgetChangeCost(optional):
object ApiEntityBudgetChangeCost
-
budgetChangeId(optional):
integer(int64)
The system-generated identifier of a budget change. This value should not be provided in create operation request data, however, it is required for update requests.
-
budgetTransactions(optional):
array budgetTransactions
List of all budget transactions for the budget change.
-
description(optional):
string
Details supporting the change request.
-
itemCode:
string
The unique identifier of the project budget change request.
-
itemPrefix(optional):
string
The prefix of a budget change code.
-
itemSuffix(optional):
integer(int64)
The suffix of a budget change code.
-
lastModifiedById(optional):
integer(int64)
Read Only:
true
The username of the user who last made changes to the item. -
link(optional):
string(url)
Read Only:
true
-
projectBudgetId:
integer(int64)
The system-generated identifier of a project budget.
-
rejectByUserId(optional):
integer(int64)
Read Only:
true
The username of the user that rejected the item. -
rejectDate(optional):
object TimezoneSensitiveDateTime
-
status(optional):
string
Read Only:
true
Allowed Values:[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]
The state of the project budget change request. Pending: The change request is awaiting a decision. Approved: The change request was approved. Rejected: The change request was not approved. -
submitByUserId(optional):
integer(int64)
Read Only:
true
The username of the user that submitted the item. -
submitDate(optional):
object TimezoneSensitiveDateTime
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
withdrawApprovalByUserId(optional):
integer(int64)
Read Only:
true
The username of the user that with withdrew approval of the item. -
withdrawApprovalDate(optional):
object TimezoneSensitiveDateTime
Nested Schema : ApiEntityBudgetChangeConfiguredFields
Type:
Show Source
object
-
budgetChangeId(optional):
integer(int64)
The system-generated identifier of a budget change.
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing cost fields in the form of key-value pairs.
-
link(optional):
string(url)
Read Only:
true
-
otherFlexMap(optional):
object otherFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing non-cost, non-text fields in the form of key-value pairs.
-
textFlexMap(optional):
object textFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing text fields in the form of key-value pairs.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityBudgetChangeCost
Type:
Show Source
object
-
budgetChangeId(optional):
integer(int64)
The system-generated identifier of a budget change. This value should not be provided in create operation request data, however, it is required for update requests.
-
link(optional):
string(url)
Read Only:
true
-
totalCost(optional):
object Cost
-
totalCostProject(optional):
object Cost
-
totalCostWorkspace1(optional):
object Cost
-
totalCostWorkspace2(optional):
object Cost
-
totalCostWorkspace3(optional):
object Cost
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : budgetTransactions
Type:
array
List of all budget transactions for the budget change.
Show Source
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing cost fields in the form of key-value pairs.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing non-cost, non-text fields in the form of key-value pairs.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing text fields in the form of key-value pairs.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : Cost
Type:
object
Nested Schema : ApiEntityBudgetChangeTransaction
Type:
Show Source
object
-
approveDate(optional):
object TimezoneSensitiveDateTime
-
budgetCbsSheetCodeId(optional):
integer(int64)
The name of the CBS Code associated with the budget line item.
-
budgetChangeId(optional):
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(optional):
integer(int64)
The type of cost associated with the budget line item.
-
budgetHours(optional):
object Hour
-
budgetItemId(optional):
integer(int64)
A unique identifier for the budget item.
-
budgetItemName(optional):
string
The name of the budget item.
-
budgetTransactionConfiguredFields(optional):
object ApiEntityBudgetTransactionConfiguredFields
-
budgetTransactionCost(optional):
object ApiEntityBudgetTransactionCost
-
budgetTransactionId(optional):
integer(int64)
The system-generated identifier of a budget transaction.
-
itemCode(optional):
string
The unique identifier of the project budget line item detail.
-
itemCodeSuffix(optional):
integer(int64)
The suffix of a budget transaction code.
-
productionRate(optional):
object Hour
-
quantity(optional):
number(double)
Read Only:
true
The number of each budget line item needed to complete the work. -
status(optional):
string
Allowed Values:
[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]
The status of the transaction. Indicates whether the transaction is approved, pending, draft, or rejected. -
transactionType(optional):
string
Read Only:
true
Allowed Values:[ "ORIGINAL", "CHANGE", "TRANSFER" ]
Specifies whether the budget row is an original, change, or transfer value. -
unitOfMeasureId(optional):
integer(int64)
Read Only:
true
The Unit of Measure used for the budget line item detail.
Nested Schema : ApiEntityBudgetTransactionConfiguredFields
Type:
Show Source
object
-
budgetTransactionId(optional):
integer(int64)
The system-generated identifier of a budget item.
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesA list of all configured cost fields and values assigned to the budget change in the form of key-value pairs.
-
link(optional):
string(url)
Read Only:
true
-
otherFlexMap(optional):
object otherFlexMap
Additional Properties Allowed: additionalPropertiesA list of all configured other fields and values assigned to the budget change in the form of key-value pairs.
-
textFlexMap(optional):
object textFlexMap
Additional Properties Allowed: additionalPropertiesA list of all configured text fields and values assigned to the budget change in the form of key-value pairs.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityBudgetTransactionCost
Type:
Show Source
object
-
amountCost:
object Cost
-
amountCostProject(optional):
object Cost
-
amountCostWorkspace1(optional):
object Cost
-
amountCostWorkspace2(optional):
object Cost
-
amountCostWorkspace3(optional):
object Cost
-
budgetTransactionId(optional):
integer(int64)
The system-generated identifier of a budget transaction. This value should not be provided in create operation request data, however, it is required for update requests.
-
currentCost(optional):
object Cost
-
currentCostProject(optional):
object Cost
-
currentCostWorkspace1(optional):
object Cost
-
currentCostWorkspace2(optional):
object Cost
-
currentCostWorkspace3(optional):
object Cost
-
laborRate(optional):
object Cost
-
laborRateProject(optional):
object Cost
-
laborRateWorkspace1(optional):
object Cost
-
laborRateWorkspace2(optional):
object Cost
-
laborRateWorkspace3(optional):
object Cost
-
link(optional):
string(url)
Read Only:
true
-
unitRate(optional):
object Cost
-
unitRateProject(optional):
object Cost
-
unitRateWorkspace1(optional):
object Cost
-
unitRateWorkspace2(optional):
object Cost
-
unitRateWorkspace3(optional):
object Cost
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
A list of all configured cost fields and values assigned to the budget change in the form of key-value pairs.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
A list of all configured other fields and values assigned to the budget change in the form of key-value pairs.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
A list of all configured text fields and values assigned to the budget change in the form of key-value pairs.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
404 Response
The requested budget change does not exist, or you do not have access to it.