GET a/PosVoids/GetVoids?start={start}&end={end}
Get void information for the report period, grouped by void reason.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| start |
Report Start time |
date |
Required |
| end |
Report end time |
date |
Required |
Body Parameters
None.
Response Information
Resource Description
List of void reasons and their information
Collection of PosVoidsSummaryDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| VoidReason |
Gets or sets the void type / reason |
string |
None. |
| VoidQuantity |
Gets or sets the number of items voided |
decimal number |
None. |
| VoidAmount |
Gets or sets the dollar amount voided |
decimal number |
None. |
| WasteQuantity |
Gets or sets the number of items wasted |
decimal number |
None. |
| WasteAmount |
Gets or sets the dollar amount wasted |
decimal number |
None. |
| Transactions |
Gets or sets the number of transacitons voided |
decimal number |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"voidReason": "sample string 1",
"voidQuantity": 1.1,
"voidAmount": 1.0,
"wasteQuantity": 1.1,
"wasteAmount": 1.0,
"transactions": 1.0
},
{
"voidReason": "sample string 1",
"voidQuantity": 1.1,
"voidAmount": 1.0,
"wasteQuantity": 1.1,
"wasteAmount": 1.0,
"transactions": 1.0
}
]
application/xml, text/xml
Sample:
<ArrayOfPosVoidsSummaryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Loaded.WebApi.Models.POS.Voids">
<PosVoidsSummaryDTO>
<Transactions>1</Transactions>
<VoidAmount>1</VoidAmount>
<VoidQuantity>1.1</VoidQuantity>
<VoidReason>sample string 1</VoidReason>
<WasteAmount>1</WasteAmount>
<WasteQuantity>1.1</WasteQuantity>
</PosVoidsSummaryDTO>
<PosVoidsSummaryDTO>
<Transactions>1</Transactions>
<VoidAmount>1</VoidAmount>
<VoidQuantity>1.1</VoidQuantity>
<VoidReason>sample string 1</VoidReason>
<WasteAmount>1</WasteAmount>
<WasteQuantity>1.1</WasteQuantity>
</PosVoidsSummaryDTO>
</ArrayOfPosVoidsSummaryDTO>