List Books Bills

GET /tenants/{tenant}/clients/{clientCode}/books/bills

Lists the bills (purchase invoices) in the client's own books, most recent first: what the client owes its suppliers. Paged and filtered exactly like the invoices endpoint: 'offset' and 'limit' give that window, 'totalCount' may be null (read 'hasMore'), 'status' and 'dateRange' (or dateRange=CustomDateRange with 'dateFrom' and 'dateTo') are answered by the platform. Statuses are the invoice ones; Overdue here means the client has not paid the supplier by the due date, and a status no bill can be in on that platform (Draft on FreeAgent or QuickBooks, say) is an empty list.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

status query enum

Unknown Draft Unpaid Paid Overdue Void PartiallyPaid

Unknown Draft Unpaid Paid Overdue Void PartiallyPaid

clientCode* path string
dateFrom query string (date)
dateRange query enum

ThisWeek NextWeek Last7Days Next7Days Last30Days Next30Days PreviousMonth ThisMonth NextMonth PreviousQuarter ThisQuarter NextQuarter PreviousYear ThisYear NextYear YearToDate PreviousTaxYear ThisTaxYear NextTaxYear TaxYearToDate Today PreviousWeek CustomDateRange

ThisWeek NextWeek Last7Days Next7Days Last30Days Next30Days PreviousMonth ThisMonth NextMonth PreviousQuarter ThisQuarter NextQuarter PreviousYear ThisYear NextYear YearToDate PreviousTaxYear ThisTaxYear NextTaxYear TaxYearToDate Today PreviousWeek CustomDateRange

dateTo query string (date)
offset query integer (int32)

Number of records to skip (default: 0). Use with limit for pagination.

Number of records to skip (default: 0). Use with limit for pagination.

limit query integer (int32)

Maximum number of records to return (default: 10, max: 50)

Maximum number of records to return (default: 10, max: 50)

Responses

400 Bad Request
401 Unauthorized – Invalid or missing API key
404 Not Found