Create credit memo

POST/api/v1/credit-memos

Create a new credit memo in draft status.

Operation ID: create_credit_memo_api_v1_credit_memos_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.

Request body

Schema: CreditMemoCreate

customer_idstringrequired: Customer receiving the credit
amount_centsintegerrequired: Credit amount in cents
restocking_fee_centsinteger: Restocking fee withheld on a return (cents). Recognized as income; the gross value reversed is amount_cents + this fee.
reasonCreditMemoReasonEnumCreditMemoReasonEnum: Reason for the credit memo
descriptionstring: Description of the credit
invoice_idstring: Original invoice being credited (optional)
issue_datestring · date: Issue date (defaults to today)
line_itemsarray · CreditMemoLineItem: Optional line items for credit detail
internal_notesstring: Internal notes (not visible to customer)

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/credit-memos

bash

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