Search reconciliations

get

https://{tenant}.onechurchsoftware.com/api/banking/reconciliations

Retrieve a list of bank reconciliations matching the given filters.

Required permission: Full Read Accounting

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

account

string

Comma-delimited list of bank account ids (from the chart of accounts). Returns reconciliations for those accounts.

startingBalance.start

double

Return reconciliations with a starting balance of at least this amount.

startingBalance.end

double

Return reconciliations with a starting balance of at most this amount.

status

string

Comma-delimited list of status ids or codes: reconciliation_status_pending, reconciliation_status_complete, or reconciliation_status_invalid.

endingBalance.start

double

Return reconciliations with an ending balance of at least this amount.

endingBalance.end

double

Return reconciliations with an ending balance of at most this amount.

endingDate.start

date

Return reconciliations whose statement ends on or after this date.

endingDate.end

date

Return reconciliations whose statement ends on or before this date.

reconciledBy

string

Return reconciliations finished by a user whose name contains the given text.

reconciledOn.start

date-time

Return reconciliations finished on or after this date.

reconciledOn.end

date-time

Return reconciliations finished on or before this date.

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK