Skip to main content
POST
Create Change Order

Authorizations

X-API-KEY
string
header
required

Headers

Idempotency-Key
string

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.

Maximum string length: 255

Path Parameters

contract_id
integer
required

Body

application/json
effective_date
string<date> | null
memo
string
default:""
apply_cumulative_catchup
boolean
default:false
obligation_modifications
ObligationModificationIn · object[]
obligation_additions
PerformanceObligationIn · object[]

Response

Created

id
integer
required
number
integer
required
company_id
integer
required
company_name
string
required
contract_id
integer
required
contract_name
string
required
effective_date
string<date> | null
required
memo
string | null
required
apply_cumulative_catchup
boolean
required
transaction_id
integer | null
required
record_status
enum<string>
required
Available options:
draft,
posted,
archived
is_incomplete
boolean
required
obligation_modifications
Obligation Modifications · object[]
required
obligation_additions
PerformanceObligationIn · object[]
required
catchup_amount
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
change_summary
ObligationChangeSummary · object[]
Last modified on August 18, 2026