Sign in
latestOpenAPI 3.0.02026-07-2422987517.5 KB

ff1aeb3fda8b

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

Example response

[
  {
    "id": "d4c3b2a1-6f5e-4a3b-8c7d-9e0f1a2b3c4d",
    "company_id": "550e8400-e29b-41d4-a716-446655440000",
    "record_a_id": "8e668a4e-8485-4248-86cc-a7a2201cf8c3",
    "record_b_id": "09f6cc5e-8a16-43ae-8bb1-637c0e1c0a6d",
    "amount": 150000,
    "type": "Reconciliation::Match::PayableTransaction",
    "record_a": {
      "id": "8e668a4e-8485-4248-86cc-a7a2201cf8c3",
      "type": "Reconciliation::Record::Payable",
      "source_type": "Erp::Payouts::Payable",
      "company_id": "550e8400-e29b-41d4-a716-446655440000",
      "amount_cents": 150000,
      "currency": "CLP",
      "amount_to_be_reconciled": 50000
    },
    "record_b": {
      "id": "8e668a4e-8485-4248-86cc-a7a2201cf8c3",
      "type": "Reconciliation::Record::Payable",
      "source_type": "Erp::Payouts::Payable",
      "company_id": "550e8400-e29b-41d4-a716-446655440000",
      "amount_cents": 150000,
      "currency": "CLP",
      "amount_to_be_reconciled": 50000
    }
  }
]