Skip to main content
PUT
Update Change Order
effective_date is required. An addition requires item_id, quantity, and rate. A payload with no modifications or additions stays 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, completing required fields applies the change order.
  • An omitted billing_frequency or billing_interval uses the item catalog before the monthly default.
  • On released v1 and v2, a new obligation stores a billing period count of 1. quantity is the quantity for the whole term. On v3, quantity is the quantity for each billing period.
Side effects
  • If this change order was already applied, DualEntry first reverses those changes. DualEntry applies this change order again only if effective_date is today or earlier.

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
change_order_id
integer
required

Body

application/json
effective_date
string<date>
required
memo
string
default:""
apply_cumulative_catchup
boolean
default:false
obligation_modifications
PublicContractChangeOrderObligationModificationIn · object[]
obligation_additions
PublicContractChangeOrderObligationAdditionIn · object[]
record_status
enum<string> | null
Available options:
draft,
posted,
archived

Response

OK

created_at
string<date-time>
required

Date and time the record was created

updated_at
string<date-time>
required

Date and time the record was last updated

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
ObligationAdditionOut · object[]
required
book_ids
integer[]
required
code
string | null
catchup_amount
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
change_summary
ObligationChangeSummary · object[]