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_id string required

Responses

200 Successful Response

Schema: CustomerCreditSummary

customer_id string required

Customer ID

customer_name string

Customer display name

total_credits_available integer required

Total available credits in cents

total_credits_available_dollars string required

Total available credits in dollars

credit_memos_count integer required

Number of credit memos with available balance

credit_memos array · CreditMemoResponse CreditMemoResponse

Credit memos with available balance

31 fields
id string required

Credit memo ID

business_id string required

Business that issued the credit

customer_id string required

Customer receiving the credit

invoice_id string

Original invoice being credited

number string

Auto-generated credit memo number (e.g. CM-001)

status string required

Status: draft, issued, partially_applied, fully_applied, void

currency string required

ISO currency code (e.g. USD)

amount integer required

Total credit amount in cents

amount_in_dollars string required

Total credit amount in dollars

amount_applied integer required

Amount applied in cents

amount_applied_in_dollars string required

Amount applied in dollars

amount_remaining integer required

Remaining amount in cents

amount_remaining_in_dollars string required

Remaining amount in dollars

issue_date string · date required

Date the credit memo was issued

applied_date string · date-time

When credits were last applied

created_at string · date-time required

Record creation timestamp

updated_at string · date-time required

Last update timestamp

reason string required

Reason code (e.g. pricing_error, refund, other)

reason_display string required

Human-readable reason label

description string

Description of the credit

internal_notes string

Internal notes (not visible to customer)

line_items object

Detailed line items breakdown

voided_at string · date-time

When the credit memo was voided

voided_reason string

Reason for voiding

customer_name string

Customer display name

invoice_number string

Original invoice number

applications array · CreditMemoApplicationResponse

Applications to invoices

can_be_applied boolean required

Whether credits can be applied to invoices

can_be_voided boolean required

Whether the credit memo can be voided

can_be_deleted boolean required

Whether the credit memo can be deleted (drafts only)

has_applications boolean required

Whether any credits have been applied

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError
5 fields
loc array · string | integer required
msg string required
type string required
input object
ctx object