Reconciliations
Reconciliations are used to match and verify financial transactions across different accounts or statements. They help ensure the accuracy of accounting records by confirming that transactions are properly recorded and balanced.
Endpoints
| Method |
Endpoint |
Description |
| GET |
/reconciliations |
List reconciliations |
| DELETE |
/reconciliations/{id} |
Delete a reconciliation |
Query Parameters
The GET /reconciliations endpoint supports the following query parameters:
| Parameter |
Type |
Required |
Description |
| client_account_id |
integer |
Yes |
Filter by client account ID. Must be one of the user’s eligible client accounts |
| date_from |
date |
No |
Filter entries from this date (inclusive) |
| date_to |
date |
No |
Filter entries to this date (inclusive) |
| journal_entry_line_id |
integer |
No |
Filter by specific journal entry line |
| page |
integer |
No |
Page number for pagination (default: 0) |
| per_page |
integer |
No |
Number of items per page (default: 100) |
Attributes
| Attribute |
Type |
Description |
| id |
integer |
The unique identifier of the reconciliation |
| created_at |
date |
The date and time when the reconciliation was created |
| created_by_id |
integer |
The ID of the user that created the reconciliation |
| client_account_id |
integer |
The ID of the client account associated with the reconciliation |
| sequence_number |
integer |
The sequence number of the reconciliation |
| reconciliation_date |
date |
The date of the reconciliation |
Relationships
| Relationship |
Type |
Description |
| created_by |
User |
The user who created the reconciliation |
| entries |
ReconciliationEntry |
The entries in this reconciliation |
Reconciliation Entry
| Attribute |
Type |
Description |
| id |
integer |
The unique identifier of the reconciliation entry |
| journal_entry_id |
integer |
The ID of the associated journal entry |
| journal_entry_line_id |
integer |
The ID of the associated journal entry line |
| debit |
decimal |
The debit amount in the base currency |
| debit_fc |
decimal |
The debit amount in foreign currency |
| credit |
decimal |
The credit amount in the base currency |
| credit_fc |
decimal |
The credit amount in foreign currency |
Example Response
{
"id": 1,
"created_at": "2023-05-10T12:00:00Z",
"created_by_id": 1,
"client_account_id": 1,
"sequence_number": 1,
"reconciliation_date": "2023-05-10",
"entries": [
{
"id": 1,
"journal_entry_id": 1,
"journal_entry_line_id": 1,
"debit": "100.00",
"debit_fc": "100.00",
"credit": "0.00",
"credit_fc": "0.00",
"journal_entry_line": {
"id": 1,
"posting_date": "2023-05-10",
"description": "Bank transaction",
"account_code": "1920",
"account_id": 1,
"debit": "100.00",
"credit": "0.00"
}
}
],
"created_by": {
"id": 1,
"name": "John Doe"
}
}
Notes
- The client_account_id must be one of the eligible client accounts for the authenticated user.
- Reconciliations can only be deleted if they belong to one of the user’s eligible client accounts.
- The journal_entry_line relationship can be included in the entries by specifying it in the with_relations parameter.
- All amounts are returned as string representations of decimal numbers.
- All dates are returned in ISO 8601 format.
- The
_fc suffix on amount fields represents “foreign currency” amounts.