invoiceninja_list_purchase_orders
List purchase orders from Invoice Ninja with filters for status, dates, vendors, sorting, and pagination; use an id from results to fetch the full order record.
Instructions
List purchase orders from Invoice Ninja with filtering, sorting and pagination. client_status values: all, draft, sent, accepted, cancelled. extra_filters keys: date_range ('YYYY-MM-DD,YYYY-MM-DD' on the document date, or 'due_date,YYYY-MM-DD,YYYY-MM-DD' for another column), date (on/after YYYY-MM-DD), due_date (on/before YYYY-MM-DD), number, vendor_id; created_between / updated_between ('YYYY-MM-DD,YYYY-MM-DD'), tag_ids (comma separated), assigned_user_ids. Related names are resolved automatically (vendor_name). Use invoiceninja_get_purchase_order with an id from this list for the full record.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, starting at 1 | |
| sort | No | Sort as 'column|asc' or 'column|desc', e.g. 'date|desc' | |
| fields | No | JSON format only: return just these top-level fields (id is always included), e.g. ['number', 'client_name', 'balance', 'due_date'] | |
| filter | No | Free-text search across the main columns (number, name, contacts, notes…) | |
| status | No | Lifecycle filter, comma separated: active, archived, deleted (e.g. 'active' to skip archived and deleted records) | |
| include | No | Extra relations to embed, comma separated (e.g. 'payments,activities') | |
| per_page | No | Records per page (1-100) | |
| client_status | No | Business status filter, comma separated; one or more of: all, draft, sent, accepted, cancelled | |
| extra_filters | No | Additional API query filters as name -> value (see the tool description) | |
| response_format | No | 'markdown' (default) for a readable summary, 'json' for complete machine-readable data (empty fields removed) | markdown |