list_documents
List documents by type with filters for date, contact, and payment status to find specific invoices, receipts, or orders.
Instructions
List all documents of a specific type with optional filters for date range, contact, payment status, and sorting. Supports field filtering to reduce response size.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| docType | Yes | Type of document to list | |
| page | No | Page number for pagination (optional) | |
| limit | No | Maximum number of items to return (default: 50, max: 500) | |
| summary | No | Return only count and pagination metadata without items (default: false) | |
| starttmp | No | Starting timestamp (Unix timestamp) for filtering documents by date | |
| endtmp | No | Ending timestamp (Unix timestamp) for filtering documents by date | |
| contactid | No | Filter documents by contact ID | |
| paid | No | Filter by payment status: 0=not paid, 1=paid, 2=partially paid | |
| billed | No | Filter by billed status: 0=not billed, 1=billed | |
| sort | No | Sort order by creation date | |
| fields | No | Select specific fields to return (e.g., ["id", "contactName", "total"]). Reduces response size by 70-90%. If not provided, returns default fields: id, contact, contactName, date, tax, total, status |