Start free trial

Edit contract

PATCH/api/v1/contracts/{contract_id}

Edit a contract's descriptive/schedule fields (number, first invoice date, estimated end date). Running tallies (billed/recognized/value) are maintained by the billing engine and cannot be edited.

Operation ID: update_contract_api_v1_contracts__contract_id__patch·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

contract_idstringrequired

Request body

Schema: ContractUpdate

numberstring

Contract reference number.

statusstring

Manual lifecycle change: 'completed' to close the contract, 'on_hold'/'paused' to pause billing, or 'active'/'resume' to resume a paused contract. Routed through the contract's lifecycle guards (can_be_paused / can_be_resumed).

first_invoice_datestring · date

Anchor date for the contract's term clock.

end_datestring · date

Estimated end of term.

line_itemsarray · ContractLineItemUpdate

Per-line edits to the contract's order lines. Lines omitted from the list are left untouched (this is not a wholesale replacement).

Responses

200Successful Response

Schema: SuccessEnvelope_ContractResponse_

successboolean
messagestring
codestring
dataContractResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject