List Books Invoices
Lists the sales invoices in the client's own books, most recent first. Paged like any other list: pass 'offset' and 'limit' and you get exactly that window, whatever page size the platform behind it uses. 'totalCount' is null on platforms that report no total — read 'hasMore' rather than inferring the end from a short page. Pass 'status' to list only invoices in one status; the platform does the filtering, so the window and total are of the matching invoices (a status the platform never produces is an empty list). Pass 'dateRange' (a PresetDateRange) to list only invoices dated in that period, or dateRange=CustomDateRange with 'dateFrom' and 'dateTo' (inclusive).
Parameters
| Name | Type | Description |
|---|---|---|
| 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) |
||