List sales invoices
list_sales_invoicesRetrieve sales invoices from Moneybird with filters for status, period, contact, and reference. Pass a period to look beyond the current financial year and paginate through results.
Instructions
List sales invoices. Defaults to the current financial year, so pass an explicit period in the filter to look further back.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 1-based page number. | |
| filter | No | Comma-separated `key:value` filter. Keys: state (all|draft|open|scheduled|pending_payment|late|reminded|paid|uncollectible, pipe-separated for several), period (this_week|prev_week|next_week|this_month|prev_month|next_month|this_quarter|prev_quarter|next_quarter|this_year|prev_year|next_year, or a range like 20130101..20130131), reference, contact_id, recurring_sales_invoice_id, workflow_id, created_after, updated_after. A filter replaces Moneybird's default of `period:this_year` entirely. Several states can be combined with a pipe (`state:draft|scheduled`). A draft without an `invoice_date` is only matched by a period containing today, so list drafts with `state:draft` and no period. | |
| per_page | No | Records per page (max 100, Moneybird defaults to 50). | |
| administration_id | No | Administration to act on. Defaults to the administration this server was configured with; call list_administrations to discover the available ids. |