Create batch

post

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

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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The batch details.

name

string | null

required

The batch's name.

description

string | null

The batch's description.

date

date-time

The batch's posting date. 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.

expected

double | null

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

campus

object | null

A reference to an existing record by its id.

merchant

object | null

A reference to an existing record by its id.

depositDate

date-time | null

The date the batch's funds were deposited. 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.

200OK

404Not Found