get_outstanding_documents
Retrieve all posted customer invoices, vendor bills, employee vouchers, and credit notes with outstanding balances. Get the authoritative unpaid list, sorted most-overdue-first.
Instructions
Get all posted customer invoices, vendor bills, employee vouchers, and credit notes with outstanding balances.
This is the authoritative unpaid list: outstanding = posted
with a remaining balance > 0. One call answers "what is
actually unpaid?" — no need to combine list_documents and
get_document (full status vocabulary on list_documents).
Leads with a Showing X-Y of Z invoices (date range) line,
then a compact one-line-per-doc format by default with action
columns (due date, days past due, currency, BILL tag, owner).
Sorted most-overdue-first so the bookkeeper sees the urgent
items at the top. Page with offset; limit=0 returns the
count only.
Use verbose=true for structured JSON with original_amount /
amount_paid / amount_due breakdown — the shape
pay_document workflows expect.
Args: party_type: Filter by "customer" or "vendor". Omit for all. customer_id: Filter by specific customer ID. vendor_id: Filter by specific vendor ID. 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. offset: 0-indexed first row to return (default 0).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| verbose | No | ||
| vendor_id | No | ||
| party_type | No | ||
| customer_id | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |