Jump to Content
Guides
API Reference
Changelog
Home
Guides
API Reference
Changelog
RevelSystems
v2024.3.1
v2024.4.0
v2024.4.1
v2024.7.0
v2024.8.0
v2025.3.0
Guides
API Reference
Changelog
Log In
API Reference
Log In
v2025.3.0
API Reference
Overview
JUMP TO
Cash Management
Overview
BankDrop
Returns the list of BankDrop objects
get
Add a new BankDrop
post
Find BankDrop by ID
get
Replaces a BankDrop object
put
Updates details of an BankDrop object
patch
CashOffice
Returns the list of CashOffice objects
get
Add a new CashOffice
post
Find CashOffice by ID
get
Update an existing CashOffice
put
Update an existing CashOffice
patch
Payout
Returns the list of Payout objects
get
Add a new Payout
post
Find Payout by ID
get
Update an existing Payout
put
Update an existing Payout
patch
Till
Returns the list of Till objects
get
Add a new Till
post
Find Till by ID
get
Replaces a Till object
put
Updates details of an Till object
patch
Customers
Overview
Customer
Returns the list of Customer objects
get
Add a new Customer
post
Find Customer by ID
get
Update Customer by ID
patch
Overwrite an existing Customer
put
Delete an existing Customer
del
CustomerAddress
Returns the list of CustomerAddress objects
get
Add a new CustomerAddress
post
Find CustomerAddress by ID
get
Update CustomerAddress by ID
patch
Overwrite an existing CustomerAddress
put
CustomerEstablishment
Returns the list of CustomerEstablishment objects
get
Add a new CustomerEstablishment
post
Find CustomerEstablishment by ID
get
Update CustomerEstablishment by ID
patch
Overwrite an existing CustomerEstablishment
put
CustomerGroup
Return the list of CustomerGroup objects.
get
Add a new CustomerGroup
post
Find CustomerGroup by ID
get
Updates a CustomerGroup object
put
Updates details of an CustomerGroup object
patch
CustomerGroupCustomers
Return the list of CustomerGroupCustomers objects.
get
Add a new CustomerGroupCustomers
post
Find CustomerGroupCustomers by ID
get
Updates a CustomerGroupCustomers object
put
Updates details of an CustomerGroupCustomers object
patch
CustomerHistory
Return the list of CustomerHistory objects.
get
Discounts
Overview
Discount
Returns the list of Discount objects
get
Add a new Discount
post
Returns a single Discount object
get
Updates a Discount object
put
Updates details of a Discount object
patch
DiscountCode
Returns the list of DiscountCode objects
get
Add a new DiscountCode
post
Returns a single DiscountCode object
get
Updates a DiscountCode object
put
Updates details of a DiscountCode object
patch
DiscountLevel
Returns the list of DiscountLevel objects
get
Returns a single DiscountLevel object
get
Employees
Overview
DeclaredTips
Returns the list of DeclaredTips objects
get
Add a new DeclaredTips
post
Returns a single DeclaredTips object
get
Updates a DeclaredTips object
put
Updates details of a DeclaredTips object
patch
Department
Returns the list of department objects
get
Add a new Department for the Employees
post
Find Department by ID
get
Employee
Returns the list of employee objects
get
Add a new Employee
post
Find Employee by ID
get
Update Employee by ID
patch
Overwrite an existing Employee
put
EmployeeRoleEstablishment
Returns the list of employeeroleestablishment objects
get
Add a new EmployeeRoleEstablishment
post
Find EmployeeRoleEstablishment by ID
get
Update EmployeeRoleEstablishment by ID
patch
Overwrite an existing EmployeeRoleEstablishment
put
Permission
Returns the list of Permission objects
get
Returns a single Permission object
get
Role
Returns the list of role objects
get
Find Role by ID
get
General
Overview
Address
Returns the list of Address objects
get
Add a new Address
post
Find Address by ID
get
Replaces a Address object
put
Updates details of an Address object
patch
BusinessActionLog
Returns the list of BusinessActionLog objects
get
Find BusinessActionLog by ID
get
Replaces a BusinessActionLog object
put
BusinessDay
Returns the list of BusinessDay objects
get
Add a new BusinessDay
post
Find BusinessDay by ID
get
Replaces a BusinessDay object
put
Updates details of an BusinessDay object
patch
Company
Returns the list of Company objects
get
Find Company by ID
get
Currency
Returns the list of Currency objects
get
Add a new Currency
post
Find Currency by ID
get
Replaces a Currency object
put
Updates details of an Currency object
patch
Device
Returns the list of Device objects
get
Find Device by ID
get
Establishment
Returns the list of Establishment objects
get
Find Establishment by ID
get
Replaces a Establishment object
put
Updates details of an Establishment object
patch
PosStation
Returns the list of PosStation objects
get
Find PosStation by ID
get
RevenueCenter
Returns the list of RevenueCenter objects
get
Add a new RevenueCenter
post
Find RevenueCenter by ID
get
Update an existing RevenueCenter
put
Update an existing RevenueCenter
patch
SystemSetting
Returns the list of SystemSetting objects
get
Find SystemSetting by ID
get
SystemSettingOption
Returns the list of SystemSettingOption objects
get
Find SystemSettingOption by ID
get
Timetable
Returns the list of Timetable objects
get
Add a new Timetable
post
Find Timetable by ID
get
Update an existing Timetable
put
TimetableItem
Returns the list of TimetableItem objects
get
Add a new TimetableItem
post
Find TimetableItem by ID
get
Update an existing TimetableItem
put
Update an existing TimetableItem
patch
User
Returns the list of User objects
get
Find User by ID
get
House Accounts
Overview
HouseAccount
Returns the list of HouseAccount objects
get
Find HouseAccount by ID
get
Update an existing HouseAccount
put
Update an existing HouseAccount
patch
HouseAccountPayment
Returns the list of HouseAccountPayment objects
get
Find HouseAccountPayment by ID
get
Update an existing HouseAccountPayment
put
Update an existing HouseAccountPayment
patch
HouseAccountTransaction
Returns the list of HouseAccountTransaction objects
get
Find HouseAccountTransaction by ID
get
Inventory
Overview
CurrentStock
Returns the list of CurrentStock objects
get
IngredientInventory
Returns the list of IngredientInventory objects
get
Find IngredientInventory by ID
get
Updates details of an IngredientInventory object
patch
Inventory
Returns the list of Inventory objects
get
Find Inventory by ID
get
Updates details of an Inventory object
patch
InventoryReceipt
Returns the list of InventoryReceipt objects
get
Add a new InventoryReceipt
post
Find InventoryReceipt by ID
get
Replaces a InventoryReceipt object
put
Updates details of an InventoryReceipt object
patch
InventoryUnit
Returns the list of InventoryUnit objects
get
Add a new InventoryUnit
post
Find InventoryUnit by ID
get
Updates details of an InventoryUnit object
patch
InventoryXProduct
Returns the list of Product's Inventory objects
get
Returns a single Product's Inventory object
get
Recieve into Products's Inventory
post
InventoryXIngredient
Returns the list of Ingredient's Inventory objects
get
Returns a single Ingredient's Inventory object
get
Recieve into Ingredient's Inventory
post
PhysicalInventory
Returns the list of PhysicalInventory objects
get
Find PhysicalInventory by ID
get
PhysicalInventoryItem
Returns the list of PhysicalInventoryItem objects
get
Find PhysicalInventoryItem by ID
get
PhysicalInventoryScannedItem
Returns the list of PhysicalInventoryScannedItem objects
get
Add a new PhysicalInventoryScannedItem
post
Find PhysicalInventoryScannedItem by ID
get
PhysicalInventorySection
Returns the list of PhysicalInventorySection objects
get
Find PhysicalInventorySection by ID
get
Replaces a PhysicalInventorySection object
put
Stocktake
Returns the list of Stocktake objects
get
Find Stocktake by ID
get
StocktakeItem
Returns the list of StocktakeItem objects
get
Find StocktakeItem by ID
get
StocktakeScannedItem
Returns the list of StocktakeScannedItem objects
get
Add a new StocktakeScannedItem
post
Returns a single StocktakeScannedItem object
get
Updates details of an StocktakeScannedItem object
patch
StocktakeSection
Returns the list of StocktakeSection objects
get
Returns a single StocktakeSection object
get
Replaces a StocktakeSection object
put
Updates details of an StocktakeSection object
patch
Transfer
Returns a list of Transfer objects
get
Returns a list of Transfer objects
get
TransferItem
Returns the list of TransferItem objects
get
Find TransferItem by ID
get
TransferReceipt
Returns the list of TransferReceipt objects
get
Find TransferReceipt by ID
get
TransferReceiptItem
Returns the list of TransferReceiptItem objects
get
Find TransferReceiptItem by ID
get
Orders
Overview
AppliedServiceFee
Return the list of AppliedServiceFee objects.
get
Add a new AppliedServiceFee
post
Returns a single AppliedServiceFee object
get
Updates a AppliedServiceFee object
put
Updates details of an AppliedServiceFee object
patch
AppliedTaxOrder
Returns the list of AppliedTaxOrder objects
get
Add a new AppliedTaxOrder
post
Returns a single AppliedTaxOrder object
get
Updates a AppliedTaxOrder object
put
Updates details of a AppliedTaxOrder object
patch
AppliedTaxOrderItem
Returns the list of AppliedTaxOrderItem objects
get
Add a new AppliedTaxOrderItem
post
Returns a single AppliedTaxOrderItem object
get
Updates a AppliedTaxOrderItem object
put
Updates details of a AppliedTaxOrderItem object
patch
CustomPaymentType
Returns the list of CustomPaymentType objects
get
Returns a single CustomPaymentType object
get
CustomOrderOption
Returns the list of CustomOrderOption objects
get
ModifierItem
Return the list of ModifierItem objects.
get
Add a new ModifierItem
post
Returns a single ModifierItem object
get
Updates a ModifierItem object
put
Updates details of an ModifierItem object
patch
Order
Returns the list of Order objects
get
Add a new Order
post
Find Order by ID
get
Update Order by ID
patch
Update an existing Order
put
OrderDataDiff
Returns the list of OrderDataDiff objects
get
Returns a single OrderDataDiff object
get
OrderExchange
Returns the list of OrderExchange objects
get
Add a new OrderExchange
post
Find OrderExchange by ID
get
Update OrderExchange by ID
patch
Update an existing OrderExchange
put
OrderExchangeItem
Returns the list of OrderExchangeItem objects
get
Adds new OrderExchangeItem object
post
Returns a single OrderExchangeItem object
get
Updates a OrderExchangeItem object
put
Updates details of a OrderExchangeItem object
patch
OrderHistory
Returns the list of OrderHistory objects
get
Add a new OrderHistory
post
Find OrderHistory by ID
get
Update OrderHistory by ID
patch
Update an existing OrderHistory
put
OrderItem
Returns the list of OrderItem objects
get
Adds new OrderItem object
post
Returns a single OrderItem object
get
Updates an OrderItem object
put
Updates details of an OrderItem object
patch
OrderItemCatering
Returns the list of OrderItemCatering objects
get
Returns a single OrderItemCatering object
get
OrderItemCommission
Returns the list of OrderItemCommission objects
get
Add a new OrderItemCommission
post
Returns a single OrderItemCommission object
get
Updates a OrderItemCommission object
put
Updates details of a OrderItemCommission object
patch
OrderItemDataDiff
Returns the list of OrderItemDataDiff objects
get
Find OrderItemDataDiff by ID
get
OrderTaxBreakDown
Returns the list of OrderTaxBreakDown objects
get
Find OrderTaxBreakDown by ID
get
Package
Returns the list of Package objects
get
Add a new Package
post
Find Package by ID
get
Overwrite an existing Package
put
Update Package by ID
patch
Payment
Returns the list of Payment objects
get
Adds new Payment object
post
Returns a single Payment object
get
Updates a Payment object
put
Updates details of a Payment object
patch
PaymentType
Return the list of PaymentType objects.
get
Add a new PaymentType
post
Find PaymentType by ID
get
Updates a PaymentType object
put
Updates details of an PaymentType object
patch
Return
Returns the list of Return objects
get
Add a new Return
post
Find Return by ID
get
Update Return by ID
patch
Overwrite an existing Return
put
ReturnedItem
Returns the list of ReturnedItem objects
get
Add a new ReturnedItem
post
Find ReturnedItem by ID
get
Update ReturnedItem by ID
patch
Overwrite an existing ReturnedItem
put
Products
Overview
Attribute
Return the list of Attribute objects.
get
Add a new Attribute
post
Find Attribute by ID
get
Updates a Attribute object
put
Updates details of an Attribute object
patch
AttributeValue
Return the list of AttributeValue objects.
get
Add a new AttributeValue
post
Find AttributeValue by ID
get
Updates a AttributeValue object
put
Updates details of an AttributeValue object
patch
ComboProductSet
Returns the list of ComboProductSet objects
get
Find ComboProductSet by ID
get
ComboProductSetProduct
Returns the list of ComboProductSetProduct objects
get
Find ComboProductSetProduct by ID
get
CustomMenu
Returns the list of CustomMenu objects
get
Find CustomMenu by ID
get
DynamicCombo
Returns the list of DynamicCombo objects
get
Find DynamicCombo by ID
get
DynamicComboUpsellSlot
Return the list of DynamicComboUpsellSlot objects.
get
Find DynamicComboUpsellSlot by ID
get
Ingredient
Returns the list of Ingredient objects
get
Add a new Ingredient
post
Find Ingredient by ID
get
Update Ingredient by ID
patch
Overwrite an existing Ingredient
put
IngredientRecipe
Returns the list of IngredientRecipe objects
get
Add a new IngredientRecipe
post
Find IngredientRecipe by ID
get
Update IngredientRecipe by ID
patch
Overwrite an existing IngredientRecipe
put
Modifier
Returns the list of Modifier objects
get
Add a new Modifier
post
Find Modifier by ID
get
Update Modifier by ID
patch
Overwrite an existing Modifier
put
ModifierClass
Return the list of ModifierClass objects.
get
Add a new ModifierClass
post
Returns a single ModifierClass objects.
get
Updates a ModifierClass object
put
Updates details of an ModifierClass object
patch
ModifierDiscount
Return the list of ModifierDiscount objects.
get
Add a new ModifierDiscount
post
Returns a single ModifierDiscount object
get
Updates a ModifierDiscount object
put
Updates details of an ModifierDiscount object
patch
ModifierRecipe
Returns the list of ModifierRecipe objects
get
Add a new ModifierRecipe
post
Find ModifierRecipe by ID
get
Update ModifierRecipe by ID
patch
Overwrite an existing ModifierRecipe
put
PriceTier
Returns the list of PriceTier objects
get
Find PriceTier by ID
get
Product
Returns the list of Product objects
get
Adds new Product object
post
Returns a single Product object
get
Updates a Product object
put
Updates details of a Product object
patch
ProductCategory
Returns the list of ProductCategory objects
get
Add a new ProductCategory
post
Find ProductCategory by ID
get
Update ProductCategory by ID
patch
Update an existing ProductCategory
put
ProductClass
Returns the list of ProductClass objects
get
Adds new ProductClass object
post
Returns a single ProductClass object
get
Updates a ProductClass object
put
Updates details of a ProductClass object
patch
ProductGroup
Returns the list of ProductGroup objects
get
Adds new ProductGroup object
post
Returns a single ProductGroup object
get
Updates a ProductGroup object
put
Updates details of a ProductGroup object
patch
ProductGroupAction
Returns the list of ProductGroupAction objects
get
Adds new ProductGroupAction object
post
Returns a single ProductGroupAction object
get
ProductModifier
Return the list of ProductModifier objects.
get
Add a new ProductModifier
post
Returns a single ProductModifier object
get
Updates a ProductModifier object
put
Updates details of an ProductModifier object
patch
ProductModifierClass
Return the list of ProductModifierClass objects.
get
Add a new ProductModifierClass
post
Returns a single ProductModifierClass object
get
Updates a ProductModifierClass object
put
Updates details of an ProductModifierClass object
patch
ProductPriceLifeCycleAction
Returns the list of ProductPriceLifeCycleAction objects
get
Add a new ProductPriceLifeCycleAction
post
Find ProductPriceLifeCycleAction by ID
get
Update ProductPriceLifeCycleAction by ID
patch
Overwrite an existing ProductPriceLifeCycleAction
put
ProductPriceTierPrice
Returns the list of ProductPriceTierPrice objects
get
Find ProductPriceTierPrice by ID
get
ProductRecipe
Returns the list of ProductRecipe objects
get
Add a new ProductRecipe
post
Find ProductRecipe by ID
get
Update ProductRecipe by ID
patch
Overwrite an existing ProductRecipe
put
ProductSerial
Return the list of ProductSerial objects.
get
Find ProductSerial by ID
get
ProductVariablePrice
Return the list of ProductVariablePrice objects.
get
Add a new ProductVariablePrice
post
Returns a single ProductVariablePrice objects.
get
Updates a ProductVariablePrice object
put
Updates details of an ProductVariablePrice object
patch
ServiceFee
Return the list of ServiceFee objects.
get
Add a new ServiceFee
post
Returns a single ServiceFee object
get
Updates a ServiceFee object
put
Updates details of an ServiceFee object
patch
Surcharge
Returns the list of Surcharge objects
get
Add a new Surcharge
post
Find Surcharge by ID
get
Update Surcharge by ID
patch
Overwrite an existing Surcharge
put
UnitType
Returns the list of UnitType objects
get
Add a new UnitType
post
Find UnitType by ID
get
Update UnitType by ID
patch
Overwrite an existing UnitType
put
Purchase Orders
Overview
IngredientPurchase
Returns the list of IngredientPurchase objects
get
Find IngredientPurchase by ID
get
ProductPurchase
Returns the list of ProductPurchase objects
get
Returns a single ProductPurchase object
get
ProductPurchaseOrderItem
Returns the list of ProductPurchaseOrderItem objects
get
Returns a single ProductPurchaseOrderItem object
get
Updates a ProductPurchaseOrderItem object
put
Updates details of a ProductPurchaseOrderItem object
patch
PurchaseLedger
Returns the list of PurchaseLedger objects
get
Create a PurchaseLedger object
post
Returns a single PurchaseLedger object
get
Updates a PurchaseLedger object
put
Partial update of a ProductLedger's details
patch
PurchaseOrder
Returns the list of PurchaseOrder objects
get
Add a new PurchaseOrder
post
Find PurchaseOrder by ID
get
Replaces a PurchaseOrder object
put
Updates details of an PurchaseOrder object
patch
PurchaseOrderInvoice
Returns the list of PurchaseOrderInvoice objects
get
Add a new PurchaseOrderInvoice
post
Find PurchaseOrderInvoice by ID
get
Replaces a PurchaseOrderInvoice object
put
Updates details of an PurchaseOrderInvoice object
patch
PurchaseOrderItem
Returns the list of PurchaseOrderItem objects
get
Add a new PurchaseOrderItem
post
Find PurchaseOrderItem by ID
get
Replaces a PurchaseOrderItem object
put
Updates details of an PurchaseOrderItem object
patch
Vendor
Returns the list of Vendor objects
get
Add a new Vendor
post
Find Vendor by ID
get
Update an existing Vendor
put
Update an existing Vendor
patch
VendorEstablishment
Returns the list of VendorEstablishment objects
get
Add a new VendorEstablishment
post
Find VendorEstablishment by ID
get
Replaces a VendorEstablishment object
put
Updates details of an VendorEstablishment object
patch
VendorOrderableItem
Returns the list of VendorOrderableItem objects
get
Add a new VendorOrderableItem
post
Find VendorOrderableItem by ID
get
Updates details of an VendorOrderableItem object
patch
ViewPurchaseOrder
Returns a read-only list PurchaseOrder objects
get
View PurchaseOrder by ID
get
ViewPurchaseOrderProduct
Returns the list of ViewPurchaseOrderProduct objects
get
Returns a single ViewPurchaseOrderProduct object
get
Scheduling
Overview
TimeSchedule
Returns the list of TimeSchedule objects
get
Add a new TimeSchedule
post
Find TimeSchedule by ID
get
Update an existing TimeSchedule
put
Update an existing TimeSchedule
patch
Delete an existing TimeSchedule
del
TimeScheduleRule
Returns the list of TimeScheduleRule objects
get
Find TimeScheduleRule by ID
get
TimeSheetEntry
Returns the list of TimeSheetEntry objects
get
Add a new TimeSheetEntry
post
Find TimeSheetEntry by ID
get
Update an existing TimeSheetEntry
put
Update an existing TimeSheetEntry
patch
Tables
Overview
Table
Returns the list of Table objects
get
Find Table by ID
get
Replaces a Table object
put
TableSection
Return the list of TableSection objects.
get
Add a new TableSection
post
Find TableSection by ID
get
Updates a TableSection object
put
Updates details of an TableSection object
patch
TableTag
Return the list of TableTag objects.
get
Add a new TableTag
post
Find TableTag by ID
get
Updates a TableTag object
put
Updates details of an TableTag object
patch
Tax
Overview
Tax
Returns the list of Tax objects
get
Add a new Tax
post
Find Tax by ID
get
Replaces a Tax object
put
Updates details of an Tax object
patch
TaxAgency
Returns the list of TaxAgency objects
get
Add a new TaxAgency
post
Find TaxAgency by ID
get
Replaces a TaxAgency object
put
Updates details of an TaxAgency object
patch
TaxCode
Returns the list of TaxCode objects
get
Add a new TaxCode
post
Find TaxCode by ID
get
Update an existing TaxCode
put
Update an existing TaxCode
patch
TaxProductGroup
Returns the list of TaxProductGroup objects
get
Find TaxProductGroup by ID
get
TaxRate
Returns the list of TaxRate objects
get
Add a new TaxRate
post
Find TaxRate by ID
get
Replaces a TaxRate object
put
Updates details of an TaxRate object
patch
TaxTable
Returns the list of TaxTable objects
get
Add a new TaxTable
post
Find TaxTable by ID
get
Weborders
Overview
CalculateCart
Calculates Cart Totals
post
ValidateCart
Validates Cart and returns Cart object
post
SubmitCart
Submits Cart and returns order
post
Modifiers
Returns a list of WebordersModifierClass objects
get
Menu
Returns an entire menu
get
ProductCategories
Returns the list of product categories
get
Products
Return a list of products
get
Attributes
Returns a list of attributes and child products of the parent product
get
ProductUpcharge
Returns info about linked combos attached to product
get
ProductSets
Returns info about group combos attached to product
get
SystemSettings
Returns a list of SystemSettings
get
More Resources
Inventory X
Reporting
Overview
Orders
Overview
Updated 5 months ago
Find TransferReceiptItem by ID
AppliedServiceFee
Updated 5 months ago
Find TransferReceiptItem by ID
AppliedServiceFee
