200Successful Response
Schema: SuccessEnvelope_InvoiceListResponse_
successbooleanmessagestringcodestringdataInvoiceListResponse
/api/v1/invoicesRetrieve invoices with optional filtering by customer, product, or status.
Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.
idstringFilter by specific invoice UUID
customer_idstringFilter by customer UUID
product_idstringFilter by product UUID
variant_idstringFilter by variant UUID
statusarray · stringFilter by status. Supports repeated params (?status=open&status=partially-paid) or bracket notation (?status[]=open&status[]=partially-paid).
searchstringSearch invoices by number, description, or customer name (case-insensitive partial match)
cursorstringCursor for pagination
limitintegerPagination limit
directionstringdefault: nextPagination direction: 'next' or 'prev'
include_total_countbooleandefault: FalseWhether to include total count (expensive - avoid if possible)
sort_bystringColumn name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.
descendingbooleandefault: TrueSort direction: true for descending (newest/largest first), false for ascending
Schema: SuccessEnvelope_InvoiceListResponse_
successbooleanmessagestringcodestringdataInvoiceListResponseSchema: HTTPValidationError
detailarray · ValidationErrorValidationErrorlocarray · string | integerrequiredmsgstringrequiredtypestringrequiredinputobjectctxobject