Using SOAP APIs

Calls:

• GetHouseAccount - What is the general information for this House Account?
• GetHouseAccountCharges - What are the charges towards this House Account for a date range?
• GetHouseAccountPayments - What are the payments from this House Account for a date range?
• GetHouseAccounts - What are all the House Accounts for this location?

Provides data on house accounts, including their charges and payments.

Calls:

• GetOrderBumpTimes - What are the Order Bump Times available for this business date?
• GetOrderItemBumpTimes - What are the Order Item Bump Times available for this business date?

Provides data on kitchen queues and bump times.

Calls:

• GetLaborSchedule - What is the Labor Schedule at this location?
• GetShifts - What are the Shifts that have been worked at this location?
• SaveLaborSchedule - Saving ScheduledShifts for this location.

Provides labor functionalities like the ability to save and retrieve labor schedules, as well as retrieve shifts recorded by the Register at a location.

Calls:

• ApplyPayment - Apply partial or complete payment to an order at a location.
• CalculateOrder - Calculate the taxes, subtotals, and totals for this Order.
• CancelOrder - Cancel an open Order that has not yet been sent to the kitchen.
• GetItemAvailability - Quantity still available for one or more particular Items.
• GetMasterTerminalStatus - Is the Primary Register online or offline?
• GetOrder - Retrieve an open Order from current Business Date.
• GetParty - Retrieve an open Party from current Business Date.
• GetUnavailableItems - Retrieve the list of item IDs that are active but unavailable at the location on current Business Date.
• SendKitchenInstructions - Send kitchen instructions to the KDS (Kitchen Display System).
• SendOrder - Manually send an order from current Business Date to kitchen at this location.
• SubmitOrder - Submit a new Order at the location.
• UpdateItemAvailability - Update the quantity available for one or more particular items.

Provides ordering functionalities like the ability to calculate, submit, and retrieve orders, update or retrieve item availability, and many more. Additionally there is a GetMasterTerminalStatus call which checks that the Primary Register is online.

Calls:

• GetCurrentBusinessDate - Retrieve the Business Date on the Register.
• GetDeposits - Retrieve the Deposits made on a specific business date.
• GetFutureDateOrderDeposits - Retrieve the Deposits made on a specific business date for an order one or more days in advance.
• GetFutureDateOrders - Retrieve the Future Date Orders for a specific date range.
• GetOrders - Retrieve the Orders opened on a specific business date.
• GetTills - Retrieve the Tills on a specific business date.

Provides data on the sales at a location, namely Deposits, Orders, Tills, and the current business date of the Register.

Calls:

• GetCashDrawers - Retrieve the Cash Drawers for this location.
• GetDayParts - Retrieve the Day Parts for this location.
• GetDestinations - Retrieve the Destinations for my orders.
• GetDiscounts - Retrieve the Discounts at this location.
• GetEmployees - Retrieve the Employees for this location.
• GetItemGroups - Retrieve the Item Groups for this location.
• GetItems - Retrieve the Items for this location.
• GetJobs - Retrieve the Jobs employees can clock in under for this location.
• GetModifierCodes - Retrieve the Modifier Codes for this location.
• GetModifierGroups - Retrieve the Modifier Groups for this location.
• GetOptions - Retrieve the Options for this location.
• GetPettyAccounts - Retrieve the Petty Accounts for this location.
• GetPromotions - Retrieve the Promotions at this location.
• GetRegisters - Retrieve the Registers for this location.
• GetRevenueCenters - Retrieve the Revenue Centers for this location.
• GetSections - Retrieve the Sections for this location.
• GetSurcharges - Retrieve the Surcharges at this location.
• GetTaxes - Retrieve the Taxes at this location.
• GetTenders - Retrieve the Tenders for this location.
• GetVoidReasons - Retrieve the Void Reasons for this location.

Provides data about the configuration Settings for a single location.

Note: Authentication for Settings.svc uses tokens in the SOAP body, not HTTP headers.

Calls:

• DeleteBusinessHours - Delete existing business hours of a location.
• DeleteDestinations - Delete existing destinations at a location.
• DeleteExceptionDates - Delete existing exception dates of a location.
• DeleteItems - Delete existing items at a location.
• DeletePriceChanges - Remove a price change at a location.
• DeleteTaxes - Delete existing taxes at a location.
• GetBrands - Retrieve the available brands containing set of items that were assigned to a brand.
• GetBusinessHours - Retrieve the business hours for a location along with any exceptions.
• GetCharities - Retrieve the list of charities for a location.
• GetDestinations - Retrieves the list of the destinations for a location.
• GetEmployees - Retrieve the Employees for this location.
• GetFutureOrderingOptions - Retrieve the Future Ordering Options for this location.
• GetItems - Retrieve the list of items for a location.
• GetJobs - Retrieve the Jobs employees can clock in under for this location.
• GetKitchenQueues - Retrieve the Kitchen Queues for this location.
• GetLastModifiedTime - Retrieve the last time the Settings and/or Employees were modified.
• GetMenu - What is included in a particular Menu?
• GetModifierGroups - Retrieve the Modifier Groups for this location.
• GetOnlineOrderingMenuOptions - Retrieve the Id of the Online Ordering Menu and/or other Alternate Menus.
• GetPermissions - Retrieve the Permissions at this location.
• GetPriceChanges - Retrieve the Price Changes that have occurred at this location.
• GetPromotions - Retrieve the list of promotions for a location.
• GetRefundReasons - Retrieve the list of Refund Reasons for a location.
• GetSecurityLevels - Retrieve the Security Levels at this location.
• GetSettings - Retrieve multiple or all the settings at this location.
• GetTables - Retrieve the Tables at this location.
• GetTaxes - Retrieve the list of taxes for a location.
• SaveBusinessHours - Create or update the existing business hours of a location.
• SaveDestinations - Create new destination or update the existing destination details.
• SaveEmployees - Create or update one or more Employees at a location.
• SaveExceptionDates - Create or update the existing exception dates of a location.
• SaveItems - Create new items or update the existing item details at a location.
• SaveModifierGroups - Create new modifier groups or update the existing modifier groups details.
• SavePriceChanges - Upsert a price change at a location for marking up or down prices.
• SavePromotions - Upsert a promotion at a location.
• SaveTaxes - Create new taxes or update the existing taxes details at a location.
• UpdateItemPrice - Update an item's price at a location.

Provides data about the configuration Settings for a single location, with enhanced APIs. There are additional APIs on top of the ones already existing in Settings.svc to better manage configuration settings.