list_documents
List customer invoices, vendor bills, employee vouchers, and credit notes with filters by status, type, or party, and pagination. Use verbose mode for structured JSON details.
Instructions
List customer invoices, vendor bills, employee vouchers, and credit notes.
Leads with a Showing X-Y of Z invoices (date range) line,
then a compact one-line-per-invoice format by default. Page with
offset; limit=0 returns the count only. Use verbose=true
for structured JSON with GUIDs, dates, notes, etc.
Status vocabulary (shared by every invoice/bill tool):
open = created and editable, not yet booked to A/R//A/P —
not payable. posted = booked to A/R//A/P with a lot
tracking its balance — payable. paid = posted with a zero
remaining balance (lot closed). outstanding = posted with
a remaining balance — the unpaid subset; get it directly from
get_outstanding_documents rather than deriving it here.
The status filter below covers document state
(open/posted) only; settlement state lives on the lot.
Args: status: Filter by status: "posted" or "open", or omit for all. document_type: Filter to one document kind ("invoice", "bill", "voucher", "credit_note"). Omit for all. party_type: Filter by owner side ("customer", "vendor"). Omit for all. verbose: If false (default), compact text output — optimized for reading and token efficiency. If true, structured JSON, for when you need machine-readable fields rather than a report. limit: Page size (default 50, max 250). 0 = count only. job_id: Filter to invoices grouped under a specific job — useful for the "what's part of this engagement?" listing pattern. offset: 0-indexed first row to return (default 0).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| job_id | No | ||
| offset | No | ||
| status | No | ||
| verbose | No | ||
| party_type | No | ||
| document_type | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |