List documents
easybill_list_documentsRetrieve easybill documents with filters for type, date, customer, and status, including pagination to access invoices, offers, credit notes, reminders, deliveries, and orders.
Instructions
List documents from easybill with optional filters and pagination.
Covers every document type: invoices, offers, credit notes, reminders, deliveries, orders.
NOT the right tool for: finding out whether a customer exists (use easybill_find_customer), or orienting yourself before creating a document (see easybill_create_document). Only call this when you actually need to read existing documents, and always with a filter.
Common recipes:
Unpaid invoices: type='INVOICE', paid_at='null'
Revenue in a period: type='INVOICE', document_date='2025-01-01,2025-12-31'
A customer's history: customer_id=
Exclude drafts: is_draft='0' - exclude cancelled: cancel_id='null'
Returns a compact field set by default; pass 'fields' for specific columns or ['all'] for everything.
Returns: { total, count, page, pages, has_more, next_page, items[] }. Use 'next_page' to continue paging. Monetary values are integers in cents (150 = 1.50 EUR).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, starting at 1. Use 'next_page' from a previous response to continue. | |
| type | No | Filter by document type. One of INVOICE, RECURRING, CREDIT, OFFER, REMINDER, DUNNING, STORNO, STORNO_CREDIT, DELIVERY, PDF, CHARGE, CHARGE_CONFIRM, LETTER, ORDER, PROFORMA_INVOICE, STORNO_PROFORMA_INVOICE, or several comma-separated (e.g. 'INVOICE,CREDIT'). | |
| limit | No | Items per page, 1-1000 (default 25). Keep this small unless you need bulk data. | |
| title | No | Filter by document title. | |
| fields | No | Limit returned columns to these field names (e.g. ['number','amount','paid_at']). Pass ['all'] for every field. Omit for a compact default set. Fewer fields = less context used. | |
| number | No | Filter by document number (the official invoice number). Accepts one value or a list of values. | |
| ref_id | No | Filter by reference ID. | |
| status | No | Filter by status (ACCEPT, DONE, DROPSHIPPING, CANCEL). Not all types have one. | |
| paid_at | No | Filter by payment date. Single date 'YYYY-MM-DD' or an inclusive range 'YYYY-MM-DD,YYYY-MM-DD'. Use the literal string 'null' to find all UNPAID documents. | |
| is_draft | No | '0' = only completed documents, '1' = only drafts. | |
| cancel_id | No | Filter by the ID of the cancelling document. Use the literal string 'null' for all documents that are NOT cancelled. Accepts one value or a list of values. | |
| edited_at | No | Filter by last edit date. Single date 'YYYY-MM-DD' or an inclusive range 'YYYY-MM-DD,YYYY-MM-DD' | |
| is_archive | No | '0' = not archived, '1' = archived only. | |
| project_id | No | Filter by project ID. Accepts one value or a list of values. | |
| customer_id | No | Filter by customer ID. Accepts one value or a list of values. | |
| vat_country | No | Filter by VAT country (ISO 2-letter code). | |
| document_date | No | Filter by document date. Single date 'YYYY-MM-DD' or an inclusive range 'YYYY-MM-DD,YYYY-MM-DD' | |
| response_format | No | Output format: 'markdown' for readable prose, 'json' for machine-readable data | markdown |
| shipping_country | No | Filter by shipping country (ISO code). | |
| fulfillment_country | No | Filter by fulfillment country (ISO code). |