Common Models

Some Batches endpoints share a common data model for requests; these are described below.

Batches

Optional querystring filter parameters:

Key

Value

excludeClosedBatches

Boolean for excluding batches that have been closed.

openedAfter

Displays only batches opened after the specified date.

openedBefore

Displays only batches opened before the specified date.

closedAfter

Displays only batches closed after the specified date.

closedBefore

Displays only batches closed before the specified date.

🚧

Note

All dates are in ISO-8601 format, i.e. they should be specified as YYYY-MM-DD.

Batches Response

A collection of objects with the following properties:

Key

Value

batchId

The batch ID to assign to this contribution.

batchName

The batch name to assign to this contribution.

designationId

The designation Id.

dateOpened

The date the batch was opened.

currentCount

Total number of contributions in the batch.

currentAmount

Total amount

currentMemoedCount

Count of memoed contributions.

currentMemoedAmount

Total amount of memoed contributions.

currentNonmemoedCount

Count of non-memoed contributions.

currentNonmemoedAmount

Total amount of non-memoed contributions.

isOpen

Is the batch open.

Example GET data (note that this is submitted with content-type application/json) with a successful get returns a list of contact codes. Example:

[
  {
    "batchId": 1594,
    "batchName": "test",
    "designationId": 1,
    "dateOpened": "2014-03-11T04:00:00Z",
    "currentCount": 1,
    "currentAmount": 23.32,
    "currentMemoedCount": 0,
    "currentMemoedAmount": 0,
    "currentNonmemoedCount": 1,
    "currentNonmemoedAmount": 23.32,
    "isOpen": true
  },
  {
    "batchId": 1595,
    "batchName": "test2",
    "designationId": 1,
    "dateOpened": "2014-03-11T04:00:00Z",
    "currentCount": 4,
    "currentAmount": 93.28,
    "currentMemoedCount": 0,
    "currentMemoedAmount": 0,
    "currentNonmemoedCount": 4,
    "currentNonmemoedAmount": 93.28,
    "isOpen": true
  }
]