Revel API 1.01.1954

Table of Contents
Table of Contents 1
Authentication 8
Using the API 8
Filtering Results 8
Ordering Results 9
Limiting Fields 9
Expanding Related Fields 9
Pagination 9
Additional Limiting Methods 9
Resource List 10
Resource: ATGLog 14
Resource: Address 16
Resource: AppliedServiceFee 18
Resource: AppliedTaxOrder 20
Resource: AppliedTaxOrderItem 22
Resource: Appointment 24
Resource: Attribute 26
Resource: AttributeValue 28
Resource: BankDrop 29
Resource: Board 31
Resource: Brand 33
Resource: BusinessActionLog 34
Resource: BusinessDay 36
Resource: Campaign 37
Resource: Cardswipe 39
Resource: CashOffice 40
Resource: CateringDelivery 42
Resource: ClockInImage 43
Resource: ComboProductSet 44
Resource: Company 45
Resource: Currency 46
Resource: CustomMenu 47
Resource: CustomPaymentType 48
Resource: Customer 49
Resource: CustomerAddOn 53
Resource: CustomerAddress 54
Resource: CustomerEstablishment 56
Resource: CustomerFrontdeskAnywhereData 57
Resource: CustomerGroup 58
Resource: CustomerGroupCustomers 60
Resource: CustomerHistory 61
Resource: CustomerImage 62
Resource: CustomerVehicle 63
Resource: DeclaredTips 65
Resource: Deliveries 66
Resource: DeliveryDriver 67
Resource: DeliveryMileage 68
Resource: Department 69
Resource: Device 70
Resource: DeviceExtraParameters 72
Resource: DeviceView 73
Resource: Discount 75
Resource: DiscountCode 78
Resource: DiscountLevel 79
Resource: DisplayUnit 80
Resource: DocumentStorage 81
Resource: DynamicCombo 83
Resource: DynamicComboUpsellSlot 84
Resource: Employee 85
Resource: EmployeeRoleEstablishment 87
Resource: EnablerFieldNameMapping 88
Resource: Establishment 89
Resource: EstablishmentImage 92
Resource: EstablishmentTag 93
Resource: EventDate 94
Resource: EventInfo 95
Resource: EventInventory 96
Resource: FiscalReport 98
Resource: ForecourtData 99
Resource: FuelPriceAcknowledgement 104
Resource: GiftCard 105
Resource: GiftCardLog 107
Resource: Grades 109
Resource: HelpArticle 111
Resource: HelpLabel 112
Resource: HoseLogs 113
Resource: Hoses 115
Resource: HouseAccount 116
Resource: HouseAccountPayment 117
Resource: HouseAccountTransaction 119
Resource: Ingredient 121
Resource: IngredientInventory 123
Resource: IngredientPurchase 125
Resource: IngredientRecipe 127
Resource: InterfacesDashboard 129
Resource: Inventory 130
Resource: InventoryReceipt 132
Resource: InventoryStockAmount 134
Resource: InventoryUnit 135
Resource: ItemTrackingReport 137
Resource: ItemTrackingReportV2 138
Resource: ItemTrackingSet 139
Resource: ItemTrackingSetProduct 141
Resource: KitchenProduct 142
Resource: KitchenView 143
Resource: LanguagePackage 146
Resource: LanguagePackageItem 147
Resource: LoyaltyTier 148
Resource: LoyaltyTierRule 150
Resource: Modifier 152
Resource: ModifierClass 154
Resource: ModifierDiscount 156
Resource: ModifierItem 158
Resource: ModifierRecipe 160
Resource: Order 162
Resource: OrderAllInOne 168
Resource: OrderDataDiff 174
Resource: OrderExchange 176
Resource: OrderExchangeItem 179
Resource: OrderHistory 181
Resource: OrderItem 183
Resource: OrderItemCatering 188
Resource: OrderItemCommission 190
Resource: OrderItemDataDiff 192
Resource: OrderRegistryData 193
Resource: OrderTaxBreakDown 194
Resource: OriginalProductGroup 195
Resource: OutdoorPaymentTerminal 196
Resource: POSMessage 197
Resource: Package 198
Resource: Payment 200
Resource: PaymentSignatureImage 203
Resource: Payout 204
Resource: Permission 206
Resource: PhysicalInventory 207
Resource: PhysicalInventoryItem 208
Resource: PhysicalInventorySection 209
Resource: PortData 211
Resource: PosStation 212
Resource: PosTemplate 215
Resource: PriceTier 216
Resource: Product 217
Resource: ProductCategory 223
Resource: ProductCategorySoldCount 225
Resource: ProductClass 226
Resource: ProductGroup 228
Resource: ProductGroupAction 230
Resource: ProductModifier 231
Resource: ProductModifierClass 233
Resource: ProductPriceLifeCycleAction 235
Resource: ProductPurchase 237
Resource: ProductPurchaseOrderItem 241
Resource: ProductRecipe 242
Resource: ProductRevelImage 244
Resource: ProductSerial 245
Resource: ProductVariablePrice 246
Resource: ProtocolType 247
Resource: PumpProtocolData 248
Resource: PumpTypeData 249
Resource: Pumps 251
Resource: PurchaseLedger 253
Resource: PurchaseOrder 256
Resource: PurchaseOrderInvoice 259
Resource: PurchaseOrderItem 260
Resource: ReceiptText 262
Resource: Return 264
Resource: ReturnedItem 266
Resource: RevelImage 268
Resource: RevenueCenter 269
Resource: RewardCardLog 270
Resource: RewardsCard 272
Resource: RewardsCardNew 274
Resource: RewardsCardv3 276
Resource: Role 278
Resource: SMSMessageIncoming 279
Resource: SMSMessageOutcoming 280
Resource: ServiceFee 282
Resource: ShipRate 284
Resource: SiteModeSettings 285
Resource: SocialNetwork 287
Resource: SpecialRequest 288
Resource: Surcharge 289
Resource: SystemSetting 290
Resource: SystemSettingOption 292
Resource: Table 293
Resource: TableReservation 294
Resource: TableSection 296
Resource: TableTag 297
Resource: TableType 298
Resource: Tanks 299
Resource: Tax 301
Resource: TaxAgency 303
Resource: TaxCode 304
Resource: TaxProductGroup 305
Resource: TaxRate 306
Resource: TaxTable 308
Resource: Till 309
Resource: TimeBlock 311
Resource: TimeSchedule 313
Resource: TimeScheduleRule 315
Resource: TimeSheetEntry 317
Resource: Timetable 319
Resource: TimetableItem 321
Resource: UnitType 322
Resource: UpdateTimes 323
Resource: User 324
Resource: Vendor 325
Resource: VendorEstablishment 327
Resource: VendorOrderableItem 328
Resource: Version 330
Resource: ViewPurchaseOrder 331
Resource: ViewPurchaseOrderProduct 334
Resource: ViewTax 338
Resource: VisitorTracking 340
Resource: WSRShifts 341
Support 342
Revel Systems API
Version: 1.01.1954
Authentication
Revel Systems allows access to the API by granting two codes - a key code and a secret code.
In each request, pass the key and secret in one of the following ways:
1) In the Request Header
The key and secret should be joined by a colon and passed in each request as a header named API-AUTHENTICATION
For example:
API-AUTHENTICATION: xxxxxxxxxxxxxxxxxxxxxxx:yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
2) As a GET or POST variable
The key and secret can be passed as parameters named api_key and api_secret.
For example:
?api_key=xxxxxxxxxxxxxxxxxxxxxxx&api_secret=yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
For security reasons, https must be used for API communication.
If you do not have an API key/secret combination, please contact the Revel Support team to obtain one.
Using the API
Filtering Results
A variety of optional filters are available when accessing the API to limit the data returned with each call. Filters are allowed on a
per-field basis of each resource. To see which filters are allowed on individual fields, reference the ‘Filtering’ section for each
resource in the Resources section below. Exact matches can be accessed by simply using an equals sign, while filters can be
applied by using a double-underscore (__) after specifying a field in a query-string (see examples below). The filters available
include the following:
Filter Description Examples
&id__lt=25
lt Less than
&created_date__lt=2014-12-01T19:58:25
&id__lte=25
lte Less than or equal to &created_date__lte=2014-12-
01T19:58:25
&id__gt=25
gt Greater than &created_date__gt=2014-12-
01T19:58:25
&id__gte=25
Greater than or equal
gte &created_date__gte=2014-12-
to
01T19:58:25
Case-sensitive exact
exact &call_name__exact=Jim
match
Case-insensitive
iexact &call_name__iexact=jim
exact match
Case-sensitive
contains &call_name__contains=Jack
containment
Case-insensitive
icontains &call_name__icontains=jack
containment
In a given array
in &id__in=1,2,3
(comma separated)
Case-sensitive starts-
startswith &name__startswith=Fries
with
Case-insensitive
istartswith &name__istartswith=fries
starts-with
Case-sensitive ends-
endswith &name__endswith=Burger
with
Case-insensitive
iendswith &name__iendswith=burger
ends-with
Inclusive range &created_date__range=2015-06-

range
(comma separated) 01T12:00:00,2015-07-01T12:00:00
isnull Checks null value &course_number__isnull=true

Ordering Results
Like filters, ordering options are allowed on a per-field basis of each resource. To order results by an allowed ordering field, use the
order_by option in a query-string parameter like so:
&order_by=updated_date
Limiting Fields
Sometimes it is helpful to specify which resource fields are returned with API calls, and often times this can speed up performance
as well. The Revel API provides the fields option for doing this. For example, if the only data that is needed from a resource are the
id and created_date, use the fields option like so:
&fields=id,created_date
Please be aware that the fields option is only for use on items that exist directly on a resource. Passing fields that are foreign-key
relations can produce unintended results and does not provide any performance enhancements. Also, please note that certain
fields are returned by default on every response, even if not specified in the fields parameter.
Expanding Related Fields
Related fields in API responses will contain a URI reference to the related resource. For instance, the manager field of the
Establishment resource contains a reference to a User entry:
{“manager”: “/enterprise/User/7/”}
The Revel API provides the expand option in order to view the entirety of a related field’s data in a single API call. To use the
expand option, pass a json object of the fields that you would like expanded in the query-string of your API call. For example:
https://****.revelup.com/enterprise/Establishment/?expand={“manager”:1,”address”:1}
This call returns Establishment data containing nested objects including all fields for both the manager and address relations.
Please note that the 1 value passed in the json object is a boolean directive for true (not an id of any sort).
The expand option is only for use on singly-related resources, not on fields with many-to-many relationships.
Pagination
The Revel API returns a default limit of 20 items with each API call. If more than 20 items are available, the meta object contains
next and previous items containing references for paginating results.
The total number of records returned in a call can be viewed in the total_count field of the meta object.
It is recommended to use an order_by option when paginating results.
Additional Limiting Methods
In addition to filters, API calls can be structured to return single entries or a list of entries. To return a single entry by its id
attribute, add the id to the end of the resource URI:
https://****.revelup.com/resources/Product/24/
To return a list of entries by their ids, use set and separate the ids with semicolons:
https://****.revelup.com/resources/Product/set/12;25;32/
Resource List
ATGLog
Address
AppliedServiceFee
AppliedTaxOrder
AppliedTaxOrderItem
Appointment
Attribute
AttributeValue
BankDrop
Board
Brand
BusinessActionLog
BusinessDay
Campaign
Cardswipe
CashOffice
CateringDelivery
ClockInImage
ComboProductSet
Company
Currency
CustomMenu
CustomPaymentType
Customer
CustomerAddOn
CustomerAddress
CustomerEstablishment
CustomerFrontdeskAnywhereData
CustomerGroup
CustomerGroupCustomers
CustomerHistory
CustomerImage
CustomerVehicle
DeclaredTips
Deliveries
DeliveryDriver
DeliveryMileage
Department
Device
DeviceExtraParameters
DeviceView
Discount
DiscountCode
DiscountLevel
DisplayUnit
DocumentStorage
DynamicCombo
DynamicComboUpsellSlot
Employee
EmployeeRoleEstablishment
EnablerFieldNameMapping
Establishment
EstablishmentImage
EstablishmentTag
EventDate
EventInfo
EventInventory
FiscalReport
ForecourtData
FuelPriceAcknowledgement
GiftCard
GiftCardLog
Grades
HelpArticle
HelpLabel
HoseLogs
Hoses
HouseAccount
HouseAccountPayment
HouseAccountTransaction
Ingredient
IngredientInventory
IngredientPurchase
IngredientRecipe
InterfacesDashboard
Inventory
InventoryReceipt
InventoryStockAmount
InventoryUnit
ItemTrackingReport
ItemTrackingReportV2
ItemTrackingSet
ItemTrackingSetProduct
KitchenProduct
KitchenView
LanguagePackage
LanguagePackageItem
LoyaltyTier
LoyaltyTierRule
Modifier
ModifierClass
ModifierDiscount
ModifierItem
ModifierRecipe
Order
OrderAllInOne
OrderDataDiff
OrderExchange
OrderExchangeItem
OrderHistory
OrderItem
OrderItemCatering
OrderItemCommission
OrderItemDataDiff
OrderRegistryData
OrderTaxBreakDown
OriginalProductGroup
OutdoorPaymentTerminal
POSMessage
Package
Payment
PaymentSignatureImage
Payout
Permission
PhysicalInventory
PhysicalInventoryItem
PhysicalInventorySection
PortData
PosStation
PosTemplate
PriceTier
Product
ProductCategory
ProductCategorySoldCount
ProductClass
ProductGroup
ProductGroupAction
ProductModifier
ProductModifierClass
ProductPriceLifeCycleAction
ProductPurchase
ProductPurchaseOrderItem
ProductRecipe
ProductRevelImage
ProductSerial
ProductVariablePrice
ProtocolType
PumpProtocolData
PumpTypeData
Pumps
PurchaseLedger
PurchaseOrder
PurchaseOrderInvoice
PurchaseOrderItem
ReceiptText
Return
ReturnedItem
RevelImage
RevenueCenter
RewardCardLog
RewardsCard
RewardsCardNew
RewardsCardv3
Role
SMSMessageIncoming
SMSMessageOutcoming
ServiceFee
ShipRate
SiteModeSettings
SocialNetwork
SpecialRequest
Surcharge
SystemSetting
SystemSettingOption
Table
TableReservation
TableSection
TableTag
TableType
Tanks
Tax
TaxAgency
TaxCode
TaxProductGroup
TaxRate
TaxTable
Till
TimeBlock
TimeSchedule
TimeScheduleRule
TimeSheetEntry
Timetable
TimetableItem
UnitType
UpdateTimes
User
Vendor
VendorEstablishment
VendorOrderableItem
Version
ViewPurchaseOrder
ViewPurchaseOrderProduct
ViewTax
VisitorTracking
WSRShifts
Resource: ATGLog
URL: /resources/ATGLog/?format=json
Default Format: application/json
Default Limit: 20
FIELDS
Read
Name Type Default Null Unique Blank Help Text
Only
A date & time as a string. Ex: "2010-11-
updated_date Datetime True False False False True
10T03:07:43"
No default A single related resource. Can be either a
tank Tanks (FK) False False False False
provided. URI or set of nested resource data.
No default
temperature Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
density Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
water_level Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
level Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default A date & time as a string. Ex: "2010-11-
last_reading Datetime True False False False
provided. 10T03:07:43"
No default
volume Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
non_compensated_volume Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
Available choices: (0, Auto ATG log
type_log Integer 0 False False False False
reading), (1, Manual ATG log reading)
No default
ullage Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
created_date Datetime True False False False True
10T03:07:43"
No default
water_volume Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
resource_uri String False True False False Unicode string data. Ex: "Hello World"
provided.
Establishment No default A single related resource. Can be either a
establishment False False False False
(FK) provided. URI or set of nested resource data.
id Integer Auto False False True True Auto generated unique ID.
Universally unique identifier. Ex-
No default
uuid UUID False False False False 550e8400-e29b-41d4-a716-
provided.
446655440000
Ordering
Name
id
Allowed detail http methods
Name
GET
POST
Allowed list http methods
Name
GET
POST
Resource: Address
URL: /resources/Address/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
province String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
county String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
city_name String False False False False Unicode string data. Ex: "Hello World"
provided.
Universally unique identifier. Ex- 550e8400-e29b-
uuid UUID False False True True
41d4-a716-446655440000
No default
district String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
zipcode String False False False False Unicode string data. Ex: "Hello World"
provided.
No default A single related resource. Can be either a URI or set
created_by User (FK) False False False False
provided. of nested resource data.
No default
state String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
latitude Float True False False False Floating point numeric data. Ex: 26.73
provided.
line_2 String False False False True Unicode string data. Ex: "Hello World"
updated_date Datetime False True False False
No default
door String True False False False Unicode string data. Ex: "Hello World"
provided.
updated_by User (FK) False False False False
No default
line_1 String False False False False Unicode string data. Ex: "Hello World"
provided.
active Boolean False False False False True Boolean data. Ex: True
is_external Boolean False False False False True Boolean data. Ex: True
No default
country String False False False False Unicode string data. Ex: "Hello World"
provided.
No default
longitude Float True False False False Floating point numeric data. Ex: 26.73
provided.
No default
building_number String True False False False Unicode string data. Ex: "Hello World"
provided.
alias String False False False True Unicode string data. Ex: "Hello World"
created_date Datetime False True False False
No default
provided.
Filtering
Name
is_external
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: AppliedServiceFee
URL: /resources/AppliedServiceFee/?format=json
Default Limit: 20
FIELDS
Read
Only
post_tax Boolean False False False False True Boolean data. Ex: True
No default
passthrough_type Integer True False False False Integer data. Ex: 2673
provided.
No default
parent_uuid String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
passthrough_amount Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
application_type Integer False False False False Integer data. Ex: 2673
provided.
No default
invoice_document_uuid String True False False True A UUID formatted field.
provided.
No default Universally unique identifier. Ex- 550e8400-
uuid UUID False False True False
provided. e29b-41d4-a716-446655440000
No default
type Integer False False False False Integer data. Ex: 2673
provided.
updated_date Datetime False False False False
deleted Boolean False False False False True Boolean data. Ex: True
sort Integer 0 False False False False Integer data. Ex: 2673
No default
name String False False False False Unicode string data. Ex: "Hello World"
provided.
No default
tax_amount Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
total_amount Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
local_service_fee_id Integer True False False False Integer data. Ex: 2673
provided.
OrderItem No default A single related resource. Can be either a URI
item True False False True
(FK) provided. or set of nested resource data.
No default
amount Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.

created_date Datetime False False False False
taxed Boolean False False False False True Boolean data. Ex: True
Order No default A single related resource. Can be either a URI
order True False False True
No default
provided.
Filtering
Name
item
order
uuid
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: AppliedTaxOrder
URL: /resources/AppliedTaxOrder/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
max_quantity_threshold Integer True False False False Integer data. Ex: 2673
provided.
No default
min_quantity_threshold Integer True False False False Integer data. Ex: 2673
provided.
No default
fiscal_rate Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
Universally unique identifier. Ex- 550e8400-
uuid UUID False False False True
e29b-41d4-a716-446655440000
No default
max_threshold Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
min_threshold Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
rounding_type Integer 0 False False False False Integer data. Ex: 2673
on_full_price Boolean True False False False True Boolean data. Ex: True
order False False False False
is_prevailing Boolean False False False False True Boolean data. Ex: True
No default
tax_rate Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
TaxTable No default A single related resource. Can be either a URI
tax_table True False False True
No default
local_tax_id Integer True False False False Integer data. Ex: 2673
provided.
No default
provided.
No default
dining_options String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
provided.
Filtering
Name
order
uuid
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
AppliedTaxOrderItem
URL: /resources/AppliedTaxOrderItem/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
No default
provided.
No default
fiscal_rate Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
uuid UUID False False False True
e29b-41d4-a716-446655440000
No default
provided.
No default
provided.
No default
actual_tax_rate Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
tax_amount Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
provided.
on_full_price Boolean True False False False True Boolean data. Ex: True
TaxTable No default A single related resource. Can be either a URI
order_item False False False False
No default
provided.
No default
provided.
No default
provided.
Filtering
Name
order_item
uuid
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: Appointment
URL: /resources/Appointment/?format=json
Default Limit: 20
FIELDS
Read
Only
Customer No default A single related resource. Can be either a URI or
customer False False False False
(FK) provided. set of nested resource data.
No default A single related resource. Can be either a URI or
product Product (FK) False False False False
provided. set of nested resource data.
No default Universally unique identifier. Ex- 550e8400-e29b-
provided. 41d4-a716-446655440000
Establishment No default A single related resource. Can be either a URI or
notes String False False False False Unicode string data. Ex: "Hello World"
confirm_type Integer 0 False False False False Integer data. Ex: 2673
reminder_send Boolean None True False False False Boolean data. Ex: True
confirmed Boolean False False False False True Boolean data. Ex: True
active Boolean True False False False True Boolean data. Ex: True
No default
duration Integer False False False False Integer data. Ex: 2673
provided.
user User (FK) False False False False
date Datetime False False False False
version_date Datetime True False False False True
10T03:07:43"
No default
order_uuid String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
provided.
Filtering
Name
updated_date
establishment
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: Attribute
URL: /resources/Attribute/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
sort Integer False False False False Integer data. Ex: 2673
provided.
10T03:07:43"
brand Brand (FK) False False False False
10T03:07:43"
No default
provided.
No default
provided.
Filtering
Name
active
updated_date
brand
establishment
Ordering
Name
sort
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: AttributeValue
URL: /resources/AttributeValue/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
updated_date Datetime True False False False True A date & time as a string. Ex: "2010-11-10T03:07:43"
No default
provided.
Attribute No default A single related resource. Can be either a URI or set
attribute False False False False
(FK) provided. of nested resource data.
created_date Datetime True False False False True A date & time as a string. Ex: "2010-11-10T03:07:43"
No default
provided.
Filtering
Name
active
attribute
updated_date
Ordering
Name
sort
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: BankDrop
URL: /resources/BankDrop/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
provided.
No default A single related resource. Can be either a URI
provided. or set of nested resource data.
till Till (FK) True False False True
10T03:07:43"
No default
currency_type Integer False False False False Integer data. Ex: 2673
provided.
No default
amount Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
local_id String False False False True Unicode string data. Ex: "Hello World"
No default
drawer_number Integer False False False False Integer data. Ex: 2673
provided.
transaction_uuid String False False False True Unicode string data. Ex: "Hello World"
till_owner User (FK) True False False True
No default
bank_deposit_num String True False False False Unicode string data. Ex: "Hello World"
provided.
PosStation No default A single related resource. Can be either a URI

station provided. False False False False
(FK) or set of nested resource data.

10T03:07:43"
Establishment No default A single related resource. Can be either a URI
provided. e29b-41d4-a716-446655440000
Filtering
Name
till
local_id
establishment
uuid
drawer_number
Ordering
Name
id

Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: Board
URL: /resources/Board/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
pin String True False True False Pin to access DMB on TV
provided.
No default
title String False False False False The name of the display board
provided.
No default Select a background color for the board. This
color String True False False False
provided. will apply to all pages
rgb(255, Select a border color for the board. This will
border_color String True False False False
255, 255) apply to all pages
No default
markers_color String True False False False Select a color for page markers
provided.
If using more than one page, select how long
timer Integer 15 False False False False you'd like each page to display before switching
to the next.
No default
background_image_url String False True False False Unicode string data. Ex: "Hello World"
provided.
animation Integer 1 False False False False Select which type of animation to use
Displays page markers at the bottom of the
markers Boolean None False False False True
board
10T03:07:43"
No default
background_image_fill Integer True False False False Board background image fill type
provided.
border Boolean None False False False True Border color for the board
No default
provided.
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
Brand
URL: /enterprise/Brand/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
provided.
company Company (FK) False False False False
call_names String True False False False Unicode string data. Ex: "Hello World"
client_type Integer 0 False False False False Integer data. Ex: 2673
Establishment No default Many related resources. Can be either a list of URIs
establishments True True False True
(FK) provided. or list of individually nested resource data.
10T03:07:43"
No default
provided.
Filtering
Name
id
Ordering
Name
id
Name
GET
Name
GET
Resource: BusinessActionLog
URL: /resources/BusinessActionLog/?format=json
Default Limit: 20
FIELDS
Read
Only
description String False False False False Unicode string data. Ex: "Hello World"
No default
object_id Integer True False False False Integer data. Ex: 2673
provided.
action_date_time Datetime False False False False
No default
reason String False False False False Unicode string data. Ex: "Hello World"
provided.
PosStation No default A single related resource. Can be either a URI or
pos_station False False False False
Employee No default A single related resource. Can be either a URI or
target_employee True False False True
No default
action_type Integer False False False False Integer data. Ex: 2673
provided.
details String False False False False Unicode string data. Ex: "Hello World"
No default
provided.
provided. e29b-41d4-a716-446655440000
Filtering
Name
uuid
action_date_time
pos_station
user
action_type
establishment
Ordering
Name
id
Name
GET
POST
PUT

Name
GET
PATCH
Resource: BusinessDay
URL: /resources/BusinessDay/?format=json
Default Limit: 20
FIELDS
Read
Only
41d4-a716-446655440000
No default
third_party_id Integer True False False False Integer data. Ex: 2673
provided.
No default
closed Datetime True False False False Timestamp of BusinessDay closing
provided.
No default Business day date. Should be unique for given
provided. establishment.
No default
provided.
No default
opened Datetime False False False False Timestamp of BusinessDay opening
provided.
Filtering
Name
establishment
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: Campaign
URL: /resources/Campaign/?format=json
Default Limit: 20
FIELDS
Read
Only
directory_users Boolean False False False False True Boolean data. Ex: True
activated Boolean True False False False True Boolean data. Ex: True
directory_within_zip_codes String False False False True Unicode string data. Ex: "Hello World"
No default
unique_code_length Integer True False False False Integer data. Ex: 2673
provided.
No default A single related resource. Can be either
provided. a URI or set of nested resource data.
scheduled_send_date Datetime True False False False
directory_within Integer 0 False False False False Integer data. Ex: 2673
whitelabel_within Integer 0 False False False False Integer data. Ex: 2673
No default
whitelabel_within_miles Integer True False False False Integer data. Ex: 2673
provided.
footer_text String False False False True Unicode string data. Ex: "Hello World"
push_notifications Boolean True False False False True Boolean data. Ex: True
Establishment No default A single related resource. Can be either
(FK) provided. a URI or set of nested resource data.
10T03:07:43"
description String False False False True Unicode string data. Ex: "Hello World"
send_immediately Boolean False False False False True Boolean data. Ex: True
10T03:07:43"
unique_code_starts_with String False False False True Unicode string data. Ex: "Hello World"
Many related resources. Can be either a
No default
discount Discount (FK) True False False True list of URIs or list of individually nested
provided.
resource data.
schedule_send Boolean False False False False True Boolean data. Ex: True
No default
business_name String False False False False Unicode string data. Ex: "Hello World"
provided.
directory_within_geojson_code String False False False True Unicode string data. Ex: "Hello World"
emails Boolean True False False False True Boolean data. Ex: True
app_users Boolean True False False False True Boolean data. Ex: True
one_code String False False False True Unicode string data. Ex: "Hello World"
subject_line String False False False True Unicode string data. Ex: "Hello World"
use_code Integer 0 False False False False Integer data. Ex: 2673
offer_date_start Datetime True False False False
No default
provided.
No default A dictionary of data. Ex: {'price': 26.73,
within_geojson_code Dict True False False False
provided. 'name': 'Daniel'}
message_text String False False False True Unicode string data. Ex: "Hello World"
offer_date_end Datetime True False False False
whitelabel_within_zip_codes String False False False True Unicode string data. Ex: "Hello World"
whitelabel_within_geojson_code String False False False True Unicode string data. Ex: "Hello World"
No default
directory_within_miles Integer True False False False Integer data. Ex: 2673
provided.
No default
provided.
Filtering
Name
establishment
Ordering
Name
id
Name
GET
POST
PUT
Name
GET
POST
PUT
Resource: Cardswipe
URL: /resources/Cardswipe/?format=json
Default Limit: 20
FIELDS
Read
Only
tips_enabled Boolean False False False False True Boolean data. Ex: True
No default
lane_id String True False False False Unicode string data. Ex: "Hello World"
provided.
admin_cards Boolean True False False False True Boolean data. Ex: True
Device No default A single related resource. Can be either a URI or
device False False False False
No default
terminal_serial_number String True False False False Unicode string data. Ex: "Hello World"
provided.
cardswipe_type Integer 0 False False False False Integer data. Ex: 2673
saf_enabled Boolean False False False False True Boolean data. Ex: True
No default
ecr_id String True False False False Unicode string data. Ex: "Hello World"
provided.
loyalty_cards Boolean True False False False True Boolean data. Ex: True
No default
provided.
Filtering
Name
device
Ordering
Name
id
Name
GET
PATCH
PUT
Name
GET
PATCH
PUT
Resource: CashOffice
URL: /resources/CashOffice/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
confirmed_amount Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
confirmed_date Datetime True False False False
No default
provided.
No default
amount Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
bankdrop_local_id Integer True False False False Integer data. Ex: 2673
provided.
No default
provided.
flag Integer 1 False False False False Integer data. Ex: 2673
10T03:07:43"
No default
action Integer True False False False Integer data. Ex: 2673
provided.
No default
variance Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
safe_uuid String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
bank_deposit_num String True False False False Unicode string data. Ex: "Hello World"
provided.

establishment provided. False False False False
(FK) or set of nested resource data.

confirmed_by User (FK) False False False False
action_taken_by User (FK) False False False False
Filtering
Name
establishment
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: CateringDelivery
URL: /resources/CateringDelivery/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
10T03:07:43"
OrderItem No default A single related resource. Can be either a URI or
order Order (FK) False False False False
delivery_date Datetime False False False False
No default
provided.
Filtering
Name
delivery_date
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: ClockInImage
URL: /resources/ClockInImage/?format=json
Default Limit: 20
FIELDS
Read
Only
No default A file URL as a string. Ex:
original String False False False False
provided. "http://media.example.com/media/photos/my_photo.jpg"
No default
provided.
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: ComboProductSet
URL: /resources/ComboProductSet/?format=json
Default Limit: 20
FIELDS
Read
Only
Product No default A single related resource. Can be either a URI or set of
product False False False False
(FK) provided. nested resource data.
No default A single related resource. Can be either a URI or set of
provided. nested resource data.
No default
provided.
No default
provided.
Product No default Many related resources. Can be either a list of URIs or
products True True False True
(FK) provided. list of individually nested resource data.
quantity Integer 1 False False False True Integer data. Ex: 2673
is_combo_saving Boolean False False False False True Boolean data. Ex: True
Filtering
Name
product
Ordering
Name
id
Name
GET
Name
GET
Resource: Company
URL: /enterprise/Company/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
active Boolean True False False False False Boolean data. Ex: True
No default
provided.
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: Currency
URL: /resources/Currency/?format=json
Default Limit: 20
FIELDS
Name Type Default Null Read Only Unique Blank Help Text
symbol String No default provided. False False False False Unicode string data. Ex: "Hello World"
resource_uri String No default provided. False True False False Unicode string data. Ex: "Hello World"
name String No default provided. False False False False Unicode string data. Ex: "Hello World"
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: CustomMenu
URL: /resources/CustomMenu/?format=json
Default Limit: 20
FIELDS
Read
Only
restricted_products Boolean False False False False True Boolean data. Ex: True
PosStation No default Many related resources. Can be either a list of
stations True False False True
(FK) provided. URIs or list of individually nested resource data.
application_type Integer 0 False False False False Integer data. Ex: 2673
Timetable No default A single related resource. Can be either a URI or
timetable True False False True
mode Integer 0 True False False False Integer data. Ex: 2673
No default
active Boolean False True False False Boolean data. Ex: True
provided.
ProductGroup No default A single related resource. Can be either a URI or
product_group False False False False
No default
provided.
Filtering
Name
active
updated_date
product_group
Ordering
Name
id
Name
GET
Name
GET
Resource: CustomPaymentType
URL: /resources/CustomPaymentType/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
payment_id Integer False False True False Integer data. Ex: 2673
provided.
No default
change_label String False False False False Unicode string data. Ex: "Hello World"
provided.
capture_id Boolean False False False False True Boolean data. Ex: True
No default
id_label String False False False False Unicode string data. Ex: "Hello World"
provided.
is_admin Boolean False False False False True Boolean data. Ex: True
is_public Boolean True False False False True Boolean data. Ex: True
No default
provided.
type Integer 0 False False False False Integer data. Ex: 2673
No default
provided.
Name
GET
Name
GET
Resource: Customer
URL: /resources/Customer/?format=json
Default Limit: 20
FIELDS
Read
Only
No
Unicode string data. Ex:
phone_number String default True False False True
"Hello World"
provided.
No
last_name String default True False False False
"Hello World"
provided.
track_as_company Boolean False False False False True Boolean data. Ex: True
Many related resources. Can
No
be either a list of URIs or list
addresses CustomerAddress (FK) default True False False True
of individually nested
provided.
resource data.
No
pin String default True False False True
"Hello World"
provided.
No A single related resource.
image CustomerImage (FK) default True True False True Can be either a URI or set of
total_purchases Integer 0 True False False False Integer data. Ex: 2673
No
A date & time as a string.
contract_expiration Datetime default True False False False
Ex: "2010-11-10T03:07:43"
provided.
CustomerFrontdeskAnywhereData
frontdeskanywheredata default True True False True Can be either a URI or set of
(FK)
No
Floating point numeric data.
account_balance Float default True False False False
Ex: 26.73
provided.
No
exp_date Datetime default True False False False
Ex: "2010-11-10T03:07:43"
provided.
No
city String default True False False True
"Hello World"
provided.
No
first_name String default True False False False
"Hello World"
provided.
Universally unique identifier.
uuid UUID False False True True Ex- 550e8400-e29b-41d4-
a716-446655440000
charge_account Boolean False False False False True Boolean data. Ex: True
No
source Integer default True False False False Integer data. Ex: 2673
provided.
No
cc_exp String default True False False False
"Hello World"
provided.
No
account_limit Float default True False False False
Ex: 26.73
provided.
No
zipcode String default True False False True
"Hello World"
provided.
created_by User (FK) default False False False False Can be either a URI or set of
cc_number String True False False False
"Hello World"
is_visitor Boolean False False False False True Boolean data. Ex: True
No
state String default True False False True
"Hello World"
provided.
No
cc_first_name String default True False False False
"Hello World"
provided.
No
company_name String default True False False False
"Hello World"
provided.
No
expensify_account String default True False False False
"Hello World"
provided.
No
version_date Datetime default True False False True
Ex: "2010-11-10T03:07:43"
provided.
No
email String default True False False False
"Hello World"
provided.
Ex: "2010-11-10T03:07:43"
No
picture String default False True False False
"Hello World"
provided.
No
third_party_id Integer default True False False False Integer data. Ex: 2673
provided.
No
tax_location String default True False False False
"Hello World"
provided.
updated_by User (FK) default False False False False Can be either a URI or set of
No
deleted Boolean default False True False True Boolean data. Ex: True
provided.
Ex: "2010-11-10T03:07:43"
ok_to_email Boolean True False False False True Boolean data. Ex: True
No
vehicles CustomerVehicle (FK) default True False False True
provided.
resource data.
No
customer_groups CustomerGroup (FK) default True False False True
provided.
resource data.
No
discount Float default True False False False
Ex: 26.73
provided.
No
lic_number String default True False False False
"Hello World"
provided.
No
address String default True False False True
"Hello World"
provided.
tax_exempt Boolean False False False False True Boolean data. Ex: True
No
loyalty_ref_id String default True False False False
"Hello World"
provided.
No
past_due Float default True False False False
Ex: 26.73
provided.
No
loyalty_number String default True False False False
"Hello World"
provided.
accept_checks Boolean False False False False True Boolean data. Ex: True
notes String True False False False
"Hello World"
No
title String default True False False False
"Hello World"
provided.
No
cc_last_4_digits String default True False False False
"Hello World"
provided.
No
ref_number String default True False False False
"Hello World"
provided.
total_visits Integer 0 True False False False Integer data. Ex: 2673
gender Integer 0 False False False False Integer data. Ex: 2673
No
birth_date Datetime default True False False False
Ex: "2010-11-10T03:07:43"
provided.
No
cc_last_name String default True False False False
"Hello World"
provided.
No
resource_uri String default False True False False
"Hello World"
provided.
Filtering
Name
updated_date
phone_number
last_name
total_purchases
active
first_name
uuid
ref_number
email
created_date
total_visits
Ordering
Name
id
Name
POST
PUT
GET
PATCH
DELETE
Name
GET
POST
PUT
PATCH
Resource:
CustomerAddOn
URL: /resources/CustomerAddOn/?format=json
Default Limit: 20
FIELDS
contract_rate Decimal No default provided. True False False False Fixed precision numeric data. Ex: 26.73
addon_code String No default provided. False False True False Unicode string data. Ex: "Hello World"
description String False False False True Unicode string data. Ex: "Hello World"
title String False False False True Unicode string data. Ex: "Hello World"
price Decimal No default provided. True False False False Fixed precision numeric data. Ex: 26.73
description_activated String False False False True Unicode string data. Ex: "Hello World"
enabled Boolean False False False False True Boolean data. Ex: True
more_details_link String False False False True Unicode string data. Ex: "Hello World"
ns_internal_id String True True False False False Unicode string data. Ex: "Hello World"
learn_more_link String False False False True Unicode string data. Ex: "Hello World"
version String False False False True Unicode string data. Ex: "Hello World"
video String False False False True Unicode string data. Ex: "Hello World"
payment_type Integer 0 False False False False Integer data. Ex: 2673
global_add_on Boolean False False False False True Boolean data. Ex: True
enabled_description String False False False True Unicode string data. Ex: "Hello World"
help_link String False False False True Unicode string data. Ex: "Hello World"
Filtering
Name
establishment
Ordering
Name
id
Name
GET
Name
GET
Resource: CustomerAddress
URL: /resources/CustomerAddress/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
phone_number String True False False False Unicode string data. Ex: "Hello World"
provided.
10T03:07:43"
No default
address_type Integer True False False False Integer data. Ex: 2673
provided.
No default
name String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
city String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
country String False False False False Unicode string data. Ex: "Hello World"
provided.
10T03:07:43"
No default
zipcode String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
email String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
provided.
company_name String True False False False Unicode string data. Ex: "Hello World"
No default
provided.
No default
street_1 String True False False False Unicode string data. Ex: "Hello World"
provided.
primary_billing Boolean False False False False True Boolean data. Ex: True
No default
street_2 String True False False False Unicode string data. Ex: "Hello World"
provided.
primary_shipping Boolean False False False False True Boolean data. Ex: True
uuid UUID False False True True Universally unique identifier. Ex- 550e8400-e29b-
41d4-a716-446655440000
Filtering
Name
id
uuid
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
Resource:
CustomerEstablishment
URL: /resources/CustomerEstablishment/?format=json
Default Limit: 20
FIELDS
Read
Only
Customer No default A single related resource. Can be either a
last_sale Datetime True False False False
is_reward_reminder_sent Boolean False False False False True Boolean data. Ex: True
No default
provided.
Filtering
Name
customer
establishment
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: CustomerFrontdeskAnywhereData
URL: /resources/CustomerFrontdeskAnywhereData/?format=json
Default Limit: 20
FIELDS
Read
Only
checkedin_date Datetime True False False False
room_number String False False False True Unicode string data. Ex: "Hello World"
No default
hotel_id String False False False False Unicode string data. Ex: "Hello World"
provided.
third_party_number String False False False True Unicode string data. Ex: "Hello World"
No default
provided.
reservation_number String False False False True Unicode string data. Ex: "Hello World"
No default
hotel_name String False False False False Unicode string data. Ex: "Hello World"
provided.
checkedout_date Datetime True False False False
Filtering
Name
customer
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: CustomerGroup
URL: /resources/CustomerGroup/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
sorting Integer False False False False Integer data. Ex: 2673
provided.
No default Many related resources. Can be either a list of
tax_free_taxes Tax (FK) True False False True
provided. URIs or list of individually nested resource data.
discounts Discount (FK) True False False True
tax_codes TaxCode (FK) True False False True
10T03:07:43"
DiscountLevel No default A single related resource. Can be either a URI or
discount_level True True False True
tax_free Boolean False False False False True Boolean data. Ex: True
No default
provided.
auto_apply_discounts Boolean False False False False True Boolean data. Ex: True
No default
provided.
Filtering
Name
id
Ordering
Name
id
Name
GET
POST
PUT
PATCH

Name
GET
POST
PUT
PATCH
Resource:
CustomerGroupCustomers
URL: /resources/CustomerGroupCustomers/?format=json
Default Limit: 20
FIELDS
Read
Only
customer Customer (FK) False False False False
CustomerGroup No default A single related resource. Can be either a URI or
customer_group False False False False
No default
provided.
Filtering
Name
customer_group
id
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: CustomerHistory
URL: /resources/CustomerHistory/?format=json
Default Limit: 1
FIELDS
Read
Only
No default
total_refunds Float False True False False Floating point numeric data. Ex: 26.73
provided.
No default
total_payments Float False True False False Floating point numeric data. Ex: 26.73
provided.
range_to Datetime False True False False
No default
last_4_cc_digits String False True False False Unicode string data. Ex: "Hello World"
provided.
No default
cc_first_name String False True False False Unicode string data. Ex: "Hello World"
provided.
No default A dictionary of data. Ex: {'price': 26.73, 'name':
names Dict False True False False
provided. 'Daniel'}
No default
cc_last_name String False True False False Unicode string data. Ex: "Hello World"
provided.
No default
total_discounts Float False True False False Floating point numeric data. Ex: 26.73
provided.
range_from Datetime False True False False
id Integer Auto False True False False Auto generated unique ID.
No default
total_orders Integer False True False False Integer data. Ex: 2673
provided.
Filtering
Name
cc_last_name
now
last_4_cc_digits
cc_first_name
id
Ordering
Name
id
Name
Name
GET
Resource: CustomerImage
URL: /resources/CustomerImage/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: CustomerVehicle
URL: /resources/CustomerVehicle/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
plate String True False False False Unicode string data. Ex: "Hello World"
provided.
41d4-a716-446655440000
No default
vin String False False False False Unicode string data. Ex: "Hello World"
provided.
No default
odometer Integer True False False False Integer data. Ex: 2673
provided.
No default
owner String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
provided.
No default
year Integer True False False False Integer data. Ex: 2673
provided.
No default
model String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
provided.
No default
manufacturer String True False False False Unicode string data. Ex: "Hello World"
provided.
Filtering
Name
id
uuid
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
Resource: DeclaredTips
URL: /resources/DeclaredTips/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
41d4-a716-446655440000
tips_date Datetime False False False False
No default
amount Float False False False False Floating point numeric data. Ex: 26.73
provided.
10T03:07:43"
employee User (FK) False False False False
No default
provided.
Filtering
Name
employee
date_range_from
establishment
date_range_to
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
Deliveries
URL: /resources/Deliveries/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
actual_delivery Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
note String True False False False Unicode string data. Ex: "Hello World"
10T03:07:43"
No default
invoice_no String False False False False Unicode string data. Ex: "Hello World"
provided.
No default
invoice_delivery Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
delivery_date Datetime False False False False
No default
provided.
Filtering
Name
establishment
Ordering
Name
id
Name
GET
POST
Name
GET
POST
Resource: DeliveryDriver
URL: /resources/DeliveryDriver/?format=json
Default Limit: 20
FIELDS
Read
Only
clock_in Datetime True False False False
10T03:07:43"
provided. 41d4-a716-446655440000
clock_out Datetime False False False False
10T03:07:43"
employee False False False False
No default
provided.
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: DeliveryMileage
URL: /resources/DeliveryMileage/?format=json
Default Limit: 20
FIELDS
Read
Only
mileage Decimal 0.000000 True False False False Fixed precision numeric data. Ex: 26.73
linked_order Order (FK) True False False True
main_order Order (FK) False False False False
Employee No default A single related resource. Can be either a URI or set of
No default
provided.
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: Department
URL: /resources/Department/?format=json
Default Limit: 20
FIELDS
Ordering
Name
id
Name
GET
POST
Name
GET
POST
Resource: Device
URL: /resources/Device/?format=json
Default Limit: 0
FIELDS
Read
Only
No
user_pswd String default True False False False Unicode string data. Ex: "Hello World"
provided.
scale_measurement_unit Integer 0 False False False True Integer data. Ex: 2673
swipe_type Integer 0 False False False True Integer data. Ex: 2673
bumpbar_type Integer 0 False False False True Integer data. Ex: 2673
third_party_id String True False False False Unicode string data. Ex: "Hello World"
No
printer_language Integer default True False False False Integer data. Ex: 2673
provided.
No
device_type Integer default False False False False Integer data. Ex: 2673
provided.
No
printer_type Integer default True False False False Integer data. Ex: 2673
provided.
barcode_scanner_type Integer 0 True False False False Integer data. Ex: 2673
No
printer_encoding String default False True False False Unicode string data. Ex: "Hello World"
provided.
No
printer_pos_or_items Integer default True False False False Integer data. Ex: 2673
provided.
uuid UUID False False True True 550e8400-e29b-41d4-a716-
446655440000
No Many related resources. Can be
delegated_printers Device (FK) default True True False True either a list of URIs or list of
provided. individually nested resource data.
No
port Integer default True False False False Integer data. Ex: 2673
provided.
platform String False False False True Unicode string data. Ex: "Hello World"
No
version String default True False False False Unicode string data. Ex: "Hello World"
provided.
No A single related resource. Can be

establishment Establishment (FK) default True False False True either a URI or set of nested resource
provided. data.
printer_expo Boolean False False False False True Boolean data. Ex: True
label_template PosTemplate (FK) default True False False True either a URI or set of nested resource
provided. data.
No
printer_model Integer default True False False False Integer data. Ex: 2673
provided.
DeviceExtraParameters
deviceextraparameters default False False False False either a list of URIs or list of
(FK)
No
user_code String default True False False False Unicode string data. Ex: "Hello World"
provided.
printer_template PosTemplate (FK) default True False False True either a URI or set of nested resource
provided. data.
rfid_reader_type Integer 0 False False False True Integer data. Ex: 2673
fire_course_template PosTemplate (FK) default True False False True either a URI or set of nested resource
provided. data.
No
ip_address String default True False False False Unicode string data. Ex: "Hello World"
provided.
scale_type Integer 0 False False False True Integer data. Ex: 2673
No
name String default False False False False Unicode string data. Ex: "Hello World"
provided.
mac String False False False True Unicode string data. Ex: "Hello World"
kitchen_flow_views Device (FK) default True True False True either a list of URIs or list of
void_receipt_template PosTemplate (FK) default True False False True either a URI or set of nested resource
provided. data.
bumpbar_orientation Integer 0 False False False True Integer data. Ex: 2673

gift_receipt_template PosTemplate (FK) default True False False True either a URI or set of nested resource
provided. data.
No
resource_uri String default False True False False Unicode string data. Ex: "Hello World"
provided.
Filtering
Name
printer_pos_or_items
uuid
establishment
device_type
active
ip_address
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: DeviceExtraParameters
URL: /resources/DeviceExtraParameters/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
No default
value String False False False False Unicode string data. Ex: "Hello World"
provided.
Device No default A single related resource. Can be either a URI or set of
No default
provided.
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: DeviceView
URL: /resources/DeviceView/?format=json
Default Limit: 0
FIELDS
Read
Only
No default
user_pswd String True False False False Unicode string data. Ex: "Hello World"
provided.
scale_measurement_unit Integer 0 False False False True Integer data. Ex: 2673
swipe_type Integer 0 False False False True Integer data. Ex: 2673
bumpbar_type Integer 0 False False False True Integer data. Ex: 2673
No default
printer_language Integer True False False False Integer data. Ex: 2673
provided.
No default
device_type Integer False False False False Integer data. Ex: 2673
provided.
No default
printer_type Integer True False False False Integer data. Ex: 2673
provided.
barcode_scanner_type Integer 0 True False False False Integer data. Ex: 2673
printer_encoding Integer 1 False False False True Integer data. Ex: 2673
No default
printer_pos_or_items Integer True False False False Integer data. Ex: 2673
provided.
446655440000
No default
port Integer True False False False Integer data. Ex: 2673
provided.
platform String False False False True Unicode string data. Ex: "Hello World"
No default
version String True False False False Unicode string data. Ex: "Hello World"
provided.
establishment True False False True
printer_expo Boolean False False False False True Boolean data. Ex: True
No default
printer_model Integer True False False False Integer data. Ex: 2673
provided.
mac String False False False True Unicode string data. Ex: "Hello World"
rfid_reader_type Integer 0 False False False True Integer data. Ex: 2673
No default
ip_address String True False False False Unicode string data. Ex: "Hello World"
provided.
scale_type Integer 0 False False False True Integer data. Ex: 2673
No default
provided.
No default
user_code String True False False False Unicode string data. Ex: "Hello World"
provided.
bumpbar_orientation Integer 0 False False False True Integer data. Ex: 2673
No default
provided.
Filtering
Name
name
Ordering
Name
id
Name
GET
Name
GET
Resource: Discount
URL: /resources/Discount/?format=json
Default Limit: 20
FIELDS
Read
Only
old_taxed_flag Boolean False False False False True Boolean data. Ex: True
ProductGroup
volume_product_group default True False False True either a list of URIs or list of
(FK)
No
Fixed precision numeric data. Ex:
max_limit Decimal default True False False False
26.73
provided.
ModifierClass
volume_modifier_classes default True False False True either a list of URIs or list of
(FK)
ModifierClass
modifier_classes default True False False True either a list of URIs or list of
(FK)
No
application_type Integer default False True False False Integer data. Ex: 2673
provided.
discount_function Integer 0 False False False False Integer data. Ex: 2673
auto_apply Boolean False False False False True Boolean data. Ex: True
how_often_apply Integer 0 False False False False Integer data. Ex: 2673
apply_to_entire_application_type Boolean False False False False True Boolean data. Ex: True
rewards_type Integer 0 True False False False Integer data. Ex: 2673
A date & time as a string. Ex: "2010-
11-10T03:07:43"

ProductClass either a list of URIs or list of
volume_product_class default True False False True
(FK) individually nested resource data.
provided.

volume_product Product (FK) default True False False True either a URI or set of nested resource
provided. data.
discount_at_item_level Boolean False False False False True Boolean data. Ex: True
apply_to_weighted_products Integer 0 False False False False Integer data. Ex: 2673
apply_to_base_product_only Boolean False False False False True Boolean data. Ex: True
Floating point numeric data. Ex:
points_needed_for_redemption Float 0.0 False False False True
26.73
No
dummy_pan String default True False False False Unicode string data. Ex: "Hello World"
provided.
No
maximum_off Float default True False False False
26.73
provided.
created_by User (FK) default False False False False either a URI or set of nested resource
provided. data.
No
min_limit Decimal default True False False False
26.73
provided.
No
loyalty_code String default True False False False Unicode string data. Ex: "Hello World"
provided.
No
scheme_code String default True False False False Unicode string data. Ex: "Hello World"
provided.
No
effective_to Datetime default True False False True
11-10T03:07:43"
provided.
Timetable
timetable default False True False True either a URI or set of nested resource
(FK)
provided. data.
No
default Integer data. Ex: 2673
stackable_discount_type Integer True False False False
provided.

ProductGroup
product_group default True False False True either a list of URIs or list of
(FK)
discount_code Boolean False False False False True Boolean data. Ex: True
minimum_amount_to_entire_order Boolean False False False False True Boolean data. Ex: True
product Product (FK) default True False False True either a URI or set of nested resource
provided. data.
updated_by User (FK) default False False False False either a URI or set of nested resource
provided. data.
password_required Boolean False False False False True Boolean data. Ex: True
tally Boolean False False False False True Boolean data. Ex: True
awarding Boolean False False False False True Boolean data. Ex: True
apply_reprice_to_sum_of_products Boolean False False False False True Boolean data. Ex: True
No
volume Integer default True False False False Integer data. Ex: 2673
provided.
No
discount_type Integer default False False False False Integer data. Ex: 2673
provided.
admin_key String True False False False Unicode string data. Ex: "Hello World"
qualification_subtype Integer 0 False False False False Integer data. Ex: 2673
No
effective_from Datetime default True False False True
11-10T03:07:43"
provided.
ProductClass
product_class default True False False True either a list of URIs or list of
(FK)
Establishment either a URI or set of nested resource
establishment default False False False False
(FK) data.
provided.
qualification_type Integer 0 False False False False Integer data. Ex: 2673
No
provided.
No
discount_amount Float default False False False False
26.73
provided.
apply_to_all_qualifying_products Boolean False False False False True Boolean data. Ex: True
No
name String default False False False False Unicode string data. Ex: "Hello World"
provided.
gift Product (FK) default True False False True either a URI or set of nested resource
provided. data.
product_from_each_cls_grp Boolean False False False False True Boolean data. Ex: True
is_variable Boolean False False False False True Boolean data. Ex: True
volume_type Integer 0 False False False False Integer data. Ex: 2673
No Price tier for AltPrice discounts.
alt_price_tier PriceTier (FK) default False False False True Defaults to the Alternative Price
provided. PriceTier.
No
weborder_name String default True False False False Unicode string data. Ex: "Hello World"
provided.
volume_modifier Modifier (FK) default True False False True either a URI or set of nested resource
provided. data.
is_wholesale Boolean False False False False True Boolean data. Ex: True
No
discount_method Integer default True False False False Integer data. Ex: 2673
provided.
No
minimum_amount Float default True False False False
26.73
provided.
display_on_ipad Boolean True False False False True Boolean data. Ex: True
modifier Modifier (FK) default True False False True either a URI or set of nested resource
provided. data.
No
dining_options String default True False False False Unicode string data. Ex: "Hello World"
provided.
11-10T03:07:43"
Filtering
Name
updated_date
loyalty_code
barcode
establishment
created_date
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: DiscountCode
URL: /resources/DiscountCode/?format=json
Default Limit: 20
FIELDS
Read
Only
used Boolean False False False False True Boolean data. Ex: True
discount Discount (FK) True False False True
No default
code String False False False False Unicode string data. Ex: "Hello World"
provided.
No default
provided.
No default
provided.
Filtering
Name
code
discount
used
establishment
type
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: DiscountLevel
URL: /resources/DiscountLevel/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
Brand No default A single related resource. Can be either a URI or set of
brand False False False False
No default
auto_apply Boolean False False False False Boolean data. Ex: True
provided.
Discount No default Many related resources. Can be either a list of URIs or list
discount True False False True
(FK) provided. of individually nested resource data.
No default
provided.
No default
provided.
Filtering
Name
brand
id
Ordering
Name
sorting
id
Name
GET
Name
GET
Resource: DisplayUnit
URL: /resources/DisplayUnit/?format=json
Default Limit: 20
FIELDS
Read
Only
DeviceView No default A single related resource. Can be either a URI or set
No default
provided.
Filtering
Name
device
Ordering
Name
id
Name
GET
PATCH
PUT
Name
GET
PATCH
PUT
Resource: DocumentStorage
URL: /resources/DocumentStorage/?format=json
Default Limit: 20
FIELDS
Read
Only
document_date Datetime False False False False
updated_at False False False False
created_by User (FK) True False False True
customer_tax_id String True False False False Unicode string data. Ex: "Hello World"
No default
total Float False False False False Floating point numeric data. Ex: 26.73
provided.
customer_name String True False False False Unicode string data. Ex: "Hello World"
e29b-41d4-a716-446655440000
No default
order_uuid String True False False False Unicode string data. Ex: "Hello World"
provided.
document_number String False False False False Unicode string data. Ex: "Hello World"
invalid Boolean False False False False True Boolean data. Ex: True
10T03:07:43"
establishment Establishment No default False False False False A single related resource. Can be either a URI

10T03:07:43"
updated_by User (FK) True False False True
No default
document_counter Integer False False False False Integer data. Ex: 2673
provided.
data String False False False False Unicode string data. Ex: "Hello World"
No default
doc_type Integer False False False False Integer data. Ex: 2673
provided.
created_at False False False False
10T03:07:43"
order Order (FK) True False False True
No default
provided.
Filtering
Name
updated_date
pos_station
customer_tax_id
id
document_date
doc_type
uuid
document_number
invalid
created_date
customer_name
establishment
order
Ordering
Name
updated_date
uuid
created_date
Name
GET
POST
PUT
Name
GET
POST
PUT
Resource: DynamicCombo
URL: /resources/DynamicCombo/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
provided.
No default
provided.
DynamicComboUpsell No default Many related resources. Can be either a list of
upsells True True False True
price Decimal 0.0 False False False False Fixed precision numeric data. Ex: 26.73
10T03:07:43"
establishment Establishment (FK) False False False False
No default
provided.
Filtering
Name
updated_date
establishment
Ordering
Name
id
Name
GET
Name
GET
Resource:
DynamicComboUpsellSlot
URL: /resources/DynamicComboUpsellSlot/?format=json
Default Limit: 20
FIELDS
Read
Only
Product No default A single related resource. Can be either a URI or set
default_product True True False True
10T03:07:43"
Product No default Many related resources. Can be either a list of URIs
product_substitutions True True False True
default_products True True False True
No default
name String False True False False Unicode string data. Ex: "Hello World"
provided.
No default
slot_id Integer False True False False Integer data. Ex: 2673
provided.
No default
combo_items List False False False False A list of data. Ex: ['abc', 26.73, 8]
provided.
10T03:07:43"
products True True False True
No default
provided.
products_price Decimal 0.0 False False False False Fixed precision numeric data. Ex: 26.73
No default
quantity Integer False True False False Integer data. Ex: 2673
provided.
substitutions_price Decimal 0.0 False False False False Fixed precision numeric data. Ex: 26.73
Ordering
Name
id
Name
GET
Name
GET
Resource: Employee
URL: /resources/Employee/?format=json
Default Limit: 20
FIELDS
Read
Only
employee_lastlogin Datetime True False False False
No default
last_name String False False False False Unicode string data. Ex: "Hello World"
provided.
10T03:07:43"
No default
pin String False False False False Unicode string data. Ex: "Hello World"
provided.
No default
employee_card String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
first_name String False False False False Unicode string data. Ex: "Hello World"
provided.
employee_start Datetime False False False False
exempt Boolean False False False False True Boolean data. Ex: True
No default
email String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
phone_number String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
picture String False True False False Unicode string data. Ex: "Hello World"
provided.
failed_login_attempts Integer 0 True False False False Integer data. Ex: 2673
password_history String True False False False Unicode string data. Ex: "Hello World"
user User (FK) True False False True
mileage_reimbursement Decimal 0.000000 True False False False Fixed precision numeric data. Ex: 26.73
employee_end Datetime True False False False
locked_account Boolean False False False False True Boolean data. Ex: True
No default
internal_empl_id String True False False False Internal Employee ID number
provided.
locked_account_timestamp Datetime True False False False
10T03:07:43"
TimeSheetEntry No default A single related resource. Can be either
last_timesheet_entry True True False True
No default
external_id String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
provided.
Filtering
Name
updated_date
last_timesheet_entry
created_date
id
user
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: EmployeeRoleEstablishment
URL: /resources/EmployeeRoleEstablishment/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
wage Float True False False False Floating point numeric data. Ex: 26.73
provided.
role Role (FK) False False False False
No default
provided.
Filtering
Name
establishment
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: EnablerFieldNameMapping
URL: /resources/EnablerFieldNameMapping/?format=json
Default Limit: 20
FIELDS
enabler_field_name String No default provided. False False False False Unicode string data. Ex: "Hello World"
resource_name String No default provided. False False False False Unicode string data. Ex: "Hello World"
field_name String No default provided. False False False False Unicode string data. Ex: "Hello World"
Ordering
Name
id
Name
GET
PUT
PATCH
Name
GET
PUT
PATCH
Resource: Establishment
URL: /enterprise/Establishment/?format=json
Default Limit: 200
FIELDS
Read
Only
No
Unicode string data. Ex: "Hello
web_reservations_key String default True False False False
World"
provided.
disabled_for_cancellation Boolean False False False False True Boolean data. Ex: True
No
site_number String default True False False False
World"
provided.
disabled_for_payment Boolean False False False False True Boolean data. Ex: True
export_type Integer 2 False False False False Integer data. Ex: 2673
A date & time as a string. Ex:
on_boarding_started_date Datetime None True False False False
"2010-11-10T03:07:43"
rti Boolean False False False False True Boolean data. Ex: True
on_boarding_required Boolean False False False False True Boolean data. Ex: True
time_zone String UTC False False False False
World"
currency Currency (FK) default True True False True either a URI or set of nested
provided. resource data.
information_verified Boolean False False False False True Boolean data. Ex: True
manager User (FK) default False False False False either a URI or set of nested
cancelable_by_billing Boolean True False False False True Boolean data. Ex: True
No
default Unicode string data. Ex: "Hello
about_title String True False False False
provided. World"

about_access_to_location String True False False False
World"
No
images List default True True False True A list of data. Ex: ['abc', 26.73, 8]
provided.
No
location_account_status String default True False False False
World"
provided.
contact_name String False False False True
World"
No
ns_internal_id String default True False False False
World"
provided.
No
retailer_id String default True False False False
World"
provided.
No
tax_payer_num String default True False False False
World"
provided.
No
location_name String default True False False False
World"
provided.
android_settings String {} False False False True
World"
effective_from Datetime No False False False False A date & time as a string. Ex:
default "2010-11-10T03:07:43"
provided.
ctuit Boolean False False False False True Boolean data. Ex: True
lock_add_modifierclass Integer 0 False False False False Integer data. Ex: 2673
created_by User (FK) default False False False False either a URI or set of nested
about_description String True False False False
World"
time_worked_available Boolean False False False False True Boolean data. Ex: True
disabled_backend_for_payment Boolean False False False False True Boolean data. Ex: True
Surcharge
surcharge default True False False True either a URI or set of nested
(FK)
No
disabled_backend_for_payment_date Datetime default True False False False
"2010-11-10T03:07:43"
provided.
email String False False False True
World"
No
sorting_id Integer default True False False False Integer data. Ex: 2673
provided.
phone String False False False True
World"
"2010-11-10T03:07:43"
No
store_number Integer default True False False False Integer data. Ex: 2673
provided.
No
fax String default True False False False
World"
provided.
type_of_service Integer 0 False False False False Integer data. Ex: 2673
show_payment_warning Boolean False False False False True Boolean data. Ex: True
updated_by User (FK) default False False False False either a URI or set of nested
billing_enabled Boolean False False False False True Boolean data. Ex: True
tax ViewTax (FK) default False False False False either a list of URIs or list of
brand Brand (FK) default False False False False either a URI or set of nested
on_boarding_completed Boolean False False False False True Boolean data. Ex: True
RevelImage
logo_img default True False False True either a URI or set of nested
(FK)
matrix_inventory Boolean False False False False True Boolean data. Ex: True
address Address (FK) default False False False False either a URI or set of nested
show_backend_payment_warning Boolean False False False False True Boolean data. Ex: True
lock_add_category Integer 0 False False False False Integer data. Ex: 2673
No
logo_url_legacy String default True False False False
World"
provided.
No
effective_to Datetime default True False False False
"2010-11-10T03:07:43"
provided.
delivery_management Boolean False False False False True Boolean data. Ex: True
lock_add_discount Boolean False False False False True Boolean data. Ex: True
No
name String default False False False False
World"
provided.
No
display_unit_bg_url String default True False False False
provided. World"
SystemSetting
settings default False False False False either a URI or set of nested
(FK)
World"
No
kiosk_image_url_legacy String default True False False False
World"
provided.
vip Boolean False False False False True Boolean data. Ex: True
No
location_email String default True False False False
World"
provided.
on_boarding_completed_date Datetime None True False False False
"2010-11-10T03:07:43"
cancellation_date Datetime None True False False False
"2010-11-10T03:07:43"
No
client_type Integer default False True False False Integer data. Ex: 2673
provided.
sc_cert Boolean False False False False True Boolean data. Ex: True

"2010-11-10T03:07:43"
SocialNetwork
social_networks default False False False False either a list of URIs or list of
(FK)
No
World"
provided.
payment_gateway Integer 0 False False False False Integer data. Ex: 2673
quick_books Integer 0 False False False False Integer data. Ex: 2673
Filtering
Name
brand
id
Ordering
Name
id
Name
GET
PUT
PATCH
Name
GET
PUT
PATCH
Resource:
EstablishmentImage
URL: /resources/EstablishmentImage/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: EstablishmentTag
URL: /resources/EstablishmentTag/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
No default
provided.
Filtering
Name
establishment
name
Ordering
Name
id
Name
GET
POST
PATCH
DELETE
Name
GET
POST
PATCH
DELETE
Resource:
EventDate
URL: /resources/EventDate/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
date Datetime False False False False A date & time as a string. Ex: "2010-11-10T03:07:43"
provided.
No default
provided.
EventInfo No default A single related resource. Can be either a URI or set of
event_info False False False False
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
EventInfo
URL: /resources/EventInfo/?format=json
Default Limit: 20
FIELDS
Read
Only
EventDate No default Many related resources. Can be either a list of URIs or
dates False True False False
event_type Integer 0 True False False False Integer data. Ex: 2673
No default
provided.
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
EventInventory
URL: /resources/EventInventory/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
starting_amount Integer False False False False Integer data. Ex: 2673
provided.
No default
actual_amount Integer True False False False Integer data. Ex: 2673
provided.
screen Modifier (FK) False False False False
No default
sales Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
ProductCategory No default A single related resource. Can be either a URI
event False False False False
No default
sold_amount Integer False False False False Integer data. Ex: 2673
provided.
time Modifier (FK) False False False False
No default
provided.
Filtering
Name
date
screen
establishment
event
time
Ordering
Name
id
Name
GET
POST
PUT
PATCH

Name
GET
POST
PUT
PATCH
Resource: FiscalReport
URL: /resources/FiscalReport/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
name String False False True False Unicode string data. Ex: "Hello World"
provided.
PosStation No default A single related resource. Can be either a URI or set of
report String False False False False
Establishment No default A single related resource. Can be either a URI or set of
No default
provided.
Filtering
Name
pos_station
establishment
id
created_date
Ordering
Name
id
Name
GET
Name
GET
POST
Resource: ForecourtData
URL: /resources/ForecourtData/?format=json
Default Limit: 20
FIELDS
Read
Only
is_synced Boolean False False False False True Boolean data. Ex: True
Controls the facility to block
block_hose_by_grade_allowed Boolean False False False False True grades. If set to true, the ability to
block grades is active at this site.
The time in seconds that the pump
remains locked out after the
prepay refund is taken by the
No customer. The actual timeout is
prepay_taken_timeout Integer default True False False False this value less the time that the
provided. prepay refund was on the pump
before the customer took it. The
purpose of this timeout is to
prevent operator fraud.
The time in seconds that a delivery
No will remain before being
monitor_timeout Integer default True False False False automatically cleared as a Monitor
provided. delivery (if Monitor deliveries are
enabled).
Only this station will communicate
No
PosStation with Forecourt Controller in order
forecourt_configuration_station default True False False False
(FK) to change configuration and
provided.
update fuel prices
Site-wide threshold for
No discrepancies in electronic totals.
minimum_e_total_difference Decimal default True False False False Discrepancies over this limit are
provided. logged by Pump Server as an
`offline delivery` record.
The time that a compulsory
No authorise pump will remain
authorise_timeout Integer default True False False False authorised after being authorised
provided. by an operator without the
customer starting a delivery.
No Determines if calculated blend
price_calc_round_type Integer default True False False False prices are rounded or truncated: 0
provided. = Round 1 = Truncate
The maximum time (seconds) that
a pump remains authorised for a
No Preauth delivery without starting
preauth_authorise_timeout Integer default True False False False the delivery. When the timeout is
provided. reached the reserve on the pump
is removed, and the pump returns
to the locked state.
Is the attendant mode supported
attendant_allowed Boolean False False False False True
on this site. false = no true = yes
If enabled, an approval is required
approval_for_fuel_recon_mode Boolean False False False False True before publishing Fuel
Reconciliation Data.
No
The regular backup time to run the
backup_time String default True False False False
backup script.
provided.
Indicates if Enabler is currently
using Pump Based or Profile Based
price level configuration. Setting to
zero means Pump Based which is
the Enablers existing behaviour
price_level_control_mode Boolean False False False False True
prior to version 3.40.8. Set this
field to 1 for Profile Based price
level control - this ignores any
price levels configured in the
Pumps table.
If a pump is delivering and goes to
not responding state, if the pump
is still not responding after this
No timeout expires a delivery will
delivery_not_responding_timeout Integer default True False False False automatically be created from the
provided. most recent running total. Set to 0
to disable. It is recommended that
this field is left at the default of
zero.
The maximum time in seconds
that a pump will remain authorised
for a prepay delivery without
No
starting the delivery. If this timeout
prepay_authorise_timeout Integer default True False False False
is reached the reserve on the
provided.
pump is removed, and a prepay
refund delivery for the total
amount is generated.
Determines whether Attendant
Tagging features are active in
attendant_tagging_mode Boolean False False False False True
configuration and pump server
operation.
This determines whether the
detection of a tanker delivery will
automatically disable/enable a
tank. If true, tanks will be
block_tank_on_tank_delivery_mode Boolean False False False False True automatically disabled when a
tanker delivery is detected, and
enabled when the delivery stops
(and the `Low Level` alarm is not
active).
Automatically clearing attendant
deliveries - if you need to generate
transactions in your audit trail for
clear_attendant_deliveries_mode Boolean False False False False True
attendant deliveries, you can set
this to true. When you do this your
application becomes responsible
for clearing attendant deliveries.
The timeout in seconds that a
prepay refund locks out the pump.
Default value 180 ie. three
No minutes. During this time the
prepay_refund_timeout Integer default True False False False customer is able to return to the
provided. shop and retrieve their refund
after this the refund is cleared
automatically from the pump and
the pump is released.

Establishment
establishment default False False False False either a URI or set of nested
(FK)
Reserved for future use - will
No determine whether Fuel
recon_export_mandatory_mode Integer default True False False False Reconciliation can exit with a
provided. reconciled period that has not yet
been exported.
No The number of days to retain tank
tank_deliveries_keep_days Integer default True False False False deliveries, in the tank_deliveries
provided. table.
updated Datetime True False False False True
"2010-11-10T03:07:43"
Where Enabler calculates prices
No
for blended, this site setting
price_calc_decimals Integer default True False False False
indicates the number of decimals
provided.
for the resulting prices.
Does the Fuel Reconciliation
Application require/permit the
pump_meters_allowed Boolean False False False False True
entry of the pump mechanical
meter reads.
Time in seconds that a Pump
No Reserve remains in place. After
reserve_timeout Integer default True False False False this timeout the Reserve will be
provided. cancelled and events fired to
connected terminals.
Reserved for future
implementation. This field will set
the style of Prepay Refund
calculations. The value zero
indicates that the standard
calculation method is to be used,
No this is the most compatible with
prepay_refund_type Integer default True False False False existing applications making use of
provided. the EnbPumpX. 1 indicates that
the new method of calculation is
used. Consult the Programmers
Reference for information on how
this affects the use of Enabler
ActiveX controls.
Indicates if Enabler will create an

offline_delivery_mode Boolean False False False False True `Offline Delivery` record for
changes in pump meters.
Indicates whether Fuel
recon_edits_allowed Boolean False False False False True Reconciliation allows edits to
already reconciled periods.
No
The number of days to keep closed
attendant_keep_days Integer default True False False False
attendant periods on the system.
provided.
Automatically performing
auto_mode_change Boolean False False False False True switching between Mode Profiles
based on the Start/End and Valid
days settings.
This determines whether tanks can
be blocked and unblocked. if true,
block_hose_by_tank_allowed Boolean False False False False True
tanks can be blocked and
unblocked.
No
Reserved for future use - exporting
recon_export_type Integer default True False False False
of Fuel Reconciliation data.
provided.
No
The number of days to retain
events_keep_days Integer default True False False False
events in the events journal.
provided.
The maximum number of seconds
No of age for an unpaid delivery
not_taken_timeout Integer default True False False False before it is displayed in red
provided. indicating that this is a possible
drive off.
Determines whether Enabler
automatically calculates post mix
auto_post_mix_price_mode Boolean False False False False True
pricing using pricing for base
grades. When set blend prices
may not be set directly.
The maximum time in seconds of a
No
hose being out and idle before the
fuelling_timeout Integer default True False False False
pump goes into hose_left_out
provided.
state.
Stores the current state of
`Fallback` mode based on other
No
configurations. This facility allows
fallback_mode Integer default True False False False
Pump Server to automatically
provided.
authorise pumps if all client
applications go offline.
Indicates which report format Fuel
No Reconciliation should use when
recon_report_type Integer default True False False False viewing and printing
provided. reconciliations. Defaults to 2 (Daily
Tank Reconciliation Report).
A short name used by the system
operator to identify the site. It will
No
be automatically generated if not
name String default True False False False
provided during configuration. The
provided.
field should have minimum length
of 5 chars and maximum of 40.
Maximum number of backup files
to keep. The backup files archive
set is automatically maintained by
No the backup script. The backup
backup_file_count Integer default True False False False script will delete all but the n
provided. newest files that match the
pattern "Enabler_*.dmp", where
`n` represents the number of
backup files.
No
created Datetime default True False False False
"2010-11-10T03:07:43"
provided.
This determines whether the `Low
Level` alarm from a tank gauge
will automatically disable/enable a
tank. If true, tanks will be
block_tank_on_low_level_alarm_mode Boolean False False False False True automatically disabled when the
`Low Level` alarm is detected, and
enabled when the alarm is off (and
no tanker delivery is in progress).
This extends disabling of hoses to

stopping deliveries already in
progress. If true, when a hose is
disabled (e.g. the cashier blocks a
grade that the hose delivers), any
block_hose_during_delivery_mode Boolean False False False False True delivery in progress at that hose id
immediately stopped. If false,
prevents authorisation of any new
delivery attempts but do not
interrupt any deliveries already in
progress.
No
last_sync Datetime default True False False False
"2010-11-10T03:07:43"
provided.
If set to true, used by Fuel
Reconciliation to allow Test
test_delivery_mode Boolean False False False False True
Deliveries to be mapped to Tank
Transfers.
If enabled, Pump Server will use
hose_turnover_mode Boolean False False False False True Hose Turnover fields. By default is
enabled.
No
World"
provided.
tank_drops_allowed Boolean False False False False True Application require/permit the
entry of tank drops.
tank_dips_allowed Boolean False False False False True Application require/permit the
entry of manual tank dips.
Filtering
Name
updated
establishment
Ordering
Name
id
Name
GET
PUT
POST
Name
GET
PUT
POST
Resource: FuelPriceAcknowledgement
URL: /resources/FuelPriceAcknowledgement/?format=json
Default Limit: 20
FIELDS
Read
Only
ProductPriceLifeCycleAction No default A single related resource. Can be either a
pplc True False False True
No default
uuid UUID False False True False 550e8400-e29b-41d4-a716-
provided.
446655440000
timestamp Datetime False False False False
No default
price Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
provided.
Ordering
Name
id
Name
POST
Name
POST
Resource:
GiftCard
URL: /resources/GiftCard/?format=json
Default Limit: 20
FIELDS
Read
Only
customer True False False True
initial_value Float 0.0 False False False False Floating point numeric data. Ex: 26.73
Address No default A single related resource. Can be either a URI or
address True False False True
No default
number String False False False False Unicode string data. Ex: "Hello World"
provided.
card_type Integer 0 False False False False Type of the gift card: 0 - Regular, 1 - ENT
No default
remaining_balance Float True False False False Floating point numeric data. Ex: 26.73
provided.
No default
payment_type Integer False False False False Integer data. Ex: 2673
provided.
No default
provided.
Filtering
Name
customer
updated_date
created_date
id
number
Ordering
Name
id
Name
GET
POST
PUT

Name
GET
POST
PUT
Resource: GiftCardLog
URL: /resources/GiftCardLog/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
type_of_change String False False False False Unicode string data. Ex: "Hello World"
provided.
gift_card GiftCard (FK) True False False True
No default
order_local_id String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
provided.
10T03:07:43"
from_gift_card_flow Boolean False False False False True Boolean data. Ex: True
No default
provided.
Filtering
Name
updated_date
gift_card
order
created_date
establishment
card_number
Ordering
Name
id
Name
GET
POST
PUT
Name
GET
POST
PUT
Resource: Grades
URL: /resources/Grades/?format=json
Default Limit: 20
FIELDS
Read
Only
description String True False False False Unicode string data. Ex: "Hello World"
No default
minimum_price Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
grade_type Integer 1 False False False False Integer data. Ex: 2673
No default
price_profile_id Integer True False False False Integer data. Ex: 2673
provided.
enabled Boolean True False False False True Boolean data. Ex: True
10T03:07:43"
created Datetime True False False False
No default
price Float True False False False Floating point numeric data. Ex: 26.73
provided.
No default
provided.
No default
maximum_price Decimal provided. True False False False Fixed precision numeric data. Ex: 26.73

last_sync Datetime True False False False
No default
external_id Integer True False False False Integer data. Ex: 2673
provided.
No default
provided.
Filtering
Name
establishment
Ordering
Name
id
Name
GET
PUT
PATCH
Name
GET
PUT
PATCH
Resource: HelpArticle
URL: /resources/HelpArticle/?format=json
Default Limit: 20
FIELDS
Read
Only
body String None True False False False Unicode string data. Ex: "Hello World"
title String None True False False False Unicode string data. Ex: "Hello World"
HelpLabel No default Many related resources. Can be either a list of URIs or
labels True False False True
article_type Integer 0 False False False False Integer data. Ex: 2673
No default
zen_article_id String False False True False Unicode string data. Ex: "Hello World"
provided.
No default
provided.
Filtering
Name
active
updated_date
labels
article_type
created_date
Ordering
Name
id
Name
GET
Name
GET
Resource: HelpLabel
URL: /resources/HelpLabel/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
name String None True False True False Unicode string data. Ex: "Hello World"
No default
zen_label_id String False False True False Unicode string data. Ex: "Hello World"
provided.
10T03:07:43"
No default
provided.
Filtering
Name
id
name
Ordering
Name
id
Name
GET
Name
GET
Resource: HoseLogs
URL: /resources/HoseLogs/?format=json
Default Limit: 20
FIELDS
Read
Only
No
A single related resource. Can be either a URI or
grade Grades (FK) default True True False True
set of nested resource data.
provided.
No
calc_tank_vol Decimal default False True False False Fixed precision numeric data. Ex: 26.73
provided.
No
volume_delta Decimal default True False False False Volume change per transaction
provided.
No
uuid UUID default True False True False
41d4-a716-446655440000
provided.
No
created_by User (FK) default True False False True
provided.
note String None True False False False Custom notes for the event
No
pump Pumps (FK) default True False False True
provided.
No
approved_by User (FK) default True False False True
provided.
No
Establishment A single related resource. Can be either a URI or
(FK) set of nested resource data.
provided.
10T03:07:43"
No
hose Hoses (FK) default True False False True A single related resource. Can be either a URI or
No
created_date_manual Datetime default True False False False
10T03:07:43"
provided.
No
measured_tank_vol Decimal default True False False False Measured fuel volume in tank
provided.
No
hose_meter Decimal default True False False False Fuel amount dispensed as on meter counter
provided.
No
Deliveries A single related resource. Can be either a URI or
delivery default True False False True
provided.
No
tank Tanks (FK) default True False False True
provided.
Available choices: (0, Sale), (1, Pump Test), (2, End
Of Day Adjustment), (3, Manual Adjustment), (4,
No
Delivery), (5, Tank Readings), (6, Tank Transfer),
type Integer default False False False False
(7, Pump Test Return), (8, Pump Meter Reading),
provided.
(9, Delivery Edit), (10, Drive Off Incident), (11, ATG
Data)
No
PosStation A single related resource. Can be either a URI or
created_at default True False False True
provided.
No
calc_hose_meter Decimal default True False False False Calculated hose meter data
provided.
10T03:07:43"
No
provided.
Ordering
Name
id
Name
GET
POST
Name
GET
POST
Resource: Hoses
URL: /resources/Hoses/?format=json
Default Limit: 20
FIELDS
Read
Only
updated Datetime True False False False True A date & time as a string. Ex: "2010-11-10T03:07:43"
Tanks No default A single related resource. Can be either a URI or set of
tank False False False False
No default
created Datetime True False False False A date & time as a string. Ex: "2010-11-10T03:07:43"
provided.
No default
number Integer False False False False Integer data. Ex: 2673
provided.
No default
last_sync Datetime True False False False A date & time as a string. Ex: "2010-11-10T03:07:43"
provided.
Pumps No default A single related resource. Can be either a URI or set of
pump False False False False
No default
provided.
No default
provided.
Ordering
Name
id
Name
GET
PUT
PATCH
Name
GET
PUT
PATCH
Resource: HouseAccount
URL: /resources/HouseAccount/?format=json
Default Limit: 20
FIELDS
Read
Only
customer False True False False
10T03:07:43"
No default
max_limit Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
enabled Boolean False False False False True Boolean data. Ex: True
10T03:07:43"
No default
balance Decimal False True False False Fixed precision numeric data. Ex: 26.73
provided.
establishment False True False False
No default
provided.
Filtering
Name
customer
establishment
Ordering
Name
id
Name
GET
PUT
PATCH
Name
GET
Resource:
HouseAccountPayment
URL: /resources/HouseAccountPayment/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
exchanged Boolean True False False False Boolean data. Ex: True
provided.
No default
executed Boolean True False False False Boolean data. Ex: True
provided.
is_billed Boolean False False False False False Boolean data. Ex: True
No default
last_4_cc_digits String False False False False Unicode string data. Ex: "Hello World"
provided.
transaction_status Integer None True False False False Integer data. Ex: 2673
payment_date Datetime False False False False
provided. e29b-41d4-a716-446655440000
No default
gratuity Float True False False False Floating point numeric data. Ex: 26.73
provided.
No default
tip Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
processor_accepted Boolean True False False False Boolean data. Ex: True
provided.
refund_transaction_id String None True False False False Unicode string data. Ex: "Hello World"
cc_first_name String None True False False False Unicode string data. Ex: "Hello World"
online Boolean False False False False True Boolean data. Ex: True
No default
customer_id Integer True False False False Integer data. Ex: 2673
provided.
No default
transaction_id String False False False False Unicode string data. Ex: "Hello World"
provided.
No default
transaction_captured Boolean True False False False Boolean data. Ex: True
provided.
No default
deleted Boolean True False False False Boolean data. Ex: True
provided.
refunded Boolean False True False False False Boolean data. Ex: True
transaction_data String True False False False Unicode string data. Ex: "Hello World"
No default
payer_id Integer True False False False Integer data. Ex: 2673
provided.
No default
provided.
source_type Integer 1 False False False False Integer data. Ex: 2673
processor_response String None True False False False Unicode string data. Ex: "Hello World"
first_4_cc_digits String None True False False False Unicode string data. Ex: "Hello World"
No default
amount_authorized Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
signature_img_url String None True False False False Unicode string data. Ex: "Hello World"
change Decimal 0 False False False False Fixed precision numeric data. Ex: 26.73
invoice_transition_date Datetime None True False False False
10T03:07:43"
No default
receipt_email String True False False False Unicode string data. Ex: "Hello World"
provided.
is_paid Boolean False False False False False Boolean data. Ex: True
bill Integer 0 False False False False Integer data. Ex: 2673
No default
card_type Integer True False False False Integer data. Ex: 2673
provided.
No default
provided.
No default
provided.
cc_last_name String None True False False False Unicode string data. Ex: "Hello World"
rounding_delta Float None True False False False Floating point numeric data. Ex: 26.73
No default
provided.
Filtering
Name
customer
updated_date
uuid
is_billed
created_date
is_paid
establishment
order
Ordering
Name
id
Name
GET
PUT
PATCH
Name
GET
Resource:
HouseAccountTransaction
URL: /resources/HouseAccountTransaction/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
applied Boolean False False False False True Boolean data. Ex: True
HouseAccount No default A single related resource. Can be either a URI or
house_account True True False True
No default
source Integer False False False False Integer data. Ex: 2673
provided.
apply_type Integer 1 False False False False Integer data. Ex: 2673
No default
provided.
customer Customer (FK) False False False False
action_date Datetime False False False False
No default
end_balance Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
10T03:07:43"
No default
applied_amount Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
balance Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
provided.
payment Payment (FK) True True False True
No default
provided.
Filtering
Name
customer
applied
establishment
house_account
source
type
payment
Ordering
Name
id
Name
GET
Name
GET
Resource: Ingredient
URL: /resources/Ingredient/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
bin_value String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
barcode String True False False False Unicode string data. Ex: "Hello World"
provided.
track_in_inventory Boolean True False False False True Boolean data. Ex: True
No default
provided.
default_inventory Boolean False False False False True Boolean data. Ex: True
10T03:07:43"
No default
provided.
unit_type UnitType (FK) False False False False
No default
cost Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
IngredientInventory No default A single related resource. Can be either a
inventory True True False True
sku String True False False False Unicode string data. Ex: "Hello World"
prep_recipe Boolean False False False False True Boolean data. Ex: True
No default
provided.
No default
prep_yield Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
Filtering
Name
sku
updated_date
name
track_in_inventory
default_inventory
active
barcode
establishment
created_date
Ordering
Name
sort
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: IngredientInventory
URL: /resources/IngredientInventory/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
waste_loss_variance String True True False False Unicode string data. Ex: "Hello World"
provided.
No default
actual_amount Decimal True False False False Actual stock amount
provided.
added_amount Decimal 0 False False False False Added to stock since business start
No default
theoretical_ending_inventory String True True False False Unicode string data. Ex: "Hello World"
provided.
threshold Decimal 0 False False False False Fixed precision numeric data. Ex: 26.73
sold_amount Decimal 0 False False False False Sold from stock since business start
starting_amount Decimal 0 False False False False Stock amount on business start
No default
waste_loss_percentage String True True False False Unicode string data. Ex: "Hello World"
provided.
Ingredient No default A single related resource. Can be either a
ingredient False False False False
No default
provided.
Filtering
Name
updated_date
id
ingredient
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
IngredientPurchase
URL: /resources/IngredientPurchase/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
provided.
No default
provided.
No default
provided.
10T03:07:43"
No default
provided.
No default
cost Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
provided.
No default
provided.
establishment Establishment (FK) True False False True
ProductPurchaseOrderItem No default
orderitems True False False False list of URIs or list of individually nested
(FK) provided.
resource data.
Filtering
Name
barcode
establishment
id
Ordering
Name
id
Name
GET
Name
GET
Resource: IngredientRecipe
URL: /resources/IngredientRecipe/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
10T03:07:43"
Product No default A single related resource. Can be either a URI or
product True False False True
Ingredient No default A single related resource. Can be either a URI or
ingredient True False False True
10T03:07:43"
Ingredient No default A single related resource. Can be either a URI or
main_ingredient False False False False
No default
provided.
No default
quantity Float provided. False False False False Floating point numeric data. Ex: 26.73
Filtering
Name
main_ingredient
product
ingredient
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
InterfacesDashboard
URL: /resources/InterfacesDashboard/?format=json
Default Limit: 20
FIELDS
Read
Only
last_call_failed Datetime True False False False
last_call_success Datetime True False False False
No default
provided.
No default
provided.
Filtering
Name
establishment
Ordering
Name
type
Name
PATCH
PUT
Name
PATCH
GET
Resource: Inventory
URL: /resources/Inventory/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
waste_loss_variance String True True False False Unicode string data. Ex: "Hello World"
provided.
Product No default A single related resource. Can be either a
No default
actual_amount Decimal True False False False Actual stock amount
provided.
No default
added_amount Decimal False False False False Added to stock since business start
provided.
No default
theoretical_ending_inventory String True True False False Unicode string data. Ex: "Hello World"
provided.
No default
threshold Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
sold_amount Decimal False False False False Sold from stock since business start
provided.
No default
starting_amount Decimal False False False False Stock amount on business start
provided.
No default
waste_loss_percentage String True True False False Unicode string data. Ex: "Hello World"
provided.
No default
provided.
Filtering
Name
updated_date
product
id
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
InventoryReceipt
URL: /resources/InventoryReceipt/?format=json
Default Limit: 20
FIELDS
Read
Only
serial_numbers String False False False True Unicode string data. Ex: "Hello World"
A single related resource. Can be
No default
product Product (FK) True False False True either a URI or set of nested resource
provided.
data.
tax_rate Decimal 0.0000 False False False False
26.73
vendor_item_id String False False False True Unicode string data. Ex: "Hello World"
No default
inventory_unit String False False False False Unicode string data. Ex: "Hello World"
provided.
PurchaseOrderInvoice No default
purchase_order_invoice True False False True either a URI or set of nested resource
(FK) provided.
data.
No default Fixed precision numeric data. Ex:
reorder_quantity Decimal False False False False
provided. 26.73
conversion_factor Decimal False True False False
provided. 26.73
inventory_quantity Decimal False False False False
provided. 26.73
No default
purchase_order PurchaseOrder (FK) False False False False either a URI or set of nested resource
provided.
data.
cost Decimal False False False False
provided. 26.73
No default
reorder_unit_type InventoryUnit (FK) True False False True either a URI or set of nested resource
provided.
data.
11-10T03:07:43"
No default
reorder_unit String False True False False Unicode string data. Ex: "Hello World"
provided.
No default
provided.
No default
ingredient Ingredient (FK) True False False True either a URI or set of nested resource
provided.
data.
Filtering
Name
purchase_order
created_date
product
ingredient
Ordering
Name
id
Name
GET
POST
PATCH
PUT
Name
GET
POST
PATCH
PUT
Resource: InventoryStockAmount
URL: /resources/InventoryStockAmount/?format=json
Default Limit: 20
FIELDS
stock_amount Decimal No default provided. False True False False Fixed precision numeric data. Ex: 26.73
establishment_id Integer No default provided. False True False False Integer data. Ex: 2673
establishment_name String No default provided. False True False False Unicode string data. Ex: "Hello World"
Name
GET
Name
GET
Resource: InventoryUnit
URL: /resources/InventoryUnit/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
Ingredient No default A single related resource. Can be either a URI or set
ingredient False False False False
No default
provided.
No default
conversion Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
key String False False False False Unicode string data. Ex: "Hello World"
provided.
No default
qty_in_units Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
provided.
primary_unit Boolean False False False False True Boolean data. Ex: True
Filtering
Name
updated_date
product
active
ingredient
establishment
primary_unit
Ordering
Name
updated_date
id
Name
GET
Name
GET
Resource: ItemTrackingReport
URL: /resources/ItemTrackingReport/?format=json
Default Limit: 20
FIELDS
Read
Only
reports Dict False False False False
provided. 'Daniel'}
Filtering
Name
day
Name
GET
Name
Resource: ItemTrackingReportV2
URL: /resources/ItemTrackingReportV2/?format=json
Default Limit: 20
FIELDS
Read
Only
reports Dict False False False False
provided. 'Daniel'}
Filtering
Name
day
Name
GET
Name
Resource: ItemTrackingSet
URL: /resources/ItemTrackingSet/?format=json
Default Limit: 20
FIELDS
Read
Only
11-10T03:07:43"
safety_factor String False False False True Unicode string data. Ex: "Hello World"
opening_report_sections Integer 0 False False False False Integer data. Ex: 2673
sorting Integer 1 False False False False Integer data. Ex: 2673
No default
provided.
Establishment No default
establishment False False False False either a URI or set of nested resource
(FK) provided.
data.
No default
tracking_frequency Integer False False False False Integer data. Ex: 2673
provided.
11-10T03:07:43"
backend_report_sections Integer 0 False False False False Integer data. Ex: 2673
closing_report_sections Integer 0 False False False False Integer data. Ex: 2673
interval_report_sections Integer 0 False False False False Integer data. Ex: 2673
preparation_time_multiplier Integer 1 False False False False Integer data. Ex: 2673
last_prep_delta_before_closing Integer 0 False False False False Integer data. Ex: 2673
decimals Integer 0 False False False False Integer data. Ex: 2673
display_prep_column Boolean False False False False True Boolean data. Ex: True
No default
provided.
Filtering
Name
active
establishment
id
Ordering
Name
id
Name
GET
Name
GET
Resource: ItemTrackingSetProduct
URL: /resources/ItemTrackingSetProduct/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
ItemTrackingSet No default A single related resource. Can be either a
itemtrackingset False False False False
10T03:07:43"
No default
conversion_quantity Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
provided.
Filtering
Name
product
Ordering
Name
id
Name
GET
Name
GET
Resource: KitchenProduct
URL: /resources/KitchenProduct/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
kitchen_time Datetime False False False False A date & time as a string. Ex: "2010-11-10T03:07:43"
provided.
No default
start_time Datetime False False False False A date & time as a string. Ex: "2010-11-10T03:07:43"
provided.
No default
expedite_time Datetime False False False False A date & time as a string. Ex: "2010-11-10T03:07:43"
provided.
No default
provided.
Filtering
Name
product
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: KitchenView
URL: /resources/KitchenView/?format=json
Default Limit: 20
FIELDS
Read
Only
No
kitchen_print_ip String default True True False True
"Hello World"
provided.
display_call_number Boolean False False False False True Boolean data. Ex: True
passcode_protection Boolean True False False False True Boolean data. Ex: True
12:10 A time as string. Ex:
yellow_timer_fire_delay Time False False False False
a.m. "20:05:23"
kitchen_group_by Integer 0 False False False False Integer data. Ex: 2673
No
expedite_print_ip String default True True False True
"Hello World"
provided.
course Boolean True False False False True Boolean data. Ex: True
sort_asceding Boolean True False False False True Boolean data. Ex: True
keep_time_orders Integer 24 False False False False Integer data. Ex: 2673
special_request Boolean True False False False True Boolean data. Ex: True
enable_sound Boolean True False False False True Boolean data. Ex: True
tile_expedite_group_identical_products Boolean False False False False True Boolean data. Ex: True
dinning_option Boolean True False False False True Boolean data. Ex: True
network_key String True False False False
"Hello World"
sort_recall_asceding Boolean False False False False True Boolean data. Ex: True
enable_checkoff Boolean False False False False True Boolean data. Ex: True
DeviceView default
expedite_print_printer (FK) True False False True Can be either a URI or set of
No
tile_expedite_print_ip String default True True False True
"Hello World"
provided.
done_as_bump Boolean False False False False True Boolean data. Ex: True
override_per_item Boolean True False False False True Boolean data. Ex: True
snaking_mode Integer 0 False False False False Integer data. Ex: 2673
reset_expedite_timers Integer 3 False False False False Integer data. Ex: 2673
max_storage_order_items Integer 1000 False False False False Integer data. Ex: 2673
DeviceView
bumpbar default True False False True Can be either a URI or set of
(FK)
theme String White False False False False
"Hello World"
expedite_print Boolean False False False False True Boolean data. Ex: True
expedite_move_completed_order_to_top Boolean False False False False True Boolean data. Ex: True
hide_server_name Boolean False False False False True Boolean data. Ex: True
order_display_quantity Boolean True False False False True Boolean data. Ex: True
kitchen_sort_by Integer 0 False False False False Integer data. Ex: 2673
move_completed_order_to_the_top Boolean False False False False True Boolean data. Ex: True
show_absolute_order_time Boolean False False False False True Boolean data. Ex: True
kitchen_show_kitchen_hidden_items Boolean False False False False True Boolean data. Ex: True
kitchen_show_different_modifiers_separately Boolean True False False False True Boolean data. Ex: True
tap_done_on_waiting_orders Integer 0 False False False False Integer data. Ex: 2673
No Unicode string data. Ex:
logo_image String default False True False False "Hello World"
provided.
complete_whole_order Boolean False False False False True Boolean data. Ex: True
tile_use_kitchen_print_name Boolean False False False False True Boolean data. Ex: True
kitchen_use_kitchen_print_name Boolean True False False False True Boolean data. Ex: True
PosTemplate
printer_template default True False False True Can be either a URI or set of
(FK)
DeviceView
tile_expedite_print_printer default True False False True Can be either a URI or set of
(FK)
DeviceView
device default False False False False Can be either a URI or set of
(FK)
tile_enable_vertical_scrolling Boolean True False False False True Boolean data. Ex: True
recall_one_by_one Boolean False False False False True Boolean data. Ex: True
seat Boolean True False False False True Boolean data. Ex: True
tile_expedite_print Boolean False False False False True Boolean data. Ex: True
double_tap_to_complete Boolean False False False False True Boolean data. Ex: True
DeviceView
kitchen_print_printer default True False False True Can be either a URI or set of
(FK)
modifiers Boolean True False False False True Boolean data. Ex: True
green_timer_fire_delay Time False False False False
a.m. "20:05:23"
default_kitchen_view Integer 1 False False False False Integer data. Ex: 2673
display_item_details Boolean True False False False True Boolean data. Ex: True
red_timer_fire_delay Time False False False False
a.m. "20:05:23"
kitchen_all_day_view_mode Boolean False False False False True Boolean data. Ex: True
No
orderup_image_url String default True False False False
"Hello World"
provided.
No
advertising_image_url String default True False False False
"Hello World"
provided.
expedite_use_kitchen_print_name Boolean False False False False True Boolean data. Ex: True
order_display_call_name_font_size Integer 20 False False False False Integer data. Ex: 2673
passcode Integer 1234 False False False False Integer data. Ex: 2673
No
"Hello World"
provided.
blink_completed_order Boolean False False False False True Boolean data. Ex: True
kitchen_print Boolean False False False False True Boolean data. Ex: True
Filtering
Name
device
Ordering
Name
id
Name
GET
PATCH
PUT
Name
GET
PATCH
PUT
Resource: LanguagePackage
URL: /resources/LanguagePackage/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
No default
items_count Integer False True False False Integer data. Ex: 2673
provided.
Filtering
Name
establishment
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: LanguagePackageItem
URL: /resources/LanguagePackageItem/?format=json
Default Limit: 20
FIELDS
primary String No default provided. False False False False Unicode string data. Ex: "Hello World"
secondary String False False False True Unicode string data. Ex: "Hello World"
Filtering
Name
code
establishment
primary
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: LoyaltyTier
URL: /resources/LoyaltyTier/?format=json
Default Limit: 20
FIELDS
Read
Only
dummy_pan_identifier Boolean False False False False True Boolean data. Ex: True
range_to String True False False False Unicode string data. Ex: "Hello World"
max_points_period Integer 1 False False False False Integer data. Ex: 2673
No default
discounts Discount (FK) True False False True list of URIs or list of individually nested
provided.
resource data.
Establishment No default A single related resource. Can be either
No default
max_points_per_transaction Integer True False False False Integer data. Ex: 2673
provided.
10T03:07:43"
LoyaltyTierRule No default
rules True False False True list of URIs or list of individually nested
(FK) provided.
resource data.
awarding Boolean False False False False True Boolean data. Ex: True
No default
restricted_discounts Discount (FK) True False False True list of URIs or list of individually nested
provided.
resource data.
range_from String True False False False Unicode string data. Ex: "Hello World"
No default
max_points_per_period Integer True False False False Integer data. Ex: 2673
provided.
redemption Boolean False False False False True Boolean data. Ex: True
balance_inquiry Boolean False False False False True Boolean data. Ex: True
No default
max_transactions_per_period Integer True False False False Integer data. Ex: 2673
provided.
max_transactions_period Integer 1 False False False False Integer data. Ex: 2673
10T03:07:43"
No default
award_limit Integer True False False False Integer data. Ex: 2673
provided.
Additional customer-related data in JSON
additional_data String True False False False
format
No default
provided.
Filtering
Name
active
updated_date
establishment
Ordering
Name
id
Name
GET
POST
PUT
Name
GET
POST
PUT
Resource: LoyaltyTierRule
URL: /resources/LoyaltyTierRule/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
start_date_time Datetime True False False False
No default
max_limit Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
rounding_rule Integer True False False False Integer data. Ex: 2673
provided.
Additional customer-related data in JSON
additional_data String True False False False
format
10T03:07:43"
No default
award_per_unit Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
weekdays String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
min_limit Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
is_blanket Boolean True False False False Boolean data. Ex: True
provided.
products Product (FK) True False False True
ProductCategory No default Many related resources. Can be either a list of
product_categories True False False True
end_date_time Datetime True False False False
unit_of_measure Integer 0 False False False False Integer data. Ex: 2673
No default
award_value Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
provided.
Filtering
Name
active
updated_date
name
Ordering
Name
id
Name
GET
POST
PUT
Name
GET
POST
PUT
Resource:
Modifier
URL: /resources/Modifier/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
kitchen_print_name String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
cost Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
provided.
color_code Integer 0 True False False False Integer data. Ex: 2673
e29b-41d4-a716-446655440000
is_quick Boolean False False False False True Boolean data. Ex: True
Many related resources. Can be either a list of
No default
substitutions Modifier (FK) True False False True URIs or list of individually nested resource
provided.
data.
display_in_kiosk Boolean True False False False True Boolean data. Ex: True
do_not_print Boolean False False False False True Boolean data. Ex: True
No default
printers Device (FK) True False False True URIs or list of individually nested resource
provided.
data.
No default
substitute_modifiers Boolean False True False False Boolean data. Ex: True
provided.
brand Brand (FK) True False False True
No default
provided.
No default
price Float False False False False Floating point numeric data. Ex: 26.73
provided.
No default
provided.
ModifierClass No default A single related resource. Can be either a URI
modifierClass False False False False
No default
available_seats Integer True False False False Integer data. Ex: 2673
provided.
display_online Boolean True False False False True Boolean data. Ex: True
No default
provided.
no_modifier_substitute Boolean False False False False True Boolean data. Ex: True
No default
img_url String provided. False True False False Unicode string data. Ex: "Hello World"
No default
provided.
10T03:07:43"
is_hot Boolean False False False False True Boolean data. Ex: True
No default
provided.
Filtering
Name
updated_date
modifierClass
establishment
active
id
Ordering
Name
sort
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
ModifierClass
URL: /resources/ModifierClass/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
split Boolean False False False False True Boolean data. Ex: True
brand Brand (FK) False True False False
free_modifier Integer 0 False False False False Integer data. Ex: 2673
No default
admin_mod_key String True False False False Unicode string data. Ex: "Hello World"
provided.
lock_add_modifier Integer 0 False False False False Integer data. Ex: 2673
No default
provided.
No default
provided.
admin_modifier Boolean False False False False True Boolean data. Ex: True
Filtering
Name
updated_date
active
establishment
Ordering
Name
sort
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
ModifierDiscount
URL: /resources/ModifierDiscount/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
date_from Datetime False False False False
date_to Datetime True False False False
discount Discount (FK) False False False False
10T03:07:43"
modifier Modifier (FK) False False False False
No default
provided.
Filtering
Name
updated_date
discount
modifier
establishment
id
Ordering
Name
id
Name
GET
POST
PUT
PATCH

Name
GET
POST
PUT
PATCH
Resource: ModifierItem
URL: /resources/ModifierItem/?format=json
Default Limit: 20
FIELDS
Read
Only
Modifier No default A single related resource. Can be either a URI
modifier False False False False
qty_type Integer None True False False False Integer data. Ex: 2673
e29b-41d4-a716-446655440000
Modifier No default A single related resource. Can be either a URI
substitution_of True False False True
No default
provided.
no_modifier_substitute Boolean False False False False True Boolean data. Ex: True
mod_type Integer 0 False False False False Integer data. Ex: 2673
modifier_cost Decimal 0.0 False False False False Fixed precision numeric data. Ex: 26.73
qty Float 1.0 False False False False Floating point numeric data. Ex: 26.73
is_discounted Boolean False False False False True Boolean data. Ex: True
is_substituted Boolean False False False False True Boolean data. Ex: True
No default
modifier_price Float False False False False Floating point numeric data. Ex: 26.73
provided.
Filtering
Name
order_item
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
ModifierRecipe
URL: /resources/ModifierRecipe/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
No default
quantity Float False False False False Floating point numeric data. Ex: 26.73
provided.
Modifier No default A single related resource. Can be either a URI or set
modifier False False False False
No default
provided.
Filtering
Name
product
modifier
ingredient
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: Order
URL: /resources/Order/?format=json
Default Limit: 20
FIELDS
Read
Only
No
Floating point numeric
gratuity Float default True False False False
data. Ex: 26.73
provided.
web_order Boolean False False False False True Boolean data. Ex: True
No
has_items Boolean default False True False False Boolean data. Ex: True
provided.
A single related
No
OrderRegistryData resource. Can be either
registry_data default True True False True
(FK) a URI or set of nested
provided.
resource data.
No
exchange_discount Boolean default True False False False Boolean data. Ex: True
provided.
gift_reward_data String True False False False
"Hello World"
Universally unique
identifier. Ex-
550e8400-e29b-41d4-
a716-446655440000
A single related
No
resource. Can be either
created_by User (FK) default False False False False
a URI or set of nested
provided.
resource data.
Fixed precision numeric
service_fee_untaxed Decimal 0 False False False False
data. Ex: 26.73
No
discount_tax_amount_included Float default True False False False
data. Ex: 26.73
provided.
No
discount_amount Float default True False False False
data. Ex: 26.73
provided.
sent Boolean False False False False True Boolean data. Ex: True
No
exchanged Boolean default True False False False Boolean data. Ex: True
provided.
A single related
No
updated_by User (FK) default False False False False
provided.
resource data.
No
default Unicode string data. Ex:
check_sum String True False False False
provided. "Hello World"
A single related
No
delivery_employee User (FK) default True False False True
provided.
resource data.
No
crv_value Float default True False False False
data. Ex: 26.73
provided.
No
delivery_duration Integer default True False False False Integer data. Ex: 2673
provided.
A single related
No
table_owner User (FK) default True False False True
provided.
resource data.
surcharge_excluded Float 0.0 False False False False
data. Ex: 26.73
taxable_surcharge_excluded Float 0.0 False False False False
data. Ex: 26.73
No
number_of_people Integer default True False False False Integer data. Ex: 2673
provided.
"Hello World"
Many related resources.
No Can be either a list of
AppliedDiscountOrder
applied_discounts default False True False False URIs or list of
(FK)
provided. individually nested
resource data.
No
pos_mode String default False False False False
"Hello World"
provided.
ha_applied Boolean False False False False True Boolean data. Ex: True
No
deleted_discounts String default True False False False
"Hello World"
provided.
points_added Integer 0 True False False False Integer data. Ex: 2673
No
bills_info String default True False False False
"Hello World"
provided.
tax_excluded_amount Float 0.0 False False False False
data. Ex: 26.73
No
auto_grat_pct Float default True False False False
data. Ex: 26.73
provided.
No
is_discounted Boolean default False True False False Boolean data. Ex: True
provided.
notification_email_sent Boolean False False False False True Boolean data. Ex: True
No
delivery_distance Integer default True False False False Integer data. Ex: 2673
provided.
No
gratuity_type Integer default True False False False Integer data. Ex: 2673
provided.
orderhistory OrderHistory (FK) default True False False True URIs or list of
resource data.
No
closed Boolean default False True False False Boolean data. Ex: True
provided.
No
tax_country String default True False False False
"Hello World"
provided.
No
discount_code String default True False False False
"Hello World"
provided.
No A date & time as a
pickup_time Datetime default True False False False string. Ex: "2010-11-
asap Boolean False False False False True Boolean data. Ex: True
No
deleted Boolean default False True False False Boolean data. Ex: True
provided.
has_delivery_info Boolean False True False False False Boolean data. Ex: True
No
reporting_id Integer default True True False False Integer data. Ex: 2673
provided.
No
discount_nontaxable_surcharge_included Float default True False False False
data. Ex: 26.73
provided.
taxable_surcharge Float 0.0 False False False False data. Ex: 26.73
A single related
No
delivery_address AppliedAddress (FK) default True False False True
provided.
resource data.
No
final_total Float default False False False False
data. Ex: 26.73
provided.
A single related
No
discount Discount (FK) default True False False True
provided.
resource data.
is_invoice Boolean False False False False True Boolean data. Ex: True
delivery_clock_in Datetime default True False False False string. Ex: "2010-11-
created_date Datetime default False False False False string. Ex: "2010-11-
delivery_clock_out Datetime default True False False False string. Ex: "2010-11-
No
discount_tax_amount Float default True False False False
data. Ex: 26.73
provided.
rounding_delta Float None True False False False
data. Ex: 26.73
No
is_unpaid Boolean default False True False False Boolean data. Ex: True
provided.
No
tax_rebate Float default True False False False
data. Ex: 26.73
provided.
A single related
No
table Table (FK) default True False False True
provided.
resource data.
discount_reason String True False False False
"Hello World"
notification_text_sent Boolean False False False False True Boolean data. Ex: True
A single related
No
last_updated_at PosStation (FK) default True False False True
provided.
resource data.
No
subtotal Float default False False False False
data. Ex: 26.73
provided.
A single related
No
vehicle CustomerVehicle (FK) default True False False True
provided.
resource data.
No
discount_taxed Boolean default True False False False Boolean data. Ex: True
provided.
applied_taxes AppliedTaxOrder (FK) default False True False False URIs or list of
resource data.
No
prevailing_tax Float default True False False False
data. Ex: 26.73
provided.
A date & time as a
invoice_date Datetime None True False False False string. Ex: "2010-11-
10T03:07:43"
No
discount_rule_type Integer default True False False False Integer data. Ex: 2673
provided.
No
service_charge Float default True False False False
data. Ex: 26.73
provided.
No A single related
customer Customer (FK) default True False False True resource. Can be either
provided. a URI or set of nested
resource data.
AppliedServiceFee
applied_service_fee default True True False True URIs or list of
(FK)
resource data.
package Package (FK) default True False False True URIs or list of
resource data.
No
remaining_due Float default False False False False
data. Ex: 26.73
provided.
No
has_history Boolean default False True False False Boolean data. Ex: True
provided.
No
tax Float default False False False False
data. Ex: 26.73
provided.
bill_number Integer 0 False False False False Integer data. Ex: 2673
Auto generated unique
id Integer Auto False False True True
ID.
No
surcharge Float default False False False False
data. Ex: 26.73
provided.
points_redeemed Integer 0 True False False False Integer data. Ex: 2673
No
call_number Integer default True False False False Integer data. Ex: 2673
provided.
No
delivery_estimated_distance Integer default True False False False Integer data. Ex: 2673
provided.
A single related
No
bill_parent Order (FK) default True False False True
provided.
resource data.
A single related
No
establishment Establishment (FK) default False False False False
provided.
resource data.
updated_date Datetime default False False False False string. Ex: "2010-11-
No
prevailing_surcharge Float default True False False False
data. Ex: 26.73
provided.
No
dining_option Integer default False False False False Integer data. Ex: 2673
provided.
bills_type Integer 0 False False False False Integer data. Ex: 2673
No
call_name String default True False False False
"Hello World"
provided.
printed Boolean False False False False True Boolean data. Ex: True
customer_birthdate Datetime default True False False False string. Ex: "2010-11-
A single related
No
discounted_by User (FK) default True False False True
provided.
resource data.
No
discount_rule_amount Float default True False False False
data. Ex: 26.73
provided.
is_readonly Boolean False False False False True Boolean data. Ex: True

service_fee_taxed Decimal 0 False False False False
data. Ex: 26.73
A single related
No
created_at PosStation (FK) default False False False False
provided.
resource data.
service_fee_tax Decimal 0 False False False False
data. Ex: 26.73
discount_total_amount Decimal 0.0 True False False False
data. Ex: 26.73
No
crv_taxed Boolean default True False False False Boolean data. Ex: True
provided.
No
local_id String default True False False False
"Hello World"
provided.
external_sync Integer None True False False False Integer data. Ex: 2673
No
"Hello World"
provided.
Filtering
Name
updated_date
customer
call_number
uuid
web_order
establishment
is_invoice
has_items
dining_option
registry_data
created_by
has_history
local_id
delivery_employee
printed
closed
created_date
external_sync
id
call_name
Ordering
Name
updated_date
pickup_time
id
created_date
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
Resource: OrderAllInOne
URL: /resources/OrderAllInOne/?format=json
Default Limit: 20
FIELDS
Read
Only
No
gratuity_type Integer default True False False False Integer data. Ex: 2673
provided.
web_order Boolean False False False False True Boolean data. Ex: True
No
has_items Boolean default False True False False Boolean data. Ex: True
provided.
A single related
No
OrderRegistryData resource. Can be either
registry_data default True True False True
(FK) a URI or set of nested
provided.
resource data.
No
provided.
gift_reward_data String True False False False
"Hello World"
Universally unique
identifier. Ex-
550e8400-e29b-41d4-
a716-446655440000
No
provided.
A single related
No
provided.
resource data.
data. Ex: 26.73
No
discount_tax_amount_included Float default True False False False
data. Ex: 26.73
provided.
taxable_surcharge_excluded Float 0.0 False False False False
data. Ex: 26.73
No
provided.
A single related
No
provided.
resource data.
No
check_sum String default True False False False
"Hello World"
provided.
A single related
No
delivery_employee User (FK) default True False False True
provided.
resource data.
No
data. Ex: 26.73
provided.
No
delivery_duration Integer default True False False False Integer data. Ex: 2673
provided.
A single related
No
table_owner User (FK) default True False False True resource. Can be either
provided. a URI or set of nested
resource data.
surcharge_excluded Float 0.0 False False False False
data. Ex: 26.73
No
data. Ex: 26.73
provided.
No
number_of_people Integer default True False False False Integer data. Ex: 2673
provided.
"Hello World"
AppliedDiscountOrder
applied_discounts default False True False False URIs or list of
(FK)
resource data.
No
pos_mode String default False False False False
"Hello World"
provided.
ha_applied Boolean False False False False True Boolean data. Ex: True
No
deleted_discounts String default True False False False
"Hello World"
provided.
points_added Integer 0 True False False False Integer data. Ex: 2673
No
bills_info String default True False False False
"Hello World"
provided.
tax_excluded_amount Float 0.0 False False False False
data. Ex: 26.73
No
auto_grat_pct Float default True False False False
data. Ex: 26.73
provided.
No
is_discounted Boolean default False True False False Boolean data. Ex: True
provided.
notification_email_sent Boolean False False False False True Boolean data. Ex: True
No
delivery_distance Integer default True False False False Integer data. Ex: 2673
provided.
No
default Floating point numeric
gratuity Float True False False False
provided. data. Ex: 26.73

orderhistory OrderHistory (FK) default True False False True URIs or list of
resource data.
No
closed Boolean default False True False False Boolean data. Ex: True
provided.
No
tax_country String default True False False False
"Hello World"
provided.
No
"Hello World"
provided.
pickup_time Datetime default True False False False string. Ex: "2010-11-
asap Boolean False False False False True Boolean data. Ex: True
No
deleted Boolean default False True False False Boolean data. Ex: True
provided.
has_delivery_info Boolean False True False False False Boolean data. Ex: True
No
reporting_id Integer default True True False False Integer data. Ex: 2673
provided.
No
discount_nontaxable_surcharge_included Float default True False False False Floating point numeric
provided. data. Ex: 26.73
taxable_surcharge Float 0.0 False False False False
data. Ex: 26.73
A single related
No
delivery_address AppliedAddress (FK) default True False False True
provided.
resource data.
No
final_total Float default False False False False
data. Ex: 26.73
provided.
package Package (FK) default True False False True URIs or list of
resource data.
is_invoice Boolean False False False False True Boolean data. Ex: True
delivery_clock_in Datetime default True False False False string. Ex: "2010-11-
created_date Datetime default False False False False string. Ex: "2010-11-
No
discount_tax_amount Float default True False False False
data. Ex: 26.73
provided.
rounding_delta Float None True False False False
data. Ex: 26.73
No
is_unpaid Boolean default False True False False Boolean data. Ex: True
provided.
No
tax_rebate Float default True False False False data. Ex: 26.73
provided.
A single related
No
table Table (FK) default True False False True
provided.
resource data.
"Hello World"
notification_text_sent Boolean False False False False True Boolean data. Ex: True
A single related
No
last_updated_at PosStation (FK) default True False False True
provided.
resource data.
customer_birthdate Datetime default True False False False string. Ex: "2010-11-
A single related
No
vehicle CustomerVehicle (FK) default True False False True
provided.
resource data.
No
provided.
applied_taxes AppliedTaxOrder (FK) default False True False False URIs or list of
resource data.
No
prevailing_tax Float default True False False False
data. Ex: 26.73
provided.
A date & time as a
invoice_date Datetime None True False False False string. Ex: "2010-11-
10T03:07:43"
No
provided.
No
service_charge Float default True False False False
data. Ex: 26.73
provided.
A single related
No
customer Customer (FK) default True False False True
provided.
resource data.
AppliedServiceFee
applied_service_fee default True True False True URIs or list of
(FK)
resource data.
No
remaining_due Float default False False False False
data. Ex: 26.73
provided.
No
has_history Boolean default False True False False Boolean data. Ex: True
provided.
No
tax Float default False False False False
data. Ex: 26.73
provided.
bill_number Integer 0 False False False False Integer data. Ex: 2673
ID.
No
surcharge Float default False False False False
data. Ex: 26.73
provided.
points_redeemed Integer 0 True False False False Integer data. Ex: 2673
No
call_number Integer default True False False False Integer data. Ex: 2673
provided.
No
delivery_estimated_distance Integer default True False False False Integer data. Ex: 2673
provided.
No
local_id String default True False False False
"Hello World"
provided.
A single related
No
bill_parent OrderAllInOne (FK) default True False False True
provided.
resource data.
A single related
No
discount Discount (FK) default True False False True
provided.
resource data.
A single related
No
establishment Establishment (FK) default False False False False
provided.
resource data.
updated_date Datetime default False False False False string. Ex: "2010-11-
No
prevailing_surcharge Float default True False False False
data. Ex: 26.73
provided.
delivery_clock_out Datetime default True False False False string. Ex: "2010-11-
bills_type Integer 0 False False False False Integer data. Ex: 2673
No
call_name String default True False False False
"Hello World"
provided.
No
subtotal Float default False False False False
data. Ex: 26.73
provided.
A single related
No
discounted_by User (FK) default True False False True
provided.
resource data.
No
default Floating point numeric
discount_rule_amount Float True False False False
data. Ex: 26.73
provided.
is_readonly Boolean False False False False True Boolean data. Ex: True
external_sync Integer None True False False False Integer data. Ex: 2673
A single related
No
created_at PosStation (FK) default False False False False
provided.
resource data.
data. Ex: 26.73
discount_total_amount Decimal 0.0 True False False False
data. Ex: 26.73
No
crv_taxed Boolean default True False False False Boolean data. Ex: True
provided.
data. Ex: 26.73
No
"Hello World"
provided.
Filtering
Name
updated_date
customer
call_number
uuid
web_order
establishment
is_invoice
has_items
dining_option
registry_data
created_by
has_history
local_id
delivery_employee
printed
closed
created_date
external_sync
id
call_name
Ordering
Name
updated_date
pickup_time
id
created_date
Name
GET
Name
GET
POST
Resource: OrderDataDiff
URL: /resources/OrderDataDiff/?format=json
Default Limit: 20
FIELDS
Read
Only
tax Decimal 0.000000 False False False False
26.73
tax_rebate Decimal 0.000000 False False False False
26.73
tax_excluded_amount Decimal 0.000000 False False False False
26.73
surcharge Decimal 0.000000 False False False False
26.73
service_fee_untaxed Decimal 0.000000 False False False False
26.73
discount_tax_amount_included Decimal 0.000000 False False False False
26.73
discount_amount Decimal 0.000000 False False False False
26.73
crv_value Decimal 0.000000 False False False False
26.73
discount_nontaxable_surcharge_included Decimal 0.000000 False False False False
26.73
taxable_surcharge Decimal 0.000000 False False False False
26.73
subtotal Decimal 0.000000 False False False False
26.73
surcharge_excluded Decimal 0.000000 False False False False Fixed precision numeric data. Ex:
26.73
service_charge Decimal 0.000000 False False False False
26.73
taxable_surcharge_excluded Decimal 0.000000 False False False False
26.73
final_total Decimal 0.000000 False False False False
26.73
number_of_people Decimal 0.000000 False False False False
26.73
service_fee_tax Decimal 0.000000 False False False False
26.73
No default A date & time as a string. Ex:
provided. "2010-11-10T03:07:43"
service_fee_taxed Decimal 0.000000 False False False False
26.73
Order No default
order False False False False either a URI or set of nested
(FK) provided.
resource data.
No default Unicode string data. Ex: "Hello
resource_uri String False True False False
provided. World"
Filtering
Name
order
created_date
Ordering
Name
id
Name
GET
Name
GET
Resource: OrderExchange
URL: /resources/OrderExchange/?format=json
Default Limit: 20
FIELDS
Read
Only
A date &
time as a
updated_date Datetime True False False False True string. Ex:
"2010-11-
10T03:07:43"
Fixed
No precision
exchanged_discount_percent Decimal default False False False False numeric
provided. data. Ex:
26.73
Unicode
No
string data.
exchanged_order_local_id String default True True False True
Ex: "Hello
provided.
World"
A single
related
resource.
No
Can be either
a URI or set
provided.
of nested
resource
data.
No A UUID
exchanged_order_uuid String default True False False True formatted
provided. field.
A single
related
resource.
No
Can be either
return_instance Return (FK) default True True False True
a URI or set
provided.
of nested
resource
data.
A single
related
resource.
No
Can be either
a URI or set
provided.
of nested
resource
data.
Fixed
No precision
exchanged_discount_tax_amount_included Decimal default False False False False numeric
provided. data. Ex:
26.73
Fixed
No precision
exchanged_amount Decimal default False False False False numeric
provided. data. Ex:
26.73
Unicode
No
string data.
reason String default True False False False
Ex: "Hello
provided.
World"
A single
related
resource.
No
Can be either
exchanged_order Order (FK) default True False False True
a URI or set
provided.
of nested
resource
data.
Fixed
No precision
tax_excluded_amount Decimal default False False False False numeric
provided. data. Ex:
26.73
A date &
No time as a
exchanged_date Datetime default False False False False string. Ex:
provided. "2010-11-
10T03:07:43"
A date &
time as a
created_date Datetime True False False False True string. Ex:
"2010-11-
10T03:07:43"
Many related
resources.
Can be either
No a list of URIs
exchange_items OrderExchangeItem (FK) default True True False True or list of
provided. individually
nested
resource
data.
Fixed
No precision
tax_amount Decimal default False False False False numeric
provided. data. Ex:
26.73
Many related
resources.
Can be either
No a list of URIs
AppliedDiscountOrderExchange
applied_discounts default False True False False or list of
(FK)
provided. individually
nested
resource
data.
Boolean
exchanged_discount_taxed Boolean False False False False True data. Ex:
True
A single
related
resource.
No
Can be either
order Order (FK) default False False False False
a URI or set
provided.
of nested
resource
data.
Fixed
No precision
exchanged_discount_amount Decimal default False False False False numeric
provided. data. Ex:
26.73
Unicode
No
string data.
Ex: "Hello
provided.
World"
Filtering
Name
exchanged_order
order
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
Resource: OrderExchangeItem
URL: /resources/OrderExchangeItem/?format=json
Default Limit: 20
FIELDS
Read
Only
No
original_price Decimal default False False False False
data. Ex: 26.73
provided.
No
order_item_uuid String default True False False True A UUID formatted field.
provided.
order_item OrderItem (FK) default True False False True Can be either a URI or set
No
exchanged_service_fee_tax Decimal default False False False False
data. Ex: 26.73
provided.
No
title String default True False False False
"Hello World"
provided.
No
exchanged_price Decimal default False False False False
data. Ex: 26.73
provided.
No
exchanged_service_fee_untaxed Decimal default False False False False
data. Ex: 26.73
provided.
created_by User (FK) default False False False False Can be either a URI or set
No
returned_item_uuid String default True False False True A UUID formatted field.
provided.
No
exchanged_discount_amount Decimal default False False False False
data. Ex: 26.73
provided.
Ex: "2010-11-10T03:07:43"

updated_by User (FK) default False False False False Can be either a URI or set
No
barcode String default True False False False
"Hello World"
provided.
No
ervc_type Integer default True False False False Integer data. Ex: 2673
provided.
No
tax_rate Decimal default False False False False
data. Ex: 26.73
provided.
No
exchanged_service_fee_taxed Decimal default False False False False
data. Ex: 26.73
provided.
No
product_image_url String default True True False True
"Hello World"
provided.
OrderExchange
order_exchange default False False False False Can be either a URI or set
(FK)
ReturnedItem
returned_item (FK) default True False False True Can be either a URI or set
No
tax_amount Decimal default False False False False
data. Ex: 26.73
provided.
No
exchanged_discount_tax_amount_included Decimal default False False False False
data. Ex: 26.73
provided.
Ex: "2010-11-10T03:07:43"
exchanged_discount_taxed Boolean False False False False True Boolean data. Ex: True
No
"Hello World"
provided.
tax_included Boolean False False False False True Boolean data. Ex: True
No
quantity Integer default False False False False Integer data. Ex: 2673
provided.
Filtering
Name
order_item
order_exchange
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
Resource: OrderHistory
URL: /resources/OrderHistory/?format=json
Default Limit: 20
FIELDS
Read
Only
order_closed_by User (FK) True False False True
provided. 41d4-a716-446655440000
order_closed_at True False False True
No default
provided.
order_opened_by User (FK) False False False False
order_opened_at False False False False
closed Datetime True False False False
opened Datetime False False False False
Filtering
Name
opened
order
closed
uuid
Ordering
Name
id
closed
opened
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
Resource:
OrderItem
URL: /resources/OrderItem/?format=json
Default Limit: 20
FIELDS
Read
Only
No
gift_card_number String default True False False False
"Hello World"
provided.
is_cold Boolean False False False False True Boolean data. Ex: True
No
OrderItemCommission be either a list of URIs or list
commissions default False True False False
(FK) of individually nested
provided.
resource data.
No
Fixed precision numeric data.
price_to_display Decimal default True False False False
Ex: 26.73
provided.
No
provided.
No
parent_uuid String default True False False False
"Hello World"
provided.
No Universally unique identifier.
uuid UUID default False False True False Ex- 550e8400-e29b-41d4-
provided. a716-446655440000
No A single related resource. Can
created_by User (FK) default False False False False be either a URI or set of
Ex: 26.73
pure_sales Float 0.0 True False False False
Ex: 26.73
discount_tax_amount_included Decimal 0 True False False False
Ex: 26.73
voided_by User (FK) default True False False True be either a URI or set of
No
provided.
dynamic_combo DynamicCombo (FK) default True True False True be either a URI or set of
appointment Appointment (FK) default True True False True be either a URI or set of
updated_by User (FK) default False False False False be either a URI or set of
split_with_seat Integer 0 True False False False Integer data. Ex: 2673
No
provided.
No
product_name_override String default True False False False
"Hello World"
provided.
No
event_date Datetime default True False False False
"2010-11-10T03:07:43"
provided.
No
Ex: 26.73
provided.
No
tax_amount Float default False False False False
Ex: 26.73
provided.
split_parts Float 0.0 False False False False
Ex: 26.73
catering_complete Boolean False False False False True Boolean data. Ex: True
No
AppliedDiscountOrderItem be either a list of URIs or list
applied_discounts default False True False False
provided.
resource data.
weight Float None True False False False
Ex: 26.73
sold_by_weight Boolean False False False False True Boolean data. Ex: True
taxed_flag Boolean False False False False True Boolean data. Ex: True
is_discounted Boolean False False False False True Boolean data. Ex: True
No
appointment_ref_uuid String default True False False False
"Hello World"
provided.
No
course_number Integer default True False False False Integer data. Ex: 2673
provided.
shared Integer 0 True False False False Integer data. Ex: 2673
No
"Hello World"
provided.
No
deleted Boolean default True False False False Boolean data. Ex: True
provided.
discount Discount (FK) default True False False True be either a URI or set of
No
tax_rate Float default False False False False
Ex: 26.73
provided.
dynamic_combo_slot DynamicComboSlot (FK) default True True False True be either a URI or set of
No
seat_number Integer default True False False False Integer data. Ex: 2673
provided.
No
package_uuid String default True False False False
"Hello World"
provided.
No
sales_tax_exemption_reason String default True False False False
"Hello World"
provided.
No
cup_weight Float default True False False False
Ex: 26.73
provided.
package Package (FK) default True False False True be either a URI or set of
modifier_cost Decimal 0.0 False False False False
Ex: 26.73
No
initial_price Float default True False False False
Ex: 26.73
provided.
No
combo_saving_amount Decimal default True False False False
Ex: 26.73
provided.
is_layaway Boolean False True False False False Boolean data. Ex: True
No
created_date Datetime default False False False False
"2010-11-10T03:07:43"
provided.
modifier_amount Float No False False False False Floating point numeric data.
default Ex: 26.73
provided.
No
pump_number Integer default True False False False Integer data. Ex: 2673
provided.
No
invoice_document_uuid String default True False False True A UUID formatted field.
provided.
No
tax_rebate Float default True False False False
Ex: 26.73
provided.
No
special_request String default True False False False
"Hello World"
provided.
"Hello World"
No
temp_sort Integer default False False False False
Integer data. Ex: 2673
provided.

commission_amount Decimal 0.0 True False False False
Ex: 26.73
exclude_from_discounts Boolean False False False False True Boolean data. Ex: True
station PosStation (FK) default False False False False be either a URI or set of
serial_number String None True False False False
"Hello World"
No
catering_delivery_date Datetime default True False False False
"2010-11-10T03:07:43"
provided.
No
provided.
No
applied_taxes AppliedTaxOrderItem (FK) default False True False False
provided.
resource data.
external_shipping_address AppliedAddress (FK) default True True False True be either a URI or set of
No
ervc_type Integer default True False False False Integer data. Ex: 2673
provided.
No
provided.
cup_qty Integer None True False False False Integer data. Ex: 2673
No
modifieritems ModifierItem (FK) default True True False True
provided.
resource data.
split_type Integer 0 True False False False Integer data. Ex: 2673
No
applied_service_fee AppliedServiceFee (FK) default True True False True
provided.
resource data.
No
kitchen_completed Datetime default True False False False
"2010-11-10T03:07:43"
provided.
No
date_paid Datetime default True False False False
"2010-11-10T03:07:43"
provided.
cost Decimal 0.0 False False False False
Ex: 26.73
No
uom String default True False False False
"Hello World"
provided.
wholesale_saving_amount Decimal 0 True False False False Fixed precision numeric data.
Ex: 26.73
No
voided_date Datetime default True False False False
"2010-11-10T03:07:43"
provided.
No
pump_date Datetime default True False False False
"2010-11-10T03:07:43"
provided.
No
expedited Datetime default True False False False
"2010-11-10T03:07:43"
provided.
on_hold Boolean False False False False True Boolean data. Ex: True
not_returnable Boolean False False False False True Boolean data. Ex: True
No
ingredientitems IngredientItem (FK) default True True False True
provided.
resource data.
bill_parent OrderItem (FK) default True False False True be either a URI or set of
service_provider User (FK) default True False False True be either a URI or set of
No
start_time Datetime default True False False False
"2010-11-10T03:07:43"
provided.
No
updated_date Datetime default False False False False
"2010-11-10T03:07:43"
provided.
product Product (FK) default True False False True be either a URI or set of
No
void_ref_uuid String default True False False False
"Hello World"
provided.
combo_used Product (FK) default True False False True be either a URI or set of
No
Ex: 26.73
provided.
No
price Float default False False False False Ex: 26.73
provided.

voided_reason String True False False False
"Hello World"
No
combo_uuid String default True False False False
"Hello World"
provided.
No
order_local_id String default True True False False
"Hello World"
provided.
combo_product_set ComboProductSet (FK) default True True False True be either a URI or set of
returned_establishment Establishment (FK) default True False False True be either a URI or set of
discounted_by User (FK) default True False False True be either a URI or set of
No
discount_rule_amount Float default True False False False
Ex: 26.73
provided.
Ex: 26.73
Ex: 26.73
No
item_type Integer default True False False False Integer data. Ex: 2673
provided.
No
"Hello World"
provided.
reference_discounts String True False False False
"Hello World"
order Order (FK) default False False False False be either a URI or set of
No
quantity Integer default False False False False Integer data. Ex: 2673
provided.
Filtering
Name
updated_date
product
voided_date
uuid
catering_complete
created_date
catering_delivery_date
id
order
Ordering
Name
id
created_date
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: OrderItemCatering
URL: /resources/OrderItemCatering/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
customer_last_name String False True False False Unicode string data. Ex: "Hello World"
provided.
Product No default A single related resource. Can be either a URI
No default
parent_uuid String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
quantity Integer False False False False Integer data. Ex: 2673
provided.
voided_reason String True False False False Unicode string data. Ex: "Hello World"
No default
order_local_id String True True False False Unicode string data. Ex: "Hello World"
provided.
No default
product_name_override String True False False False Unicode string data. Ex: "Hello World"
provided.
catering_complete Boolean False False False False True Boolean data. Ex: True
No default
customer_first_name String False True False False Unicode string data. Ex: "Hello World"
provided.
catering_delivery_date Datetime True False False False
No default
order_call_name String False True False False Unicode string data. Ex: "Hello World"
provided.
uuid UUID provided. False False True False
e29b-41d4-a716-446655440000
Filtering
Name
updated_date
product
voided_date
uuid
catering_complete
created_date
catering_delivery_date
id
order
Ordering
Name
id
created_date
Name
Name
GET
Resource:
OrderItemCommission
URL: /resources/OrderItemCommission/?format=json
Default Limit: 20
FIELDS
Read
Only
commission_user User (FK) False False False False
No default
commission_amount Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
OrderItem No default A single related resource. Can be either a URI or
No default
commission_pct Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
provided.
Filtering
Name
order_item
commission_user
updated_date
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: OrderItemDataDiff
URL: /resources/OrderItemDataDiff/?format=json
Default Limit: 20
FIELDS
Read
Only
OrderItem No default A single related resource. Can be either a
orderitem False False False False
discount_tax_amount_included Decimal 0.000000 False False False False Fixed precision numeric data. Ex: 26.73
tax_amount Decimal 0.000000 False False False False Fixed precision numeric data. Ex: 26.73
No default
provided.
discount_amount Decimal 0.000000 False False False False Fixed precision numeric data. Ex: 26.73
Filtering
Name
orderitem
created_date
Ordering
Name
id
Name
GET
Name
GET
Resource: OrderRegistryData
URL: /resources/OrderRegistryData/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
printer_serial String True False False False Unicode string data. Ex: "Hello World"
provided.
coo_counter Integer 0 False False False False Integer data. Ex: 2673
No default
fiscale_sale_id String False False False False Unicode string data. Ex: "Hello World"
provided.
custom_data String True False False False Unicode string data. Ex: "Hello World"
Order No default A single related resource. Can be either a URI or set of
No default
provided.
Filtering
Name
order
fiscale_sale_id
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: OrderTaxBreakDown
URL: /resources/OrderTaxBreakDown/?format=json
Default Limit: 20
FIELDS
Read
Only
fiscal_rate Integer 0 False False False False Integer data. Ex: 2673
No default
tax_type Integer False False False False Integer data. Ex: 2673
provided.
order_discount Decimal 0.000000 False False False False Fixed precision numeric data. Ex: 26.73
sales Decimal 0.000000 False False False False Fixed precision numeric data. Ex: 26.73
No default
tax_name String False False False False Unicode string data. Ex: "Hello World"
provided.
taxable_amount Decimal 0.000000 False False False False Fixed precision numeric data. Ex: 26.73
tax_amount Decimal 0.000000 False False False False Fixed precision numeric data. Ex: 26.73
No default
provided.
No default
provided.
item_discount Decimal 0.000000 False False False False Fixed precision numeric data. Ex: 26.73
Order No default A single related resource. Can be either a URI or set
No default
provided.
Filtering
Name
tax_type
order
Ordering
Name
id
Name
GET
Name
GET
Resource: OriginalProductGroup
URL: /resources/OriginalProductGroup/?format=json
Default Limit: 20
FIELDS
Read
Only
is_food Boolean False False False False True Boolean data. Ex: True
discounts Boolean True False False False True Boolean data. Ex: True
ProductGroup No default A single related resource. Can be either a URI or
display Boolean False False False False True Boolean data. Ex: True
No default
provided.
Ordering
Name
id
Name
GET
Name
GET
Resource: OutdoorPaymentTerminal
URL: /resources/OutdoorPaymentTerminal/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
opt_id String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
provided.
No default
pump_number String True False False False Unicode string data. Ex: "Hello World"
provided.
Device No default A single related resource. Can be either a URI or set
eps False False False False
No default
service_level String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
outdoor_position String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
port Integer False False False False Integer data. Ex: 2673
provided.
No default
provided.
Filtering
Name
eps
Ordering
Name
id
Name
GET
PATCH
PUT
DELETE
Name
GET
PATCH
PUT
DELETE
Resource: POSMessage
URL: /resources/POSMessage/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
provided.
action_date_time Datetime True False False False
10T03:07:43"
data String None True False False False Unicode string data. Ex: "Hello World"
No default
provided.
Filtering
Name
updated_date
type
created_date
establishment
action_date_time
Ordering
Name
id
Name
GET
POST
Name
GET
POST
Resource: Package
URL: /resources/Package/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
weight Float False False False False Floating point numeric data. Ex: 26.73
provided.
No default
service_name String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
packaging String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
rate Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
tax_option Integer 1 False False False False Integer data. Ex: 2673
actual_ship_date Datetime True False False False
550e8400-e29b-41d4-a716-446655440000
state Integer 0 False False False False Integer data. Ex: 2673
10T03:07:43"
No default
shipping_charge Float False False False False Floating point numeric data. Ex: 26.73
provided.
AppliedAddress No default A single related resource. Can be either a
external_shipping_address False False False False
shipping_label String True False False False Unicode string data. Ex: "Hello World"
signature_required Boolean False False False False True Boolean data. Ex: True
AppliedAddress No default A single related resource. Can be either a
address False False False False
target_ship_date Datetime False False False False
service_code String False False False True Unicode string data. Ex: "Hello World"
No default
items OrderItem (FK) True False False True list of URIs or list of individually nested
provided.
resource data.
notes String True False False False Unicode string data. Ex: "Hello World"
No default
tracking_number String True False False False Unicode string data. Ex: "Hello World"
provided.
10T03:07:43"
shipping_company Integer 0 False False False False Integer data. Ex: 2673
No default
provided.
Filtering
Name
updated_date
uuid
items
tracking_number
created_date
active
order
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
Payment
URL: /resources/Payment/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
exchanged Boolean True False False False Boolean data. Ex: True
provided.
No default
executed Boolean True False False False Boolean data. Ex: True
provided.
No default
transaction_status String False True False False Unicode string data. Ex: "Hello World"
provided.
No default
currency_type Integer True False False True Integer data. Ex: 2673
provided.
No default
currency_amount Decimal True False False True Fixed precision numeric data. Ex: 26.73
provided.
payment_date Datetime False False False False
provided. e29b-41d4-a716-446655440000
No default
gratuity Float True False False False Floating point numeric data. Ex: 26.73
provided.
No default
tip Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
processor_accepted Boolean True False False False Boolean data. Ex: True
provided.
refund_transaction_id String None True False False False Unicode string data. Ex: "Hello World"
PosStation No default A single related resource. Can be either a
station (FK) False False False False
cc_first_name String None True False False False Unicode string data. Ex: "Hello World"
transaction_data String True False False False Unicode string data. Ex: "Hello World"
HouseAccount No default A single related resource. Can be either a
house_account True False False True
No default
transaction_id String False False False False Unicode string data. Ex: "Hello World"
provided.
No default
last_4_cc_digits String False False False False Unicode string data. Ex: "Hello World"
provided.
No default
transaction_captured Boolean True False False False Boolean data. Ex: True
provided.
No default
deleted Boolean True False False False Boolean data. Ex: True
provided.
refunded Boolean False True False False False Boolean data. Ex: True
online Boolean False False False False True Boolean data. Ex: True
payer_id Integer No default True False False False Integer data. Ex: 2673
provided.
source_type Integer 1 False False False False Integer data. Ex: 2673
processor_response String None True False False False Unicode string data. Ex: "Hello World"
first_4_cc_digits String None True False False False Unicode string data. Ex: "Hello World"
No default
amount_authorized Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
signature_img_url String True True False False Unicode string data. Ex: "Hello World"
provided.
change Decimal 0 False False False False Fixed precision numeric data. Ex: 26.73
invoice_transition_date Datetime None True False False False
10T03:07:43"
PaymentType No default A single related resource. Can be either a
other_payment_type True False False True
No default
cash_drawer Integer True False False True Integer data. Ex: 2673
provided.
No default
receipt_email String True False False False Unicode string data. Ex: "Hello World"
provided.
bill Integer 0 False False False False Integer data. Ex: 2673
No default
currency_tip Decimal True False False True Fixed precision numeric data. Ex: 26.73
provided.
No default
card_type Integer True False False False Integer data. Ex: 2673
provided.
No default
provided.
No default
provided.
cc_last_name String None True False False False Unicode string data. Ex: "Hello World"
rounding_delta Float None True False False False Floating point numeric data. Ex: 26.73
No default
provided.
Filtering
Name
updated_date
refund_transaction_id
station
uuid
created_date
establishment
order
transaction_id
Ordering
Name
payment_date
id
created_date
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
PaymentSignatureImage
URL: /resources/PaymentSignatureImage/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
payment_uuid String False False True False Unicode string data. Ex: "Hello World"
provided.
No default
provided.
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: Payout
URL: /resources/Payout/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
provided.
payout_reason String False False False True Unicode string data. Ex: "Hello World"
cash_drop Boolean False True False False False Boolean data. Ex: True
10T03:07:43"
till Till (FK) True False False True
No default
provided.
local_id String False False False True Unicode string data. Ex: "Hello World"
No default
drawer_number Integer False False False False Integer data. Ex: 2673
provided.
station False False False False
10T03:07:43"
No default
provided.
provided. 41d4-a716-446655440000
Filtering
Name
updated_date
uuid
establishment
local_id
drawer_number
created_date
type
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: Permission
URL: /resources/Permission/?format=json
Default Limit: 20
FIELDS
name String No default provided. False False True False Unicode string data. Ex: "Hello World"
Ordering
Name
id
Name
GET
Name
GET
Resource:
PhysicalInventory
URL: /resources/PhysicalInventory/?format=json
Default Limit: 20
FIELDS
Read
Only
status Integer 0 False False False False Integer data. Ex: 2673
No default
provided.
initial_count_required Boolean None False False False True Boolean data. Ex: True
No default
provided.
Filtering
Name
establishment
Name
GET
Name
GET
Resource: PhysicalInventoryItem
URL: /resources/PhysicalInventoryItem/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
count Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
serials String True False False False Unicode string data. Ex: "Hello World"
provided.
10T03:07:43"
PhysicalInventorySection No default A single related resource. Can be either a
section False False False False
10T03:07:43"
No default
provided.
Filtering
Name
section
Ordering
Name
id
Name
POST
Name
POST
Resource: PhysicalInventorySection
URL: /resources/PhysicalInventorySection/?format=json
Default Limit: 20
FIELDS
Read
Only
comment String False False False True Unicode string data. Ex: "Hello World"
No default
status Integer False False False False Integer data. Ex: 2673
provided.
e29b-41d4-a716-446655440000
initial_counted_by User (FK) True False False True
10T03:07:43"
No default
provided.
initial_count_started Datetime True False False False
initial_count_ended Datetime True False False False
10T03:07:43"
No default
number String False False True False Unicode string data. Ex: "Hello World"
provided.
count_ended Datetime True False False False
count_started Datetime True False False False
counted_by User (FK) True False False True
10T03:07:43"
PhysicalInventory No default A single related resource. Can be either a
physical_inventory False False False False
No default
initial_count Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
Filtering
Name
status
physical_inventory
uuid
Ordering
Name
id

Name
GET
PUT
Name
GET
PUT
Resource: PortData
URL: /resources/PortData/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
connection_type Integer True False False False Integer data. Ex: 2673
provided.
10T03:07:43"
PumpProtocolData No default A single related resource. Can be either a URI
protocol False False False False
No default
provided.
settings String True False False False Unicode string data. Ex: "Hello World"
No default
channel_number Integer True False False False Integer data. Ex: 2673
provided.
card_number Integer 1 False False False False Integer data. Ex: 2673
No default
port_assign Integer True False False False Integer data. Ex: 2673
provided.
No default
provided.
No default
provided.
Ordering
Name
id
Name
GET
PUT
PATCH
Name
GET
PUT
PATCH
Resource: PosStation
URL: /resources/PosStation/?format=json
Default Limit: 20
FIELDS
Read
Only
No default Unicode string data. Ex:
pos_mode String False False False False
A date & time as a
updated_date Datetime True False False False True string. Ex: "2010-11-
10T03:07:43"
is_print_online_orders Boolean False False False False True Boolean data. Ex: True
bundle_identifier String True False False False
disable_pay Boolean False False False False True Boolean data. Ex: True
is_full_sync Boolean False False False False True Boolean data. Ex: True
is_debug_build Boolean False False False False True Boolean data. Ex: True
disable_local_synchronization Boolean True False False False True Boolean data. Ex: True
No default
call_number_starts_at Integer True False False False Integer data. Ex: 2673
provided.
suppress_prompt_for_call_name Boolean False False False False True Boolean data. Ex: True
buttons_actions String False True False False
A single related
RevenueCenter No default resource. Can be either
revenue_center True False False True
(FK) provided. a URI or set of nested
resource data.
location_id String True False False False
No default
has_apn_token Boolean False True False False Boolean data. Ex: True
provided.
suppress_prompt_for_modifiers Boolean False False False False True Boolean data. Ex: True
usaepay_source_name String True False False False
[1, 2, 3, 4, 5, 6, 7,
payment_options_array String 8, 9, 10, 11, 12, True False False False
"Hello World"
17, 18, 21]
build_number String True False False False
disable_auto_prompt_for_barcode Boolean False False False False True Boolean data. Ex: True
is_social_media Boolean False False False False True Boolean data. Ex: True
possible_build_number String True False False False
usaepay_source_pin String True False False False
ID.
A date & time as a
No default
pos_last_accessed Datetime True False False False string. Ex: "2010-11-
provided.
10T03:07:43"
test_station Boolean False False False False True Boolean data. Ex: True
buttons_disabled String True False False False
"Hello World"
usaepay_source_key String True False False False
is_bar Boolean False False False False True Boolean data. Ex: True
suppress_prompt_barcode_window Boolean False False False False True Boolean data. Ex: True
A single related
Establishment No default resource. Can be either
(FK) provided. a URI or set of nested
resource data.
dining_options_array String [0, 1, 2, 3, 4, 5, 6] True False False False
"Hello World"
buttons_options_array String True False False False
"Hello World"
ip_address_eth String True False False False
suppress_prompt_for_seat_count Boolean False False False False True Boolean data. Ex: True
enabler_terminal_password String True False False False
No default
is_broadcaster Boolean False True False False Boolean data. Ex: True
provided.
mac String True False False False
suppress_prompt_for_dining_option Boolean False False False False True Boolean data. Ex: True
caller_id Boolean False False False False True Boolean data. Ex: True
manual_station_id String True False False False
ip_address String True False False False
no_cash_drawer Boolean False False False False True Boolean data. Ex: True
[0, 1, 2, 3, 5, 6, 7, Unicode string data. Ex:
card_options_array String True False False False
8, 9] "Hello World"
suppress_prompt_for_seat Boolean False False False False True Boolean data. Ex: True
No default
kitchen_view Boolean False True False False Boolean data. Ex: True
provided.
name String False False False False
qr_code_text String True False False False
enabler_terminal_id Integer None True False False False Integer data. Ex: 2673
suppress_prompt_for_course Boolean False False False False True Boolean data. Ex: True
Universally unique
identifier. Ex-
550e8400-e29b-41d4-
a716-446655440000
Can be either a list of
No default
devices Device (FK) False False False False URIs or list of
provided.
individually nested
resource data.
network_key String True False False False
is_print_item_forecasting Boolean False False False False True Boolean data. Ex: True
suppress_prompt_for_customer_name Boolean False False False False True Boolean data. Ex: True
A date & time as a
created_date Datetime True False False False True string. Ex: "2010-11-
10T03:07:43"
suppress_prompt_for_tills Boolean False False False False True Boolean data. Ex: True
A date & time as a
No default
db_dump_time Datetime True False False False string. Ex: "2010-11-
provided.
10T03:07:43"
Can be either a list of
No default
excluded_kitchen_views Device (FK) True False False True URIs or list of
provided.
individually nested
resource data.
enabler_terminal_name String True False False False
Filtering
Name
active
pos_mode
establishment
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
PosTemplate
URL: /resources/PosTemplate/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
No default
provided.
Filtering
Name
establishment
name
Name
GET
Name
GET
Resource: PriceTier
URL: /resources/PriceTier/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
is_admin Boolean False False False False True Boolean data. Ex: True
No default
provided.
No default
name String False False True False Unicode string data. Ex: "Hello World"
provided.
Filtering
Name
updated_date
Ordering
Name
id
Name
GET
Name
GET
Resource:
Product
URL: /resources/Product/?format=json
Default Limit: 20
FIELDS
Read
Only
No
original_price Decimal default True True False True
26.73
provided.
No
quick_pick_group String default True False False False
World"
provided.
allow_price_override Boolean False False False False True Boolean data. Ex: True
is_combo Boolean False False False False True Boolean data. Ex: True
upsell_combo_price Decimal 0.0 True False False False
26.73
product_weight_unit Integer 0 False False False False Integer data. Ex: 2673
No
purchase_product_age Integer default True False False False Integer data. Ex: 2673
provided.
sku String True False False False
World"
446655440000
attribute_parent Product (FK) default True False False True either a URI or set of nested
purchase_reward_multiplier Float 1.0 False False False False
26.73
created_by User (FK) default False False False False either a URI or set of nested
No
min_price Float default True False False False
26.73
provided.
product_weight Decimal None True False False False
26.73
printers Device (FK) default True False False True either a list of URIs or list of

uom String Unit True False False False
World"
dynamic_combo DynamicCombo (FK) default True False False True either a URI or set of nested
updated_by User (FK) default False False False False either a URI or set of nested
No
26.73
provided.
No
product_brand String default True False False False
World"
provided.
No
shopify_sku String default True False False False
World"
provided.
categories ProductCategory (FK) default True False False True either a list of URIs or list of
No
item_no Integer default True False False False Integer data. Ex: 2673
provided.
No
sorting Integer default False False False False Integer data. Ex: 2673
provided.
attribute_2 Attribute (FK) default True False False True either a URI or set of nested
No
World"
provided.
attribute_1 Attribute (FK) default True False False True either a URI or set of nested
limit_type Integer 0 False False False True Integer data. Ex: 2673
No
size_chart String default False True False False
World"
provided.
eligible_for_purchase_rewards Boolean True False False False True Boolean data. Ex: True
No
point_redeem Float default True False False False
26.73
provided.
commission_type Integer 0 False False False False Integer data. Ex: 2673
No
is_food Boolean default True True False True Boolean data. Ex: True
provided.
preparation_time Integer 0 False False False False Integer data. Ex: 2673
productclass ProductClass (FK) default True False False True either a URI or set of nested
kitchen_print_name String True False False False
World"
No
cost Decimal default True False False False
26.73
provided.
export Boolean True False False False True Boolean data. Ex: True
parent_dynamic_combo DynamicCombo (FK) default True False False True either a URI or set of nested
variable_pricing Boolean False False False False True Boolean data. Ex: True
variable_pricing_by Integer 0 False False False False Integer data. Ex: 2673
category ProductCategory (FK) default True False False True either a URI or set of nested
comments String True False False False
World"
No
unit_size String default True False False False
World"
provided.
No
provided.
display_on_kiosk Boolean False False False False True Boolean data. Ex: True
combo_upcharge Decimal 0.0 True False False False
26.73
No
alternate_lookup List default True False False True A list of data. Ex: ['abc', 26.73, 8]
provided.
No
World"
provided.
No
point_value Integer default True False False False Integer data. Ex: 2673
provided.
No
manufacturer String default True False False False
World"
provided.
kitchen_description String True False False False
World"
No
product_width Decimal default True False False False
26.73
provided.
tax_class Integer 0 False False False False Integer data. Ex: 2673
attribute_value_2 AttributeValue (FK) default True False False True either a URI or set of nested
No
msrp Decimal default True False False False
26.73
provided.
attribute_value_1 AttributeValue (FK) default True False False True either a URI or set of nested
No
retail String default True False False False
World"
provided.
ComboProductSet
combo_productsets default True True False True either a list of URIs or list of
(FK)
No
image String default False False False False
World"
provided.
limit_value Decimal 0 False False False True
26.73
No
promotional_product Boolean default True False False False Boolean data. Ex: True
provided.
No
product_length_unit String default True False False False
World"
provided.
receipt_text ReceiptText (FK) default True False False True either a URI or set of nested
commission Decimal 0.0 True False False False
26.73
price_embedded Boolean False False False False True Boolean data. Ex: True
is_drink Boolean False False False False True Boolean data. Ex: True
product_group ProductGroup (FK) default True False False True either a list of URIs or list of
No
start_date Datetime default True False False False
"2010-11-10T03:07:43"
provided.
external_shipping_addresses Address (FK) default True False False True either a list of URIs or list of
print_tags Boolean True False False False True Boolean data. Ex: True
ProductPriceTierPrice
price_tiers default True True False True either a list of URIs or list of
(FK)
brand Brand (FK) default True False False True either a URI or set of nested
service_duration Integer 0 False False False False Integer data. Ex: 2673
product_width_unit String No True False False False Unicode string data. Ex: "Hello
default World"
provided.
disable_modifier_popup Boolean False False False False True Boolean data. Ex: True
No
max_threshold_price Float default True False False False
26.73
provided.
percent_markup Decimal None True False False False
26.73
No
delivery_method Integer default True False False False Integer data. Ex: 2673
provided.
No
dept String default True False False False
World"
provided.
prompt_for_quantity Boolean False False False False True Boolean data. Ex: True
No
product_height Decimal default True False False False
26.73
provided.
No
third_party_id String default True False False False
World"
provided.
No
attribute_2_name String default True False False False
World"
provided.
No
redemption_level String default True False False False
World"
provided.
dining_options String [] True False False False
World"
No
crv_label String default True False False False
World"
provided.
"2010-11-10T03:07:43"
No
purchase_product_age_msg String default True False False False
World"
provided.
tax Tax (FK) default True False False True either a URI or set of nested
rti_combo Boolean False False False False True Boolean data. Ex: True
No
end_date Datetime default True False False False
"2010-11-10T03:07:43"
provided.
No
product_length Decimal default True False False False
26.73
provided.
No
tare Float default True False False False
26.73
provided.
parent_product Product (FK) default True False False True either a URI or set of nested
establishment Establishment (FK) default False False False False either a URI or set of nested
ebt_no Boolean False False False False True Boolean data. Ex: True
No
bin_value String default True False False False
World"
provided.
discountable Boolean True False False False True Boolean data. Ex: True
crv_enabled Boolean False False False False True Boolean data. Ex: True
description String True False False False
World"
attribute_type Integer 0 False False False False Integer data. Ex: 2673
No
price Float default False False False False Floating point numeric data. Ex:
provided. 26.73
"2010-11-10T03:07:43"
tax_codes TaxCode (FK) default True False False True either a list of URIs or list of
require_serial_number Boolean False False False False True Boolean data. Ex: True
No
attribute_1_name String default True False False False World"
provided.
No
product_height_unit String default True False False False
World"
provided.
No
happy_hour_price Float default True False False True
26.73
provided.
No
prep_yield Decimal default True False False False
26.73
provided.
No
max_price Float default True False False False
26.73
provided.
No
World"
provided.
Filtering
Name
updated_date
category
display_online
name
attribute_parent
attribute_type
price
barcode
uuid
sku
cost
course_number
created_date
active
establishment
id
dining_options
description
Ordering
Name
sorting
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
ProductCategory
URL: /products/ProductCategory/?format=json
Default Limit: 20
FIELDS
Read
Only
Many related resources. Can be either a list
ProductCategory No default
subcategories False True False False of URIs or list of individually nested resource
(FK) provided.
data.
lock_add_subcategory Integer 0 False False False False Integer data. Ex: 2673
No default
provided.
film Boolean False False False False True Boolean data. Ex: True
event_info EventInfo (FK) True False False True
No default
film_rating String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
img_url String False True False False Unicode string data. Ex: "Hello World"
provided.
10T03:07:43"
lock_add_product Integer 0 False False False False Integer data. Ex: 2673
ProductCategory No default A single related resource. Can be either a URI
parent True False False True
brand Brand (FK) True False False True
is_service Boolean False False False False True Boolean data. Ex: True
No default
provided.
No default
provided.
10T03:07:43"
No default
provided.
Filtering
Name
updated_date
name
parent
include_inactive
active
establishment
Ordering
Name
sorting
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
ProductCategorySoldCount
URL: /products/ProductCategorySoldCount/?format=json
Default Limit: 20
FIELDS
sold_count Integer No default provided. True False False False Integer data. Ex: 2673
Filtering
Name
active
include_inactive
Name
GET
PUT
Name
GET
Resource:
ProductClass
URL: /products/ProductClass/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
provided.
ProductClass No default A single related resource. Can be either a
parent True False False True
10T03:07:43"
exclude_from_discounts Boolean False False False False True Boolean data. Ex: True
No default
admin_class_key String True False False False Unicode string data. Ex: "Hello World"
provided.
is_admin_class Boolean False False False False True Boolean data. Ex: True
No default
provided.
No default
provided.
Filtering
Name
updated_date
brand
name
Ordering
Name
sorting
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: ProductGroup
URL: /resources/ProductGroup/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
provided.
ProductGroupAction No default Many related resources. Can be either a list of
actions True True False True
No default
provided.
products Product (FK) True True False True
10T03:07:43"
No default
provided.
Filtering
Name
updated_date
name
include_inactive
created_date
active
establishment
id
Ordering
Name
id
Name
GET
PUT
PATCH
POST
Name
GET
PUT
PATCH
POST
Resource: ProductGroupAction
URL: /resources/ProductGroupAction/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
No default
provided.
Name
GET
POST
Name
GET
POST
Resource: ProductModifier
URL: /resources/ProductModifier/?format=json
Default Limit: 20
FIELDS
Read
Only
ProductModifierClass No default
product_modifier_class False False False False either a URI or set of nested resource
(FK) provided.
data.
11-10T03:07:43"
No default
provided.
No default
updated_by User (FK) False False False False either a URI or set of nested resource
provided.
data.
default_modifier Boolean False False False False True Boolean data. Ex: True
11-10T03:07:43"
No default
created_by User (FK) False False False False either a URI or set of nested resource
provided.
data.
No default
cost_override Float True False False False Floating point numeric data. Ex: 26.73
provided.
enforce_substitution Boolean False False False False True Boolean data. Ex: True
No default
modifier Modifier (FK) False False False False either a URI or set of nested resource
provided.
data.
No default
price_override Float provided. True False False False Floating point numeric data. Ex: 26.73
No default
provided.
Filtering
Name
product_modifier_class
updated_date
modifier
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: ProductModifierClass
URL: /resources/ProductModifierClass/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
amount_free Float True False False False Floating point numeric data. Ex: 26.73
provided.
ModifierClass No default A single related resource. Can be either a
modifierclass False False False False
No default
amount_free_is_dollars Boolean True False False False Boolean data. Ex: True
provided.
auto_jumping Boolean False False False False True Boolean data. Ex: True
10T03:07:43"
No default
provided.
Filtering
Name
active
product
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: ProductPriceLifeCycleAction
URL: /resources/ProductPriceLifeCycleAction/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
applied Boolean False False False False True Boolean data. Ex: True
Product No default A single related resource. Can be either a URI
No default
shell_price_reference_id String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
max_threshold_price Decimal True False False True Fixed precision numeric data. Ex: 26.73
provided.
No default
deleted Boolean True True False True Boolean data. Ex: True
provided.
No default
price Decimal True False False True Fixed precision numeric data. Ex: 26.73
provided.
No default
shell_price_comment_text String True False False False Unicode string data. Ex: "Hello World"
provided.
start_date Datetime False False False False
No default
shell_method_of_payment String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
min_price Decimal True False False True Fixed precision numeric data. Ex: 26.73
provided.
No default
shell_price_code String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
provided.
10T03:07:43"
No default
active Boolean True False False True Boolean data. Ex: True
provided.
start_date_tz Datetime False True False False
10T03:07:43"
e29b-41d4-a716-446655440000
Filtering
Name
applied
updated_date
product
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: ProductPurchase
URL: /resources/ProductPurchase/?format=json
Default Limit: 20
FIELDS
Read
Only
No
original_price Decimal default True False False False
Ex: 26.73
provided.
No
quick_pick_group String default True False False False
"Hello World"
provided.
Ex: 26.73
No
purchase_product_age Integer default True False False False Integer data. Ex: 2673
provided.
sku String True False False False
"Hello World"
Universally unique identifier.
uuid UUID False False True True Ex- 550e8400-e29b-41d4-
a716-446655440000
purchase_reward_multiplier Float 1.0 False False False False
Ex: 26.73
No
min_price Float default True False False False
Ex: 26.73
provided.
uom String Unit True False False False
"Hello World"
No
Ex: 26.73
provided.
No
product_brand String default True False False False
"Hello World"
provided.
No
shopify_sku String default True False False False
"Hello World"
provided.
Ex: 26.73
No
item_no Integer default True False False False Integer data. Ex: 2673
provided.
No
sorting Integer default False False False False Integer data. Ex: 2673
provided.
No
"Hello World"
provided.
No
"Hello World"
provided.
No
point_redeem Float default True False False False
provided. Ex: 26.73
No
ProductPurchaseOrderItem be either a list of URIs or list
orderitems default True False False False
provided.
resource data.
Ex: 26.73
kitchen_print_name String True False False False
"Hello World"
No
cost Decimal default True False False False
Ex: 26.73
provided.
No
third_party_id String default True False False False
"Hello World"
provided.
No
crv_label String default True False False False
"Hello World"
provided.
comments String True False False False
"Hello World"
No
unit_size String default True False False False
"Hello World"
provided.
No
provided.
Ex: 26.73
No
alternate_lookup String default True False False False
"Hello World"
provided.
No
"Hello World"
provided.
No
point_value Integer default True False False False Integer data. Ex: 2673
provided.
No
manufacturer String default True False False False
"Hello World"
provided.
kitchen_description String True False False False
"Hello World"
No
product_width Decimal default True False False False
Ex: 26.73
provided.
No
msrp Decimal default True False False False
Ex: 26.73
provided.
"2010-11-10T03:07:43"
No
retail String default True False False False
"Hello World"
provided.
No
promotional_product Boolean default True False False False Boolean data. Ex: True
provided.
No
product_length_unit String default True False False False
"Hello World"
provided.
Ex: 26.73
No
start_date Datetime default True False False False
"2010-11-10T03:07:43"
provided.
No
product_width_unit String default True False False False
"Hello World"
provided.
No
max_threshold_price Float default True False False False
Ex: 26.73
provided.
Ex: 26.73
No
delivery_method Integer default True False False False Integer data. Ex: 2673
provided.
No
dept String default True False False False
"Hello World"
provided.
No
product_height Decimal default True False False False
Ex: 26.73
provided.
No
redemption_level String default True False False False
"Hello World"
provided.
dining_options String [] True False False False
"Hello World"
"2010-11-10T03:07:43"
No
purchase_product_age_msg String default True False False False
"Hello World"
provided.
No
end_date Datetime default True False False False
"2010-11-10T03:07:43"
provided.
No
product_length Decimal default True False False False
Ex: 26.73
provided.
No
tare Float default True False False False
Ex: 26.73
provided.
establishment Establishment (FK) default True False False True be either a URI or set of
No
bin_value String default True False False False
"Hello World"
provided.
description String True False False False
"Hello World"
No
price Float default False False False False
Ex: 26.73
provided.
No
"Hello World"
provided.
No Unicode string data. Ex:
product_height_unit String default True False False False "Hello World"
provided.
No
prep_yield Decimal default True False False False
Ex: 26.73
provided.
No
max_price Float default True False False False
Ex: 26.73
provided.
No
"Hello World"
provided.
Filtering
Name
barcode
establishment
id
Ordering
Name
id
Name
GET
Name
GET
Resource: ProductPurchaseOrderItem
URL: /resources/ProductPurchaseOrderItem/?format=json
Default Limit: 20
FIELDS
Read
Only
ViewPurchaseOrder No default A single related resource. Can be either a
purchase True False False False
No default
total_price Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
inventory_unit String Unit True False False False Unicode string data. Ex: "Hello World"
No default
provided.
No default
conversion_factor Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
tax_rate Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
closed Boolean False False False False True Boolean data. Ex: True
reorder_unit String Unit False False False False Unicode string data. Ex: "Hello World"
No default
quantity Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
price Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
paid_by_ebt Boolean False False False False True Boolean data. Ex: True
Ordering
Name
id
Name
GET
PUT
PATCH
Name
GET
PUT
PATCH
Resource:
ProductRecipe
URL: /resources/ProductRecipe/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
main_product False False False False
No default
provided.
No default
quantity Float False False False False Floating point numeric data. Ex: 26.73
provided.
Filtering
Name
product
main_product
ingredient
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: ProductRevelImage
URL: /resources/ProductRevelImage/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: ProductSerial
URL: /resources/ProductSerial/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
serial String False False False False Unicode string data. Ex: "Hello World"
provided.
No default
provided.
No default
provided.
Filtering
Name
product
type
serial
Ordering
Name
id
Name
GET
Name
GET
Resource: ProductVariablePrice
URL: /resources/ProductVariablePrice/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
No default
provided.
No default
weight Float False False False False Floating point numeric data. Ex: 26.73
provided.
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: ProtocolType
URL: /resources/ProtocolType/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
provided.
No default
provided.
No default
provided.
Ordering
Name
id
Name
GET
PUT
PATCH
Name
GET
PUT
PATCH
Resource: PumpProtocolData
URL: /resources/PumpProtocolData/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
provided.
No default
provided.
ProtocolType No default A single related resource. Can be either a URI or set
protocol_type False False False False
No default
provided.
Ordering
Name
id
Name
GET
PUT
PATCH
Name
GET
PUT
PATCH
Resource: PumpTypeData
URL: /resources/PumpTypeData/?format=json
Default Limit: 20
FIELDS
Read
Only
PumpProtocolData No default
protocol False False False False either a URI or set of nested resource
(FK) provided.
data.
No default
price_off_set Integer True False False False Integer data. Ex: 2673
provided.
is_blending Boolean False False False False True Boolean data. Ex: True
No default
max_no_responses Integer True False False False Integer data. Ex: 2673
provided.
No default
volume_format String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
max_hoses Integer True False False False Integer data. Ex: 2673
provided.
No default
poll_response_timeout Integer True False False False Integer data. Ex: 2673
provided.
has_tag_reader Boolean False False False False True Boolean data. Ex: True
No default
value_off_set Integer True False False False Integer data. Ex: 2673
provided.
is_single_hose_auth Boolean False False False False True Boolean data. Ex: True
No default
running_total_polling_rate Integer True False False False Integer data. Ex: 2673
provided.
has_lights Boolean False False False False True Boolean data. Ex: True
No default
polling_rate Integer True False False False Integer data. Ex: 2673
provided.
11-10T03:07:43"
No default
default_display_type Integer True False False False Integer data. Ex: 2673
provided.
has_preset Boolean False False False False True Boolean data. Ex: True
No default
max_price_levels Integer True False False False Integer data. Ex: 2673
provided.
No default
price_format String True False False False Unicode string data. Ex: "Hello World"
provided.
is_multiplier Boolean False False False False True Boolean data. Ex: True
No default
provided.
No default A date & time as a string. Ex: "2010-
provided. 11-10T03:07:43"
No default
inter_char_timeout Integer True False False False Integer data. Ex: 2673
provided.
provided. 11-10T03:07:43"
No default
provided.
No default
provided.
No default
value_format String True False False False Unicode string data. Ex: "Hello World"
provided.
Ordering
Name
id
Name
GET
PUT
PATCH
Name
GET
PUT
PATCH
Resource:
Pumps
URL: /resources/Pumps/?format=json
Default Limit: 20
FIELDS
Read
Only
price_level_profile_2 Integer 1 False False False False Integer data. Ex: 2673
10T03:07:43"
No default A short name used by the system operator to
name String True False False False
provided. identify this pump.
PumpTypeData No default A single related resource. Can be either a URI or
type True False False False
error_message String True False False False Unicode string data. Ex: "Hello World"
No default The pump number of the pump as Displayed on
number Integer False False False False
provided. the POS and card Terminals.
Indicates whether the pump has an integrated Tag
tag_reader Boolean False False False False True
Reader fitted.
price_level_profile_1 Integer 1 False False False False Integer data. Ex: 2673
No default
provided.
The polling address of the pump used by the
pooling_address Integer 0 True False False False pump driver to Communicate to the pump. This is
Restricted to 1 to 16.
No default
provided.
enabler_port PortData (FK) True False False False
Filtering
Name
establishment
Ordering
Name
id
Name
GET
PUT
PATCH
Name
GET
PUT
PATCH
Resource: PurchaseLedger
URL: /resources/PurchaseLedger/?format=json
Default Limit: 20
FIELDS
Read
Only
vendor_fax String False False False True
World"
shipping_state String False False False True
World"
finalized Boolean False False False False True Boolean data. Ex: True
shipping_terms String False False False True
World"
Sept. 18,
overriden_created_date Datetime 2017, 3:36 False False False False
"2010-11-10T03:07:43"
p.m.
26.73
vendor_zip String False False False True
World"
No default
created_by User (FK) False False False False either a URI or set of nested
provided.
resource data.
invoice_number String True False False False
provided. World"
invoice_note String True False False False
provided. World"
World"
total Decimal 0.0000 False False False False
26.73
vendor_email String False False False True
World"
vendor_contact_name String False False False True
World"
446655440000
provided. World"

vendor_state String False False False True
World"
comments String False False False True
World"
original_invoice_id String True False False False
provided. World"
is_sent Boolean False False False False True Boolean data. Ex: True
No default
fob Integer True False False False Integer data. Ex: 2673
provided.
shipping_contact_name String False False False True
World"
"2010-11-10T03:07:43"
contant_name_for_authorization String False False False True
World"
establishment False False False False either a URI or set of nested
(FK) provided.
resource data.
"2010-11-10T03:07:43"
shipping_name String False False False False
provided. World"
sent_date Datetime None True False False False
"2010-11-10T03:07:43"
shipping_city String False False False True
World"
vendor_phone_number String False False False True
World"
vendor_id String True False False False
provided. World"
invoice_date Datetime True False False False
provided. "2010-11-10T03:07:43"
No default
purchase_type Integer False False False False Integer data. Ex: 2673
provided.
26.73
vendor_address2 String False False False True
World"
shipping_address1 String False False False True
World"
World"
vendor_address1 String False False False True World"

shipping_email String False False False True
World"
is_submitted Boolean False False False False True Boolean data. Ex: True
No default
updated_by User (FK) False False False False either a URI or set of nested
provided.
resource data.
shipping_and_handling Decimal 0.00 False False False False
26.73
is_deleted Boolean False False False False True Boolean data. Ex: True
shipping_zip String False False False True
World"
vendor_city String False False False True
World"
contact_phone String False False False True
World"
finalized_date Datetime None True False False False
"2010-11-10T03:07:43"
vendor_account_no String False False False True
World"
contact_fax String False False False True
World"
misc_amount Decimal 0.00 False False False False
26.73
contact_email String False False False True
World"
vendor_name String False False False False
provided. World"
shipping_phone_number String False False False True
World"
shipping_country String USA False False False True
World"
vendor_country String USA False False False True
World"
Filtering
Name
status
establishment
Ordering
Name
purchase_type
total
invoice_date
original_invoice_id
created_date
invoice_number
vendor_name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
Resource: PurchaseOrder
URL: /resources/PurchaseOrder/?format=json
Default Limit: 20
FIELDS
Read
Only
World"
World"
World"
Ex: 26.73
No default One of [partially_invoiced,
invoiced_status String False True False False
provided. uninvoiced, fully_invoiced]
World"
World"
No default One of [new, partially_received,
receive_status String False True False False
provided. fully_received, sent, finalized]
World"
Ex: 26.73
World"
World"
World"
provided. World"
World"
World"
No default
provided.
"2010-11-10T03:07:43"
World"
No default
establishment Establishment (FK) False False False False either a URI or set of nested
provided.
resource data.
"2010-11-10T03:07:43"
provided. World"
"2010-11-10T03:07:43"
shipping_city String False False False True World"
World"
vendor_id String True False False False
provided. World"
No default
establishment_id Integer False True False False Integer data. Ex: 2673
provided.
World"
World"
World"
World"
World"
Ex: 26.73
Sept. 18,
overriden_created_date Datetime 2017, 3:36 False False False False
"2010-11-10T03:07:43"
p.m.
World"
World"
World"
"2010-11-10T03:07:43"
contact_fax String False False False True World"

Ex: 26.73
World"
provided. World"
World"
World"
Many related resources. Can be
PurchaseOrderItem No default either a list of URIs or list of
orderitems True False False False
(FK) provided. individually nested resource
data.
World"
Filtering
Name
updated_date
establishment
Ordering
Name
id
Name
GET
PATCH
PUT
POST
Name
GET
PATCH
PUT
POST
Resource: PurchaseOrderInvoice
URL: /resources/PurchaseOrderInvoice/?format=json
Default Limit: 20
FIELDS
Read
Only
shipping_terms String False False False True Unicode string data. Ex: "Hello World"
shipping_and_handling Decimal 0.0000 False False False False Fixed precision numeric data. Ex: 26.73
10T03:07:43"
10T03:07:43"
tax Decimal 0.0000 False False False False Fixed precision numeric data. Ex: 26.73
comments String False False False True Unicode string data. Ex: "Hello World"
overrides_po_costs Boolean False False False False True Boolean data. Ex: True
PurchaseOrder No default A single related resource. Can be either a
purchase_order False False False False
vendor_invoice_no String False False False True Unicode string data. Ex: "Hello World"
10T03:07:43"
misc_amount Decimal 0.0000 False False False False Fixed precision numeric data. Ex: 26.73
No default Unicode string data. Ex: "Hello World"
resource_uri String provided. False True False False
Filtering
Name
purchase_order
Ordering
Name
id
Name
GET
PATCH
PUT
Name
GET
POST
Resource: PurchaseOrderItem
URL: /resources/PurchaseOrderItem/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
ingredient Ingredient (FK) True False False False either a URI or set of nested resource
provided.
data.
ViewPurchaseOrderProduct No default
product True False False False either a URI or set of nested resource
(FK) provided.
data.
total_price Decimal False False False False
provided. 26.73
tax_rate Decimal True False False False
provided. 26.73
inventory_unit String Unit True False False False Unicode string data. Ex: "Hello World"
No default
provided.
price Decimal False False False False
provided. 26.73
No default
purchase_order PurchaseOrder (FK) False False False False either a URI or set of nested resource
provided.
data.
conversion_factor Decimal False True False True
provided. 26.73
No default
reorder_unit_type InventoryUnit (FK) True False False False either a URI or set of nested resource
provided.
data.
closed Boolean False False False False True Boolean data. Ex: True
paid_by_ebt Boolean False False False False True Boolean data. Ex: True
quantity Decimal False False False False
provided. 26.73
Ordering
Name
id
Name
GET
PUT
PATCH
POST
Name
GET
PUT
PATCH
POST
Resource: ReceiptText
URL: /resources/ReceiptText/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
start_date_time Datetime True False False False
No default
range_to String True False False False Unicode string data. Ex: "Hello World"
provided.
10T03:07:43"
lines String False False False False Unicode string data. Ex: "Hello World"
No default
transaction_type Integer True False False False Integer data. Ex: 2673
provided.
No default
range_from String True False False False Unicode string data. Ex: "Hello World"
provided.
end_date_time Datetime True False False False
No default
provided.
No default
provided.
Filtering
Name
updated_date
start_date_time
establishment
end_date_time
Ordering
Name
id
Name
GET
POST
PUT

Name
GET
POST
PUT
Resource: Return
URL: /resources/Return/?format=json
Default Limit: 20
FIELDS
Read
Only
Customer No default A single related resource. Can be either a URI or set
payout Payout (FK) True False False True
ReturnedItem No default Many related resources. Can be either a list of URIs
return_items False True False False
No default
total_tax Float False False False False Floating point numeric data. Ex: 26.73
provided.
No default
reason String False False False False Unicode string data. Ex: "Hello World"
provided.

order Order (FK) True False False True of nested resource data.
provided.
canceled Boolean False False False False True Boolean data. Ex: True
No default
provided.
No default
tax_country String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
tender Integer True False False False Integer data. Ex: 2673
provided.
Establishment No default A single related resource. Can be either a URI or set
No default
return_date Datetime False False False False A date & time as a string. Ex: "2010-11-10T03:07:43"
provided.
No default
provided.
Filtering
Name
order
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
ReturnedItem
URL: /resources/ReturnedItem/?format=json
Default Limit: 20
FIELDS
Read
Only
uuid UUID True False True False
provided. 41d4-a716-446655440000
weight Float None True False False False Floating point numeric data. Ex: 26.73
No default
provided.
No default
tax Float False False False False Floating point numeric data. Ex: 26.73
provided.
inventory_cost Decimal None True False False False Fixed precision numeric data. Ex: 26.73
inventory_update Boolean False False False False True Boolean data. Ex: True
No default
product_price Float False False False False Floating point numeric data. Ex: 26.73
provided.
No default
tax_rate Float False False False False Floating point numeric data. Ex: 26.73
provided.
serial_number String None True False False False Unicode string data. Ex: "Hello World"
No default
return_value Float False False False False Floating point numeric data. Ex: 26.73
provided.
Return No default A single related resource. Can be either a URI or set
returns False False False False
quantity Integer 1 False False False True Integer data. Ex: 2673
Filtering
Name
serial_number
returns
product
Ordering
Name
id
Name
GET
POST
PUT
PATCH

Name
GET
POST
PUT
PATCH
Resource: RevelImage
URL: /resources/RevelImage/?format=json
Default Limit: 20
FIELDS
is_public Boolean True False False False True Boolean data. Ex: True
purpose Integer No default provided. True False False False Integer data. Ex: 2673
Filtering
Name
is_public
Name
GET
Name
GET
Resource: RevenueCenter
URL: /resources/RevenueCenter/?format=json
Default Limit: 20
FIELDS
Read
Only
PosStation No default Many related resources. Can be either a list of URIs
pos_stations True False False True
No default
provided.
No default
provided.
Filtering
Name
establishment
name
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
RewardCardLog
URL: /resources/RewardCardLog/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
type_of_change String False False False False Unicode string data. Ex: "Hello World"
provided.
points_by_visits Integer 0 False False False True Integer data. Ex: 2673
No default
point Float False False False False Floating point numeric data. Ex: 26.73
provided.
No default
import_uuid String True False True False Unicode string data. Ex: "Hello World"
provided.
RewardsCard No default A single related resource. Can be either a URI
reward_card True False False True
visit Boolean False False False False True Boolean data. Ex: True
import_date Datetime True False False False
No default
provided.
points_by_purchases Float 0.0 False False False True Floating point numeric data. Ex: 26.73
No default
export_uuid String True False True False Unicode string data. Ex: "Hello World"
provided.
No default
purchased Float False False False False Floating point numeric data. Ex: 26.73
provided.
10T03:07:43"
No default
provided.
Filtering
Name
updated_date
reward_card
establishment
card_number
order
Ordering
Name
id

Name
GET
POST
PUT
Name
GET
POST
PUT
Resource:
RewardsCard
URL: /resources/RewardsCard/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
10T03:07:43"
No default
total_purchases Float False False False False Floating point numeric data. Ex: 26.73
provided.
No default
current_points Float False False False False Floating point numeric data. Ex: 26.73
provided.
No default
provided.
No default
total_points Float False False False False Floating point numeric data. Ex: 26.73
provided.
No default
provided.
Address No default A single related resource. Can be either a URI or

address True False False True set of nested resource data.
(FK) provided.
No default
total_visits Integer False False False False Integer data. Ex: 2673
provided.
No default
provided.
Filtering
Name
customer
id
number
Ordering
Name
id
Name
GET
POST
PUT
Name
GET
POST
PUT
Resource:
RewardsCardNew
URL: /resources/RewardsCardNew/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
Customer No default A single related resource. Can be either a URI
10T03:07:43"
No default
provided.
No default
provided.
No default
provided.
No default
provided.
No default
provided.

address Address (FK) True False False True or set of nested resource data.
provided.
No default
provided.
No default
provided.
Filtering
Name
customer
updated_date
created_date
id
number
Ordering
Name
id

Name
GET
POST
PUT
Name
GET
POST
PUT
Resource: RewardsCardv3
URL: /resources/RewardsCardv3/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
Customer No default A single related resource. Can be either a URI
address Address (FK) True False False True
No default
provided.
No default
provided.
No default
provided.
No default
provided.
10T03:07:43"
No default
provided.
No default
provided.
No default
provided.
Filtering
Name
customer
updated_date
created_date
id
number
Ordering
Name
id
Name
GET
POST
PUT
Name
GET
POST
PUT
Resource: Role
URL: /resources/Role/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
Department No default A single related resource. Can be either a URI or set
department False False False False
10T03:07:43"
No default
provided.
No default
provided.
Filtering
Name
active
establishment
Ordering
Name
id
Name
GET
Name
GET
Resource: SMSMessageIncoming
URL: /resources/SMSMessageIncoming/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
e29b-41d4-a716-446655440000
text String False False False False Unicode string data. Ex: "Hello World"
No default
customer_phone String False False False False Unicode string data. Ex: "Hello World"
provided.
No default
establishment_phone String False False False False Unicode string data. Ex: "Hello World"
provided.
received_date Datetime False False False False
10T03:07:43"
version_date Datetime True True False True
No default
provided.
Filtering
Name
updated_date
establishment
received_date
Ordering
Name
id
Name
GET
Name
GET
Resource: SMSMessageOutcoming
URL: /resources/SMSMessageOutcoming/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
customer Customer (FK) True False False True
sent_date Datetime True False False False
No default
uuid UUID False False True False 550e8400-e29b-41d4-a716-
provided.
446655440000
text String False False False False Unicode string data. Ex: "Hello World"
No default
sms_type Integer False False False False Integer data. Ex: 2673
provided.
No default
customer_phone String False False False False Unicode string data. Ex: "Hello World"
provided.
No default
object_id Integer True False False False Integer data. Ex: 2673
provided.
TableReservation No default A single related resource. Can be either a
content_object True False False True
No default
establishment_phone String True False False False Unicode string data. Ex: "Hello World"
provided.
10T03:07:43"
sending_failed Boolean False False False False True Boolean data. Ex: True
outdated_date Datetime True False False False
10T03:07:43"
No default
provided.
Filtering
Name
updated_date
establishment
outdated_date
sent_date
content_object
Ordering
Name
id

Name
POST
GET
PUT
Name
POST
GET
PUT
Resource:
ServiceFee
URL: /resources/ServiceFee/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
autoapply_guestcount Integer True False False False Integer data. Ex: 2673
provided.
No default
autoapply_paymenttype Integer True False False False Integer data. Ex: 2673
provided.
application_type Integer 0 False False False False Integer data. Ex: 2673
No default
autoapply_type Integer True False False False Integer data. Ex: 2673
provided.
min_threshold Decimal 0.0 False False False False Fixed precision numeric data. Ex: 26.73
List Of No default
autoapply_diningtype True False False True A list of data. Ex: [1, 5, 8]
Integers provided.
Timetable No default A single related resource. Can be either a
autoapply_timetable False False False True
10T03:07:43"
No default
provided.
password_required Boolean False False False False True Boolean data. Ex: True
List Of No default
autoapply_paymentcard True False False True A list of data. Ex: [1, 5, 8]
Integers provided.
No default
servicefee_type Integer False False False False Integer data. Ex: 2673
provided.
No default
provided.
No default
provided.
apply_post_tax Boolean False False False False True Boolean data. Ex: True
10T03:07:43"
No default
provided.
Filtering
Name
name
updated_by
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: ShipRate
URL: /resources/ShipRate/?format=json
Default Limit: 20
FIELDS
not_used String No default provided. True False False False Unicode string data. Ex: "Hello World"
shipping_charge Float No default provided. True False False False Floating point numeric data. Ex: 26.73
ship_compliant_code String No default provided. True False False False Unicode string data. Ex: "Hello World"
zone String No default provided. True False False False Unicode string data. Ex: "Hello World"
end_weight Float No default provided. True False False False Floating point numeric data. Ex: 26.73
country String No default provided. True False False False Unicode string data. Ex: "Hello World"
state String No default provided. True False False False Unicode string data. Ex: "Hello World"
start_weight Float No default provided. True False False False Floating point numeric data. Ex: 26.73
end_order_total Float No default provided. True False False False Floating point numeric data. Ex: 26.73
start_order_total Float No default provided. True False False False Floating point numeric data. Ex: 26.73
class_of_service String No default provided. True False False False Unicode string data. Ex: "Hello World"
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: SiteModeSettings
URL: /resources/SiteModeSettings/?format=json
Default Limit: 20
FIELDS
Read
Only
fallback Boolean False False False False True Whether fallback mode is allowed for this pump.
10T03:07:43"
No
created Datetime default True False False False
10T03:07:43"
provided.
Is pump stacking allowed during this profile. A
pump stack is a per pump stack of un-cleared
stacking Boolean False False False False True
deliveries. Note this Setting can override that
specified in the site profile table.
No
Establishment A single related resource. Can be either a URI or
provided.
No
last_sync Datetime default True False False False
10T03:07:43"
provided.
Are the pump lights on or off for this profile: 0 =
lights Boolean False False False False True Off 1 = On 2 = Use site setting. Note this setting
can override that specified in the site profile.
Available choices: (0, Off), (1, , Monitors), (2,
authorise_mode Integer 0 False False False False
Attendant)
This column determines the maximum number
No of stacked (complete unsold) pump deliveries
max_stacked_deliveries Integer default True False False False that may be stored for this pump. Replaces the
provided. previous site-wide setting.
Is auto pump stacking allowed during this

profile. Auto pump stacking is the shifting of a
current delivery to the pump Stack, if there is
auto_stack Boolean False False False False True room, when a Pump calls, allowing the pump to
auto-authorise and start Delivering again. Note
this setting can override that specified in the
site setting table.
Is the pump auto-authorise, ie. will the pump
start delivering without requiring authorisation
by a system operator when the hose is removed
by a customer. This mode is only relevant for
auto_auth Boolean False False False False True postpay and monitor deliveries. If both of the
Allow_Postpay and Allow_Monitor flags are 1 the
contents of this column are ignored. Note: This
setting can override that specified in the site
profile.
No
external_id Integer default True False False False Integer data. Ex: 2673
provided.
No
provided.
Filtering
Name
establishment
Ordering
Name
id
Name
GET
PUT
PATCH
POST
Name
GET
PUT
PATCH
POST
Resource: SocialNetwork
URL: /resources/SocialNetwork/?format=json
Default Limit: 20
FIELDS
url String No default provided. False False False False Unicode string data. Ex: "Hello World"
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
SpecialRequest
URL: /resources/SpecialRequest/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
provided.
No default
provided.
10T03:07:43"
No default
provided.
Ordering
Name
id
Name
GET
Name
GET
Resource: Surcharge
URL: /resources/Surcharge/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
No default
provided.
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: SystemSetting
URL: /resources/SystemSetting/?format=json
Default Limit: 500
FIELDS
Read
Only
delivery_printers Device (FK) default False False False False either a list of URIs or list of
incoming_web_orders_printers Device (FK) default False False False False either a list of URIs or list of
other_printers Device (FK) default False False False False either a list of URIs or list of
No
World"
provided.
drivethrough_printers Device (FK) default False False False False either a list of URIs or list of
order_taker_stations PosStation (FK) default True False False True either a list of URIs or list of
shipping_printers Device (FK) default False False False False either a list of URIs or list of

move_merge_printers Device (FK) default False False False False either a list of URIs or list of
establishment Establishment (FK) default False False False False either a URI or set of nested
catering_printers Device (FK) default False False False False either a list of URIs or list of
tax_included_revenue_centers RevenueCenter (FK) default True False False True either a list of URIs or list of
togo_printers Device (FK) default False False False False either a list of URIs or list of
payment_taker_stations PosStation (FK) default True False False True either a list of URIs or list of
SystemSettingOption default
settingoptions False False False False either a list of URIs or list of
(FK) provided. individually nested resource data.

reports_itemtracking_printers Device (FK) default False False False False either a list of URIs or list of
onlineordering_printers Device (FK) default False False False False either a list of URIs or list of
extra_items_printers Device (FK) default False False False False either a list of URIs or list of
eatin_printers Device (FK) default False False False False either a list of URIs or list of
Filtering
Name
establishment
Ordering
Name
id
Name
GET
Name
GET
Resource: SystemSettingOption
URL: /resources/SystemSettingOption/?format=json
Default Limit: 20
FIELDS
Read
Only
parameter_value String False False False False Unicode string data. Ex: "Hello World"
SystemSetting No default A single related resource. Can be either a URI
settings_parent False False False False
enabled Boolean False False False False False Boolean data. Ex: True
No default
choices_array String True True False False Unicode string data. Ex: "Hello World"
provided.
No default
display_format Integer True True False False Integer data. Ex: 2673
provided.
No default
staff_only Boolean True True False False Boolean data. Ex: True
provided.
No default
user_friendly_name String True True False False Unicode string data. Ex: "Hello World"
provided.
No default
setting_name String False False False False Unicode string data. Ex: "Hello World"
provided.
No default
parameter_name String True True False False Unicode string data. Ex: "Hello World"
provided.
establishment False True False False
No default
provided.
Filtering
Name
setting_name
settings_parent
Ordering
Name
id
Name
GET
Name
GET
Resource: Table
URL: /resources/Table/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
capacity Integer True False False False Integer data. Ex: 2673
provided.
No default
provided.
No default
qr_code_text String True False False False Unicode string data. Ex: "Hello World"
provided.
TableType No default A single related resource. Can be either a URI or set
table_type False False False False
TableSection No default A single related resource. Can be either a URI or set
section False False False False
No default Many related resources. Can be either a list of URIs
table_tags TableTag (FK) True False False True
provided. or list of individually nested resource data.
No default
y_value Float False False False False Floating point numeric data. Ex: 26.73
provided.
No default
x_value Float False False False False Floating point numeric data. Ex: 26.73
provided.
No default
rotation Float True False False False Floating point numeric data. Ex: 26.73
provided.
establishment provided. False False False False
(FK) of nested resource data.
No default
provided.
Ordering
Name
id
Name
GET
PUT
Name
GET
PUT
Resource:
TableReservation
URL: /resources/TableReservation/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
removal_reason String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
customer_phone_number String True False False False Unicode string data. Ex: "Hello World"
provided.
seated_time Datetime True False False False
No default
customer_name String True False False False Unicode string data. Ex: "Hello World"
provided.
auto_notify Boolean False False False False True Boolean data. Ex: True
No default
assigned_tables Table (FK) False False False False of URIs or list of individually nested resource
provided.
data.
e29b-41d4-a716-446655440000
No default
assigned_tags TableTag (FK) False False False False of URIs or list of individually nested resource
provided.
data.
targeted_time Datetime False False False False
No default
party_size Integer True False False False Integer data. Ex: 2673
provided.

10T03:07:43"
No default
provided.
No default
customer_note String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
customer_email String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
reservation_type Integer False False False False Integer data. Ex: 2673
provided.
No default
order_uuid String True False True False Unicode string data. Ex: "Hello World"
provided.
Customer No default A single related resource. Can be either a
10T03:07:43"
No default
provided.
reserved_on Datetime True False False False
Filtering
Name
updated_date
targeted_time
status
establishment
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
TableSection
URL: /resources/TableSection/?format=json
Default Limit: 20
FIELDS
Read
Only
No default Many related resources. Can be either a list of URIs
tables Table (FK) False False False False
provided. or list of individually nested resource data.
No default
provided.
No default
provided.
Filtering
Name
active
establishment
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: TableTag
URL: /resources/TableTag/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
No default
pos_inactive_image_url String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
provided.
No default
pos_active_image_url String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
image_url String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
provided.
Filtering
Name
active
deleted
establishment
Ordering
Name
id
Name
GET
PATCH
POST
PUT
Name
GET
PATCH
POST
PUT
Resource: TableType
URL: /resources/TableType/?format=json
Default Limit: 20
FIELDS
name String No default provided. False False True False Unicode string data. Ex: "Hello World"
inactive_image_url String No default provided. False False False False Unicode string data. Ex: "Hello World"
height Float No default provided. False False False False Floating point numeric data. Ex: 26.73
width Float No default provided. False False False False Floating point numeric data. Ex: 26.73
active_image_url String No default provided. False False False False Unicode string data. Ex: "Hello World"
touch_image_url String No default provided. False False False False Unicode string data. Ex: "Hello World"
Ordering
Name
id
Name
GET
Name
GET
Resource: Tanks
URL: /resources/Tanks/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
diameter Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
grade Grades (FK) False False False False
No default
number Integer False False False False Integer data. Ex: 2673
provided.
No default
high_volume_alarm Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
capacity Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
high_water_alarm Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
10T03:07:43"
No default
physical_label String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
provided.
No default
high_volume_warning Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
low_volume_warning Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
provided.
No default
low_volume_alarm Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
provided.
Filtering
Name
deleted
establishment
Ordering
Name
id
Name
GET
PUT
PATCH
Name
GET
PUT
PATCH
Resource: Tax
URL: /resources/Tax/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
provided.
No default
provided.
No default
provided.
No default
provided.
TaxAgency No default A single related resource. Can be either a URI
agency True False False True
No default
tax_rate TaxRate (FK) True True False False URIs or list of individually nested resource
provided.
data.
created_date Datetime True False False False True A date & time as a string. Ex: "2010-11-
10T03:07:43"
No default
provided.
No default
provided.
No default
provided.
Filtering
Name
establishment
tax_rate
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: TaxAgency
URL: /resources/TaxAgency/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
provided.
10T03:07:43"
No default
provided.
Filtering
Name
active
establishment
id
name
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: TaxCode
URL: /resources/TaxCode/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
No default
provided.
No default
provided.
Filtering
Name
active
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: TaxProductGroup
URL: /resources/TaxProductGroup/?format=json
Default Limit: 20
FIELDS
Read
Only
No default Many related resources. Can be either a list of URIs or
all_taxes ViewTax (FK) True False False True
provided. list of individually nested resource data.
No default Many related resources. Can be either a list of URIs or
taxes ViewTax (FK) True True False True
provided. list of individually nested resource data.
is_prevailing Boolean False False False False True Boolean data. Ex: True
tax_rule Integer 0 False False False False Integer data. Ex: 2673
ProductGroup No default A single related resource. Can be either a URI or set
No default
provided.
Ordering
Name
id
Name
GET
POST
Name
GET
POST
Resource: TaxRate
URL: /resources/TaxRate/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
use_tax_table Boolean False False False False Boolean data. Ex: True
provided.
tax Tax (FK) False False False False
No default
tax_rate Float False False False False Floating point numeric data. Ex: 26.73
provided.
TaxTable No default A single related resource. Can be either a URI or set
No default
effective_from Datetime False False False False A date & time as a string. Ex: "2010-11-10T03:07:43"
provided.
No default
provided.
No default
effective_to Datetime True False False False A date & time as a string. Ex: "2010-11-10T03:07:43"
provided.
Filtering
Name
tax_rate
id
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: TaxTable
URL: /resources/TaxTable/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
provided.
10T03:07:43"
No default
provided.
No default
data String False False False False Unicode string data. Ex: "Hello World"
provided.
Filtering
Name
active
updated_date
establishment
Ordering
Name
id
Name
GET
POST
Name
GET
POST
Resource: Till
URL: /resources/Till/?format=json
Default Limit: 20
FIELDS
Read
Only
closed_by_employee User (FK) True False False False
No default
amount_in_bank_drop Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
provided.
PosStation No default A single related resource. Can be either a
held_by_employee User (FK) True False False False
No default
amount_till_set Decimal False False False False Fixed precision numeric data. Ex: 26.73
provided.
till_manager User (FK) True False False True
provided. e29b-41d4-a716-446655440000
No default
amount_present Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
employee User (FK) False False False False

10T03:07:43"
10T03:07:43"
closed Datetime True False False False
No default
amount_should_be Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
opened Datetime False False False False
No default
cash_drawer Integer False False False False Integer data. Ex: 2673
provided.
No default
amount_in_safe Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
cash_transactions Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
held_date Datetime True False False False
10T03:07:43"
No default
variance Decimal True False False False Fixed precision numeric data. Ex: 26.73
provided.
No default
provided.
Filtering
Name
employee
pos_station
establishment
opened
closed
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
TimeBlock
URL: /resources/TimeBlock/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
reverse Boolean False False False False True Boolean data. Ex: True
No default
provided.
start_time Datetime False False False False
No default
exclude_for_uuid String True False False False Unicode string data. Ex: "Hello World"
provided.
label String False False False False Unicode string data. Ex: "Hello World"
No default
repeat_days Integer False False False False Integer data. Ex: 2673
provided.
end_time Datetime False False False False
repeat_till_date Datetime True False False False
provided. e29b-41d4-a716-446655440000
Filtering
Name
updated_date
establishment
Ordering
Name
id
Name
GET
POST
PUT
PATCH

Name
GET
POST
PUT
PATCH
Resource: TimeSchedule
URL: /resources/TimeSchedule/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
shift_end_time Datetime False False False False
Department No default A single related resource. Can be either a URI or
department False False False False
No default
break_type Integer True False False False Integer data. Ex: 2673
provided.
role Role (FK) False False False False
10T03:07:43"
shift_begin_time Datetime False False False False
No default
provided.
stage Integer 0 False False False False Integer data. Ex: 2673
Filtering
Name
updated_date
shift_end_time
created_date
employee
shift_begin_time
establishment
id
Ordering
Name
id
Name
GET
POST
PUT
PATCH
DELETE
Name
GET
POST
PUT
PATCH
DELETE
Resource: TimeScheduleRule
URL: /resources/TimeScheduleRule/?format=json
Default Limit: 20
FIELDS
Read
Only
prevent_clockin_before_break_end Boolean False False False False True Boolean data. Ex: True
break_lengths String False False False True
World"
company_code_ADP String True False False False
provided. World"
allow_clockin_before_shift Boolean False False False False True Boolean data. Ex: True
labor_cost_goal_margin Float 1.0 False False False False
26.73
is_manual_paid_break Boolean False False False False True Boolean data. Ex: True
day_start_time Time 00:00 False False False False A time as string. Ex: "20:05:23"
No default Floating point numeric data. Ex:
overtime_value Float False False False False
provided. 26.73
No default
work_time_for_paid_break Time True False False False A time as string. Ex: "20:05:23"
provided.
is_include_declared_tips Boolean False False False False True Boolean data. Ex: True
adp_report_type Integer 0 False False False False Integer data. Ex: 2673
No default
limit_clockin_before_shift Time True False False False A time as string. Ex: "20:05:23"
provided.
is_manual_unpaid_break Boolean False False False False True Boolean data. Ex: True
No default
created_by User (FK) False False False False either a URI or set of nested
provided.
resource data.
enable_ADP_report Boolean False False False False True Boolean data. Ex: True
seventh_day_rule Boolean False False False False True Boolean data. Ex: True
establishment False False False False either a URI or set of nested
(FK) provided.
resource data.
labor_cost_goal Float 22.0 False False False False
26.73
"2010-11-10T03:07:43"
start_day Integer 0 False False False False Integer data. Ex: 2673
No default
updated_by User (FK) False False False False either a URI or set of nested
provided.
resource data.
No default
paid_break_duration Time True False False False A time as string. Ex: "20:05:23"
provided.
rate_overtime Float False False False False
provided. 26.73
No default
auto_clockout_time Time True False False False A time as string. Ex: "20:05:23"
provided.
doubletime_value Float False False False False
provided. 26.73
regular_value Float False False False False
provided. 26.73
regular_week_hours Float False False False False
provided. 26.73
rate_double Float False False False False
provided. 26.73
enable_12h_format Boolean False False False False True Boolean data. Ex: True
is_include_payment_tips Boolean False False False False True Boolean data. Ex: True
"2010-11-10T03:07:43"
provided. World"
Filtering
Name
establishment
Ordering
Name
id
Name
GET
Name
GET
Resource:
TimeSheetEntry
URL: /resources/TimeSheetEntry/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
clock_in Datetime False False False False
TimeSheetEntry No default A single related resource. Can be either a URI
parent True True False True
No default
provided.
No default
role_wage Float False False False False Floating point numeric data. Ex: 26.73
provided.
department_name String False False False True Unicode string data. Ex: "Hello World"
employee Employee (FK) False False False False
No default
break_type Integer True False False False Integer data. Ex: 2673
provided.
role_name String False False False True Unicode string data. Ex: "Hello World"

clock_out Datetime True False False False
10T03:07:43"
No default
break_length Integer True False False False Integer data. Ex: 2673
provided.
returned_date Datetime True True False True
is_auto_clock_out Boolean None True False False False Boolean data. Ex: True
stage Integer 0 False False False False Integer data. Ex: 2673
Filtering
Name
clock_in
updated_date
clock_out
created_date
employee
shift
establishment
id
Ordering
Name
clock_in
employee
role_name
id
clock_out
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
Timetable
URL: /resources/Timetable/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
TimetableItem No default Many related resources. Can be either a list of URIs
timetable_data True False False False
from_date Datetime True False False False
to_date Datetime True False False False
10T03:07:43"
Filtering
Name
active
type
establishment
id
Ordering
Name
id
Name
GET
POST
PUT
Name
GET
POST
PUT
Resource: TimetableItem
URL: /resources/TimetableItem/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
close_time Time False False False False A time as string. Ex: "20:05:23"
provided.
No default
day_of_week Integer False False False False Integer data. Ex: 2673
provided.
Timetable No default A single related resource. Can be either a URI or set
timetable True False False True
No default
open_time Time False False False False A time as string. Ex: "20:05:23"
provided.
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
UnitType
URL: /resources/UnitType/?format=json
Default Limit: 20
FIELDS
is_default Boolean False False False False True Boolean data. Ex: True
Filtering
Name
name
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource:
UpdateTimes
URL: /resources/UpdateTimes/?format=json
Default Limit: 20
FIELDS
objects List No default provided. False False False False A list of data. Ex: ['abc', 26.73, 8]
Name
GET
Name
Resource:
User
URL: /enterprise/User/?format=json
Default Limit: 20
FIELDS
Read
Only
No default Required. 50 characters or fewer. Letters, digits
username String False False True False
provided. and @/./+/-/_ only.
first_name String False False False True Unicode string data. Ex: "Hello World"
last_name String False False False True Unicode string data. Ex: "Hello World"
has_ems_access Boolean False False False False True Boolean data. Ex: True
is_global_superuser Boolean False False False False True Boolean data. Ex: True
Designates whether this user should be treated as
is_active Boolean True False False False True
active. Unselect this instead of deleting accounts.
additional_data String {} True False False False Unicode string data. Ex: "Hello World"
Designates whether the user can log into this
is_staff Boolean False False False False True
admin site.
Sept. 18,
last_login Datetime 2017, 3:36 False False False False
10T03:07:43"
p.m.
No default
provided.
Sept. 18,
date_joined Datetime 2017, 3:36 False False False False
10T03:07:43"
p.m.
Filtering
Name
is_active
Ordering
Name
last_login
Name
GET
Name
GET
Resource: Vendor
URL: /resources/Vendor/?format=json
Default Limit: 20
FIELDS
Read
Only
vendor_tax_id String False False False True Unicode string data. Ex: "Hello World"
shipping_terms String False False False True Unicode string data. Ex: "Hello World"
twitter String False False False True Unicode string data. Ex: "Hello World"
linkedin String False False False True Unicode string data. Ex: "Hello World"
vendor_eligible_for_1099 Boolean False False False False True Boolean data. Ex: True
contact_name String False False False True Unicode string data. Ex: "Hello World"
email2 String False False False True Unicode string data. Ex: "Hello World"
payment_terms String False False False True Unicode string data. Ex: "Hello World"
city String False False False True Unicode string data. Ex: "Hello World"
zip String False False False True Unicode string data. Ex: "Hello World"
billed_from_zip String False False False True Unicode string data. Ex: "Hello World"
establishments False True False False of URIs or list of individually nested resource
(FK) provided.
data.
website String False False False True Unicode string data. Ex: "Hello World"
url4 String False False False True Unicode string data. Ex: "Hello World"
state String False False False True Unicode string data. Ex: "Hello World"
No default
provided.
phone_other String False False False True Unicode string data. Ex: "Hello World"
phone_number String False False False True Unicode string data. Ex: "Hello World"
email String False False False True Unicode string data. Ex: "Hello World"
account_number String False False False True Unicode string data. Ex: "Hello World"
10T03:07:43"
fax String False False False True Unicode string data. Ex: "Hello World"
address1 String False False False True Unicode string data. Ex: "Hello World"
address2 String False False False True Unicode string data. Ex: "Hello World"
10T03:07:43"
billed_from_state String False False False True Unicode string data. Ex: "Hello World"
vendor_type String False False False True Unicode string data. Ex: "Hello World"
facebook String False False False True Unicode string data. Ex: "Hello World"
skype_id String False False False True Unicode string data. Ex: "Hello World"
billed_from_country String False False False True Unicode string data. Ex: "Hello World"
billed_from_address2 String False False False True Unicode string data. Ex: "Hello World"
billed_from_address1 String False False False True Unicode string data. Ex: "Hello World"
print_name_on_check_as String False False False True Unicode string data. Ex: "Hello World"
country String USA False False False True Unicode string data. Ex: "Hello World"
phone_mobile String False False False True Unicode string data. Ex: "Hello World"
billed_from_city String False False False True Unicode string data. Ex: "Hello World"
No default
vendor_name String False False False False Unicode string data. Ex: "Hello World"
provided.
No default
provided.
Filtering
Name
updated_date
active
brand
id
establishments
Ordering
Name
vendor_name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: VendorEstablishment
URL: /resources/VendorEstablishment/?format=json
Default Limit: 20
FIELDS
Read
Only
vendor Vendor (FK) False False False False
No default
provided.
Filtering
Name
id
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: VendorOrderableItem
URL: /resources/VendorOrderableItem/?format=json
Default Limit: 20
FIELDS
Read
Only
default_price Decimal True False False False
provided. 26.73
ViewPurchaseOrderProduct No default
product True False False False either a URI or set of nested resource
(FK) provided.
data.
No default
vendor Vendor (FK) False False False False either a URI or set of nested resource
provided.
data.
default_quantity Decimal True False False False
provided. 26.73
No default
vendor_item_id String True False False False Unicode string data. Ex: "Hello World"
provided.
taxed_on_reorder Boolean False False False False True Boolean data. Ex: True
reorder_to_par Boolean False False False False True Boolean data. Ex: True
reorder_tax_rate Decimal True False False False
provided. 26.73
conversion_factor Decimal 1.00 False False False False
26.73
No default
reorder_unit_type InventoryUnit (FK) True False False False either a URI or set of nested resource
provided.
data.
primary_vendor Boolean True False False False True Boolean data. Ex: True
No default
ingredient Ingredient (FK) True False False False either a URI or set of nested resource
provided.
data.
No default
provided.
Filtering
Name
active
product
vendor
primary_vendor
ingredient
Ordering
Name
id
Name
GET
Name
GET
Resource: Version
URL: /resources/Version/?format=json
Default Limit: 20
FIELDS
Name
Name
GET
Resource:
ViewPurchaseOrder
URL: /resources/ViewPurchaseOrder/?format=json
Default Limit: 20
FIELDS
Read
Only
submitted_date Datetime False True False False
provided. "2010-11-10T03:07:43"
World"
World"
World"
26.73
World"
World"
World"
26.73
World"
World"
provided. World"
World"
World"
No default
provided.
"2010-11-10T03:07:43"
World"
World"
"2010-11-10T03:07:43"
provided. World"
"2010-11-10T03:07:43"
shipping_city String False False False True
World"
World"
vendor_id String provided. True False False False World"
26.73
World"
World"
World"
vendor_address1 String False False False True Unicode string data. Ex: "Hello
World"
World"
No default
is_submitted Boolean False True False False Boolean data. Ex: True
provided.
26.73
Sept. 18, 2017, A date & time as a string. Ex:
overriden_created_date Datetime False False False False
3:36 p.m. "2010-11-10T03:07:43"
World"
World"
"2010-11-10T03:07:43"
World"
contact_fax String False False False True
World"
26.73
World"
provided. World"
World"
World"
World"
Filtering
Name
updated_date
created_date
Ordering
Name
id
Name
GET
Name
GET
Resource: ViewPurchaseOrderProduct
URL: /resources/ViewPurchaseOrderProduct/?format=json
Default Limit: 20
FIELDS
Read
Only
original_price Decimal True False False False
provided. 26.73
No default
quick_pick_group String True False False False Unicode string data. Ex: "Hello World"
provided.
26.73
No default
purchase_product_age Integer True False False False Integer data. Ex: 2673
provided.
446655440000
purchase_reward_multiplier Float 1.0 False False False False Floating point numeric data. Ex: 26.73
No default
min_price Float True False False False Floating point numeric data. Ex: 26.73
provided.
uom String Unit True False False False Unicode string data. Ex: "Hello World"
No default
crv_value Float True False False False Floating point numeric data. Ex: 26.73
provided.
No default
product_brand String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
shopify_sku String True False False False Unicode string data. Ex: "Hello World"
provided.
26.73
No default
item_no Integer True False False False Integer data. Ex: 2673
provided.
No default
provided.
No default
provided.
No default
attribute_2_name String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
point_redeem Float True False False False Floating point numeric data. Ex: 26.73
provided.
26.73
kitchen_print_name String True False False False Unicode string data. Ex: "Hello World"
cost Decimal True False False False
provided. 26.73
No default
provided.
crv_label String No default True False False False Unicode string data. Ex: "Hello World"
provided.
comments String True False False False Unicode string data. Ex: "Hello World"
No default
unit_size String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
course_number Integer True False False False Integer data. Ex: 2673
provided.
26.73
No default
alternate_lookup String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
provided.
No default
point_value Integer True False False False Integer data. Ex: 2673
provided.
No default
manufacturer String True False False False Unicode string data. Ex: "Hello World"
provided.
kitchen_description String True False False False Unicode string data. Ex: "Hello World"
product_width Decimal True False False False
provided. 26.73
msrp Decimal True False False False
provided. 26.73
11-10T03:07:43"
No default
retail String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
promotional_product Boolean True False False False Boolean data. Ex: True
provided.
No default
product_length_unit String True False False False Unicode string data. Ex: "Hello World"
provided.
26.73
start_date Datetime True False False False
provided. 11-10T03:07:43"
No default
product_width_unit String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
max_threshold_price Float True False False False Floating point numeric data. Ex: 26.73
provided.
26.73
No default
delivery_method Integer True False False False Integer data. Ex: 2673
provided.
No default
dept String True False False False Unicode string data. Ex: "Hello World"
provided.
product_height Decimal True False False False
provided. 26.73
No default
redemption_level String True False False False Unicode string data. Ex: "Hello World"
provided.
dining_options String [] True False False False Unicode string data. Ex: "Hello World"
11-10T03:07:43"
No default
purchase_product_age_msg String True False False False Unicode string data. Ex: "Hello World"
provided.
end_date Datetime True False False False
provided. 11-10T03:07:43"
product_length Decimal True False False False
provided. 26.73
No default
tare Float True False False False Floating point numeric data. Ex: 26.73
provided.
No default
inventory Inventory (FK) True False False False either a URI or set of nested resource
provided.
data.
establishment True False False True either a URI or set of nested resource
(FK) provided.
data.
No default
provided.
No default
provided.
No default
attribute_1_name String True False False False Unicode string data. Ex: "Hello World"
provided.
No default
product_height_unit String True False False False Unicode string data. Ex: "Hello World"
provided.
prep_yield Decimal True False False False
provided. 26.73
No default
max_price Float True False False False Floating point numeric data. Ex: 26.73
provided.
No default
provided.
Filtering
Name
active
establishment
track_in_inventory
Ordering
Name
id
Name
GET
Name
GET
Resource: ViewTax
URL: /resources/ViewTax/?format=json
Default Limit: 20
FIELDS
Read
Only
10T03:07:43"
No default
provided.
No default
provided.
No default
provided.
No default
provided.
No default
tax_rate TaxRate (FK) True True False False URIs or list of individually nested resource
provided.
data.
10T03:07:43"
No default
provided.

No default
provided.
No default
provided.
Filtering
Name
establishment
tax_rate
Ordering
Name
id
Name
GET
Name
GET
Resource: VisitorTracking
URL: /resources/VisitorTracking/?format=json
Default Limit: 20
FIELDS
Read
Only
clock_in Datetime True False False False
No default
status String True False False False Unicode string data. Ex: "Hello World"
provided.
sponsor True False False True
clock_out Datetime True False False False
No default
image_url String True False False False Unicode string data. Ex: "Hello World"
provided.
purpose_of_visit String True False False False Unicode string data. Ex: "Hello World"
No default
provided.
Filtering
Name
customer
establishment
Ordering
Name
id
Name
GET
POST
PUT
PATCH
Name
GET
POST
PUT
PATCH
Resource: WSRShifts
URL: /resources/WSRShifts/?format=json
Default Limit: 20
FIELDS
Read
Only
No default
provided.
10T03:07:43"
end Datetime True False False False
day Datetime False False False False
No default
provided.
start Datetime False False False False
10T03:07:43"
No default
provided.
Filtering
Name
establishment
day
Ordering
Name
id
Name
GET
POST
Name
GET
POST
Support
For support or clarification please contact the Revel Support Team.

Page

Revel API 1.01.1954

Загружено:

Сведения о документе

Оригинальное название

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

Revel API 1.01.1954

Загружено:

Авторское право:

Доступные форматы

Table of Contents

Using the API

Filter Description Examples

Inclusive range &created_date__range=2015-06-

isnull Checks null value &course_number__isnull=true

Expanding Related Fields

It is recommended to use an order_by option when paginating results.

Additional Limiting Methods

Default Format: application/json

Allowed detail http methods

Allowed list http methods

Default Format: application/json

Allowed detail http methods

Allowed list http methods

Default Format: application/json

No default A date & time as a string. Ex: "2010-11-

Allowed detail http methods

Allowed list http methods

Default Format: application/json

Allowed detail http methods

Allowed list http methods

Default Format: application/json

Allowed detail http methods

Allowed list http methods

Default Format: application/json

Allowed detail http methods

Default Format: application/json

Allowed detail http methods

Allowed list http methods

Default Format: application/json

Allowed detail http methods

Allowed list http methods

Default Format: application/json

PosStation No default A single related resource. Can be either a URI

A date & time as a string. Ex: "2010-11-

Allowed detail http methods

Allowed list http methods

Default Format: application/json

Allowed detail http methods

Allowed list http methods

Default Format: application/json

Allowed detail http methods

Allowed list http methods

Default Format: application/json

Allowed detail http methods

Allowed list http methods

Default Format: application/json

Allowed detail http methods

Allowed list http methods

Default Format: application/json

Allowed detail http methods

Allowed list http methods

Default Format: application/json

Allowed detail http methods

Allowed list http methods

Default Format: application/json

Establishment No default A single related resource. Can be either a URI

No default A single related resource. Can be either a URI

Allowed detail http methods

Allowed list http methods

Default Format: application/json

Allowed detail http methods

Allowed list http methods