Skip to main content

List Provider-only Documents

GET 
/api/ledger/reconciliation/provider-documents

The provider documents (Xero/QBO) that have NOT been linked to a SKU ledger entry and have not been dismissed, over a connection's window — a normalized, paginated, filterable, sortable list across every document kind (invoices, bills, credit notes, journals).

Authentication: Requires Bearer token.

Query parameters: connection_id (required); standard pagination; sort (prefix with - for DESC; allowed: reference, secondary_reference, counterparty, total, sub_total, tax_total, amount_due, document_date, due_date, line_count, provider_updated_at, status, remote_type, remote_id); per-field filter[...] (remote_type, status, doc_class = invoice|journal, date_from/date_to); general search (matches reference, secondary reference, counterparty, amount, and exact provider id); and filter_groups. Each row's id is the composite "{remote_type}:{remote_id}".

Response fields: doc_class splits invoice-shaped documents (invoices/bills/credit notes) from journals. Invoice-shaped rows carry counterparty, secondary_reference (the provider's free-text reference), sub_total, tax_total, amount_due, and due_date; journal rows carry line_count. provider_updated_at is the provider-side last-modified timestamp. Fields not applicable to a document kind are null.

Response: 200, a paginated list of provider documents.

Request​

Responses​

OK

Response Headers
    Content-Type