Class Batch
Represents a batch of items for deposit.
Properties
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| BatchNumber | string | A unique number either assigned by the user to correlate to the integrators system or autogenerated by the system. Also known as Deposit Name. |
| BatchReference | string | The unique value assigned to each batch which can be used to find details about the batch. |
| Events | Event[] | Events that have occured on the batch. |
| LocationName | string | The location used for the deposit. |
| LocationReference | string | The unique value of the location used for the deposit. |
| Status | string | The Batch status code. |
| StatusDescription | string | The Batch status description to be displayed. |
| TotalAmount | decimal | The amount of the items in a batch in DECIMAL format. |
| TotalCount | decimal | The number of items in the batch. |
Event
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| Date | DateTime | The date the event occured. |
| Description | string | Public property Description The description of the event. |
Batch.Status
| Batch Status Code | Batch Status Description |
|---|---|
| BatchStatus01 | Deleted |
| BatchStatus02 | Deposited |
| BatchStatus03 | Deposited With Adjustment |
| BatchStatus04 | Needs Rescan |
| BatchStatus05 | Open For Scanning |
| BatchStatus06 | Partial Deposit |
| BatchStatus07 | Rejected |
| BatchStatus08 | Submitted |
| BatchStatus09 | Unknown |
Batch.StatusDescription
| Batch Status Code | Batch Status Description |
|---|---|
| BatchStatus01 | Deleted |
| BatchStatus02 | Deposited |
| BatchStatus03 | Deposited With Adjustment |
| BatchStatus04 | Needs Rescan |
| BatchStatus05 | Open For Scanning |
| BatchStatus06 | Partial Deposit |
| BatchStatus07 | Rejected |
| BatchStatus08 | Submitted |
| BatchStatus09 | Unknown |
Examples
{
"__type": "Batch:#JackHenry.Eps.Mobile.RDC",
"LocationName": "String Content",
"LocationReference": "String Content",
"BatchReference": "String Content",
"BatchNumber": "String Content",
"Status": "String Content",
"StatusDescription": "String Content",
"TotalAmount": 12678967.54,
"TotalCount": 12678967.54,
"Events": []
}