Batch Integrate Budget Items with an External Data Source
post
/api/restapi/budgetItem/syncBatch
Send a request to this endpoint to create or update one or more integrated budget items. If an object provided in the request body does not exist in the application, an object is created using the request data. Integrated objects can only be modified using the API.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityExternallySourcedBudgetItemInput>
Type:
array
Title:
Show Source
List<ApiEntityExternallySourcedBudgetItemInput>
-
Array of:
object ApiEntityExternallySourcedBudgetItemInput
Title:
ApiEntityExternallySourcedBudgetItemInput
This entity represents a ExternallySourcedBudgetItem object, a unique ExternallySourcedBudgetItem object can be identified by the following combinations of the fields.- budgetItemId
- budgetItemCode,projectId
- budgetItemCode,projectCode,workspaceCode
Nested Schema : ApiEntityExternallySourcedBudgetItemInput
Type:
object
Title:
ApiEntityExternallySourcedBudgetItemInput
This entity represents a ExternallySourcedBudgetItem object, a unique ExternallySourcedBudgetItem object can be identified by the following combinations of the fields.
Show Source
- budgetItemId
- budgetItemCode,projectId
- budgetItemCode,projectCode,workspaceCode
-
abbreviation: string
Minimum Length:
1
Maximum Length:10
The abbreviated name of a cost category. -
budgetChangeId: integer(int64)Read Only:true
Deprecated. As of 23.11.Indicates whether the budget item originated in a budget change. -
budgetHours: number(double)Read Only:true
Deprecated. As of 23.11.The number of hours needed to complete the budget item. Calculated as Production Rate multiplied by Quantity. -
budgetItemCode: string
Minimum Length:
0
Maximum Length:60
The unique identifier of the project budget item. -
budgetItemCost:
budgetItemCost
Contains Budget Item cost related fields.
-
budgetItemId: integer
(int64)
The system-generated identifier of a budget item.
-
cbsCode: stringMinimum Length:1
Maximum Length:60
Deprecated. As of 23.5, replaced by 'ApiEntityBudgetItem.cbsCodes'.The CBS associated with this budget item. -
cbsCodes: array
cbsCodes
List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
-
cbsSheetCodeId(required): integer
(int64)
The unique identifier of the CBS Code.
-
configuredFields: array
configuredFields
The list of configured fields for a budget item.
-
costCategoryId: integer
(int64)
The type of cost associated with the budget item.
-
costCategoryName: string
Minimum Length:
1
Maximum Length:255
The cost category assigned to this budget item. -
itemName(required): string
Minimum Length:
0
Maximum Length:255
The name of the budget item. -
itemSuffix: integer(int64)Read Only:true
Deprecated. As of 23.11.The suffix of a budget item 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 item. -
projectBudgetId: integer
(int64)
The system-generated identifier of a project budget.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The project associated with this budget item. -
projectId(required): integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
quantity: number
(double)
The number of each budget item needed to complete the work.
-
sourceId: string
Maximum Length:
255
The unique identifier of budget item data in an external source. -
unitsOfMeasureId: integer
(int64)
The Unit of Measure used for the budget item.
-
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
Nested Schema : budgetItemCost
Contains Budget Item cost related fields.
Match All
Show Source
-
object
ApiEntityBudgetItemCostInput
Title:
ApiEntityBudgetItemCostInput
Nested Schema : cbsCodes
Type:
array
List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
Show Source
Nested Schema : configuredFields
Type:
array
The list of configured fields for a budget item.
Show Source
-
Array of:
object ApiEntityBudgetItemConfiguredFieldValueInput
Title:
ApiEntityBudgetItemConfiguredFieldValueInput
This entity represents a BudgetItemConfiguredFieldValue object, a unique BudgetItemConfiguredFieldValue object can be identified by the following combinations of the fields.- budgetItemConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
Nested Schema : ApiEntityBudgetItemCostInput
Type:
object
Title:
Show Source
ApiEntityBudgetItemCostInput
-
budgetItemId(required): integer
(int64)
The system-generated identifier of a budget item.
-
currentCost: number(double)Read Only:true
Deprecated. As of 23.11.The current cost of the 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 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 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 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 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. This value is based on the base currency. -
laborRateProject: number
(double)
The cost per labor hour of the budget line item. 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. 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. 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. 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. -
originalCost: number(double)Read Only:true
Minimum Value:0
Deprecated. As of 23.11.The original cost of the budget line item. This value is based on the base currency. -
originalCostProject: number
(double)
The original cost of the budget line item. This value is based on the project currency.
-
originalCostWorkspace1: number(double)Read Only:true
Deprecated. As of 23.11.The original cost of the budget line item. This value is based on the workspace1 currency. -
originalCostWorkspace2: number(double)Read Only:true
Deprecated. As of 23.11.The original cost of the budget line item. This value is based on the workspace2 currency. -
originalCostWorkspace3: number(double)Read Only:true
Deprecated. As of 23.11.The original cost of the budget line item. This value is based on the workspace3 currency. -
unitRate: number(double)Read Only:true
Deprecated. As of 23.11.The cost per Unit of Measure for the budget line item. This value is based on the base currency. -
unitRateProject: number
(double)
The cost per Unit of Measure for the budget line item. 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. 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. 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. 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 : ApiEntityBudgetItemConfiguredFieldValueInput
Type:
object
Title:
ApiEntityBudgetItemConfiguredFieldValueInput
This entity represents a BudgetItemConfiguredFieldValue object, a unique BudgetItemConfiguredFieldValue object can be identified by the following combinations of the fields.
Show Source
- budgetItemConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
budgetItemConfiguredFieldValueId: integer
(int64)
The unique identifier for the Budget Item Configured Field.
-
budgetItemId: integer
(int64)
The system-generated identifier for an Budget.
-
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
Supported Media Types
- application/json
207 Response
The object was successfully integrated.
Root Schema : List<ApiEntityERPSyncApiResponse>
Type:
array
Title:
Show Source
List<ApiEntityERPSyncApiResponse>
-
Array of:
object ApiEntityERPSyncApiResponse
Title:
ApiEntityERPSyncApiResponse
Nested Schema : ApiEntityERPSyncApiResponse
Type:
object
Title:
Show Source
ApiEntityERPSyncApiResponse
-
identifier: object
identifier
The unique identifier of the supported object returned based on the user input.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked. -
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
message: string
Message is populated based on result of the operation.
Success - Message will not be populated. Please refer the statusCode.
Failure - Error message or reason for operation failure is populated.
Warning - warning message is populated.
The field is non-persistable and thus maximum length is not applicable. -
primaryKeyName: string
The primary key field name associated with the integrated object.
The field is non-persistable and thus maximum length is not applicable. -
primaryKeyValue: integer
(int64)
The unique identifier for the integrated object.
-
sourceId: string
Maximum Length:
255
The unique identifier of the object in an external source. -
statusCode: integer
(int32)
The response code representing the state of the API operation.
-
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated.
Nested Schema : identifier
Type:
object
The unique identifier of the supported object returned based on the user input.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked.
Match One Schema
Show Source
-
object
ProjectIdentifier
Title:
ProjectIdentifier
-
object
CBSSheetCodeIdentifier
Title:
CBSSheetCodeIdentifier
-
object
ResourceIdentifier
Title:
ResourceIdentifier
Nested Schema : ProjectIdentifier
Type:
object
Title:
Show Source
ProjectIdentifier
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : CBSSheetCodeIdentifier
Type:
object
Title:
Show Source
CBSSheetCodeIdentifier
-
cbsCode: string
Maximum Length:
60
The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition. -
cbsSheetCodeId: integer
(int64)
The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition.
-
costSheetId: integer
(int64)
The unique identifier of a cost sheet.
-
parentId: integer
(int64)
The system-generated identifier of a parent cost item in a cost sheet.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ResourceIdentifier
Type:
object
Title:
Show Source
ResourceIdentifier
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
resourceClass: string
Allowed Values:
[ "RESOURCE", "ROLE" ]
The class identifies the item as a resource or a role. -
resourceCode: string
Maximum Length:
60
The unique identifier for the resource or role. -
resourceId: integer
(int64)
The unique identifier for the resource or role.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
400 Response
Invalid Input.