The deprecated
api that does not have a version is the one that exists from 01.01.2022 (a.k.a the Big Bang).
Common API
API |
Version |
Deprecated |
V1/Common.Ping |
07.15.2024 |
|
V1/Common.GetStore |
07.15.2024 |
GetStoreRequestToGroup |
V1/Common.GetConfigurations |
07.15.2024 |
GetConfigurationsRequestToGroup |
V1/Common.GetPaymentMethods |
08.30.2024 |
|
|
Not implemented yet |
GetEmailsRequestToGroup |
|
Not implemented yet |
GetEmployeesRequestToGroup |
Sale Receipt
API |
Version |
Deprecated |
|
Not implemented yet |
GetSaleReceiptByInvoiceRequestToGroup |
|
Not implemented yet |
GetSaleReceiptByInvoiceForUnpaidOrderRequestToGroup |
|
Not implemented yet |
GetSaleReceiptsByDateRequestToGroup |
Sales Summary
Export excel
API |
Version |
Deprecated |
|
Not implemented yet |
ExportSaleSummaryRequestToGroup |
|
Not implemented yet |
ExportSaleSummaryV2RequestToGroup |
|
Not implemented yet |
ExportSaleByDayPartBreakdownRequestToGroup |
|
Not implemented yet |
ExportSaleByDayPartByItemTypeRequestToGroup |
Day of Week & Time of Day Chart
API |
Version |
Deprecated |
V1/SalesSummary.GetChart |
Not implemented yet |
SaleSummaryChartRequestToGroup |
At a Glance (Sales comparison)
API |
Version |
Deprecated |
V1/SalesSummary.GetComparison |
Not implemented yet |
ComparisonRequestToGroup |
Sales Summary + Liabilities + Void + Cancelled
API |
Version |
Deprecated |
V1/SalesSummary.GetQuickReport |
Not implemented yet |
QuickReportRequestToGroup |
Tax Detail
API |
Version |
Deprecated |
V1/SalesSummary.GetSaleTaxDetail |
Not implemented yet |
GetSaleTaxDetailReportRequestToGroup |
Labor Overview
API |
Version |
Deprecated |
V1/SalesSummary.GetLaborOverview |
Not implemented yet |
LaborOverviewRequestToGroup (04.03.2024) |
Payment (a.k.a Tender Types)
API |
Version |
Deprecated |
V1/SalesSummary.GetPayments |
Not implemented yet |
SaleSummaryPaymentsRequestToGroup |
Credit Card & Cash
API |
Version |
V1/SalesSummary.GetCreditAndCash |
07.15.2024 |
Credit Card Online Order
API |
Version |
V1/SalesSummary.GetSalesByOnlineOrdering |
10.23.2024 |
Credit Card QR Code (Dine-in)
API |
Version |
V1/SalesSummary.GetSalesByQRCodeDineIn |
10.23.2024 |
Cash Summary
API |
Version |
Deprecated |
V1/SalesSummary.GetCashSummary |
Not implemented yet |
GetCashSummaryRequestToGroup (09.22.2023) |
Sale Types
API |
Version |
Deprecated |
V1/SalesSummary.GetSaleTypes |
Not implemented yet |
GetSaleTypesReportRequestToGroup (01.01.2022) |
Batch Summary
API |
Version |
Deprecated |
V1/SalesSummary.GetBatch |
Not implemented yet |
GetBatchReportRequestToGroup (10.19.2023) |
Top Categories
API |
Version |
Deprecated |
V1/SalesSummary.ListTopSaleCategory |
Not implemented yet |
TopSaleCategoryV2RequestToGroup (03.27.2024) |
Top Items
API |
Version |
Deprecated |
V1/SalesSummary.ListTopSaleItem |
Not implemented yet |
TopSaleItemV2RequestToGroup (03.27.2024) |
Day Parts
API |
Version |
Deprecated |
V1/SalesSummary.GetDayParts |
Not implemented yet |
DaypartReportRequestToGroup |
Payment by Type
API |
Version |
Deprecated |
|
Not implemented yet |
GetSaleReceiptPaymentDetailsByIDRequestToGroup |
Sales by Category
API |
Version |
Deprecated |
|
Not implemented yet |
ItemReportRequestToGroup |
|
Not implemented yet |
CategoryReportRequestToGroup |
|
Not implemented yet |
ItemReportByTypeRequestToGroup |
|
Not implemented yet |
ItemTypesReportRequestToGroup |
Daily Sales Breakdown - 04.01.2024
API |
Version |
Deprecated |
V1/DailySales.List |
11.14.2024 |
DailySalesReportRequestToGroup |
V1/DailySales.Summary |
04.01.2024 |
DailySalesOverviewReportRequestToGroup |
Sales by Employee - 11.17.2023
API |
Version |
Deprecated |
V1/SaleByEmployees.List |
11.15.2024 |
GetEmployeePerformanceReportRequestToGroup |
Payment Summary
API |
Version |
Deprecated |
|
Not implemented yet |
GetPaymentSummaryReportRequestToGroup |
Payments (a.k.a Receipts)
API |
Version |
Deprecated |
|
Not implemented yet |
GetSaleReceiptsByDateRequestToGroup |
Voided
API |
Version |
Deprecated |
|
Not implemented yet |
GetVoidReportGroupByEmployeeRequestToGroup |
|
Not implemented yet |
GetVoidReportGroupByApproverRequestToGroup |
|
Not implemented yet |
GetVoidReportGroupByItemRequestToGroup |
|
Not implemented yet |
GetVoidReportRequestToGroup |
|
Not implemented yet |
GetVoidedReceiptsWithConditionalRequestToGroup |
Unpaid Orders
API |
Version |
Deprecated |
V1/UnpaidOrders.GetOverview |
08.15.2024 |
GetUnpaidOrdersOverviewReportRequestToGroup |
V1/UnpaidOrders.List |
08.15.2024 |
GetOpenningTicketsRequestToGroup |
Discounts - 02.10.2023
API |
Version |
Deprecated |
|
Not implemented yet |
GetDiscountByReasonReportRequestToGroup |
|
Not implemented yet |
GetDiscountByItemTypeReportRequestToGroup |
|
Not implemented yet |
GetDiscountByApproverReportRequestToGroup |
|
Not implemented yet |
GetDiscountReportGroupByOrderRequestToGroup |
Cancelled Items
API |
Version |
Deprecated |
V1/Cancels.ListByApprovers |
10.03.2024 |
|
V1/Cancels.ListByItems |
10.03.2024 |
GetCancelItemByTicketReportRequestToGroup |
V1/Cancels.ListByReasons |
10.03.2024 |
GetCancelItemByReasonReportRequestToGroup |
V1/Cancels.ListByServers |
10.03.2024 |
GetCancelItemByEmployeeReportRequestToGroup |
V1/Cancels.ListReceipts |
10.03.2024 |
GetCanceledReceiptsWithConditionalRequestToGroup |
COMP - 12.01.2023
API |
Version |
Deprecated |
|
Not implemented yet |
GetCOMPByReasonReportRequestToGroup |
|
Not implemented yet |
GetCOMPByServerReportRequestToGroup |
|
Not implemented yet |
GetCOMPByApproverReportRequestToGroup |
|
Not implemented yet |
GetCOMPByItemTypeReportRequestToGroup |
|
Not implemented yet |
GetCOMPByItemReportRequestToGroup |
|
Not implemented yet |
GetCOMPDetailReportRequestToGroup |
CC Batch History
API |
Version |
Deprecated |
V1/SalesSummary.GetBatch |
Not implemented yet |
GetBatchReportRequestToGroup (10.19.2023) |
|
Not implemented yet |
GetTransactionsByBatchRequestToGroup |
Deposit History - 07.31.2023
API |
Version |
Deprecated |
|
Not implemented yet |
GetDepositReportRequestToGroup |
Shift Reports
API |
Version |
Deprecated |
V1/Shifts.List |
11.14.2024 |
GetShiftsRequestToGroup |
V1/Shifts.GetByID |
11.14.2024 |
GetShiftReportByIDRequestToGroup |
Employees (a.k.a Labor)
API |
Version |
Deprecated |
|
Not implemented yet |
LaborSummaryReportRequestToGroup |
|
Not implemented yet |
ExportLaborSummaryReportRequestToGroup |
V1/Employees.ListPayroll |
12.06.2024 |
|
V1/Employees.ListTimeEntries |
11.26.2024 |
GetTimeClocksRequestToGroup (07.17.2024) |
Tip Sharing - 06.12.2024
API |
Version |
Deprecated |
|
Not implemented yet |
TipShareGetDataRequestToGroup |
|
Not implemented yet |
TipShareListRequestToGroup |
|
Not implemented yet |
TipShareDetailByIDRequestToGroup |
|
Not implemented yet |
TipShareOverlapValidationRequestToGroup |
|
Not implemented yet |
TipShareCreateRequestToGroup |
|
Not implemented yet |
TipShareDeleteRequestToGroup |
|
Not implemented yet |
TipShareSummaryReportRequestToGroup |
|
Not implemented yet |
TipShareByEmployeeReportRequestToGroup |
|
Not implemented yet |
TipShareOverviewReportRequestToGroup |
Customer - 10.19.2023
API |
Version |
Deprecated |
|
10.19.2023 |
GetCustomerSummaryReportRequestToGroup |
|
10.19.2023 |
GetCustomerStatusReportRequestToGroup |
|
10.19.2023 |
GetCustomerReportRequestToGroup |
|
10.19.2023 |
GetCustomerInformationRequestToGroup |
|
10.19.2023 |
ListCreditCardByCustomerRequestToGroup |
|
10.19.2023 |
UpdateCustomerRequestToGroup |
|
10.19.2023 |
UpdateCustomerCreditCardRequestToGroup |
|
10.19.2023 |
ListSaleActivitiesByCustomerRequestToGroup |
|
10.19.2023 |
GetSaleBehaviorByCustomerRequestToGroup |
|
10.19.2023 |
GetStatisticByCustomerRequestToGroup |
|
10.19.2023 |
ListTopSaleItemByCustomerRequestToGroup |
|
10.19.2023 |
ListCustomerInformationByStatusReportRequestToGroup |
|
10.19.2023 |
GetCustomerSummaryByStatusReportRequestToGroup |
|
10.19.2023 |
GetCustomerFrequencyReportRequestToGroup |
|
10.19.2023 |
ListCouponAvailableRequestToGroup |
Setup - 10.23.2024
Coupon
API |
Version |
V1/Coupons.List |
10.23.2024 |
V1/Coupons.Create |
10.23.2024 |
V1/Coupons.Update |
10.23.2024 |
V1/Coupons.Delete |
10.23.2024 |
Report Scheduler
API |
Version |
V1/EmailSchedulers.GetList |
10.23.2024 |
V1/EmailSchedulers.Create |
10.23.2024 |
V1/EmailSchedulers.Update |
10.23.2024 |
Notification
API |
Version |
V1/EmailConfigurations.List |
10.23.2024 |
V1/EmailConfigurations.Create |
10.23.2024 |
V1/EmailConfigurations.Update |
10.23.2024 |
V1/EmailConfigurations.Delete |
10.23.2024 |
API |
Version |
V1/Surveys.List |
11.20.2024 |
V1/Surveys.GetConfiguration |
11.20.2024 |
V1/Surveys.UpdateConfiguration |
11.20.2024 |
SMS Template
API |
Version |
V1/SmsTemplates.Create |
Not implemented yet |
V1/SmsTemplates.Update |
Not implemented yet |
V1/SmsTemplates.Delete |
Not implemented yet |
V1/SmsTemplates.GetByID |
Not implemented yet |
V1/SmsTemplates.List |
Not implemented yet |
V1/SmsTemplates.ListConfigurations |
Not implemented yet |
V1/SmsTemplates.UpdateConfiguration |
Not implemented yet |