v1

latestOpenAPI 3.0.02026-07-2422987517.5 KB

Reconciliation

List reconciliation matches

Returns a paginated list of reconciliation matches for the company. Each match links two reconciliation records (e.g. a payable and the bank transaction that paid it) and embeds both records (record_a, record_b) without their embedding vectors. The type field is the STI subtype derived from the linked pair. Non-admin callers only see matches whose payable they can access.

get/v1/reconciliation/matches

Query parameters

_startinteger

If all the transactions where in an array, this would represent the index of the first item returned in the response

_endinteger

If all the transactions where in an array, this would represent the index of the last item returned in the response

_order'asc' | 'desc'

The order method, which can be ascending or descending

_fieldstring

Example:created_at

The field used to sort, the example illustrates a response that would be sorted by the creation date

record_a_idstring uuid

Filter matches by one of the linked records.

record_b_idstring uuid

Filter matches by the other linked record.

Headers

company-idstring uuid required

UUID of the company on whose behalf the request is made. Required for every Accounting endpoint. See The company-id header for details on how to obtain a value for this header and the error responses to expect when it is missing or invalid.

Response

Paginated list of matches

idstring uuid required

company_idstring uuid

record_a_idstring uuid required

One side of the match.

record_b_idstring uuid required

The other side of the match.

amountinteger nullable

The reconciled amount in cents.

type'Reconciliation::Match::PayableTransaction' | 'Reconciliation::Match::SubPayable' | 'Reconciliation::Match::PayableCreditNote' | 'Reconciliation::Match::PayableDebitNote' | 'Reconciliation::Match::PayableReimbursement' nullable

Fully-namespaced STI class name of the match, derived from the linked record pair.

created_atstring date-time

updated_atstring date-time