Search batches

get

https://{tenant}.onechurchsoftware.com/api/batches

Retrieve the contribution batches matching the given filters.

Required permission: Limited Read Contributions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Return batches whose name contains the given text.

number

string

The batch number. Returns the batch matching the given number exactly.

status

string

Comma-delimited list of status ids. Values come from /api/property_values/batch_statuses/values.

date.start

date-time

Return batches whose posting date is on or after this date and time.

date.end

date-time

Return batches whose posting date is on or before this date and time.

merchant

string

Comma-delimited list of merchant account ids. Use -1 to include batches without a merchant account.

expected.start

double

Return batches with an expected amount of at least this value.

expected.end

double

Return batches with an expected amount of at most this value.

campus

string

Comma-delimited list of campus (location) ids. Use -1 to include batches with no campus. Values come from /api/locations.

balanced

boolean

If true, returns batches where the expected amount equals the total amount of the batch (or there is no expected amount). If false, returns batches where they are not equal.

description

string

Return batches whose description contains the given text.

deposited.start

date-time

Return batches deposited on or after this date.

deposited.end

date-time

Return batches deposited on or before this date.

designation

string

Comma-delimited list of designation ids. Returns batches containing contributions to those designations.

method

string

Comma-delimited list of payment method ids. Returns batches containing transactions with those methods. Values come from /api/property_values/transaction_methods/values.

paid.start

double

Return batches whose received total is at least this amount. Compares the total excluding donor-covered fees; the total returned on responses includes them.

paid.end

double

Return batches whose received total is at most this amount. Compares the total excluding donor-covered fees; the total returned on responses includes them.

fees.start

double

Return batches whose fees are at least this amount. Compares the positive fee amount; the fees returned on responses are negated.

fees.end

double

Return batches whose fees are at most this amount. Compares the positive fee amount; the fees returned on responses are negated.

deposit.start

double

Return batches whose deposit is at least this amount.

deposit.end

double

Return batches whose deposit is at most this amount.

unmatched.start

double

Return batches with at least this many unmatched contributions.

unmatched.end

double

Return batches with at most this many unmatched contributions.

contributors.start

double

Return batches with at least this many contributors.

contributors.end

double

Return batches with at most this many contributors.

transactions.start

double

Return batches with at least this many transactions.

transactions.end

double

Return batches with at most this many transactions.

posted

boolean

Whether the batch has been posted to the general ledger.

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