Skip to main content
GET
/
v0
/
reconciliations
/
{reconciliation_id}
Fetch a Reconciliation
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/reconciliations/{reconciliation_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "id": "<string>",
  "start_datetime": "2023-11-07T05:31:56Z",
  "end_datetime": "2023-11-07T05:31:56Z",
  "reconciled_balance": 123,
  "statement_ending_balance": 123,
  "reconciliation_status": "reconciled",
  "progress_status": "<string>",
  "ledger_id": "WTjdK47SHxokWUdypL8zyB",
  "statement_starting_balance": 122629.38,
  "completed_on_datetime": "2024-01-01T00:00:00Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
teal-instance-id
string
required

The Teal instance ID

Path Parameters

​
reconciliation_id
string
required

The reconciliation ID

Response

Successful Response

​
id
string
required

The Reconciliation ID.

Example:

"FYQxHfWNCMnUuXr6iQhjgG"

​
start_datetime
string<date-time>
required

The start datetime of the Reconciliation.

Example:

"2024-01-01T00:00:00Z"

​
end_datetime
string<date-time>
required

The end datetime of the Reconciliation.

Example:

"2024-01-01T00:00:00Z"

​
reconciled_balance
number
required

The balance of all reconciled journal entries in the ledger with a datetime before the end datetime. Excludes journal entries that were skipped to be reconciled in a later reconciliation after the end datetime.

Example:

132629.38

​
statement_ending_balance
number
required

The ending balance of the statement used to perform the Reconciliation.

Example:

132629.38

​
reconciliation_status
enum<string>
required

The status of the Reconciliation.

Available options:
reconciled,
unreconciled
Examples:

"unreconciled"

"reconciled"

​
progress_status
string
required

The progress of the Reconciliation.

Examples:

"in_progress"

"completed"

​
ledger_id
string | null

The Ledger ID

Example:

"WTjdK47SHxokWUdypL8zyB"

​
statement_starting_balance
number | null

The starting balance of the statement. Equal to the statement_ending_balance of the previous reconciliation or the opening balance of the ledger

Example:

122629.38

​
completed_on_datetime
string<date-time> | null

The datetime when the Reconciliation was last changed to completed.

Example:

"2024-01-01T00:00:00Z"