GET v2/Sales/GetSalesExport/{SiteID}?StartDate={StartDate}&EndDate={EndDate}&ZReportId={ZReportId}
Returns transaction data for a given site, either between two dates (maximum range: 1 day) or for a single Z report. Supply StartDate and EndDate, or ZReportId, or both (the dates then further narrow the Z report). Cache Time: 60 minutes.
Request Information
URI Parameters
| Name | Type | Description | Additional information |
|---|---|---|---|
| SiteID | integer |
The Unique ID Of The Site |
|
| StartDate | datetime |
Start of the date range. Required unless ZReportId is supplied. Truncated to the nearest hour — use whole hours only (e.g. 2026-05-30T22:00:00) |
None. |
| EndDate | datetime |
End of the date range. Required unless ZReportId is supplied. Truncated to the nearest hour — use whole hours only (e.g. 2026-05-31T00:00:00) |
None. |
| ZReportId | integer |
Optional. Only return transactions assigned to this Z report. When supplied, the dates are optional and the 1 day limit does not apply |
None. |
| version | string |
None. |
Body Parameters
None.
Response Information
Resource Description
V2SalesExportModel| Name | Type | Description | Additional information |
|---|---|---|---|
| SiteID | integer |
None. |
|
| transactions | Collection of V2BillHeaderAndFooterModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"SiteID": 1,
"transactions": [
{
"EPOSTransactionID": 1,
"SaleDate": "2026-11-11T12:53:50.0330955",
"WeekNo": 3,
"CoverCount": 4,
"TableNumber": 5,
"Session": "sample string 6",
"RevenueCenter": "sample string 7",
"ActualGrossAmt": 8.0,
"ActualNetAmt": 9.0,
"TaxableNetAmt": 10.0,
"TaxAmt": 11.0,
"ServiceChargeAmt": 12.0,
"GratuityAmt": 13.0,
"TotalDiscountAmount": 14.0,
"OpenDateTime": "2026-11-11T12:53:50.0330955",
"ClosedDateTime": "2026-11-11T12:53:50.0330955",
"EmployeeOpenedBillID": 17,
"EmployeeOpenedBill": "sample string 18",
"EmployeeClosedBillID": 19,
"EmployeeClosedBill": "sample string 20",
"BillPaid": true,
"BillTransferred": true,
"EmployeeWhoTransferredBillID": 23,
"EmployeeWhoTransferredBillName": "sample string 24",
"TransferDateTime": "2026-11-11T12:53:50.0330955",
"CRMMemberID": 25,
"IsRefund": true,
"Terminal": "sample string 27",
"ExternalMembershipID": "sample string 28",
"RefundTransactionID": 29,
"RefundOriginalTransactionID": 30,
"ZReportID": 31,
"BillItemInfos": [
{
"EPOSTransactionItemID": 1,
"EPOSTransactionID": 2,
"QtySold": 3.0,
"UnitQuantity": 4.0,
"OfSku": 5.0,
"CostPrice": 6.0,
"ExpectedGrossAmt": 7.0,
"ActualGrossAmt": 8.0,
"TaxableNetAmt": 9.0,
"TaxAmt": 10.0,
"VATRate": 11.0,
"VATID": 1,
"ServiceChargeAmount": 12.0,
"MeasureID": 13,
"MeasureName": "sample string 14",
"ProductID": 15,
"ProductName": "sample string 16",
"ProductGroupID": 17,
"ProductGroupName": "sample string 18",
"ProductTypeID": 19,
"ProductTypeName": "sample string 20",
"PriceGroupID": 21,
"PriceGroupName": "sample string 22",
"PLU": "sample string 23",
"CostCenter": "sample string 24",
"SessionName": "sample string 25",
"EmployeeWhoSoldID": 26,
"EmployeeWhoSoldName": "sample string 27",
"EnterDateTime": "2026-11-11T12:53:50.0330955",
"IsVoided": true,
"VoidReason": "sample string 30",
"EmployeeWhoVoidedID": 1,
"EmployeeWhoVoidedName": "sample string 31",
"VoidDateTime": "2026-11-11T12:53:50.0330955",
"IsErrorCorrect": true,
"IsOption": true,
"TransactionItemOptionID": 34,
"IsSold": true,
"IsRefund": true,
"IsRefundReturnToStock": true,
"DiscountInfos": [
{
"DiscountReasonID": 1,
"DiscountReasonDesc": "sample string 2",
"DiscountAmt": 3.0,
"DiscountApprovedByEmployee": true,
"DiscountApprovalDateTime": "2026-11-11T12:53:50.0330955"
},
{
"DiscountReasonID": 1,
"DiscountReasonDesc": "sample string 2",
"DiscountAmt": 3.0,
"DiscountApprovedByEmployee": true,
"DiscountApprovalDateTime": "2026-11-11T12:53:50.0330955"
}
],
"PromotionInfos": [
{
"PromotionID": 1,
"PromotionName": "sample string 2",
"PromotionLossGrossAmt": 3.0,
"PromotionLossNetAmt": 4.0
},
{
"PromotionID": 1,
"PromotionName": "sample string 2",
"PromotionLossGrossAmt": 3.0,
"PromotionLossNetAmt": 4.0
}
]
},
{
"EPOSTransactionItemID": 1,
"EPOSTransactionID": 2,
"QtySold": 3.0,
"UnitQuantity": 4.0,
"OfSku": 5.0,
"CostPrice": 6.0,
"ExpectedGrossAmt": 7.0,
"ActualGrossAmt": 8.0,
"TaxableNetAmt": 9.0,
"TaxAmt": 10.0,
"VATRate": 11.0,
"VATID": 1,
"ServiceChargeAmount": 12.0,
"MeasureID": 13,
"MeasureName": "sample string 14",
"ProductID": 15,
"ProductName": "sample string 16",
"ProductGroupID": 17,
"ProductGroupName": "sample string 18",
"ProductTypeID": 19,
"ProductTypeName": "sample string 20",
"PriceGroupID": 21,
"PriceGroupName": "sample string 22",
"PLU": "sample string 23",
"CostCenter": "sample string 24",
"SessionName": "sample string 25",
"EmployeeWhoSoldID": 26,
"EmployeeWhoSoldName": "sample string 27",
"EnterDateTime": "2026-11-11T12:53:50.0330955",
"IsVoided": true,
"VoidReason": "sample string 30",
"EmployeeWhoVoidedID": 1,
"EmployeeWhoVoidedName": "sample string 31",
"VoidDateTime": "2026-11-11T12:53:50.0330955",
"IsErrorCorrect": true,
"IsOption": true,
"TransactionItemOptionID": 34,
"IsSold": true,
"IsRefund": true,
"IsRefundReturnToStock": true,
"DiscountInfos": [
{
"DiscountReasonID": 1,
"DiscountReasonDesc": "sample string 2",
"DiscountAmt": 3.0,
"DiscountApprovedByEmployee": true,
"DiscountApprovalDateTime": "2026-11-11T12:53:50.0330955"
},
{
"DiscountReasonID": 1,
"DiscountReasonDesc": "sample string 2",
"DiscountAmt": 3.0,
"DiscountApprovedByEmployee": true,
"DiscountApprovalDateTime": "2026-11-11T12:53:50.0330955"
}
],
"PromotionInfos": [
{
"PromotionID": 1,
"PromotionName": "sample string 2",
"PromotionLossGrossAmt": 3.0,
"PromotionLossNetAmt": 4.0
},
{
"PromotionID": 1,
"PromotionName": "sample string 2",
"PromotionLossGrossAmt": 3.0,
"PromotionLossNetAmt": 4.0
}
]
}
],
"PaymentInfos": [
{
"EPOSTransactionID": 1,
"TenderAmount": 2.0,
"TenderTypeID": 3,
"TenderTypeName": "sample string 4",
"EmployeeID": 5,
"EmployeeName": "sample string 6",
"TenderedDateTime": "2026-11-11T12:53:50.0487506",
"TableNo": 8,
"TenderID": 9,
"ThirdPartyReference": "sample string 10"
},
{
"EPOSTransactionID": 1,
"TenderAmount": 2.0,
"TenderTypeID": 3,
"TenderTypeName": "sample string 4",
"EmployeeID": 5,
"EmployeeName": "sample string 6",
"TenderedDateTime": "2026-11-11T12:53:50.0487506",
"TableNo": 8,
"TenderID": 9,
"ThirdPartyReference": "sample string 10"
}
]
},
{
"EPOSTransactionID": 1,
"SaleDate": "2026-11-11T12:53:50.0330955",
"WeekNo": 3,
"CoverCount": 4,
"TableNumber": 5,
"Session": "sample string 6",
"RevenueCenter": "sample string 7",
"ActualGrossAmt": 8.0,
"ActualNetAmt": 9.0,
"TaxableNetAmt": 10.0,
"TaxAmt": 11.0,
"ServiceChargeAmt": 12.0,
"GratuityAmt": 13.0,
"TotalDiscountAmount": 14.0,
"OpenDateTime": "2026-11-11T12:53:50.0330955",
"ClosedDateTime": "2026-11-11T12:53:50.0330955",
"EmployeeOpenedBillID": 17,
"EmployeeOpenedBill": "sample string 18",
"EmployeeClosedBillID": 19,
"EmployeeClosedBill": "sample string 20",
"BillPaid": true,
"BillTransferred": true,
"EmployeeWhoTransferredBillID": 23,
"EmployeeWhoTransferredBillName": "sample string 24",
"TransferDateTime": "2026-11-11T12:53:50.0330955",
"CRMMemberID": 25,
"IsRefund": true,
"Terminal": "sample string 27",
"ExternalMembershipID": "sample string 28",
"RefundTransactionID": 29,
"RefundOriginalTransactionID": 30,
"ZReportID": 31,
"BillItemInfos": [
{
"EPOSTransactionItemID": 1,
"EPOSTransactionID": 2,
"QtySold": 3.0,
"UnitQuantity": 4.0,
"OfSku": 5.0,
"CostPrice": 6.0,
"ExpectedGrossAmt": 7.0,
"ActualGrossAmt": 8.0,
"TaxableNetAmt": 9.0,
"TaxAmt": 10.0,
"VATRate": 11.0,
"VATID": 1,
"ServiceChargeAmount": 12.0,
"MeasureID": 13,
"MeasureName": "sample string 14",
"ProductID": 15,
"ProductName": "sample string 16",
"ProductGroupID": 17,
"ProductGroupName": "sample string 18",
"ProductTypeID": 19,
"ProductTypeName": "sample string 20",
"PriceGroupID": 21,
"PriceGroupName": "sample string 22",
"PLU": "sample string 23",
"CostCenter": "sample string 24",
"SessionName": "sample string 25",
"EmployeeWhoSoldID": 26,
"EmployeeWhoSoldName": "sample string 27",
"EnterDateTime": "2026-11-11T12:53:50.0330955",
"IsVoided": true,
"VoidReason": "sample string 30",
"EmployeeWhoVoidedID": 1,
"EmployeeWhoVoidedName": "sample string 31",
"VoidDateTime": "2026-11-11T12:53:50.0330955",
"IsErrorCorrect": true,
"IsOption": true,
"TransactionItemOptionID": 34,
"IsSold": true,
"IsRefund": true,
"IsRefundReturnToStock": true,
"DiscountInfos": [
{
"DiscountReasonID": 1,
"DiscountReasonDesc": "sample string 2",
"DiscountAmt": 3.0,
"DiscountApprovedByEmployee": true,
"DiscountApprovalDateTime": "2026-11-11T12:53:50.0330955"
},
{
"DiscountReasonID": 1,
"DiscountReasonDesc": "sample string 2",
"DiscountAmt": 3.0,
"DiscountApprovedByEmployee": true,
"DiscountApprovalDateTime": "2026-11-11T12:53:50.0330955"
}
],
"PromotionInfos": [
{
"PromotionID": 1,
"PromotionName": "sample string 2",
"PromotionLossGrossAmt": 3.0,
"PromotionLossNetAmt": 4.0
},
{
"PromotionID": 1,
"PromotionName": "sample string 2",
"PromotionLossGrossAmt": 3.0,
"PromotionLossNetAmt": 4.0
}
]
},
{
"EPOSTransactionItemID": 1,
"EPOSTransactionID": 2,
"QtySold": 3.0,
"UnitQuantity": 4.0,
"OfSku": 5.0,
"CostPrice": 6.0,
"ExpectedGrossAmt": 7.0,
"ActualGrossAmt": 8.0,
"TaxableNetAmt": 9.0,
"TaxAmt": 10.0,
"VATRate": 11.0,
"VATID": 1,
"ServiceChargeAmount": 12.0,
"MeasureID": 13,
"MeasureName": "sample string 14",
"ProductID": 15,
"ProductName": "sample string 16",
"ProductGroupID": 17,
"ProductGroupName": "sample string 18",
"ProductTypeID": 19,
"ProductTypeName": "sample string 20",
"PriceGroupID": 21,
"PriceGroupName": "sample string 22",
"PLU": "sample string 23",
"CostCenter": "sample string 24",
"SessionName": "sample string 25",
"EmployeeWhoSoldID": 26,
"EmployeeWhoSoldName": "sample string 27",
"EnterDateTime": "2026-11-11T12:53:50.0330955",
"IsVoided": true,
"VoidReason": "sample string 30",
"EmployeeWhoVoidedID": 1,
"EmployeeWhoVoidedName": "sample string 31",
"VoidDateTime": "2026-11-11T12:53:50.0330955",
"IsErrorCorrect": true,
"IsOption": true,
"TransactionItemOptionID": 34,
"IsSold": true,
"IsRefund": true,
"IsRefundReturnToStock": true,
"DiscountInfos": [
{
"DiscountReasonID": 1,
"DiscountReasonDesc": "sample string 2",
"DiscountAmt": 3.0,
"DiscountApprovedByEmployee": true,
"DiscountApprovalDateTime": "2026-11-11T12:53:50.0330955"
},
{
"DiscountReasonID": 1,
"DiscountReasonDesc": "sample string 2",
"DiscountAmt": 3.0,
"DiscountApprovedByEmployee": true,
"DiscountApprovalDateTime": "2026-11-11T12:53:50.0330955"
}
],
"PromotionInfos": [
{
"PromotionID": 1,
"PromotionName": "sample string 2",
"PromotionLossGrossAmt": 3.0,
"PromotionLossNetAmt": 4.0
},
{
"PromotionID": 1,
"PromotionName": "sample string 2",
"PromotionLossGrossAmt": 3.0,
"PromotionLossNetAmt": 4.0
}
]
}
],
"PaymentInfos": [
{
"EPOSTransactionID": 1,
"TenderAmount": 2.0,
"TenderTypeID": 3,
"TenderTypeName": "sample string 4",
"EmployeeID": 5,
"EmployeeName": "sample string 6",
"TenderedDateTime": "2026-11-11T12:53:50.0487506",
"TableNo": 8,
"TenderID": 9,
"ThirdPartyReference": "sample string 10"
},
{
"EPOSTransactionID": 1,
"TenderAmount": 2.0,
"TenderTypeID": 3,
"TenderTypeName": "sample string 4",
"EmployeeID": 5,
"EmployeeName": "sample string 6",
"TenderedDateTime": "2026-11-11T12:53:50.0487506",
"TableNo": 8,
"TenderID": 9,
"ThirdPartyReference": "sample string 10"
}
]
}
]
}
application/xml, text/xml
Sample:
System.Xml.XmlDocument