Sign in
Reconciliation

Retrieve one reconciliation record

Returns a single reconciliation record by id, including its matches (matches_as_a, matches_as_b), the records it is matched against (matched_records), the remaining amount_to_be_reconciled, and whether it is exhausted. The embedding vector is omitted. Non-admin callers only see records of their companies.

Note: the record is looked up with find_by (not find_by!), so an unknown record_id does not return a 404 — the endpoint responds 200 with a null body.

get/v1/reconciliation/records/{record_id}

Path parameters

record_idstring uuid required

The id of the reconciliation 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

The requested reconciliation record, or null when record_id is unknown.

idstring uuid required

The record id (equal to the underlying source record id).

typestring required

The reconciliation-record subtype.

source_typestring

The polymorphic type of the underlying source record.

company_idstring uuid
amount_centsinteger

The record's amount in cents.

currencystring
reference_datestring date-time nullable

Display date (issue/authorized/created date depending on the source).

document_typestring nullable

SII document type, for payable-like records.

counterpart_company_idstring uuid nullable

The counterpart company id, when applicable.

amount_to_be_reconciledinteger

Remaining amount still to reconcile, in cents.

exhaustedboolean

Whether the record's available balance is genuinely zero.

embedding_contentstring nullable

Text used to build the record's semantic embedding.

created_atstring date-time

Example response

{
  "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,
  "matches_as_a": [
    {
      "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"
    }
  ],
  "matches_as_b": [
    {
      "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"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.