> ## Documentation Index
> Fetch the complete documentation index at: https://docs.recurso.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Reconciliation Run
> One recorded reconciliation run — its summary plus the discrepancy rows persisted at record time: what disagreed, by how much, and why.
Returns one recorded run made addressable: the run summary (who, when, scope,
verdict) plus the per-run discrepancy rows persisted at record time — what
disagreed, by how much, and why. Each discrepancy carries the identifier
needed to drill in: an `invoice_id` you can open with
[Invoice Journal Entries](/api-reference/invoices/journal-entries), or a
`transaction_id` you can open with [Get Journal Entry](/api-reference/ledger/transaction).
See [Explain any number](/advanced/explain-any-number).
`discrepancies_truncated` is `true` when fewer rows were stored than were
counted — either the live-run listing cap was hit, or the run was recorded
before per-run persistence existed.
## Example Request
```bash theme={null}
curl "https://api.recurso.dev/v1/finance/reconciliation/runs/3f2a1b4c-5d6e-4f70-8a9b-0c1d2e3f4a5b" \
-H "Authorization: Bearer $API_KEY"
```
## Response
```json theme={null}
{
"data": {
"id": "3f2a1b4c-5d6e-4f70-8a9b-0c1d2e3f4a5b",
"run_by": "b9071c55-0e14-4720-80f3-665613ceb7de",
"run_at": "2026-08-14T09:15:02Z",
"invoices_checked": 58231,
"paid_invoices_checked": 41207,
"total_discrepancies": 2,
"tb_compared": true,
"tb_accounts_checked": 214,
"tb_transfers_checked": 17352,
"created_at": "2026-08-14T09:15:02Z",
"discrepancies_truncated": false,
"discrepancies": [
{
"type": "missing_payment_transaction",
"invoice_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"transaction_id": null,
"reference_id": null,
"account_code": 0,
"expected_amount": 499900,
"found_amount": 0
},
{
"type": "tb_amount_mismatch",
"invoice_id": null,
"transaction_id": "9b2f1c4d-3e5a-4b6c-8d7e-0f1a2b3c4d5e",
"reference_id": null,
"account_code": 0,
"expected_amount": 129900,
"found_amount": 128900
}
]
}
}
```
## Fields
| Field | Type | Description |
| ---------------------------------------------- | ----------------------- | ------------------------------------------------------------- |
| `id` | string (uuid) | The recorded run's id |
| `run_by` | string (uuid), nullable | The user who ran it; `null` for a scheduled/system run |
| `run_at` | string (date-time) | When the reconciliation ran |
| `invoices_checked` / `paid_invoices_checked` | integer | Scope of the billing ↔ ledger pass |
| `total_discrepancies` | integer | Full count — `0` means the books tied out |
| `tb_compared` | boolean | Whether the TigerBeetle comparison pass ran |
| `tb_accounts_checked` / `tb_transfers_checked` | integer | Scope of the TigerBeetle pass |
| `created_at` | string (date-time) | When the summary row was recorded |
| `discrepancies_truncated` | boolean | `true` when fewer rows were stored than `total_discrepancies` |
| `discrepancies[]` | array | Persisted discrepancy rows (see below) |
### Discrepancy Fields
| Field | Type | Description |
| ---------------------------------- | ----------------------- | --------------------------------------------------------------------------------------- |
| `type` | string | One of the [discrepancy types](/api-reference/finance/reconciliation#discrepancy-types) |
| `invoice_id` | string (uuid), nullable | The invoice involved, for billing ↔ ledger types |
| `transaction_id` | string (uuid), nullable | The ledger transaction involved, for ledger ↔ TigerBeetle types |
| `reference_id` | string (uuid), nullable | The referenced business object, for orphan postings |
| `account_code` | integer | The ledger account involved, for trial-balance types; `0` when not applicable |
| `expected_amount` / `found_amount` | integer (int64) | What the check expected vs found, minor units |
Read-only. A missing or cross-tenant `id` returns `404`. Correcting drift
stays a deliberate human action; see the
[ledger guide](/advanced/ledger#reconciliation).
## OpenAPI
````yaml GET /v1/finance/reconciliation/runs/{id}
openapi: 3.1.0
info:
title: Recurso API
version: 1.0.0
description: |
The Recurso billing engine REST API.
Authenticate by passing your API key as a bearer token:
Authorization: Bearer
Obtain an API key by registering a tenant via `POST /auth/register`.
All authenticated endpoints live under the `/v1` prefix. Mutating
endpoints support idempotency via the `Idempotency-Key` header.
license:
name: MIT
identifier: MIT
servers:
- url: https://billing.example.com
description: >-
Example deployment — substitute the base URL of your own Recurso
deployment.
security:
- bearerAuth: []
tags:
- name: System
description: Health, version, and API metadata
- name: Auth
description: Tenant registration
- name: Plans
description: Product catalog plans
- name: Customers
description: Customer management
- name: Subscriptions
description: Subscription lifecycle
- name: Invoices
description: Invoices, PDFs, and Indian GST e-invoicing
- name: Coupons
description: Discounts
- name: Usage
description: Metered usage events
- name: Credit Notes
description: Customer credits
- name: Quotes
description: Quote-to-invoice lifecycle
- name: Webhooks
description: Webhook endpoint management and event feed
- name: Analytics
description: Revenue analytics
- name: Checkout
description: Public hosted checkout for invoices
- name: Payments
description: Payment order creation
- name: Inbound Webhooks
description: Receivers for payment-gateway callbacks (Razorpay, Stripe)
- name: Customer Portal
description: Customer-facing portal — magic-link auth and session-scoped data
- name: Developer
description: API key management
- name: Account
description: Tenant account settings
- name: Finance
description: Ledger accounts, entries, reconciliation, and revenue recognition
- name: Settings
description: Tax (GST) and e-invoicing (IRP) configuration
- name: Consents
description: Consent records for RBI-compliant recurring billing
- name: Referrals
description: Customer referral program
- name: Gifts
description: Gift subscriptions
- name: Mandates
description: UPI Autopay mandates
- name: Offline Payments
description: Virtual accounts and manually recorded payments
- name: Organizations
description: Multi-entity organizations grouping several tenants
- name: Accounting
description: QuickBooks / Xero accounting integrations
- name: Churn
description: Churn risk scoring and alerts
- name: Cancel Flows
description: Configurable retention flows shown at cancellation time
- name: Dunning
description: Dunning analytics and multi-channel dunning campaigns
paths:
/v1/finance/reconciliation/runs/{id}:
get:
tags:
- Finance
summary: Get a recorded reconciliation run with its discrepancies
description: >
One recorded run made addressable: the run summary
(who/when/scope/verdict) plus the per-run discrepancy rows persisted at
record time — what disagreed, by how much, and why.
discrepancies_truncated is true when fewer rows were stored than counted
(the live-run listing cap, or a run recorded before per-run persistence
existed). Read-only; cross-tenant ids return 404.
operationId: getReconciliationRun
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: The recorded run with its discrepancies.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: string
format: uuid
run_by:
type: string
format: uuid
nullable: true
run_at:
type: string
format: date-time
invoices_checked:
type: integer
paid_invoices_checked:
type: integer
total_discrepancies:
type: integer
tb_compared:
type: boolean
tb_accounts_checked:
type: integer
tb_transfers_checked:
type: integer
created_at:
type: string
format: date-time
discrepancies_truncated:
type: boolean
discrepancies:
type: array
items:
type: object
properties:
type:
type: string
invoice_id:
type: string
format: uuid
nullable: true
transaction_id:
type: string
format: uuid
nullable: true
reference_id:
type: string
format: uuid
nullable: true
account_code:
type: integer
expected_amount:
type: integer
format: int64
found_amount:
type: integer
format: int64
'404':
description: Reconciliation run not found.
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: API key
description: >-
Tenant API key obtained from `POST /auth/register` or `POST
/v1/developer/keys`.
````