Cash Management

Overview
BankDrop
CashOffice
Payout
Till

Customers

Overview
Customer
CustomerAddress
CustomerEstablishment
CustomerGroup
CustomerGroupCustomers
CustomerHistory
- Return the list of CustomerHistory objects.get

Discounts

Overview
Discount
DiscountCode
DiscountLevel
- Returns the list of DiscountLevel objectsget
- Returns a single DiscountLevel objectget

Employees

Overview
DeclaredTips
Department
Employee
EmployeeRoleEstablishment
Permission
- Returns the list of Permission objectsget
- Returns a single Permission objectget
Role
- Returns the list of role objectsget
- Find Role by IDget

General

Overview
Address
BusinessActionLog
BusinessDay
Company
- Returns the list of Company objectsget
- Find Company by IDget
Currency
Device
- Returns the list of Device objectsget
- Find Device by IDget
Establishment
PosStation
- Returns the list of PosStation objectsget
- Find PosStation by IDget
RevenueCenter
SystemSetting
- Returns the list of SystemSetting objectsget
- Find SystemSetting by IDget
SystemSettingOption
- Returns the list of SystemSettingOption objectsget
- Find SystemSettingOption by IDget
Timetable
TimetableItem
User
- Returns the list of User objectsget
- Find User by IDget

House Accounts

Overview
HouseAccount
HouseAccountPayment
HouseAccountTransaction
- Returns the list of HouseAccountTransaction objectsget
- Find HouseAccountTransaction by IDget

Inventory

Overview
CurrentStock
- Returns the list of CurrentStock objectsget
IngredientInventory
Inventory
InventoryReceipt
InventoryUnit
InventoryXProduct
InventoryXIngredient
PhysicalInventory
- Returns the list of PhysicalInventory objectsget
- Find PhysicalInventory by IDget
PhysicalInventoryItem
- Returns the list of PhysicalInventoryItem objectsget
- Find PhysicalInventoryItem by IDget
PhysicalInventoryScannedItem
PhysicalInventorySection
Stocktake
- Returns the list of Stocktake objectsget
- Find Stocktake by IDget
StocktakeItem
- Returns the list of StocktakeItem objectsget
- Find StocktakeItem by IDget
StocktakeScannedItem
StocktakeSection
Transfer
- Returns a list of Transfer objectsget
- Returns a list of Transfer objectsget
TransferItem
- Returns the list of TransferItem objectsget
- Find TransferItem by IDget
TransferReceipt
- Returns the list of TransferReceipt objectsget
- Find TransferReceipt by IDget
TransferReceiptItem
- Returns the list of TransferReceiptItem objectsget
- Find TransferReceiptItem by IDget

Orders

AppliedServiceFee
AppliedTaxOrder
AppliedTaxOrderItem
CustomPaymentType
- Returns the list of CustomPaymentType objectsget
- Returns a single CustomPaymentType objectget
CustomOrderOption
- Returns the list of CustomOrderOption objectsget
ModifierItem
Order
OrderDataDiff
- Returns the list of OrderDataDiff objectsget
- Returns a single OrderDataDiff objectget
OrderExchange
OrderExchangeItem
OrderHistory
OrderItem
OrderItemCatering
- Returns the list of OrderItemCatering objectsget
- Returns a single OrderItemCatering objectget
OrderItemCommission
OrderItemDataDiff
- Returns the list of OrderItemDataDiff objectsget
- Find OrderItemDataDiff by IDget
OrderTaxBreakDown
- Returns the list of OrderTaxBreakDown objectsget
- Find OrderTaxBreakDown by IDget
Package
Payment
PaymentType
Return
ReturnedItem

Products

Overview
Attribute
AttributeValue
ComboProductSet
- Returns the list of ComboProductSet objectsget
- Find ComboProductSet by IDget
ComboProductSetProduct
- Returns the list of ComboProductSetProduct objectsget
- Find ComboProductSetProduct by IDget
CustomMenu
- Returns the list of CustomMenu objectsget
- Find CustomMenu by IDget
DynamicCombo
- Returns the list of DynamicCombo objectsget
- Find DynamicCombo by IDget
DynamicComboUpsellSlot
- Return the list of DynamicComboUpsellSlot objects.get
- Find DynamicComboUpsellSlot by IDget
Ingredient
IngredientRecipe
Modifier
ModifierClass
ModifierDiscount
ModifierRecipe
PriceTier
- Returns the list of PriceTier objectsget
- Find PriceTier by IDget
Product
ProductCategory
ProductClass
ProductGroup
ProductGroupAction
ProductModifier
ProductModifierClass
ProductPriceLifeCycleAction
ProductPriceTierPrice
- Returns the list of ProductPriceTierPrice objectsget
- Find ProductPriceTierPrice by IDget
ProductRecipe
ProductSerial
- Return the list of ProductSerial objects.get
- Find ProductSerial by IDget
ProductVariablePrice
ServiceFee
Surcharge
UnitType

Purchase Orders

Overview
IngredientPurchase
- Returns the list of IngredientPurchase objectsget
- Find IngredientPurchase by IDget
ProductPurchase
- Returns the list of ProductPurchase objectsget
- Returns a single ProductPurchase objectget
ProductPurchaseOrderItem
PurchaseLedger
PurchaseOrder
PurchaseOrderInvoice
PurchaseOrderItem
Vendor
VendorEstablishment
VendorOrderableItem
ViewPurchaseOrder
- Returns a read-only list PurchaseOrder objectsget
- View PurchaseOrder by IDget
ViewPurchaseOrderProduct
- Returns the list of ViewPurchaseOrderProduct objectsget
- Returns a single ViewPurchaseOrderProduct objectget

Scheduling

Overview
TimeSchedule
TimeScheduleRule
- Returns the list of TimeScheduleRule objectsget
- Find TimeScheduleRule by IDget
TimeSheetEntry

Tables

Overview
Table
TableSection
TableTag

Tax

Overview
Tax
TaxAgency
TaxCode
TaxProductGroup
- Returns the list of TaxProductGroup objectsget
- Find TaxProductGroup by IDget
TaxRate
TaxTable

Weborders

Overview
CalculateCart
- Calculates Cart Totalspost
ValidateCart
- Validates Cart and returns Cart objectpost
SubmitCart
- Submits Cart and returns orderpost
Modifiers
- Returns a list of WebordersModifierClass objectsget
Menu
- Returns an entire menuget
ProductCategories
- Returns the list of product categoriesget
Products
- Return a list of productsget
Attributes
- Returns a list of attributes and child products of the parent productget
ProductUpcharge
- Returns info about linked combos attached to productget
ProductSets
- Returns info about group combos attached to productget
SystemSettings
- Returns a list of SystemSettingsget

Cash Management

Overview
BankDrop
CashOffice
Payout
Till

Customers

Overview
Customer
CustomerAddress
CustomerEstablishment
CustomerGroup
CustomerGroupCustomers
CustomerHistory
- Return the list of CustomerHistory objects.get

Discounts

Overview
Discount
DiscountCode
DiscountLevel
- Returns the list of DiscountLevel objectsget
- Returns a single DiscountLevel objectget

Employees

Overview
DeclaredTips
Department
Employee
EmployeeRoleEstablishment
Permission
- Returns the list of Permission objectsget
- Returns a single Permission objectget
Role
- Returns the list of role objectsget
- Find Role by IDget

General

Overview
Address
BusinessActionLog
BusinessDay
Company
- Returns the list of Company objectsget
- Find Company by IDget
Currency
Device
- Returns the list of Device objectsget
- Find Device by IDget
Establishment
PosStation
- Returns the list of PosStation objectsget
- Find PosStation by IDget
RevenueCenter
SystemSetting
- Returns the list of SystemSetting objectsget
- Find SystemSetting by IDget
SystemSettingOption
- Returns the list of SystemSettingOption objectsget
- Find SystemSettingOption by IDget
Timetable
TimetableItem
User
- Returns the list of User objectsget
- Find User by IDget

House Accounts

Overview
HouseAccount
HouseAccountPayment
HouseAccountTransaction
- Returns the list of HouseAccountTransaction objectsget
- Find HouseAccountTransaction by IDget

Inventory

Overview
CurrentStock
- Returns the list of CurrentStock objectsget
IngredientInventory
Inventory
InventoryReceipt
InventoryUnit
InventoryXProduct
InventoryXIngredient
PhysicalInventory
- Returns the list of PhysicalInventory objectsget
- Find PhysicalInventory by IDget
PhysicalInventoryItem
- Returns the list of PhysicalInventoryItem objectsget
- Find PhysicalInventoryItem by IDget
PhysicalInventoryScannedItem
PhysicalInventorySection
Stocktake
- Returns the list of Stocktake objectsget
- Find Stocktake by IDget
StocktakeItem
- Returns the list of StocktakeItem objectsget
- Find StocktakeItem by IDget
StocktakeScannedItem
StocktakeSection
Transfer
- Returns a list of Transfer objectsget
- Returns a list of Transfer objectsget
TransferItem
- Returns the list of TransferItem objectsget
- Find TransferItem by IDget
TransferReceipt
- Returns the list of TransferReceipt objectsget
- Find TransferReceipt by IDget
TransferReceiptItem
- Returns the list of TransferReceiptItem objectsget
- Find TransferReceiptItem by IDget

Orders

AppliedServiceFee
AppliedTaxOrder
AppliedTaxOrderItem
CustomPaymentType
- Returns the list of CustomPaymentType objectsget
- Returns a single CustomPaymentType objectget
CustomOrderOption
- Returns the list of CustomOrderOption objectsget
ModifierItem
Order
OrderDataDiff
- Returns the list of OrderDataDiff objectsget
- Returns a single OrderDataDiff objectget
OrderExchange
OrderExchangeItem
OrderHistory
OrderItem
OrderItemCatering
- Returns the list of OrderItemCatering objectsget
- Returns a single OrderItemCatering objectget
OrderItemCommission
OrderItemDataDiff
- Returns the list of OrderItemDataDiff objectsget
- Find OrderItemDataDiff by IDget
OrderTaxBreakDown
- Returns the list of OrderTaxBreakDown objectsget
- Find OrderTaxBreakDown by IDget
Package
Payment
PaymentType
Return
ReturnedItem

Products

Overview
Attribute
AttributeValue
ComboProductSet
- Returns the list of ComboProductSet objectsget
- Find ComboProductSet by IDget
ComboProductSetProduct
- Returns the list of ComboProductSetProduct objectsget
- Find ComboProductSetProduct by IDget
CustomMenu
- Returns the list of CustomMenu objectsget
- Find CustomMenu by IDget
DynamicCombo
- Returns the list of DynamicCombo objectsget
- Find DynamicCombo by IDget
DynamicComboUpsellSlot
- Return the list of DynamicComboUpsellSlot objects.get
- Find DynamicComboUpsellSlot by IDget
Ingredient
IngredientRecipe
Modifier
ModifierClass
ModifierDiscount
ModifierRecipe
PriceTier
- Returns the list of PriceTier objectsget
- Find PriceTier by IDget
Product
ProductCategory
ProductClass
ProductGroup
ProductGroupAction
ProductModifier
ProductModifierClass
ProductPriceLifeCycleAction
ProductPriceTierPrice
- Returns the list of ProductPriceTierPrice objectsget
- Find ProductPriceTierPrice by IDget
ProductRecipe
ProductSerial
- Return the list of ProductSerial objects.get
- Find ProductSerial by IDget
ProductVariablePrice
ServiceFee
Surcharge
UnitType

Purchase Orders

Overview
IngredientPurchase
- Returns the list of IngredientPurchase objectsget
- Find IngredientPurchase by IDget
ProductPurchase
- Returns the list of ProductPurchase objectsget
- Returns a single ProductPurchase objectget
ProductPurchaseOrderItem
PurchaseLedger
PurchaseOrder
PurchaseOrderInvoice
PurchaseOrderItem
Vendor
VendorEstablishment
VendorOrderableItem
ViewPurchaseOrder
- Returns a read-only list PurchaseOrder objectsget
- View PurchaseOrder by IDget
ViewPurchaseOrderProduct
- Returns the list of ViewPurchaseOrderProduct objectsget
- Returns a single ViewPurchaseOrderProduct objectget

Scheduling

Overview
TimeSchedule
TimeScheduleRule
- Returns the list of TimeScheduleRule objectsget
- Find TimeScheduleRule by IDget
TimeSheetEntry

Tables

Overview
Table
TableSection
TableTag

Tax

Overview
Tax
TaxAgency
TaxCode
TaxProductGroup
- Returns the list of TaxProductGroup objectsget
- Find TaxProductGroup by IDget
TaxRate
TaxTable

Weborders

Overview
CalculateCart
- Calculates Cart Totalspost
ValidateCart
- Validates Cart and returns Cart objectpost
SubmitCart
- Submits Cart and returns orderpost
Modifiers
- Returns a list of WebordersModifierClass objectsget
Menu
- Returns an entire menuget
ProductCategories
- Returns the list of product categoriesget
Products
- Return a list of productsget
Attributes
- Returns a list of attributes and child products of the parent productget
ProductUpcharge
- Returns info about linked combos attached to productget
ProductSets
- Returns info about group combos attached to productget
SystemSettings
- Returns a list of SystemSettingsget

Returns the list of Table objects

get https://qa2.revelup.com/resources/Table/

URL Expired

The URL for this request expired after 30 days.

Query Params

fields

array of strings

Comma separated list of fields to display. Only the specified fields will be returned in the response body, along with fields related to those specified.

fields

order_by

string

limit

integer

Limit for results count

offset

integer

Offset for returned results

Responses

Response body

array of objects

object

active

boolean

Flag if this Table object active or not

capacity

int64

The number of people who can fit at the table

created_by

uri

URI of an User API object which is responsible for this table creation

created_date

date-time

Date and time when table is created

establishment

uri

URI of an Establishment API object which is responsible for this table

int64

ID of the table (unique)

name

string

Name of the table

resource_uri

uri

URI of this Table API object

rotation

float

Table angle of rotation value

section

uri

Table section when this table was created

table_tags

array of objects

Array of Table tags which assigned to this Table object

table_tags

object

active

boolean

Flag if this Table tag object active or not

deleted

boolean

Flag value specifying deletion status of the table tag, 'true' if deleted

establishment

uri

URI of an Establishment API object which is responsible for this table tag

int64

ID of the table tag (unique)

image_url

uri

No info

name

string

Table tag name

pos_active_image_url

uri

Image of tag when this tag is choosen

pos_inactive_image_url

uri

Image of tag when this tag is not choosen

resource_uri

uri

URI of this TableTag API object

sorting

int64

Value representing an item position in the list

table_type

uri

URI of a TableType API object which means the type of the table

updated_by

uri

URI of an User API object which is responsible for this table update

updated_date

uri

Date and time when this table is updated

x_value

float

X position of the table in the table layout

y_value

float

Y position of the table in the table layout

401

authorization required

404

not found

Updated over 1 year ago

Overview

Find Table by ID

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://qa2.revelup.com/resources/Table/ \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated over 1 year ago

Overview

Find Table by ID

Cash Management
Overview
BankDrop
Updates details of an BankDrop objectpatch
Replaces a BankDrop objectput
Find BankDrop by IDget
Add a new BankDroppost
Returns the list of BankDrop objectsget
CashOffice
Update an existing CashOfficepatch
Update an existing CashOfficeput
Find CashOffice by IDget
Add a new CashOfficepost
Returns the list of CashOffice objectsget
Payout
Update an existing Payoutpatch
Update an existing Payoutput
Find Payout by IDget
Add a new Payoutpost
Returns the list of Payout objectsget
Till
Updates details of an Till objectpatch
Replaces a Till objectput
Find Till by IDget
Add a new Tillpost
Returns the list of Till objectsget

Customers
Overview
Customer
Delete an existing Customerdelete
Overwrite an existing Customerput
Update Customer by IDpatch
Find Customer by IDget
Add a new Customerpost
Returns the list of Customer objectsget
CustomerAddress
Overwrite an existing CustomerAddressput
Update CustomerAddress by IDpatch
Find CustomerAddress by IDget
Add a new CustomerAddresspost
Returns the list of CustomerAddress objectsget
CustomerEstablishment
Overwrite an existing CustomerEstablishmentput
Update CustomerEstablishment by IDpatch
Find CustomerEstablishment by IDget
Add a new CustomerEstablishmentpost
Returns the list of CustomerEstablishment objectsget
CustomerGroup
Updates details of an CustomerGroup objectpatch
Updates a CustomerGroup objectput
Find CustomerGroup by IDget
Add a new CustomerGrouppost
Return the list of CustomerGroup objects.get
CustomerGroupCustomers
Updates details of an CustomerGroupCustomers objectpatch
Updates a CustomerGroupCustomers objectput
Find CustomerGroupCustomers by IDget
Add a new CustomerGroupCustomerspost
Return the list of CustomerGroupCustomers objects.get
CustomerHistory
Return the list of CustomerHistory objects.get

Discounts
Overview
Discount
Updates details of a Discount objectpatch
Updates a Discount objectput
Returns a single Discount objectget
Add a new Discountpost
Returns the list of Discount objectsget
DiscountCode
Updates details of a DiscountCode objectpatch
Updates a DiscountCode objectput
Returns a single DiscountCode objectget
Add a new DiscountCodepost
Returns the list of DiscountCode objectsget
DiscountLevel
Returns a single DiscountLevel objectget
Returns the list of DiscountLevel objectsget

Employees
Overview
DeclaredTips
Updates details of a DeclaredTips objectpatch
Updates a DeclaredTips objectput
Returns a single DeclaredTips objectget
Add a new DeclaredTipspost
Returns the list of DeclaredTips objectsget
Department
Find Department by IDget
Add a new Department for the Employeespost
Returns the list of department objectsget
Employee
Overwrite an existing Employeeput
Update Employee by IDpatch
Find Employee by IDget
Add a new Employeepost
Returns the list of employee objectsget
EmployeeRoleEstablishment
Overwrite an existing EmployeeRoleEstablishmentput
Update EmployeeRoleEstablishment by IDpatch
Find EmployeeRoleEstablishment by IDget
Add a new EmployeeRoleEstablishmentpost
Returns the list of employeeroleestablishment objectsget
Permission
Returns a single Permission objectget
Returns the list of Permission objectsget
Role
Find Role by IDget
Returns the list of role objectsget

General
Overview
Address
Updates details of an Address objectpatch
Replaces a Address objectput
Find Address by IDget
Add a new Addresspost
Returns the list of Address objectsget
BusinessActionLog
Replaces a BusinessActionLog objectput
Find BusinessActionLog by IDget
Returns the list of BusinessActionLog objectsget
BusinessDay
Updates details of an BusinessDay objectpatch
Replaces a BusinessDay objectput
Find BusinessDay by IDget
Add a new BusinessDaypost
Returns the list of BusinessDay objectsget
Company
Find Company by IDget
Returns the list of Company objectsget
Currency
Updates details of an Currency objectpatch
Replaces a Currency objectput
Find Currency by IDget
Add a new Currencypost
Returns the list of Currency objectsget
Device
Find Device by IDget
Returns the list of Device objectsget
Establishment
Updates details of an Establishment objectpatch
Replaces a Establishment objectput
Find Establishment by IDget
Returns the list of Establishment objectsget
PosStation
Find PosStation by IDget
Returns the list of PosStation objectsget
RevenueCenter
Update an existing RevenueCenterpatch
Update an existing RevenueCenterput
Find RevenueCenter by IDget
Add a new RevenueCenterpost
Returns the list of RevenueCenter objectsget
SystemSetting
Find SystemSetting by IDget
Returns the list of SystemSetting objectsget
SystemSettingOption
Find SystemSettingOption by IDget
Returns the list of SystemSettingOption objectsget
Timetable
Update an existing Timetableput
Find Timetable by IDget
Add a new Timetablepost
Returns the list of Timetable objectsget
TimetableItem
Update an existing TimetableItempatch
Update an existing TimetableItemput
Find TimetableItem by IDget
Add a new TimetableItempost
Returns the list of TimetableItem objectsget
User
Find User by IDget
Returns the list of User objectsget

House Accounts
Overview
HouseAccount
Update an existing HouseAccountpatch
Update an existing HouseAccountput
Find HouseAccount by IDget
Returns the list of HouseAccount objectsget
HouseAccountPayment
Update an existing HouseAccountPaymentpatch
Update an existing HouseAccountPaymentput
Find HouseAccountPayment by IDget
Returns the list of HouseAccountPayment objectsget
HouseAccountTransaction
Find HouseAccountTransaction by IDget
Returns the list of HouseAccountTransaction objectsget

Inventory
Overview
CurrentStock
Returns the list of CurrentStock objectsget
IngredientInventory
Updates details of an IngredientInventory objectpatch
Find IngredientInventory by IDget
Returns the list of IngredientInventory objectsget
Inventory
Updates details of an Inventory objectpatch
Find Inventory by IDget
Returns the list of Inventory objectsget
InventoryReceipt
Updates details of an InventoryReceipt objectpatch
Replaces a InventoryReceipt objectput
Find InventoryReceipt by IDget
Add a new InventoryReceiptpost
Returns the list of InventoryReceipt objectsget
InventoryUnit
Updates details of an InventoryUnit objectpatch
Find InventoryUnit by IDget
Add a new InventoryUnitpost
Returns the list of InventoryUnit objectsget
InventoryXProduct
Recieve into Products's Inventorypost
Returns a single Product's Inventory objectget
Returns the list of Product's Inventory objectsget
InventoryXIngredient
Recieve into Ingredient's Inventorypost
Returns a single Ingredient's Inventory objectget
Returns the list of Ingredient's Inventory objectsget
PhysicalInventory
Find PhysicalInventory by IDget
Returns the list of PhysicalInventory objectsget
PhysicalInventoryItem
Find PhysicalInventoryItem by IDget
Returns the list of PhysicalInventoryItem objectsget
PhysicalInventoryScannedItem
Find PhysicalInventoryScannedItem by IDget
Add a new PhysicalInventoryScannedItempost
Returns the list of PhysicalInventoryScannedItem objectsget
PhysicalInventorySection
Replaces a PhysicalInventorySection objectput
Find PhysicalInventorySection by IDget
Returns the list of PhysicalInventorySection objectsget
Stocktake
Find Stocktake by IDget
Returns the list of Stocktake objectsget
StocktakeItem
Find StocktakeItem by IDget
Returns the list of StocktakeItem objectsget
StocktakeScannedItem
Updates details of an StocktakeScannedItem objectpatch
Returns a single StocktakeScannedItem objectget
Add a new StocktakeScannedItempost
Returns the list of StocktakeScannedItem objectsget
StocktakeSection
Updates details of an StocktakeSection objectpatch
Replaces a StocktakeSection objectput
Returns a single StocktakeSection objectget
Returns the list of StocktakeSection objectsget
Transfer
Returns a list of Transfer objectsget
Returns a list of Transfer objectsget
TransferItem
Find TransferItem by IDget
Returns the list of TransferItem objectsget
TransferReceipt
Find TransferReceipt by IDget
Returns the list of TransferReceipt objectsget
TransferReceiptItem
Find TransferReceiptItem by IDget
Returns the list of TransferReceiptItem objectsget

Orders
AppliedServiceFee
Updates details of an AppliedServiceFee objectpatch
Updates a AppliedServiceFee objectput
Returns a single AppliedServiceFee objectget
Add a new AppliedServiceFeepost
Return the list of AppliedServiceFee objects.get
AppliedTaxOrder
Updates details of a AppliedTaxOrder objectpatch
Updates a AppliedTaxOrder objectput
Returns a single AppliedTaxOrder objectget
Add a new AppliedTaxOrderpost
Returns the list of AppliedTaxOrder objectsget
AppliedTaxOrderItem
Updates details of a AppliedTaxOrderItem objectpatch
Updates a AppliedTaxOrderItem objectput
Returns a single AppliedTaxOrderItem objectget
Add a new AppliedTaxOrderItempost
Returns the list of AppliedTaxOrderItem objectsget
CustomPaymentType
Returns a single CustomPaymentType objectget
Returns the list of CustomPaymentType objectsget
CustomOrderOption
Returns the list of CustomOrderOption objectsget
ModifierItem
Updates details of an ModifierItem objectpatch
Updates a ModifierItem objectput
Returns a single ModifierItem objectget
Add a new ModifierItempost
Return the list of ModifierItem objects.get
Order
Update an existing Orderput
Update Order by IDpatch
Find Order by IDget
Add a new Orderpost
Returns the list of Order objectsget
OrderDataDiff
Returns a single OrderDataDiff objectget
Returns the list of OrderDataDiff objectsget
OrderExchange
Update an existing OrderExchangeput
Update OrderExchange by IDpatch
Find OrderExchange by IDget
Add a new OrderExchangepost
Returns the list of OrderExchange objectsget
OrderExchangeItem
Updates details of a OrderExchangeItem objectpatch
Updates a OrderExchangeItem objectput
Returns a single OrderExchangeItem objectget
Adds new OrderExchangeItem objectpost
Returns the list of OrderExchangeItem objectsget
OrderHistory
Update an existing OrderHistoryput
Update OrderHistory by IDpatch
Find OrderHistory by IDget
Add a new OrderHistorypost
Returns the list of OrderHistory objectsget
OrderItem
Updates details of an OrderItem objectpatch
Updates an OrderItem objectput
Returns a single OrderItem objectget
Adds new OrderItem objectpost
Returns the list of OrderItem objectsget
OrderItemCatering
Returns a single OrderItemCatering objectget
Returns the list of OrderItemCatering objectsget
OrderItemCommission
Updates details of a OrderItemCommission objectpatch
Updates a OrderItemCommission objectput
Returns a single OrderItemCommission objectget
Add a new OrderItemCommissionpost
Returns the list of OrderItemCommission objectsget
OrderItemDataDiff
Find OrderItemDataDiff by IDget
Returns the list of OrderItemDataDiff objectsget
OrderTaxBreakDown
Find OrderTaxBreakDown by IDget
Returns the list of OrderTaxBreakDown objectsget
Package
Update Package by IDpatch
Overwrite an existing Packageput
Find Package by IDget
Add a new Packagepost
Returns the list of Package objectsget
Payment
Updates details of a Payment objectpatch
Updates a Payment objectput
Returns a single Payment objectget
Adds new Payment objectpost
Returns the list of Payment objectsget
PaymentType
Updates details of an PaymentType objectpatch
Updates a PaymentType objectput
Find PaymentType by IDget
Add a new PaymentTypepost
Return the list of PaymentType objects.get
Return
Overwrite an existing Returnput
Update Return by IDpatch
Find Return by IDget
Add a new Returnpost
Returns the list of Return objectsget
ReturnedItem
Overwrite an existing ReturnedItemput
Update ReturnedItem by IDpatch
Find ReturnedItem by IDget
Add a new ReturnedItempost
Returns the list of ReturnedItem objectsget

Products
Overview
Attribute
Updates details of an Attribute objectpatch
Updates a Attribute objectput
Find Attribute by IDget
Add a new Attributepost
Return the list of Attribute objects.get
AttributeValue
Updates details of an AttributeValue objectpatch
Updates a AttributeValue objectput
Find AttributeValue by IDget
Add a new AttributeValuepost
Return the list of AttributeValue objects.get
ComboProductSet
Find ComboProductSet by IDget
Returns the list of ComboProductSet objectsget
ComboProductSetProduct
Find ComboProductSetProduct by IDget
Returns the list of ComboProductSetProduct objectsget
CustomMenu
Find CustomMenu by IDget
Returns the list of CustomMenu objectsget
DynamicCombo
Find DynamicCombo by IDget
Returns the list of DynamicCombo objectsget
DynamicComboUpsellSlot
Find DynamicComboUpsellSlot by IDget
Return the list of DynamicComboUpsellSlot objects.get
Ingredient
Overwrite an existing Ingredientput
Update Ingredient by IDpatch
Find Ingredient by IDget
Add a new Ingredientpost
Returns the list of Ingredient objectsget
IngredientRecipe
Overwrite an existing IngredientRecipeput
Update IngredientRecipe by IDpatch
Find IngredientRecipe by IDget
Add a new IngredientRecipepost
Returns the list of IngredientRecipe objectsget
Modifier
Overwrite an existing Modifierput
Update Modifier by IDpatch
Find Modifier by IDget
Add a new Modifierpost
Returns the list of Modifier objectsget
ModifierClass
Updates details of an ModifierClass objectpatch
Updates a ModifierClass objectput
Returns a single ModifierClass objects.get
Add a new ModifierClasspost
Return the list of ModifierClass objects.get
ModifierDiscount
Updates details of an ModifierDiscount objectpatch
Updates a ModifierDiscount objectput
Returns a single ModifierDiscount objectget
Add a new ModifierDiscountpost
Return the list of ModifierDiscount objects.get
ModifierRecipe
Overwrite an existing ModifierRecipeput
Update ModifierRecipe by IDpatch
Find ModifierRecipe by IDget
Add a new ModifierRecipepost
Returns the list of ModifierRecipe objectsget
PriceTier
Find PriceTier by IDget
Returns the list of PriceTier objectsget
Product
Updates details of a Product objectpatch
Updates a Product objectput
Returns a single Product objectget
Adds new Product objectpost
Returns the list of Product objectsget
ProductCategory
Update an existing ProductCategoryput
Update ProductCategory by IDpatch
Find ProductCategory by IDget
Add a new ProductCategorypost
Returns the list of ProductCategory objectsget
ProductClass
Updates details of a ProductClass objectpatch
Updates a ProductClass objectput
Returns a single ProductClass objectget
Adds new ProductClass objectpost
Returns the list of ProductClass objectsget
ProductGroup
Updates details of a ProductGroup objectpatch
Updates a ProductGroup objectput
Returns a single ProductGroup objectget
Adds new ProductGroup objectpost
Returns the list of ProductGroup objectsget
ProductGroupAction
Returns a single ProductGroupAction objectget
Adds new ProductGroupAction objectpost
Returns the list of ProductGroupAction objectsget
ProductModifier
Updates details of an ProductModifier objectpatch
Updates a ProductModifier objectput
Returns a single ProductModifier objectget
Add a new ProductModifierpost
Return the list of ProductModifier objects.get
ProductModifierClass
Updates details of an ProductModifierClass objectpatch
Updates a ProductModifierClass objectput
Returns a single ProductModifierClass objectget
Add a new ProductModifierClasspost
Return the list of ProductModifierClass objects.get
ProductPriceLifeCycleAction
Overwrite an existing ProductPriceLifeCycleActionput
Update ProductPriceLifeCycleAction by IDpatch
Find ProductPriceLifeCycleAction by IDget
Add a new ProductPriceLifeCycleActionpost
Returns the list of ProductPriceLifeCycleAction objectsget
ProductPriceTierPrice
Find ProductPriceTierPrice by IDget
Returns the list of ProductPriceTierPrice objectsget
ProductRecipe
Overwrite an existing ProductRecipeput
Update ProductRecipe by IDpatch
Find ProductRecipe by IDget
Add a new ProductRecipepost
Returns the list of ProductRecipe objectsget
ProductSerial
Find ProductSerial by IDget
Return the list of ProductSerial objects.get
ProductVariablePrice
Updates details of an ProductVariablePrice objectpatch
Updates a ProductVariablePrice objectput
Returns a single ProductVariablePrice objects.get
Add a new ProductVariablePricepost
Return the list of ProductVariablePrice objects.get
ServiceFee
Updates details of an ServiceFee objectpatch
Updates a ServiceFee objectput
Returns a single ServiceFee objectget
Add a new ServiceFeepost
Return the list of ServiceFee objects.get
Surcharge
Overwrite an existing Surchargeput
Update Surcharge by IDpatch
Find Surcharge by IDget
Add a new Surchargepost
Returns the list of Surcharge objectsget
UnitType
Overwrite an existing UnitTypeput
Update UnitType by IDpatch
Find UnitType by IDget
Add a new UnitTypepost
Returns the list of UnitType objectsget

Purchase Orders
Overview
IngredientPurchase
Find IngredientPurchase by IDget
Returns the list of IngredientPurchase objectsget
ProductPurchase
Returns a single ProductPurchase objectget
Returns the list of ProductPurchase objectsget
ProductPurchaseOrderItem
Updates details of a ProductPurchaseOrderItem objectpatch
Updates a ProductPurchaseOrderItem objectput
Returns a single ProductPurchaseOrderItem objectget
Returns the list of ProductPurchaseOrderItem objectsget
PurchaseLedger
Partial update of a ProductLedger's detailspatch
Updates a PurchaseLedger objectput
Returns a single PurchaseLedger objectget
Create a PurchaseLedger objectpost
Returns the list of PurchaseLedger objectsget
PurchaseOrder
Updates details of an PurchaseOrder objectpatch
Replaces a PurchaseOrder objectput
Find PurchaseOrder by IDget
Add a new PurchaseOrderpost
Returns the list of PurchaseOrder objectsget
PurchaseOrderInvoice
Updates details of an PurchaseOrderInvoice objectpatch
Replaces a PurchaseOrderInvoice objectput
Find PurchaseOrderInvoice by IDget
Add a new PurchaseOrderInvoicepost
Returns the list of PurchaseOrderInvoice objectsget
PurchaseOrderItem
Updates details of an PurchaseOrderItem objectpatch
Replaces a PurchaseOrderItem objectput
Find PurchaseOrderItem by IDget
Add a new PurchaseOrderItempost
Returns the list of PurchaseOrderItem objectsget
Vendor
Update an existing Vendorpatch
Update an existing Vendorput
Find Vendor by IDget
Add a new Vendorpost
Returns the list of Vendor objectsget
VendorEstablishment
Updates details of an VendorEstablishment objectpatch
Replaces a VendorEstablishment objectput
Find VendorEstablishment by IDget
Add a new VendorEstablishmentpost
Returns the list of VendorEstablishment objectsget
VendorOrderableItem
Updates details of an VendorOrderableItem objectpatch
Find VendorOrderableItem by IDget
Add a new VendorOrderableItempost
Returns the list of VendorOrderableItem objectsget
ViewPurchaseOrder
View PurchaseOrder by IDget
Returns a read-only list PurchaseOrder objectsget
ViewPurchaseOrderProduct
Returns a single ViewPurchaseOrderProduct objectget
Returns the list of ViewPurchaseOrderProduct objectsget

Scheduling
Overview
TimeSchedule
Delete an existing TimeScheduledelete
Update an existing TimeSchedulepatch
Update an existing TimeScheduleput
Find TimeSchedule by IDget
Add a new TimeSchedulepost
Returns the list of TimeSchedule objectsget
TimeScheduleRule
Find TimeScheduleRule by IDget
Returns the list of TimeScheduleRule objectsget
TimeSheetEntry
Update an existing TimeSheetEntrypatch
Update an existing TimeSheetEntryput
Find TimeSheetEntry by IDget
Add a new TimeSheetEntrypost
Returns the list of TimeSheetEntry objectsget

Tables
Overview
Table
Replaces a Table objectput
Find Table by IDget
Returns the list of Table objectsget
TableSection
Updates details of an TableSection objectpatch
Updates a TableSection objectput
Find TableSection by IDget
Add a new TableSectionpost
Return the list of TableSection objects.get
TableTag
Updates details of an TableTag objectpatch
Updates a TableTag objectput
Find TableTag by IDget
Add a new TableTagpost
Return the list of TableTag objects.get

Tax
Overview
Tax
Updates details of an Tax objectpatch
Replaces a Tax objectput
Find Tax by IDget
Add a new Taxpost
Returns the list of Tax objectsget
TaxAgency
Updates details of an TaxAgency objectpatch
Replaces a TaxAgency objectput
Find TaxAgency by IDget
Add a new TaxAgencypost
Returns the list of TaxAgency objectsget
TaxCode
Update an existing TaxCodepatch
Update an existing TaxCodeput
Find TaxCode by IDget
Add a new TaxCodepost
Returns the list of TaxCode objectsget
TaxProductGroup
Find TaxProductGroup by IDget
Returns the list of TaxProductGroup objectsget
TaxRate
Updates details of an TaxRate objectpatch
Replaces a TaxRate objectput
Find TaxRate by IDget
Add a new TaxRatepost
Returns the list of TaxRate objectsget
TaxTable
Find TaxTable by IDget
Add a new TaxTablepost
Returns the list of TaxTable objectsget

Weborders
Overview
CalculateCart
Calculates Cart Totalspost
ValidateCart
Validates Cart and returns Cart objectpost
SubmitCart
Submits Cart and returns orderpost
Modifiers
Returns a list of WebordersModifierClass objectsget
Menu
Returns an entire menuget
ProductCategories
Returns the list of product categoriesget
Products
Return a list of productsget
Attributes
Returns a list of attributes and child products of the parent productget
ProductUpcharge
Returns info about linked combos attached to productget
ProductSets
Returns info about group combos attached to productget
SystemSettings
Returns a list of SystemSettingsget

Cash Management
Overview
BankDrop
Updates details of an BankDrop objectpatch
Replaces a BankDrop objectput
Find BankDrop by IDget
Add a new BankDroppost
Returns the list of BankDrop objectsget
CashOffice
Update an existing CashOfficepatch
Update an existing CashOfficeput
Find CashOffice by IDget
Add a new CashOfficepost
Returns the list of CashOffice objectsget
Payout
Update an existing Payoutpatch
Update an existing Payoutput
Find Payout by IDget
Add a new Payoutpost
Returns the list of Payout objectsget
Till
Updates details of an Till objectpatch
Replaces a Till objectput
Find Till by IDget
Add a new Tillpost
Returns the list of Till objectsget

Customers
Overview
Customer
Delete an existing Customerdelete
Overwrite an existing Customerput
Update Customer by IDpatch
Find Customer by IDget
Add a new Customerpost
Returns the list of Customer objectsget
CustomerAddress
Overwrite an existing CustomerAddressput
Update CustomerAddress by IDpatch
Find CustomerAddress by IDget
Add a new CustomerAddresspost
Returns the list of CustomerAddress objectsget
CustomerEstablishment
Overwrite an existing CustomerEstablishmentput
Update CustomerEstablishment by IDpatch
Find CustomerEstablishment by IDget
Add a new CustomerEstablishmentpost
Returns the list of CustomerEstablishment objectsget
CustomerGroup
Updates details of an CustomerGroup objectpatch
Updates a CustomerGroup objectput
Find CustomerGroup by IDget
Add a new CustomerGrouppost
Return the list of CustomerGroup objects.get
CustomerGroupCustomers
Updates details of an CustomerGroupCustomers objectpatch
Updates a CustomerGroupCustomers objectput
Find CustomerGroupCustomers by IDget
Add a new CustomerGroupCustomerspost
Return the list of CustomerGroupCustomers objects.get
CustomerHistory
Return the list of CustomerHistory objects.get

Discounts
Overview
Discount
Updates details of a Discount objectpatch
Updates a Discount objectput
Returns a single Discount objectget
Add a new Discountpost
Returns the list of Discount objectsget
DiscountCode
Updates details of a DiscountCode objectpatch
Updates a DiscountCode objectput
Returns a single DiscountCode objectget
Add a new DiscountCodepost
Returns the list of DiscountCode objectsget
DiscountLevel
Returns a single DiscountLevel objectget
Returns the list of DiscountLevel objectsget

Employees
Overview
DeclaredTips
Updates details of a DeclaredTips objectpatch
Updates a DeclaredTips objectput
Returns a single DeclaredTips objectget
Add a new DeclaredTipspost
Returns the list of DeclaredTips objectsget
Department
Find Department by IDget
Add a new Department for the Employeespost
Returns the list of department objectsget
Employee
Overwrite an existing Employeeput
Update Employee by IDpatch
Find Employee by IDget
Add a new Employeepost
Returns the list of employee objectsget
EmployeeRoleEstablishment
Overwrite an existing EmployeeRoleEstablishmentput
Update EmployeeRoleEstablishment by IDpatch
Find EmployeeRoleEstablishment by IDget
Add a new EmployeeRoleEstablishmentpost
Returns the list of employeeroleestablishment objectsget
Permission
Returns a single Permission objectget
Returns the list of Permission objectsget
Role
Find Role by IDget
Returns the list of role objectsget

General
Overview
Address
Updates details of an Address objectpatch
Replaces a Address objectput
Find Address by IDget
Add a new Addresspost
Returns the list of Address objectsget
BusinessActionLog
Replaces a BusinessActionLog objectput
Find BusinessActionLog by IDget
Returns the list of BusinessActionLog objectsget
BusinessDay
Updates details of an BusinessDay objectpatch
Replaces a BusinessDay objectput
Find BusinessDay by IDget
Add a new BusinessDaypost
Returns the list of BusinessDay objectsget
Company
Find Company by IDget
Returns the list of Company objectsget
Currency
Updates details of an Currency objectpatch
Replaces a Currency objectput
Find Currency by IDget
Add a new Currencypost
Returns the list of Currency objectsget
Device
Find Device by IDget
Returns the list of Device objectsget
Establishment
Updates details of an Establishment objectpatch
Replaces a Establishment objectput
Find Establishment by IDget
Returns the list of Establishment objectsget
PosStation
Find PosStation by IDget
Returns the list of PosStation objectsget
RevenueCenter
Update an existing RevenueCenterpatch
Update an existing RevenueCenterput
Find RevenueCenter by IDget
Add a new RevenueCenterpost
Returns the list of RevenueCenter objectsget
SystemSetting
Find SystemSetting by IDget
Returns the list of SystemSetting objectsget
SystemSettingOption
Find SystemSettingOption by IDget
Returns the list of SystemSettingOption objectsget
Timetable
Update an existing Timetableput
Find Timetable by IDget
Add a new Timetablepost
Returns the list of Timetable objectsget
TimetableItem
Update an existing TimetableItempatch
Update an existing TimetableItemput
Find TimetableItem by IDget
Add a new TimetableItempost
Returns the list of TimetableItem objectsget
User
Find User by IDget
Returns the list of User objectsget

House Accounts
Overview
HouseAccount
Update an existing HouseAccountpatch
Update an existing HouseAccountput
Find HouseAccount by IDget
Returns the list of HouseAccount objectsget
HouseAccountPayment
Update an existing HouseAccountPaymentpatch
Update an existing HouseAccountPaymentput
Find HouseAccountPayment by IDget
Returns the list of HouseAccountPayment objectsget
HouseAccountTransaction
Find HouseAccountTransaction by IDget
Returns the list of HouseAccountTransaction objectsget

Inventory
Overview
CurrentStock
Returns the list of CurrentStock objectsget
IngredientInventory
Updates details of an IngredientInventory objectpatch
Find IngredientInventory by IDget
Returns the list of IngredientInventory objectsget
Inventory
Updates details of an Inventory objectpatch
Find Inventory by IDget
Returns the list of Inventory objectsget
InventoryReceipt
Updates details of an InventoryReceipt objectpatch
Replaces a InventoryReceipt objectput
Find InventoryReceipt by IDget
Add a new InventoryReceiptpost
Returns the list of InventoryReceipt objectsget
InventoryUnit
Updates details of an InventoryUnit objectpatch
Find InventoryUnit by IDget
Add a new InventoryUnitpost
Returns the list of InventoryUnit objectsget
InventoryXProduct
Recieve into Products's Inventorypost
Returns a single Product's Inventory objectget
Returns the list of Product's Inventory objectsget
InventoryXIngredient
Recieve into Ingredient's Inventorypost
Returns a single Ingredient's Inventory objectget
Returns the list of Ingredient's Inventory objectsget
PhysicalInventory
Find PhysicalInventory by IDget
Returns the list of PhysicalInventory objectsget
PhysicalInventoryItem
Find PhysicalInventoryItem by IDget
Returns the list of PhysicalInventoryItem objectsget
PhysicalInventoryScannedItem
Find PhysicalInventoryScannedItem by IDget
Add a new PhysicalInventoryScannedItempost
Returns the list of PhysicalInventoryScannedItem objectsget
PhysicalInventorySection
Replaces a PhysicalInventorySection objectput
Find PhysicalInventorySection by IDget
Returns the list of PhysicalInventorySection objectsget
Stocktake
Find Stocktake by IDget
Returns the list of Stocktake objectsget
StocktakeItem
Find StocktakeItem by IDget
Returns the list of StocktakeItem objectsget
StocktakeScannedItem
Updates details of an StocktakeScannedItem objectpatch
Returns a single StocktakeScannedItem objectget
Add a new StocktakeScannedItempost
Returns the list of StocktakeScannedItem objectsget
StocktakeSection
Updates details of an StocktakeSection objectpatch
Replaces a StocktakeSection objectput
Returns a single StocktakeSection objectget
Returns the list of StocktakeSection objectsget
Transfer
Returns a list of Transfer objectsget
Returns a list of Transfer objectsget
TransferItem
Find TransferItem by IDget
Returns the list of TransferItem objectsget
TransferReceipt
Find TransferReceipt by IDget
Returns the list of TransferReceipt objectsget
TransferReceiptItem
Find TransferReceiptItem by IDget
Returns the list of TransferReceiptItem objectsget

Orders
AppliedServiceFee
Updates details of an AppliedServiceFee objectpatch
Updates a AppliedServiceFee objectput
Returns a single AppliedServiceFee objectget
Add a new AppliedServiceFeepost
Return the list of AppliedServiceFee objects.get
AppliedTaxOrder
Updates details of a AppliedTaxOrder objectpatch
Updates a AppliedTaxOrder objectput
Returns a single AppliedTaxOrder objectget
Add a new AppliedTaxOrderpost
Returns the list of AppliedTaxOrder objectsget
AppliedTaxOrderItem
Updates details of a AppliedTaxOrderItem objectpatch
Updates a AppliedTaxOrderItem objectput
Returns a single AppliedTaxOrderItem objectget
Add a new AppliedTaxOrderItempost
Returns the list of AppliedTaxOrderItem objectsget
CustomPaymentType
Returns a single CustomPaymentType objectget
Returns the list of CustomPaymentType objectsget
CustomOrderOption
Returns the list of CustomOrderOption objectsget
ModifierItem
Updates details of an ModifierItem objectpatch
Updates a ModifierItem objectput
Returns a single ModifierItem objectget
Add a new ModifierItempost
Return the list of ModifierItem objects.get
Order
Update an existing Orderput
Update Order by IDpatch
Find Order by IDget
Add a new Orderpost
Returns the list of Order objectsget
OrderDataDiff
Returns a single OrderDataDiff objectget
Returns the list of OrderDataDiff objectsget
OrderExchange
Update an existing OrderExchangeput
Update OrderExchange by IDpatch
Find OrderExchange by IDget
Add a new OrderExchangepost
Returns the list of OrderExchange objectsget
OrderExchangeItem
Updates details of a OrderExchangeItem objectpatch
Updates a OrderExchangeItem objectput
Returns a single OrderExchangeItem objectget
Adds new OrderExchangeItem objectpost
Returns the list of OrderExchangeItem objectsget
OrderHistory
Update an existing OrderHistoryput
Update OrderHistory by IDpatch
Find OrderHistory by IDget
Add a new OrderHistorypost
Returns the list of OrderHistory objectsget
OrderItem
Updates details of an OrderItem objectpatch
Updates an OrderItem objectput
Returns a single OrderItem objectget
Adds new OrderItem objectpost
Returns the list of OrderItem objectsget
OrderItemCatering
Returns a single OrderItemCatering objectget
Returns the list of OrderItemCatering objectsget
OrderItemCommission
Updates details of a OrderItemCommission objectpatch
Updates a OrderItemCommission objectput
Returns a single OrderItemCommission objectget
Add a new OrderItemCommissionpost
Returns the list of OrderItemCommission objectsget
OrderItemDataDiff
Find OrderItemDataDiff by IDget
Returns the list of OrderItemDataDiff objectsget
OrderTaxBreakDown
Find OrderTaxBreakDown by IDget
Returns the list of OrderTaxBreakDown objectsget
Package
Update Package by IDpatch
Overwrite an existing Packageput
Find Package by IDget
Add a new Packagepost
Returns the list of Package objectsget
Payment
Updates details of a Payment objectpatch
Updates a Payment objectput
Returns a single Payment objectget
Adds new Payment objectpost
Returns the list of Payment objectsget
PaymentType
Updates details of an PaymentType objectpatch
Updates a PaymentType objectput
Find PaymentType by IDget
Add a new PaymentTypepost
Return the list of PaymentType objects.get
Return
Overwrite an existing Returnput
Update Return by IDpatch
Find Return by IDget
Add a new Returnpost
Returns the list of Return objectsget
ReturnedItem
Overwrite an existing ReturnedItemput
Update ReturnedItem by IDpatch
Find ReturnedItem by IDget
Add a new ReturnedItempost
Returns the list of ReturnedItem objectsget

Products
Overview
Attribute
Updates details of an Attribute objectpatch
Updates a Attribute objectput
Find Attribute by IDget
Add a new Attributepost
Return the list of Attribute objects.get
AttributeValue
Updates details of an AttributeValue objectpatch
Updates a AttributeValue objectput
Find AttributeValue by IDget
Add a new AttributeValuepost
Return the list of AttributeValue objects.get
ComboProductSet
Find ComboProductSet by IDget
Returns the list of ComboProductSet objectsget
ComboProductSetProduct
Find ComboProductSetProduct by IDget
Returns the list of ComboProductSetProduct objectsget
CustomMenu
Find CustomMenu by IDget
Returns the list of CustomMenu objectsget
DynamicCombo
Find DynamicCombo by IDget
Returns the list of DynamicCombo objectsget
DynamicComboUpsellSlot
Find DynamicComboUpsellSlot by IDget
Return the list of DynamicComboUpsellSlot objects.get
Ingredient
Overwrite an existing Ingredientput
Update Ingredient by IDpatch
Find Ingredient by IDget
Add a new Ingredientpost
Returns the list of Ingredient objectsget
IngredientRecipe
Overwrite an existing IngredientRecipeput
Update IngredientRecipe by IDpatch
Find IngredientRecipe by IDget
Add a new IngredientRecipepost
Returns the list of IngredientRecipe objectsget
Modifier
Overwrite an existing Modifierput
Update Modifier by IDpatch
Find Modifier by IDget
Add a new Modifierpost
Returns the list of Modifier objectsget
ModifierClass
Updates details of an ModifierClass objectpatch
Updates a ModifierClass objectput
Returns a single ModifierClass objects.get
Add a new ModifierClasspost
Return the list of ModifierClass objects.get
ModifierDiscount
Updates details of an ModifierDiscount objectpatch
Updates a ModifierDiscount objectput
Returns a single ModifierDiscount objectget
Add a new ModifierDiscountpost
Return the list of ModifierDiscount objects.get
ModifierRecipe
Overwrite an existing ModifierRecipeput
Update ModifierRecipe by IDpatch
Find ModifierRecipe by IDget
Add a new ModifierRecipepost
Returns the list of ModifierRecipe objectsget
PriceTier
Find PriceTier by IDget
Returns the list of PriceTier objectsget
Product
Updates details of a Product objectpatch
Updates a Product objectput
Returns a single Product objectget
Adds new Product objectpost
Returns the list of Product objectsget
ProductCategory
Update an existing ProductCategoryput
Update ProductCategory by IDpatch
Find ProductCategory by IDget
Add a new ProductCategorypost
Returns the list of ProductCategory objectsget
ProductClass
Updates details of a ProductClass objectpatch
Updates a ProductClass objectput
Returns a single ProductClass objectget
Adds new ProductClass objectpost
Returns the list of ProductClass objectsget
ProductGroup
Updates details of a ProductGroup objectpatch
Updates a ProductGroup objectput
Returns a single ProductGroup objectget
Adds new ProductGroup objectpost
Returns the list of ProductGroup objectsget
ProductGroupAction
Returns a single ProductGroupAction objectget
Adds new ProductGroupAction objectpost
Returns the list of ProductGroupAction objectsget
ProductModifier
Updates details of an ProductModifier objectpatch
Updates a ProductModifier objectput
Returns a single ProductModifier objectget
Add a new ProductModifierpost
Return the list of ProductModifier objects.get
ProductModifierClass
Updates details of an ProductModifierClass objectpatch
Updates a ProductModifierClass objectput
Returns a single ProductModifierClass objectget
Add a new ProductModifierClasspost
Return the list of ProductModifierClass objects.get
ProductPriceLifeCycleAction
Overwrite an existing ProductPriceLifeCycleActionput
Update ProductPriceLifeCycleAction by IDpatch
Find ProductPriceLifeCycleAction by IDget
Add a new ProductPriceLifeCycleActionpost
Returns the list of ProductPriceLifeCycleAction objectsget
ProductPriceTierPrice
Find ProductPriceTierPrice by IDget
Returns the list of ProductPriceTierPrice objectsget
ProductRecipe
Overwrite an existing ProductRecipeput
Update ProductRecipe by IDpatch
Find ProductRecipe by IDget
Add a new ProductRecipepost
Returns the list of ProductRecipe objectsget
ProductSerial
Find ProductSerial by IDget
Return the list of ProductSerial objects.get
ProductVariablePrice
Updates details of an ProductVariablePrice objectpatch
Updates a ProductVariablePrice objectput
Returns a single ProductVariablePrice objects.get
Add a new ProductVariablePricepost
Return the list of ProductVariablePrice objects.get
ServiceFee
Updates details of an ServiceFee objectpatch
Updates a ServiceFee objectput
Returns a single ServiceFee objectget
Add a new ServiceFeepost
Return the list of ServiceFee objects.get
Surcharge
Overwrite an existing Surchargeput
Update Surcharge by IDpatch
Find Surcharge by IDget
Add a new Surchargepost
Returns the list of Surcharge objectsget
UnitType
Overwrite an existing UnitTypeput
Update UnitType by IDpatch
Find UnitType by IDget
Add a new UnitTypepost
Returns the list of UnitType objectsget

Purchase Orders
Overview
IngredientPurchase
Find IngredientPurchase by IDget
Returns the list of IngredientPurchase objectsget
ProductPurchase
Returns a single ProductPurchase objectget
Returns the list of ProductPurchase objectsget
ProductPurchaseOrderItem
Updates details of a ProductPurchaseOrderItem objectpatch
Updates a ProductPurchaseOrderItem objectput
Returns a single ProductPurchaseOrderItem objectget
Returns the list of ProductPurchaseOrderItem objectsget
PurchaseLedger
Partial update of a ProductLedger's detailspatch
Updates a PurchaseLedger objectput
Returns a single PurchaseLedger objectget
Create a PurchaseLedger objectpost
Returns the list of PurchaseLedger objectsget
PurchaseOrder
Updates details of an PurchaseOrder objectpatch
Replaces a PurchaseOrder objectput
Find PurchaseOrder by IDget
Add a new PurchaseOrderpost
Returns the list of PurchaseOrder objectsget
PurchaseOrderInvoice
Updates details of an PurchaseOrderInvoice objectpatch
Replaces a PurchaseOrderInvoice objectput
Find PurchaseOrderInvoice by IDget
Add a new PurchaseOrderInvoicepost
Returns the list of PurchaseOrderInvoice objectsget
PurchaseOrderItem
Updates details of an PurchaseOrderItem objectpatch
Replaces a PurchaseOrderItem objectput
Find PurchaseOrderItem by IDget
Add a new PurchaseOrderItempost
Returns the list of PurchaseOrderItem objectsget
Vendor
Update an existing Vendorpatch
Update an existing Vendorput
Find Vendor by IDget
Add a new Vendorpost
Returns the list of Vendor objectsget
VendorEstablishment
Updates details of an VendorEstablishment objectpatch
Replaces a VendorEstablishment objectput
Find VendorEstablishment by IDget
Add a new VendorEstablishmentpost
Returns the list of VendorEstablishment objectsget
VendorOrderableItem
Updates details of an VendorOrderableItem objectpatch
Find VendorOrderableItem by IDget
Add a new VendorOrderableItempost
Returns the list of VendorOrderableItem objectsget
ViewPurchaseOrder
View PurchaseOrder by IDget
Returns a read-only list PurchaseOrder objectsget
ViewPurchaseOrderProduct
Returns a single ViewPurchaseOrderProduct objectget
Returns the list of ViewPurchaseOrderProduct objectsget

Scheduling
Overview
TimeSchedule
Delete an existing TimeScheduledelete
Update an existing TimeSchedulepatch
Update an existing TimeScheduleput
Find TimeSchedule by IDget
Add a new TimeSchedulepost
Returns the list of TimeSchedule objectsget
TimeScheduleRule
Find TimeScheduleRule by IDget
Returns the list of TimeScheduleRule objectsget
TimeSheetEntry
Update an existing TimeSheetEntrypatch
Update an existing TimeSheetEntryput
Find TimeSheetEntry by IDget
Add a new TimeSheetEntrypost
Returns the list of TimeSheetEntry objectsget

Tables
Overview
Table
Replaces a Table objectput
Find Table by IDget
Returns the list of Table objectsget
TableSection
Updates details of an TableSection objectpatch
Updates a TableSection objectput
Find TableSection by IDget
Add a new TableSectionpost
Return the list of TableSection objects.get
TableTag
Updates details of an TableTag objectpatch
Updates a TableTag objectput
Find TableTag by IDget
Add a new TableTagpost
Return the list of TableTag objects.get

Tax
Overview
Tax
Updates details of an Tax objectpatch
Replaces a Tax objectput
Find Tax by IDget
Add a new Taxpost
Returns the list of Tax objectsget
TaxAgency
Updates details of an TaxAgency objectpatch
Replaces a TaxAgency objectput
Find TaxAgency by IDget
Add a new TaxAgencypost
Returns the list of TaxAgency objectsget
TaxCode
Update an existing TaxCodepatch
Update an existing TaxCodeput
Find TaxCode by IDget
Add a new TaxCodepost
Returns the list of TaxCode objectsget
TaxProductGroup
Find TaxProductGroup by IDget
Returns the list of TaxProductGroup objectsget
TaxRate
Updates details of an TaxRate objectpatch
Replaces a TaxRate objectput
Find TaxRate by IDget
Add a new TaxRatepost
Returns the list of TaxRate objectsget
TaxTable
Find TaxTable by IDget
Add a new TaxTablepost
Returns the list of TaxTable objectsget

Weborders
Overview
CalculateCart
Calculates Cart Totalspost
ValidateCart
Validates Cart and returns Cart objectpost
SubmitCart
Submits Cart and returns orderpost
Modifiers
Returns a list of WebordersModifierClass objectsget
Menu
Returns an entire menuget
ProductCategories
Returns the list of product categoriesget
Products
Return a list of productsget
Attributes
Returns a list of attributes and child products of the parent productget
ProductUpcharge
Returns info about linked combos attached to productget
ProductSets
Returns info about group combos attached to productget
SystemSettings
Returns a list of SystemSettingsget

200successful operation