invoiceninja_list_records
List Invoice Ninja reference records such as tax rates, payment terms, tags, and users to resolve IDs on other records or browse the activity log.
Instructions
List reference/secondary records: tax_rates, payment_terms, expense_categories, task_statuses, group_settings, designs, documents, bank_transactions, activities, tags, locations, subscriptions, recurring_quotes, users. Use it to resolve ids found on other records (e.g. category_id, status ids, tax names) or to browse the activity log.
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' | |
| entity | Yes | Which kind of record to list | |
| 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) | |
| per_page | No | Records per page (1-100) | |
| 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 |