Sign in

v1

latestOpenAPI 3.0.02026-07-2422987517.5 KB
Reconciliation

Create a reconciliation match

Links two reconciliation records into a match. Both records must exist and be reconcilable with each other; the concrete match subtype is determined automatically from the pair.

Note: the create response returns the bare match, including its type (a persisted STI column, always present; the list endpoint's methods: [:type] is redundant). Only the embedded record_a / record_b records are list-only — they are not populated on this create response.

post/v1/reconciliation/matches

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.

Request body

record_a_idstring uuid required

One record to link.

record_b_idstring uuid required

The other record to link.

company_idstring uuid required

The owning company id. Required in the body (not read from the company-id header).

Example request

{
  "record_a_id": "8e668a4e-8485-4248-86cc-a7a2201cf8c3",
  "record_b_id": "09f6cc5e-8a16-43ae-8bb1-637c0e1c0a6d"
}

Response

Match created

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