Apply credit memo to invoice

POST/api/v1/credit-memos/{credit_memo_id}/apply

Apply a portion or all of a credit memo to an invoice.

Operation ID: apply_credit_memo_api_v1_credit_memos__credit_memo_id__apply_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

credit_memo_idstringrequired

Request body

Schema: CreditMemoApplicationCreate

invoice_idstringrequired: Invoice to apply credit to
amount_centsintegerrequired: Amount to apply in cents

Responses

201Successful Response

Schema: SuccessEnvelope_CreditMemoApplicationResponse_

successboolean
messagestring
codestring
dataCreditMemoApplicationResponse

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/credit-memos/{credit_memo_id}/apply

bash

curl -X POST 'https://api.ondayzero.com/api/v1/credit-memos/{credit_memo_id}/apply' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "invoice_id": "string",
  "amount_cents": 0
}'