OData

The API supports the OData protocol in a read-only manner. This allows a standard set of URLs to be applied to each endpoint for paging, filtering and sorting. Due to resource limitations, not all fields will be filterable or sortable. These will be documented in each specific endpoint.

The OData metadata endpoint can be found at /api/$metadata.

Further tools and documentation on OData can be found at odata.org.

OData Endpoint Reference

Endpoint: /api/sales

The SiteID is a required parameter. Pass this in the query string in the form siteID=val.

Sale

A single sale of a food or beverage item.

Field Name	Type	Nullable	Description
SaleID	Int64	False	The unique identifier of the payment in the POS system.
ItemName	String	True	The food or beverage item name.
Location	String	False	The location at which the sale occurred.
TimeStamp	DateTimeOffset	False	The date and time of the sale.
BillID	Int32	True	The unique identifier of the bill in the POS system.
Category	String	False	The category of the item sold.
CategoryGroup	String	True	The category group of the item sold.
StaffName	String	True	The staff member recording the payment.
MemberName	String	True	The customer of the sale.
Quantity	Decimal	False	The quantity sold.
GstPercent	Decimal	False	The percent GST applied to the sale.
Discount	Decimal	False	The discount amount applied to the sale.
DiscountType	String	True	The type of discount.
SaleExclGst	Decimal	False	The sale amount exclusive of GST.
Cost	Decimal	True	The cost component of the sale.

Endpoint: /api/payments

The SiteID is a required parameter. Pass this in the query string in the form siteID=val.

Payment

A payment or part payment of a bill.

Field Name	Type	Nullable	Description
PaymentID	Int32	False	The unique identifier of the payment in the POS system.
BillID	Int32	False	The unique identifier of the bill in the POS system.
Location	String	True	The location at which the payment was registered.
TimeStamp	DateTimeOffset	False	The date and time of the payment.
StaffName	String	False	The staff member recording the payment.
PaymentType	String	True	The type of the payment, e.g. Cash, Eftpos.
TerminalName	String	True	The name of the POS terminal.
InvoiceNumber	String	True	The identifier of the invoice.
PatronCount	Decimal	True	The number of patrons.
Total	Decimal	False	The amount of the payment.