Create batch

Create a contribution batch. A batch represents a single deposit; once created, record gifts against it with the add-contribution endpoint. New batches start with the Open status.

Required permission: Limited Write Contributions

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The batch details.

string | null
required

The batch's name.

string | null

The batch's description.

date

The batch's posting date, as a calendar date (yyyy-MM-dd). Required when creating a batch and when updating a manually-entered one; for gateway-generated batches it is set from the gateway and cannot be changed.

double | null

The expected total for the batch, when one was entered.

campus
object | null

The alphabetically first of campuses; on writes without campuses it stands in for them as a one-campus set with the same checks (a location that is not an active campus is refused); omit both to clear, except that a campus-limited caller keeps the campuses outside their access, and cannot clear a record whose campuses all sit inside it. Ignored while multi-campus is off.

campuses
array of objects | null

The campuses the batch belongs to, ordered by name; empty when it is available to every campus. On writes,
send the ids to set the campus set (an empty list means every campus); omit the property to keep using
campus alone. A campus-limited caller can only add or remove campuses within their access and
cannot change whether the record is available to every campus.
Ignored while multi-campus is off.

campuses
organization
object | null

The one organization this record belongs to (its books): set on every record, the default organization
until a second one exists; null only for a record saved while this release was being installed, before every record was assigned its organization. On a
save, send it with campuses empty to scope the record to the whole organization; when campuses are
sent the organization is taken from them. Required while multi-org is on; All is not offered for financial
records.

merchant
object | null

The merchant account that processed the batch, when there is one.

date | null

The calendar date (yyyy-MM-dd) the batch's funds were deposited on. Null when the batch has not been deposited. For gateway-generated batches, set this when updating to record the deposit date.

defaults
object | null

Default values applied to new transactions added to the batch.

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