> ## 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.
# List Reconciliation Runs
> The tenant's recorded reconciliation runs, newest first — when the books were checked, by whom, and whether they tied out.
Returns the tenant's recorded reconciliation runs, newest first — when each
check ran, who ran it, and whether it tied out (`total_discrepancies == 0`).
Runs are recorded by [Run and Record Reconciliation](/api-reference/finance/reconciliation-runs);
the plain [reconciliation report](/api-reference/finance/reconciliation) leaves
no trace here.
## Query Parameters
| Parameter | Type | Required | Description |
| --------- | ------- | -------- | ------------------------------------------------- |
| `limit` | integer | No | Maximum runs to return (default `50`, max `200`). |
## Example Request
```bash theme={null}
curl "https://api.recurso.dev/v1/finance/reconciliation/runs?limit=50" \
-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": 0,
"tb_compared": true,
"tb_accounts_checked": 214,
"tb_transfers_checked": 17352,
"created_at": "2026-08-14T09:15:02Z"
}
]
}
```
## Run Fields
| Field | Type | Description |
| ---------------------------------------------- | ----------------------- | --------------------------------------------------------------------------------------------------------- |
| `id` | string (uuid) | The recorded run's id — fetch it with [Get Reconciliation Run](/api-reference/finance/reconciliation-run) |
| `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` | integer | Non-draft invoices covered |
| `paid_invoices_checked` | integer | Paid invoices whose payment postings were verified |
| `total_discrepancies` | integer | Discrepancies found — `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 |
The list carries summaries only. To see what a run actually found, fetch it
with [Get Reconciliation Run](/api-reference/finance/reconciliation-run),
which returns the discrepancy rows persisted at record time.
## OpenAPI
````yaml GET /v1/finance/reconciliation/runs
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:
get:
tags:
- Finance
summary: List recorded reconciliation runs (audit trail)
description: >
The tenant's recorded reconciliation runs, newest first — when it was
checked, by whom, and whether it tied out (total_discrepancies == 0).
operationId: listReconciliationRuns
parameters:
- name: limit
in: query
required: false
schema:
type: integer
default: 50
maximum: 200
responses:
'200':
description: The recorded runs.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
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
'401':
$ref: '#/components/responses/Unauthorized'
components:
responses:
Unauthorized:
description: Missing or invalid credentials (API key or session cookie).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Error:
type: object
required:
- error
properties:
error:
type: object
description: Structured error detail.
required:
- code
- message
properties:
code:
type: string
description: Stable machine-readable error code.
examples:
- validation_failed
- unauthorized
- forbidden
- not_found
- conflict
- rate_limited
- internal_error
- invalid_api_key
- key_mode_mismatch
- over_refund
- invoice_not_paid
- invoice_already_paid
message:
type: string
description: Human-readable explanation.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: API key
description: >-
Tenant API key obtained from `POST /auth/register` or `POST
/v1/developer/keys`.
````