Get customer available credits

GET/api/v1/credit-memos/customers/{customer_id}/credits

Get summary of available credits for a customer.

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

customer_idstringrequired

Responses

200Successful Response

Schema: SuccessEnvelope_CustomerCreditSummary_

successboolean
messagestring
codestring
dataCustomerCreditSummary

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

GET/api/v1/credit-memos/customers/{customer_id}/credits

bash

curl -X GET 'https://api.ondayzero.com/api/v1/credit-memos/customers/{customer_id}/credits' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'