Contracts

Create Change Order

Changed on

Create a change order on a contract. effective_date is required. An addition requires item_id, quantity, and rate. A payload with no modifications or additions is saved as a draft. With an effective_date after today, the save keeps this change order as draft and applies nothing. With a date of today or earlier, the save validates and applies it.

  • An omitted billing_frequency or billing_interval uses the item catalog before the monthly default.
post/public/v2/contracts/{contract_id}/change-orders/

Request

  • Base URL: https://api.dualentry.com
  • URL: https://api.dualentry.com/public/v2/contracts/{contract_id}/change-orders/
  • Auth: none declared

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 required
memostring
apply_cumulative_catchupboolean

Response

Created

idinteger required
numberinteger required
codestring nullable
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
book_idsinteger[] required

Changes

  • 7588ae19aaffRevision changes
    • warning

      the // request property's min was set to 1.00

    • warning

      the // request property's min was set to 1.00

  • 3d645439b1e4Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status