List orders
cashctrl_list_ordersRead-only
Sales or purchase documents (quotes, order confirmations, invoices, delivery notes, credit notes, vendor bills) with number, date, customer, status and total. Newest first. GET /order/list.json.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dir | No | Sort direction (each list has its own default). | |
| sort | No | Column to sort by (a column name of the list reply; each list has its own default). | |
| type | No | SALES or PURCHASE documents. | |
| limit | No | Rows to return, 1-500 (default 100). | |
| query | No | Full-text search. | |
| start | No | Index of the first row (default 0). Use next_start from the previous reply. | |
| filter | No | Column filters, all must match (AND). | |
| only_open | No | Only open (not completed) orders, for example unpaid invoices. | |
| person_id | No | Only orders of this person (cashctrl_list_persons). | |
| status_id | No | Only this status (the status ids are in cashctrl_list_order_categories). | |
| category_id | No | Only this order category (cashctrl_list_order_categories), for example Invoice. | |
| only_overdue | No | Only orders past their due date. | |
| fiscal_period_id | No | Fiscal period id (cashctrl_list_fiscal_periods); default is the current period. |