Get batch contributions

Retrieve the donations and payments credited to the given batch. While multi-campus is on, for a caller holding Limited Write or Full Read Contributions whom campus limits, overrides, the lens, or a merchant account or giving portal limit narrow, every gift inside a batch the caller can open lists whatever campus it is placed at (the campuses of its designations), merchant account or giving portal, and a batch the caller cannot open answers as GET /batches/{id} does (404 or 403). A gift that is not your own shows only the contact the donor shares with the organization, a placeholder photo unless the donor is listed in the directory, and no campus, envelopes or external id for the donor when you hold neither Limited Read nor Limited Write Contributions at any of the donor's campuses and do not read the donor's profile, and such a caller whom campus limits or overrides narrow (the lens alone does not) cannot filter or sort by email or phone here (403).

Required permission: Limited Read Contributions

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the batch.

Query Params
string

Comma-delimited list of payment method ids. Values come from /api/property_values/transaction_methods/values.

string

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

string

Comma-delimited list of designation ids. Values come from /api/designations.

date-time

Return contributions given on or after this date (a calendar date; an instant is read in the church's time zone).

date-time

Return contributions given on or before this date (a calendar date; an instant is read in the church's time zone).

string

Organization ids, comma-separated; honoured only while multi-org is on. A gift matches when one of its designations is scoped to one of them or has a campus in one of them.

string

Organization ids, comma-separated; honoured while money splits by organization (multi-org is on, or an archived organization still owns money). A gift matches when it belongs to one of them (the organization it is stamped with), whatever its donor's or designations' campuses. An archived organization's id counts only when it still owns gifts or batches and the caller reads its whole giving (a giving widget's drill-down); otherwise it is dropped.

double

Return contributions of at least this amount.

double

Return contributions of at most this amount.

string

Return contributions whose confirmation number contains the given text.

string

Return contributions whose notes contain the given text.

int32
≥ 1

The id of a recurring giving schedule. Returns only contributions created by that schedule.

string

Comma-delimited list of giving campaign ids. Returns contributions applied to pledges in those campaigns.

int32
≥ 1

The id of a pledge. Returns only contributions applied to that pledge.

boolean

Whether to return only contributions applied to a pledge (true) or only those that are not (false).

int32

Return contributions given in this calendar year.

boolean

Whether the contribution was given via text message.

boolean

Whether the contribution was created by a recurring giving schedule.

boolean

Whether the contribution includes tax-deductible line items.

boolean

Whether the contribution has soft credits.

string

Return contributions whose check number contains the given text.

string

Text matched against the giver's name and aliases. When multiple words are given, every word must match.

string

Return contributions whose giver's email address contains the given text. While multi-campus is on, a caller whose Limited Read Contributions access campus limits or overrides narrow (the lens alone does not) cannot filter or sort contributions by email (403), because some givers show only what they share with the church.

string

Return contributions whose giver's phone number contains the given digits. While multi-campus is on, a caller whose Limited Read Contributions access campus limits or overrides narrow (the lens alone does not) cannot filter or sort contributions by phone (403), because some givers show only what they share with the church.

int32

The id of the person the contributions are credited to.

int32
≥ 0

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

int32
≥ 0

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

string

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

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json