Issue a contract-level credit memo

POST/api/v1/contracts/{contract_id}/credit-memo

Issue a credit memo for the contract's customer (a contract discount / concession), linking the contract id into the memo description.

Operation ID: issue_contract_credit_memo_api_v1_contracts__contract_id__credit_memo_post·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: ContractCreditMemoRequest

amount_centsintegerrequired: Credit amount in cents.
reasonstring: Reason for the credit memo.
descriptionstring: Description of the credit.
issue_datestring · date: Issue date (defaults to today).

Responses

201Successful Response

Schema: SuccessEnvelope_CreditMemoResponse_

successboolean
messagestring
codestring
dataCreditMemoResponse

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

Code samples

POST/api/v1/contracts/{contract_id}/credit-memo

bash

curl -X POST 'https://api.ondayzero.com/api/v1/contracts/{contract_id}/credit-memo' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "amount_cents": 0
}'