Skip to content
Purser

List Reconciliations

GET
/accounts/{account_id}/reconciliations
curl --request GET \
  --url 'https://example.com/accounts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/reconciliations?limit=20'

An account’s reconciliations, newest first, each re-checked against the ledger now: in_balance is false (and difference nonzero) when a later write changed the balance on that date.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
account_id
required
Account Id
string format: uuid

Query Parameters

Section titled “Query Parameters”
limit
Limit
integer
default: 20 >= 1 <= 200

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response List Reconciliations Accounts Account Id Reconciliations Get
Array<object>
ReconciliationOut

A recorded reconciliation (issue #268), re-checked against the ledger when it is read — so a backdated import, edit or replay that moved the balance on as_of shows up here as a nonzero difference instead of leaving the reconciled-through marker silently wrong.

statement_balance is the figure as the statement shows it (positive = money held; for a credit card, the amount owed). Every other amount is in ledger sign (a card is negative when owed).

object
adjustment
required
Adjustment
string
adjustment_tx_id
required
Any of:
string format: uuid
as_of
required
As Of
string format: date
basis
required
Basis
string
Allowed values: posted pending_inclusive
created_at
required
Created At
string format: date-time
difference
required
Difference
string
id
required
Id
string format: uuid
in_balance
required
In Balance
boolean
ledger_balance
required
Ledger Balance
string
statement_balance
required
Statement Balance
string
target_balance
required
Target Balance
string

Example 

[
  {
    "basis": "posted"
  }
]

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}