Update batch

put

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

Update a manually-entered batch. This is a full update: writable fields that are omitted are cleared. For gateway-generated batches only the description, deposit date, and default values can be changed. First retrieve the current batch from /api/batches/{id}, apply your changes, then send back the full object. Without the Unrestricted Batches permission you can only edit your own batches.

Required permission: Limited Write Contributions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the batch.

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

200

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

404Not Found