Contracts
Update Change Order
Update an existing change order.
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_frequencyorbilling_intervaluses the item catalog before the monthly default. - On released v1 and v2, a new obligation stores a billing period count of 1.
quantityis the quantity for the whole term. On v3,quantityis the quantity for each billing period.
- If this change order was already applied, DualEntry first reverses those changes. DualEntry applies this change order again only if
effective_dateis today or earlier.
Headers
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:
255Body
application/json
Response
OK