Some Batches endpoints share a common data model for requests; these are described below.
Batches
Optional querystring filter parameters:
Key | Value |
---|---|
| Boolean for excluding batches that have been closed. |
| Displays only batches opened after the specified date. |
| Displays only batches opened before the specified date. |
| Displays only batches closed after the specified date. |
| 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 |
---|---|
| The batch ID to assign to this contribution. |
| The batch name to assign to this contribution. |
| The designation Id. |
| The date the batch was opened. |
| Total number of contributions in the batch. |
| Total amount |
| Count of memoed contributions. |
| Total amount of memoed contributions. |
| Count of non-memoed contributions. |
| Total amount of non-memoed contributions. |
| 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
}
]