Documents - List
List accounting documents for the selected business. Supports search and extensive filtering (including account type, date range, draft/flag state, tags, attachments, and ACCRUAL_PAIR due mismatch). Numeric `search` values also match entry amounts. Use `number` for deterministic lookup when the document number is known. List `relation_network_signals` include mismatch flags only; fetch document detail for ACCRUAL_PAIR invoice_total/payment_total. The following fields are searched: | field | match mode | |--------------------------------|--------------| | `number` | prefix | | `description` | contains | | `contact__name` | contains | | `contact__name_aliases` | contains | | `contact__contact_business_id` | prefix | | `import_data__contact_hint` | contains |
Path Parameters
Business slug that scopes this request. If you do not have one yet, call common_accessible_businesses_list and pick a slug from the response.
Query Parameters
Filter documents by account ID.
Filter documents that include at least one entry matching the provided account type. The parameter can be repeated, e.g. account_type=ASS_DUE&account_type=LIA_DUE. Values must be valid AccountType enum values. Use account_type_match=all to require every provided type to be present on the same document.
Controls how repeated account_type values are combined. Use 'any' (default) or 'all'.
Filter documents by contact ID.
Filter documents from this date onwards. Date is inclusive.
dateFilter documents up to this date. Date is inclusive.
dateFilter documents that have expense entries.
Filter documents by attachment ID.
Filter documents that have attachments.
Filter documents by ACCRUAL_PAIR due-amount mismatch (the list warning icon). Pass true for documents whose linked invoice/payment network does not net to zero. Pass false to exclude those documents.
Filter documents that have an accounting rule.
Filter documents that have income entries.
Filter documents by draft status.
Filter documents by flagged status.
Filter documents by whether they are linked to another document via a relation. Pass true for linked documents and false for unlinked documents.
Filter documents by locked status.
Filter documents by exact document number. Use this when the document number is known.
A page number within the paginated result set.
Number of results to return per page.
Filter linked documents by the role the document plays in its relations, e.g. relation_role=ACCRUAL or relation_role=SETTLEMENT. Values must be valid DocumentRelationRole values. Unknown values yield an empty result set (HTTP 200), not a 400.
Filter documents by accounting rule ID.
A search term.
Filter documents by user ID tagged in comments.
Filter documents that include at least one entry with the provided VAT code.
Filter documents that include at least one entry with the provided VAT rate.
Response Body
application/json
curl -X GET "https://example.com/v1/business/string/document/"{ "count": 123, "next": 2, "prev": 1, "size": 30, "results": [ { "id": 0, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "number": "string", "is_flagged": true, "is_locked": true, "is_draft": true, "date": "2019-08-24", "description": "string", "contact_id": 0, "contact_name": "string", "balance": 0.1, "attachment_ids": [ 0 ], "type": 0, "blueprint": { "debet_account_id": 0, "debet_entries": [], "credit_account_id": 0, "credit_entries": [], "expense_entries": [] }, "blueprint_type": "string", "import_data": { "id": 0, "trace_id": "df570c03-5a03-4cea-8df0-c162d05127ac", "algo_status": "INITIAL", "data_source": "string", "identifier": "string", "date": "2019-08-24", "amount": 0.1, "description": "string", "contact_hint": "string", "balance_after_transaction": 0, "reference_number": "string", "payment_account_id": 0 }, "entry_ui_rows": [ { "account_name": "string", "account_number": "string", "vat_code": 1, "vat_rate": "string", "is_debet": true, "amount": 0.1 } ], "audit_trail_last_seen_at": "2019-08-24T14:15:22Z", "audit_trail_has_unseen_actions": true, "audit_trail_last_mention_at": "2019-08-24T14:15:22Z", "audit_trail_last_comment_at": "2019-08-24T14:15:22Z", "tag_ids": [ 0 ], "relations": [ { "id": 0, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "related_document": 0, "related_document_summary": { "property1": null, "property2": null }, "description": "string", "role": "ACCRUAL", "type": "ACCRUAL_PAIR", "source_document_signals": { "property1": null, "property2": null }, "related_document_signals": { "property1": null, "property2": null } } ], "relation_network_signals": "string", "relation_entry_signals": "string", "available_link_kinds": "string", "eu_b2b_vat_details_missing": true, "eu_sale_to_private_person": true } ]}