Batch Integrate Change Orders with an External Data Source
post
/primeapi/restapi/changeOrder/syncBatch
Send a request to this endpoint to create or update one or more integrated change orders. 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
Supported Media Types
- application/json
The unique identifier of change order data in an external source.S
Root Schema : List<ApiEntityExternallySourcedChangeOrder>
Type:
array
Title:
Show Source
List<ApiEntityExternallySourcedChangeOrder>
Nested Schema : ApiEntityExternallySourcedChangeOrder
Type:
Show Source
object
-
approveByUserName:
string
Read Only:
true
The name of the user that approved the change order. -
associatedAgreementCode:
string
The code of the aggrement associated with the change order.
-
associatedAgreementLinkId:
integer(int64)
The contract associated with the change order.
-
cancelByUser:
string
Read Only:
true
The name of the user that canceled the change order. -
changeEventId:
integer(int64)
The change event of the change order.
-
changeOrderConfiguredFields:
object ApiEntityChangeOrderConfiguredFields
-
changeOrderCost:
object ApiEntityChangeOrderCost
-
changeOrderId:
integer(int64)
The system-generated identifier of the change order.
-
closeByUserName:
string
Read Only:
true
The name of the user that closed the change order. -
currencyCode:
string
Read Only:
true
The user-specified identifier of a currency. -
currencyId:
integer(int64)
Read Only:
true
The currency in which the change order line item is written. -
description:
string
A brief explanation of the change order line item.
-
fixedExchangeRate:
number
Read Only:
true
The rate of exchange between the currency of the change order line item and the base currency, if the currencies are different. If the currencies are the same, this field is disabled. -
fromCompanyId:
integer(int64)
Read Only:
true
The company that awarded the change order. -
fromCompanyName:
string
Read Only:
true
The name of the company the change order is sent by. -
fromCompanySourceId:
string
The unique identifier of company data in an external source.
-
fromContactId:
integer(int64)
The person in the Awarded From company who is officially responsible for communications about the associated agreement.
-
fromContactUserName:
string
The name of the user associated with the change order's from company.
-
itemCode:
string
The unique identifier for the change order.
-
itemPrefix:
string
The prefix of a change order code.
-
itemSuffix:
integer(int64)
The suffix of a change order code.
-
link:
string(uri)
Read Only:
true
-
name:
string
The change event of the change order.
-
periodAppliedDate:
string(date-time)
The billing period of the payment application to which the change order schedule of values is applied.
-
projectCode:
string
The user-specified identifier of a project.
-
projectId:
integer(int64)
The project that corresponds to the change order.
-
projectSourceId:
string
The unique identifier of project data in an external source.
-
rejectByUserName:
string
Read Only:
true
The name of the user that rejected the change order. -
reopenByUserName:
string
Read Only:
true
The name of the user that reopened the change order. -
sourceId:
string
Change order data from an external source.
-
status:
string
Allowed Values:
[ "DRAFT", "PENDING", "APPROVED", "REJECTED", "CLOSED" ]
The status of the change order. -
statusTransitionData:
object ApiEntityCmStatusTransitionData
-
submitByUserName:
string
Read Only:
true
The name of the user that submitted the change order. -
timeChange:
integer(int32)
The amount of time added to or subtracted from the commitment as a result of the change order.
-
toCompanyId:
integer(int64)
Read Only:
true
The company to which the change order was awarded. -
toCompanyName:
string
Read Only:
true
The name of the company the change order is addressed to. -
toCompanySourceId:
string
The unique identifier of company data in an external source.
-
toContactId:
integer(int64)
The person in the Awarded To company who is officially responsible for communications about the change order.
-
toContactUserName:
string
The name of the user associated with the change order's to company.
-
type:
string
Allowed Values:
[ "CONTRACT", "COMMITMENT" ]
Specifies the nature of the link. -
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date. -
voidByUser:
string
Read Only:
true
The name of the user that voided the change order. -
withdrawApprovalByUserName:
string
Read Only:
true
The name of the user that withdrew approval of the change order. -
workspaceCode:
string
The user-specified identifier of a workspace.
Nested Schema : ApiEntityChangeOrderConfiguredFields
Type:
Show Source
object
-
changeOrder:
object ApiEntityChangeOrder
-
changeOrderId:
integer(int64)
The system-generated identifier of the change order.
-
costFlexMap:
object costFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing cost type configured fields in the form of key-value pairs.
-
link:
string(uri)
Read Only:
true
-
otherFlexMap:
object otherFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing non-text and non-cost configured fields in the form of key-value pairs.
-
textFlexMap:
object textFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing text fields in the form of key-value pairs.
-
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.
Nested Schema : ApiEntityChangeOrderCost
Type:
Show Source
object
-
changeOrderId:
integer(int64)
Read Only:
true
The system-generated identifier of a change order. -
changeValue:
object Cost
-
changeValueAssociatedAgreement:
object Cost
-
changeValueCommitment:
object Cost
-
changeValueContract:
object Cost
-
changeValueProject:
object Cost
-
changeValueWorkspace1:
object Cost
-
changeValueWorkspace2:
object Cost
-
changeValueWorkspace3:
object Cost
-
link:
string(uri)
Read Only:
true
-
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.
Nested Schema : ApiEntityCmStatusTransitionData
Type:
Show Source
object
-
approveByUserId:
integer(int64)
The user who approved the agreement, change, or payment application.
-
approveDate:
string(date-time)
The date the agreement, change, or payment application was approved.
-
cancelByUserId:
integer(int64)
The user who cancelled the agreement, change, or payment application.
-
cancelDate:
string(date-time)
The date the agreement, change, or payment application was cancelled.
-
closeByUserId:
integer(int64)
The user who closed the agreement, change order, or payment application.
-
closeDate:
string(date-time)
The date the agreement, change, or payment application was closed.
-
lastStatusTransitionType:
string
Allowed Values:
[ "SUBMIT", "APPROVE", "WITHDRAW_APPROVAL", "CLOSE", "REOPEN", "REJECT", "VOID", "WITHDRAW", "ANSWERED", "NONE" ]
The last status of the agreement, change, or payment application. -
link:
string(uri)
Read Only:
true
-
rejectByUserId:
integer(int64)
The user who rejected the agreement, change, or payment application.
-
rejectDate:
string(date-time)
The date when the agreement, change, or payment application was rejected.
-
reopenDate:
string(date-time)
The date when the agreement, change, or payment application was reopened.
-
rreopenByUserId:
integer(int64)
The user who reopened the agreement.
-
statusTransitionId:
integer(int64)
The system-generated identifier of a status transition.
-
submitByUserId:
integer(int64)
The user who submitted the agreement, change, or payment application for approval.
-
submitDate:
string(date-time)
The date the agreement, change, or payment application was submitted for approval.
-
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date. -
voidByUserId:
integer(int64)
The user who voided the agreement, change, or payment application.
-
voidDate:
string(date-time)
The date the agreement, change, or payment application was voided.
-
withdrawApprovalByUserId:
integer(int64)
The user who withdrew approval of the agreement, change, or payment application.
-
withdrawApprovalDate:
string(date-time)
The date when approval for the agreement, change, or payment application was withdrawn.
-
withdrawByUserId:
integer(int64)
The user who withdrew the agreement, change, or payment application.
-
withdrawDate:
string(date-time)
The date the agreement, change, or payment application was withdrawn.
Nested Schema : ApiEntityChangeOrder
Type:
Show Source
object
-
approveByUserName:
string
Read Only:
true
The name of the user that approved the change order. -
associatedAgreementCode:
string
The code of the aggrement associated with the change order.
-
associatedAgreementLinkId:
integer(int64)
The contract associated with the change order.
-
cancelByUser:
string
Read Only:
true
The name of the user that canceled the change order. -
changeEventId:
integer(int64)
The change event of the change order.
-
changeOrderConfiguredFields:
object ApiEntityChangeOrderConfiguredFields
-
changeOrderCost:
object ApiEntityChangeOrderCost
-
changeOrderId:
integer(int64)
The system-generated identifier of the change order.
-
closeByUserName:
string
Read Only:
true
The name of the user that closed the change order. -
currencyCode:
string
Read Only:
true
The user-specified identifier of a currency. -
currencyId:
integer(int64)
Read Only:
true
The currency in which the change order line item is written. -
description:
string
A brief explanation of the change order line item.
-
fixedExchangeRate:
number
Read Only:
true
The rate of exchange between the currency of the change order line item and the base currency, if the currencies are different. If the currencies are the same, this field is disabled. -
fromCompanyId:
integer(int64)
Read Only:
true
The company that awarded the change order. -
fromCompanyName:
string
Read Only:
true
The name of the company the change order is sent by. -
fromCompanySourceId:
string
The unique identifier of company data in an external source.
-
fromContactId:
integer(int64)
The person in the Awarded From company who is officially responsible for communications about the associated agreement.
-
fromContactUserName:
string
The name of the user associated with the change order's from company.
-
itemCode:
string
The unique identifier for the change order.
-
itemPrefix:
string
The prefix of a change order code.
-
itemSuffix:
integer(int64)
The suffix of a change order code.
-
link:
string(uri)
Read Only:
true
-
name:
string
The change event of the change order.
-
periodAppliedDate:
string(date-time)
The billing period of the payment application to which the change order schedule of values is applied.
-
projectCode:
string
The user-specified identifier of a project.
-
projectId:
integer(int64)
The project that corresponds to the change order.
-
projectSourceId:
string
The unique identifier of project data in an external source.
-
rejectByUserName:
string
Read Only:
true
The name of the user that rejected the change order. -
reopenByUserName:
string
Read Only:
true
The name of the user that reopened the change order. -
sourceId:
string
Change order data from an external source.
-
status:
string
Allowed Values:
[ "DRAFT", "PENDING", "APPROVED", "REJECTED", "CLOSED" ]
The status of the change order. -
statusTransitionData:
object ApiEntityCmStatusTransitionData
-
submitByUserName:
string
Read Only:
true
The name of the user that submitted the change order. -
timeChange:
integer(int32)
The amount of time added to or subtracted from the commitment as a result of the change order.
-
toCompanyId:
integer(int64)
Read Only:
true
The company to which the change order was awarded. -
toCompanyName:
string
Read Only:
true
The name of the company the change order is addressed to. -
toCompanySourceId:
string
The unique identifier of company data in an external source.
-
toContactId:
integer(int64)
The person in the Awarded To company who is officially responsible for communications about the change order.
-
toContactUserName:
string
The name of the user associated with the change order's to company.
-
type:
string
Allowed Values:
[ "CONTRACT", "COMMITMENT" ]
Specifies the nature of the link. -
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date. -
voidByUser:
string
Read Only:
true
The name of the user that voided the change order. -
withdrawApprovalByUserName:
string
Read Only:
true
The name of the user that withdrew approval of the change order. -
workspaceCode:
string
The user-specified identifier of a workspace.
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing cost type configured fields in the form of key-value pairs.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing non-text and non-cost configured 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
Response
Supported Media Types
- application/json
207 Response
Successful Sync Operation.
Nested Schema : ApiEntityERPSyncApiResponse
Type:
Show Source
object
-
link:
string(uri)
Read Only:
true
-
message:
string
-
primaryKey:
integer(int64)
-
primaryKeyName:
string
-
primaryKeyValue:
integer(int64)
-
sourceId:
string
-
statusCode:
integer(int32)
-
uniqueName:
string
-
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.
400 Response
Invalid Input.