Delete reconciliations

delete

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

Delete reconciliations in bulk. Provide ids, or explicitly set include to false to delete every reconciliation matching the filters (and every reconciliation outright when no filters are given); an empty body is rejected. Every later reconciliation for the same account is deleted along with each selected one.

Required permission: Full Write 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.

Body Params

The selection criteria

ids

array of doubles | null

The ids the operation applies to: an include list by default, or an exclude list when include is false. For deletes, required unless include is false.

ids

include

boolean | null

Whether ids is an include list (true, default) or an exclude list (false). Setting include to false with no ids applies the operation to every record matching the query filters.

Responses

200

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!