List sales receipts

GET/api/v1/sales-receipts

List sales receipts and refund receipts for the business.

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

Query

receipt_typestring

Filter by type: sale or refund.

statusstring

Filter by status: posted or void.

customer_idstring

Filter by customer.

cursorstring

Cursor for pagination

limitinteger

Pagination limit

directionstringdefault: next

Pagination direction: 'next' or 'prev'

include_total_countbooleandefault: False

Whether to include total count (expensive - avoid if possible)

sort_bystring

Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.

descendingbooleandefault: True

Sort direction: true for descending (newest/largest first), false for ascending

Responses

200Successful Response

itemsarray · SalesReceiptResponserequiredSalesReceiptResponse

List of items

22 fields
idstringrequired
business_idstringrequired
numberstring
receipt_typestringrequired
statusstringrequired
customer_idstring
customer_namestring
receipt_datestring · daterequired
deposit_to_ledger_idstringrequired
deposit_to_ledger_namestring
income_ledger_idstring
income_ledger_namestring
line_itemsarray · object
subtotalintegerrequired
tax_totalintegerrequired
totalintegerrequired
memostring
currencystringrequired
journal_entry_idstring
void_journal_entry_idstring
created_atstring · date-timerequired
updated_atstring · date-timerequired
totalinteger

Total number of items (null when not calculated for performance)

limitinteger

Pagination limit

next_cursorstring

Cursor for next page

prev_cursorstring

Cursor for previous page

has_nextbooleanrequired

Whether there are more items

has_prevbooleanrequired

Whether there are previous items

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation Error

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject