GET a/PosVoids/GetVoids?start={start}&end={end}&interval={interval}
Get void information for the report period, grouped by report interval.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| start |
Report start time |
date |
Required |
| end |
Report end time |
date |
Required |
| interval |
Report interval |
time interval |
Required |
Body Parameters
None.
Response Information
Resource Description
List of Void summary grouped by interval
Collection of PosVoidsIntervalSummaryDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| StartTime |
Gets or sets the Interval start time |
date |
None. |
| Invoices |
Gets or sets the total amount invoiced in the period (for calculating % of total sales fields) |
decimal number |
None. |
| 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:
[
{
"startTime": "2026-04-04T22:27:09.173283+00:00",
"invoices": 1.0,
"voidReason": "sample string 2",
"voidQuantity": 1.1,
"voidAmount": 1.0,
"wasteQuantity": 1.1,
"wasteAmount": 1.0,
"transactions": 1.0
},
{
"startTime": "2026-04-04T22:27:09.173283+00:00",
"invoices": 1.0,
"voidReason": "sample string 2",
"voidQuantity": 1.1,
"voidAmount": 1.0,
"wasteQuantity": 1.1,
"wasteAmount": 1.0,
"transactions": 1.0
}
]
application/xml, text/xml
Sample:
<ArrayOfPosVoidsIntervalSummaryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Loaded.WebApi.Models.POS.Voids">
<PosVoidsIntervalSummaryDTO>
<Transactions>1</Transactions>
<VoidAmount>1</VoidAmount>
<VoidQuantity>1.1</VoidQuantity>
<VoidReason>sample string 2</VoidReason>
<WasteAmount>1</WasteAmount>
<WasteQuantity>1.1</WasteQuantity>
<Invoices>1</Invoices>
<StartTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2026-04-04T22:27:09.173283Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</StartTime>
</PosVoidsIntervalSummaryDTO>
<PosVoidsIntervalSummaryDTO>
<Transactions>1</Transactions>
<VoidAmount>1</VoidAmount>
<VoidQuantity>1.1</VoidQuantity>
<VoidReason>sample string 2</VoidReason>
<WasteAmount>1</WasteAmount>
<WasteQuantity>1.1</WasteQuantity>
<Invoices>1</Invoices>
<StartTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2026-04-04T22:27:09.173283Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</StartTime>
</PosVoidsIntervalSummaryDTO>
</ArrayOfPosVoidsIntervalSummaryDTO>