PosStaffDiscounts
Provides summary information on Discounts by Staff
| API | Description |
|---|---|
| GET a/PosStaffDiscounts/GetTopStaffDiscounts?start={start}&end={end} |
Get the top discount type amount for each staff member, grouped by discount type. |
| GET a/PosStaffDiscounts/GetDiscountsForStaff?start={start}&end={end}&posIdentifier={posIdentifier} |
Get discount information for the report period and specified staff member, grouped by discount type. |
| GET r/PosStaffDiscounts?start={start}&end={end} |
Get the top discount type amount for each staff member, grouped by discount type. |
| GET r/PosStaffDiscounts?start={start}&end={end}&posIdentifier={posIdentifier} |
Get discount information for the report period and specified staff member, grouped by discount type. |
PosItemOrders
Provides access to Orders information grouped by Item
| API | Description |
|---|---|
| GET a/PosItemOrders/GetSummary?startTime={startTime}&endTime={endTime} |
Get Orders information for the report period, grouped by item. |
| GET a/PosItemOrders/GetSummary?startTime={startTime}&endTime={endTime}&categoryId={categoryId} |
Get Orders information for the report period and specified item category, grouped by item. |
| GET r/PosItemOrders?startTime={startTime}&endTime={endTime} |
Get Orders information for the report period, grouped by item. |
| GET r/PosItemOrders?startTime={startTime}&endTime={endTime}&categoryId={categoryId} |
Get Orders information for the report period and specified item category, grouped by item. |
PosDiscounts
Provides access to Discounts in the POS database
| API | Description |
|---|---|
| GET a/PosDiscounts/GetDiscounts?start={start}&end={end} |
Gets discounts information for the report period, grouped by discount type. |
| GET r/PosDiscounts?start={start}&end={end} |
Gets discounts information for the report period, grouped by discount type. |
PosSalesTransactions
Provides access to raw transaction data for a POS database
| API | Description |
|---|---|
| GET a/PosSalesTransactions/GetAll |
Get a list of sales headers for the report period |
| GET a/PosSalesTransactions/GetTransactionHeaders?start={start}&end={end} |
Get a list of sales headers for the report period |
| GET a/PosSalesTransactions/GetTransactionLines/{id} |
Get a list of sales lines for the specified sales header. |
| GET r/PosSalesTransactions |
Get a list of sales headers for the report period |
| GET r/PosSalesTransactions?start={start}&end={end} |
Get a list of sales headers for the report period |
| GET r/PosSalesTransactions/{id} |
Get a list of sales lines for the specified sales header. |
PosItemCategorySales
Provides access to sales grouped by item category
| API | Description |
|---|---|
| GET a/PosItemCategorySales/GetSummary?start={start}&end={end} |
Get sales information for the report period, grouped by item category. |
| GET a/PosItemCategorySales/GetSales?start={start}&end={end}&interval={interval} |
Get sales information for the report period, grouped by item category and report interval |
| GET r/PosItemCategorySales?start={start}&end={end} |
Get sales information for the report period, grouped by item category. |
| GET r/PosItemCategorySales?start={start}&end={end}&interval={interval} |
Get sales information for the report period, grouped by item category and report interval |
PosItemGroupSales
Provides access to sales grouped by Item Group
| API | Description |
|---|---|
| GET a/PosItemGroupSales/GetItemGroupSales?start={start}&end={end} |
Get sales information for the report period, grouped by item group |
| GET r/PosItemGroupSales?start={start}&end={end} |
Get sales information for the report period, grouped by item group |
LabourRoleAnalysis
Endpoints for Labour Roster Vs Actual Controller
| API | Description |
|---|---|
| GET a/LabourRoleAnalysis/GetLabourRoleAnalysis?start={start}&end={end} |
Get Labour Roster Vs Actual |
| GET r/LabourRoleAnalysis?start={start}&end={end} |
Get Labour Roster Vs Actual |
PosStaff
Provides access to the Staff Members in a POS database
| API | Description |
|---|---|
| GET a/PosStaff/GetStaffMembers |
Get a list of staff members from the Point of sale database. |
| GET a/PosStaff/GetStaffMember?posIdentifier={posIdentifier} |
Get a specific staff member from the point of sale database. |
| GET r/PosStaff |
Get a list of staff members from the Point of sale database. |
| GET r/PosStaff?posIdentifier={posIdentifier} |
Get a specific staff member from the point of sale database. |
LabourBudgetAnalysis
Endpoints for Labour Budget Analysis
| API | Description |
|---|---|
| GET a/LabourBudgetAnalysis/GetLabourBudgetAnalysis?start={start}&end={end}&interval={interval} |
Get Labour Budget Analysis |
| GET r/LabourBudgetAnalysis?start={start}&end={end}&interval={interval} |
Get Labour Budget Analysis |
PosStaffItemSales
Provides access to reports on Items sold by specific staff members
| API | Description |
|---|---|
| GET a/PosStaffItemSales/GetTopStaffItems?start={start}&end={end} |
Get the top item Orders for each staff member with Orders in the report period. |
| GET a/PosStaffItemSales/GetItemSalesForStaff?start={start}&end={end}&posIdentifier={posIdentifier} |
Get sales information for the report period and specified staff member, grouped by item. |
| GET r/PosStaffItemSales?start={start}&end={end} |
Get the top item Orders for each staff member with Orders in the report period. |
| GET r/PosStaffItemSales?start={start}&end={end}&posIdentifier={posIdentifier} |
Get sales information for the report period and specified staff member, grouped by item. |
PosStaffItemGroupSales
Provides access to reports on Item Groups sold by specific staff members
| API | Description |
|---|---|
| GET a/PosStaffItemGroupSales/GetTopStaffItemGroups?start={start}&end={end} |
Get the top item group Sales for each staff member |
| GET a/PosStaffItemGroupSales/GetItemGroupSalesForStaffMember?start={start}&end={end}&posIdentifier={posIdentifier} |
Get Sales information for the report period and specified staff member, grouped by item group. |
| GET r/PosStaffItemGroupSales?start={start}&end={end} |
Get the top item group Sales for each staff member |
| GET r/PosStaffItemGroupSales?start={start}&end={end}&posIdentifier={posIdentifier} |
Get Sales information for the report period and specified staff member, grouped by item group. |
GrossProfitExpectedVsActual
Provides an interface for getting information for about Gross Profit.
| API | Description |
|---|---|
| GET a/GrossProfitExpectedVsActual/GetGrossProfitExpectedVsActual?start={start}&end={end}&interval={interval} |
Gets the gross profit purchases. |
| GET r/GrossProfitExpectedVsActual?start={start}&end={end}&interval={interval} |
Gets the gross profit purchases. |
PosStaffSales
Provides access to sales summaries grouped by staff member
| API | Description |
|---|---|
| GET a/PosStaffSales/GetSales?start={start}&end={end} |
Get sales information for the report period, grouped by staff member. |
| GET a/PosStaffSales/GetStaffSales?start={start}&end={end}&interval={interval}&posIdentifier={posIdentifier} |
Get sales information for the report period and specified staff member, grouped by report interval. |
| GET r/PosStaffSales?start={start}&end={end} |
Get sales information for the report period, grouped by staff member. |
| GET r/PosStaffSales?start={start}&end={end}&interval={interval}&posIdentifier={posIdentifier} |
Get sales information for the report period and specified staff member, grouped by report interval. |
PosStaffOrders
Provides access to Orders summaries grouped by staff member
| API | Description |
|---|---|
| GET a/PosStaffOrders/GetOrders?start={start}&end={end} |
Get Orders information for the report period, grouped by staff member. |
| GET a/PosStaffOrders/GetStaffOrders?start={start}&end={end}&interval={interval}&posIdentifier={posIdentifier} |
Get Orders information for the report period and specified staff member, grouped by report interval. |
| GET r/PosStaffOrders?start={start}&end={end} |
Get Orders information for the report period, grouped by staff member. |
| GET r/PosStaffOrders?start={start}&end={end}&interval={interval}&posIdentifier={posIdentifier} |
Get Orders information for the report period and specified staff member, grouped by report interval. |
PosOrders
Provides Order summary information
| API | Description |
|---|---|
| GET a/PosOrders/GetOrdersAsync?start={start}&end={end}&interval={interval} |
Get Orders information for the report period, grouped by report interval. |
| GET r/PosOrders?start={start}&end={end}&interval={interval} |
Get Orders information for the report period, grouped by report interval. |
PosStaffVoids
Provides information on Voids in the POS database
| API | Description |
|---|---|
| GET a/PosStaffVoids/GetTopStaffVoids?start={start}&end={end} |
Get the top void reason amounts for each staff member with voids in the report period |
| GET a/PosStaffVoids/GetVoidsForStaff?start={start}&end={end}&posIdentifier={posIdentifier} |
Get void information for the report period and specified staff member, grouped by void reason. |
| GET r/PosStaffVoids?start={start}&end={end} |
Get the top void reason amounts for each staff member with voids in the report period |
| GET r/PosStaffVoids?start={start}&end={end}&posIdentifier={posIdentifier} |
Get void information for the report period and specified staff member, grouped by void reason. |
PosStaffItemGroupOrders
Provides access to reports on Item Groups sold by specific staff members
| API | Description |
|---|---|
| GET a/PosStaffItemGroupOrders/GetTopStaffItemGroups?start={start}&end={end} |
Get the top item group Orders for each staff member |
| GET a/PosStaffItemGroupOrders/GetItemGroupOrdersForStaffMember?start={start}&end={end}&posIdentifier={posIdentifier} |
Get Orders information for the report period and specified staff member, grouped by item group. |
| GET r/PosStaffItemGroupOrders?start={start}&end={end} |
Get the top item group Orders for each staff member |
| GET r/PosStaffItemGroupOrders?start={start}&end={end}&posIdentifier={posIdentifier} |
Get Orders information for the report period and specified staff member, grouped by item group. |
PosItemGroupOrders
Provides access to Orders grouped by Item Group
| API | Description |
|---|---|
| GET a/PosItemGroupOrders/GetItemGroupOrders?start={start}&end={end} |
Get Orders information for the report period, grouped by item group |
| GET r/PosItemGroupOrders?start={start}&end={end} |
Get Orders information for the report period, grouped by item group |
CogsProducts
Endpoints for Stocktake Report
| API | Description |
|---|---|
| GET a/CogsProducts/GetCogsDetail?start={start}&end={end} |
Get cogs products report |
| GET a/CogsProducts/GetCogsSummary?start={start}&end={end}&interval={interval} |
Get cogs report |
| GET r/CogsProducts?start={start}&end={end} |
Get cogs products report |
| GET r/CogsProducts?start={start}&end={end}&interval={interval} |
Get cogs report |
GrossProfitOverview
Contains endpoints for the Gross Profit Overview report.
| API | Description |
|---|---|
| GET a/GrossProfitOverview/GetOverview?start={start}&end={end}&interval={interval} |
Get the data for the gross profit overview report. |
| GET r/GrossProfitOverview?start={start}&end={end}&interval={interval} |
Get the data for the gross profit overview report. |
GrossProfitPurchases
Provides an interface for getting the gross profit of your business.
| API | Description |
|---|---|
| GET a/GrossProfitPurchases/GetGrossProfitPurchases?start={start}&end={end}&interval={interval} |
Gets the gross profit purchases. |
| GET r/GrossProfitPurchases?start={start}&end={end}&interval={interval} |
Gets the gross profit purchases. |
PosStaffItemOrders
Provides access to reports on Items sold by specific staff members
| API | Description |
|---|---|
| GET a/PosStaffItemOrders/GetTopStaffItems?start={start}&end={end} |
Get the top item Orders for each staff member with Orders in the report period. |
| GET a/PosStaffItemOrders/GetItemOrdersForStaff?start={start}&end={end}&posIdentifier={posIdentifier} |
Get Orders information for the report period and specified staff member, grouped by item. |
| GET r/PosStaffItemOrders?start={start}&end={end} |
Get the top item Orders for each staff member with Orders in the report period. |
| GET r/PosStaffItemOrders?start={start}&end={end}&posIdentifier={posIdentifier} |
Get Orders information for the report period and specified staff member, grouped by item. |
PosTenders
Provides information on Tenders
| API | Description |
|---|---|
| GET a/PosTenders/GetTenders?start={start}&end={end} |
Get tender information for the report period, grouped by day and tender type |
| GET a/PosTenders/GetTenderIntervals?start={start}&end={end}&interval={interval}&posIdentifier={posIdentifier} |
Get the tender information for a single tender type, grouped by interval |
| GET r/PosTenders?start={start}&end={end} |
Get tender information for the report period, grouped by day and tender type |
| GET r/PosTenders?start={start}&end={end}&interval={interval}&posIdentifier={posIdentifier} |
Get the tender information for a single tender type, grouped by interval |
PosItems
Provides access to the POS Item list
| API | Description |
|---|---|
| GET a/PosItems/GetPosItems |
Get a list of all items from the point of sale database. |
| GET r/PosItems |
Get a list of all items from the point of sale database. |
PosTables
Provides endpoints for querying information about Tables.
| API | Description |
|---|---|
| GET a/PosTables/GetTableSummary?start={start}&end={end}&interval={interval} |
Get table information for the report period, grouped by report interval. |
| GET r/PosTables?start={start}&end={end}&interval={interval} |
Get table information for the report period, grouped by report interval. |
PosOrdersTransactions
Provides access to raw transaction data for a POS database
| API | Description |
|---|---|
| GET a/PosOrdersTransactions/GetAll |
Get a list of sales headers for the report period |
| GET a/PosOrdersTransactions/GetTransactionHeaders?start={start}&end={end} |
Get a list of sales headers for the report period |
| GET a/PosOrdersTransactions/GetTransactionLines/{id} |
Get a list of sales lines for the specified sales header. |
| GET r/PosOrdersTransactions |
Get a list of sales headers for the report period |
| GET r/PosOrdersTransactions?start={start}&end={end} |
Get a list of sales headers for the report period |
| GET r/PosOrdersTransactions/{id} |
Get a list of sales lines for the specified sales header. |
PosVoids
Provides information about voids in the POS database
| API | Description |
|---|---|
| GET a/PosVoids/GetVoids?start={start}&end={end}&interval={interval} |
Get void information for the report period, grouped by report interval. |
| GET a/PosVoids/GetVoids?start={start}&end={end} |
Get void information for the report period, grouped by void reason. |
| GET r/PosVoids?start={start}&end={end}&interval={interval} |
Get void information for the report period, grouped by report interval. |
| GET r/PosVoids?start={start}&end={end} |
Get void information for the report period, grouped by void reason. |
PosSales
Provides sale summary information
| API | Description |
|---|---|
| GET a/PosSales/GetSales?start={start}&end={end}&interval={interval}&posItemIdentifier={posItemIdentifier} |
Get sales information for the report period, grouped by report interval. |
| GET r/PosSales?start={start}&end={end}&interval={interval}&posItemIdentifier={posItemIdentifier} |
Get sales information for the report period, grouped by report interval. |
Tills
Provides information on the Tills in the POS database
| API | Description |
|---|---|
| GET a/Tills/GetTills |
Get a list of tills from the company database. |
| GET r/Tills |
Get a list of tills from the company database. |
LabourRosterVsActual
Endpoints for Labour Roster Vs Actual Controller
| API | Description |
|---|---|
| GET a/LabourRosterVsActual/GetLabourRosterVsActual?start={start}&end={end}&interval={interval} |
Get Labour Roster Vs Actual |
| GET r/LabourRosterVsActual?start={start}&end={end}&interval={interval} |
Get Labour Roster Vs Actual |
PosItemCategoryOrders
Provides access to Orders grouped by item category
| API | Description |
|---|---|
| GET a/PosItemCategoryOrders/GetSummary?start={start}&end={end} |
Get Orders information for the report period, grouped by item category. |
| GET a/PosItemCategoryOrders/GetOrders?start={start}&end={end}&interval={interval} |
Get Orders information for the report period, grouped by item category and report interval |
| GET r/PosItemCategoryOrders?start={start}&end={end} |
Get Orders information for the report period, grouped by item category. |
| GET r/PosItemCategoryOrders?start={start}&end={end}&interval={interval} |
Get Orders information for the report period, grouped by item category and report interval |
PosStaffTables
Provides endpoints for querying information about tables grouped by staff member.
| API | Description |
|---|---|
| GET a/PosStaffTables/GetTableSummary?start={start}&end={end} |
Get table information for the report period, grouped by staff member. |
| GET a/PosStaffTables/GetTableSummary?start={start}&end={end}&interval={interval}&posIdentifier={posIdentifier} |
Get table information for the report period for an individual staff member. |
| GET r/PosStaffTables?start={start}&end={end} |
Get table information for the report period, grouped by staff member. |
| GET r/PosStaffTables?start={start}&end={end}&interval={interval}&posIdentifier={posIdentifier} |
Get table information for the report period for an individual staff member. |
PosItemSales
Provides access to Sales information grouped by Item
| API | Description |
|---|---|
| GET a/PosItemSales/GetSummary?startTime={startTime}&endTime={endTime} |
Get sales information for the report period, grouped by item. |
| GET a/PosItemSales/GetSummary?startTime={startTime}&endTime={endTime}&categoryId={categoryId} |
Get sales information for the report period and specified item category, grouped by item. |
| GET r/PosItemSales?startTime={startTime}&endTime={endTime} |
Get sales information for the report period, grouped by item. |
| GET r/PosItemSales?startTime={startTime}&endTime={endTime}&categoryId={categoryId} |
Get sales information for the report period and specified item category, grouped by item. |