Sign in
Contracts

Create Change Order

Create a change order on a contract. Incomplete payloads are saved as drafts. Complete payloads are validated and applied.

post/public/v2/contracts/{contract_id}/change-orders/

Path parameters

contract_idinteger required

Headers

Idempotency-Keystring

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Request body

effective_datestring date nullable
memostring
apply_cumulative_catchupboolean

Response

Created

idinteger required
numberinteger required
company_idinteger required
company_namestring required
contract_idinteger required
contract_namestring required
effective_datestring date nullable required
memostring nullable required
apply_cumulative_catchupboolean required
catchup_amountstring nullable
transaction_idinteger nullable required
record_status'draft' | 'posted' | 'archived' required
is_incompleteboolean required
obligation_modificationsobject[] required

Changes

Changed in 2 of the 14 revisions of this API.5

  • 4849d2498a134See the full diff
    • ○

      added the new optional request property obligation_additions/items/ramp_group_id

      new-optional-request-property

    • ○

      added the optional property change_summary/items/predecessor/anyOf[subschema #1: PerformanceObligationOut]/ramp_group_id to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property change_summary/items/successor/anyOf[subschema #1: PerformanceObligationOut]/ramp_group_id to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property obligation_additions/items/ramp_group_id to the response with the 201 status

      response-optional-property-added

  • f338ec8b3f521See the full diff
    • ○

      endpoint added

      endpoint-added