Explore the Revel API data model

See how the various Revel endpoints relate to each other, using our handy Entity Relationship Diagram

Try our interactive ERD Or, browse below

Pulling data from the Revel API is only the first part of your reporting. You also need to understand the relationships between different endpoints - something that APIs typically fail to convey.

At SyncHub, we not only sync your Revel API endpoints down into a reportable format, we also describe their relationships (e.g. in terms of foreign keys) so that you can quickly get a grasp of your data and how it fits together. This page is intended as technical documentation of these relationships.

Endpoints

Address

Documentation: https://api-sandbox.revelup.com/apidoc/Address/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Alias string - -
BuildingNumber string - -
CityName string - -
Country string - -
County string - -
District string - -
Door string - -
IsExternal boolean - -
Latitude decimal - -
Line1 string - -
Line2 string - -
Longitude decimal - -
Province string - -
State string - -
Uuid guid - -
Zipcode string - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

Attribute

Documentation: https://api-sandbox.revelup.com/apidoc/Attribute/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Establishment string - -
EstablishmentID int Establishment → ID -
Sort int - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

AttributeValue

Documentation: https://api-sandbox.revelup.com/apidoc/AttributeValue/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Attribute string - -
AttributeID int Attribute → ID -
Sort int - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

BankDrop

Documentation: https://developer.revelsystems.com/revelsystems/reference/getbankdrops

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Amount decimal - -
BankDepositNum string - -
CurrencyType int - -
DrawerNumber int - -
Establishment string - -
EstablishmentID int Establishment → ID -
LocalID string - -
ResourceUri string - -
Station string - -
PosStationID int PosStation → ID -
Till string - -
TillID int Till → ID -
TillOwner string - -
TillOwnerID int User → ID -
TransactionUuid guid - -
Uuid guid - -
VersionDate datetime - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

Brand

Documentation: https://api-sandbox.revelup.com/apidoc/Brand/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
CallNames string - -
ClientType int - -
Company string - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

CashOffice

Documentation: https://developer.revelsystems.com/revelsystems/reference/getcashoffice

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Action int - -
ActionTakenBy string - -
ActionTakenByUserID int User → ID -
Amount decimal - -
BankDepositNum string - -
DepositStatus int - -
BankdropLocalID long - -
ConfirmedAmount decimal - -
ConfirmedBy string - -
ConfirmedByUserID int User → ID -
ConfirmedDate string - -
CurrencyName string - -
CurrencySymbol string - -
CurrencyType int - -
Deleted boolean - -
DepositRefID string - -
DepositSentDate datetime - -
DepositVerifiedDate datetime - -
Establishment string - -
EstablishmentID int Establishment → ID -
Flag int - -
Rate decimal - -
ResourcesUri string - -
SafeCountStatus int - -
SafeDropStatus int - -
SafeUuid guid - -
ToDeposit decimal - -
ToRemainInSafe decimal - -
Variance decimal - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

ComboProductSet

Documentation: https://api-sandbox.revelup.com/apidoc/ComboProductSet/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Barcode string - -
BasePriceOn int - -
ChargeFullPrice int - -
ComboType int - -
IsComboSaving boolean - -
IsUpsell boolean - -
PriceInCombo decimal - -
Quantity int - -
Surcharge decimal - -
Product string - -
ProductID int Product → ID
  • 30 Jun 2020 The pricing in this entity pertains to this product
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

Currency

Documentation: https://api-sandbox.revelup.com/apidoc/Currency/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
ResourceUri string - -
Symbol string - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

CurrentStock

Documentation: https://api-sandbox.revelup.com/apidoc/CurrentStock/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
EstablishmentName string - -
ProductID int - -
QuantityForSale decimal - -
QuantityInHand decimal - -
Establishment string -
  • 5 Nov 2020 known bug The documentation says that establishment is returned, however we find it is not
EstablishmentID int - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

Customer

Documentation: https://api-sandbox.revelup.com/apidoc/Customer/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
AcceptChecks boolean - -
AccountBalance decimal - -
AccountLimit decimal - -
Address string - -
BirthDate datetime - -
CcExp string - -
CcFirstName string - -
CcLast4Digits string - -
CcLastName string - -
ChargeAccount boolean - -
City string - -
CompanyName string - -
ContractExpiration datetime - -
Deleted boolean - -
Discount decimal - -
Email string - -
EmailOptIn boolean - -
ExpDate datetime - -
ExpensifyAccount string - -
FirstName string - -
Gender int - -
IsVisitor boolean - -
LastName string - -
LicNumber string - -
LoyaltyNumber string - -
LoyaltyRefID string - -
Notes string - -
OkToEmail boolean - -
PastDue decimal - -
PhoneNumber string - -
PhoneOptIn boolean - -
Picture string - -
Pin string - -
PostOptIn boolean - -
RefNumber string - -
Source int - -
State string - -
TaxExempt boolean - -
TaxLocation string - -
ThirdPartyID int - -
Title string - -
TotalPurchases int - -
TotalVisits int - -
TrackAsCompany boolean - -
Type int - -
Uuid guid - -
VersionDate datetime - -
Zipcode string - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

CustomerGroup

Documentation: https://api-sandbox.revelup.com/apidoc/CustomerGroup/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
AutoApplyDiscounts boolean - -
DiscountLevel string - -
DiscountLevelID int DiscountLevel → ID -
Sorting int - -
TaxFree boolean - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

CustomPaymentType

Documentation: https://api-sandbox.revelup.com/apidoc/CustomPaymentType/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
CaptureID boolean - -
ChangeLabel string - -
IdLabel string - -
IsAdmin boolean - -
IsPublic boolean - -
PaymentID int -
  • 29 Jul 2020 This naming pattern is inconsistent, but I believe this is the unique ID of our custom-payment records. It supercedes the now deprecated Payments endpoint, so I expect it is a backwards-compability thing
Type decimal - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

Discount

Documentation: https://api-sandbox.revelup.com/apidoc/Discount/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
ActionCode string - -
AdminKey string - -
AltPriceTier string - -
AltPriceTierID int PriceTier → ID -
ApplicationType int - -
ApplyMultipleTimes boolean - -
ApplyRepriceToSumOfProducts boolean - -
ApplyToAllQualifyingProducts boolean - -
ApplyToBaseProductOnly boolean - -
ApplyToEntireApplicationType boolean - -
ApplyToWeightedProducts int - -
AutoApply boolean - -
Awarding boolean - -
Barcode string - -
DiscountAmount decimal - -
DiscountAtItemLevel boolean - -
DiscountCode boolean - -
DiscountFunction int - -
DiscountMethod int - -
DiscountTier int - -
DiscountType int - -
DisplayOnIpad boolean - -
DummyPan string - -
EffectiveFrom datetime - -
EffectiveTo datetime - -
Establishment string - -
EstablishmentID int Establishment → ID -
ExcludeUpsellFromDiscount boolean - -
Gift string - -
GiftID int Product → ID -
HowOftenApply int - -
IsRepeatingCashOff boolean - -
IsVariable boolean - -
IsWholesale boolean - -
LoyaltyCode string - -
MaxLimit decimal - -
MaximumOff decimal - -
MinLimit decimal - -
MinimumAmount decimal - -
MinimumAmountToEntireOrder boolean - -
Modifier string - -
ModifierID int Modifier → ID -
ModifierClass string - -
ModifierClassID int ModifierClass → ID -
OldTaxedFlag boolean - -
OvsValidation boolean - -
PasswordRequired boolean - -
PointsNeededForRedemption decimal - -
Product string - -
ProductID int Product → ID -
ProductFromEachClsGrp boolean - -
QualificationSubtype int - -
QualificationType int - -
ReceiptText string - -
RewardsType int - -
SchemeCode string - -
StackableDiscountType string - -
Tally boolean - -
TargetVolume int - -
Taxed boolean - -
TimeTableID int - -
Volume int - -
VolumeModifier string - -
VolumeModifierID int Modifier → ID -
VolumeModifierClass string - -
VolumeModifierClassID int ModifierClass → ID -
VolumeProduct string - -
VolumeProductID int Product → ID -
VolumeType int - -
WeborderName string - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

DiscountLevel

Documentation: https://api-sandbox.revelup.com/apidoc/DiscountLevel/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
AutoApply boolean - -
ResourceUri string - -
Sorting int - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

DynamicCombo

Documentation: https://api-sandbox.revelup.com/apidoc/DynamicCombo/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Establishment string - -
EstablishmentID int Establishment → ID -
Price decimal - -
Sorting int - -
Type int - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

DynamicComboUpsell

Documentation: https://api-sandbox.revelup.com/apidoc/DynamicComboUpsell/detail/

Column Type Relates to Notes
RemoteID string - -
DynamicComboRemoteID string DynamicCombo → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Price decimal - -
DynamicComboID int DynamicCombo → ID -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

DynamicComboUpsellSlot

Documentation: https://api-sandbox.revelup.com/apidoc/DynamicComboUpsellSlot/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
DefaultProduct string - -
DefaultProductID int Product → ID -
DynamicComboID int DynamicCombo → ID -
DynamicComboUpsellID int DynamicComboUpsell → ID -
ProductsPrice decimal - -
Quantity int - -
SlotID int - -
SubstitutionsPrice decimal - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

Employee

Documentation: https://api-sandbox.revelup.com/apidoc/Employee/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Email string - -
EmployeeCard string - -
EmployeeEnd datetime - -
EmployeeLastlogin datetime - -
EmployeeStart datetime - -
Exempt boolean - -
ExternalID string - -
FailedLoginAttempts int - -
FirstName string - -
InternalEmplID string - -
LastName string - -
LastTimesheetEntry string - -
LastTimesheetEntryID int TimeSheetEntry → ID -
LockedAccount boolean - -
LockedAccountTimestamp datetime - -
MileageReimbursement decimal - -
PhoneNumber string - -
Picture string - -
Pin string - -
PplcNotification boolean - -
User string - -
UserID int User → ID -
WeeklyWage decimal - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

Establishment

Documentation: https://api-sandbox.revelup.com/apidoc/Establishment/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
RUID string - -
AboutAccessToLocation string - -
AboutDescription string - -
AboutTitle string - -
Address string - -
AddressID int Address → ID -
AndroidSettings string - -
BillingEnabled boolean - -
Brand string - -
BrandID int Brand → ID -
BrandName string - -
CancelableByBilling boolean - -
CancellationDate datetime - -
ClientType int - -
ContactName string - -
Ctuit boolean - -
Currency string - -
CurrencyID int Currency → ID -
DeliveryManagement boolean - -
DisabledBackendForPayment boolean - -
DisabledBackendForPaymentDate datetime - -
DisabledForCancellation boolean - -
DisabledForPayment boolean - -
DisplayUnitBgUrl string - -
EffectiveFrom datetime - -
EffectiveTo datetime - -
Email string - -
ExportType int - -
Fax string - -
HierarchyType int - -
InformationVerified boolean - -
KioskImageUrlLegacy string - -
LocationAccountStatus string - -
LocationEmail string - -
LocationName string - -
LockAddCategory int - -
LockAddDiscount boolean - -
LockAddModifierclass int - -
LogoImg string - -
LogoUrlLegacy string - -
Manager string - -
ManagerID int User → ID -
MatrixInventory boolean - -
Notes string - -
NsInternalID string - -
OnBoardingCompleted boolean - -
OnBoardingCompletedDate datetime - -
OnBoardingStartedDate datetime - -
PaymentGateway int - -
Phone string - -
QuickBooks int - -
RetailerID string - -
RevelID string - -
Rti boolean - -
ScCert boolean - -
Settings string - -
SettingID int SystemSetting → ID -
SettingsLastUpdate datetime - -
ShowBackendPaymentWarning boolean - -
ShowPaymentWarning boolean - -
SiteNumber string - -
SortingID int - -
StoreNumber int - -
SurchargeID int Surcharge → ID -
TaxPayerNum string - -
TimeWorkedAvailable boolean - -
TypeOfService int - -
Vip boolean - -
WebReservationsKey string - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

Ingredient

Documentation: https://api-sandbox.revelup.com/apidoc/Ingredient/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Barcode string - -
BinValue string - -
Cost decimal - -
DefaultInventory boolean - -
Establishment string - -
EstablishmentID int Establishment → ID -
InventoryID int Inventory → ID -
MinimumPrepCount int - -
PrepRecipe boolean - -
PrepTime int - -
PrepYield decimal - -
Productclass string - -
ProductClassID int ProductClass → ID -
ShelfLife int - -
Sku string - -
Sort int - -
ThawTime int - -
TrackInInventory boolean - -
UnitType string - -
UnitTypeID int UnitType → ID -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

IngredientRecipe

Documentation: https://api-sandbox.revelup.com/apidoc/IngredientRecipe/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Sort int - -
Product string - -
ProductID int Product → ID -
Quantity decimal - -
DiningOption string -
  • 16 Jul 2024 Foreign Key - Refers to `Dining option` (not implemented).
MainIngredient string - -
MainIngredientID int Ingredient → ID -
Ingredient string - -
IngredientID int Ingredient → ID -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

Inventory

Documentation: https://api-sandbox.revelup.com/apidoc/Inventory/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int -
  • 29 Jul 2020 The unique identifier of the Inventory endpoint is actually the product_id. This is because the endpoint is a point-in-time snapshot of the current inventory level (ie. it is not a history of inventory movement)
Active boolean - -
Product string - -
ProductID int Product → ID -
QuantityInHand decimal - -
Cost decimal - -
Threshold decimal - -
QuantityInLayaway decimal - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

InventoryUnit

Documentation: https://api-sandbox.revelup.com/apidoc/InventoryUnit/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Barcode string - -
Conversion decimal - -
Key string - -
PrimaryUnit boolean - -
Product string - -
ProductID int Product → ID -
QtyInUnits decimal - -
Ingredient string - -
IngredientID int Ingredient → ID -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

Modifier

Documentation: https://api-sandbox.revelup.com/apidoc/Modifier/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Description string - -
Barcode string - -
ColorCode int - -
ConvOrderingDisp boolean - -
ConvOrderingSortOrder int - -
Cost decimal - -
Deleted boolean - -
DisplayInKiosk boolean - -
DisplayOnline boolean - -
DoNotPrint boolean - -
Establishment string - -
EstablishmentID int Establishment → ID -
ImgUrl string - -
IsHot boolean - -
IsQuick boolean - -
KitchenDescription string - -
KitchenPrintName string - -
Modifierclass string - -
ModifierClassID int ModifierClass → ID -
NoModifierSubstitute boolean - -
PrepRecipe boolean - -
PrepYield decimal - -
Price decimal - -
Sku string - -
Sort int - -
SubstituteModifiers boolean - -
ThirdPartyName string - -
Uuid guid - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

ModifierClass

Documentation: https://api-sandbox.revelup.com/apidoc/ModifierClass/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
AdminModKey string - -
AdminModifier boolean - -
ColorCode int - -
ConvOrderingDisp boolean - -
ConvOrderingSortOrder int - -
Establishment string - -
EstablishmentID int Establishment → ID -
FreeModifier int - -
LockAddModifier int - -
Sort int - -
Split boolean - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

ModifierRecipe

Documentation: https://api-sandbox.revelup.com/apidoc/ModifierRecipe/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Sort int - -
Product string - -
ProductID int Product → ID -
Modifier string - -
ModifierID int Modifier → ID -
DiningOption string -
  • 16 Jul 2024 Foreign Key - Refers to `Dining option` (not implemented).
Quantity decimal - -
Ingredient string - -
IngredientID int Ingredient → ID -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

Order

Documentation: https://api-sandbox.revelup.com/apidoc/Order/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Asap boolean - -
AutoGratPct decimal - -
BillNumber int - -
BillParent string - -
BillParentOrderID int Order → ID -
BillsInfo string - -
BillsType int - -
CallName string - -
CallNumber int - -
CheckSum string - -
Closed boolean - -
CreatedAt string - -
CreatedAtPosStationID int PosStation → ID -
CrvTaxed boolean - -
CrvValue decimal - -
Customer string - -
CustomerID int Customer → ID -
CustomerAddressDistance int - -
CustomerBirthdate datetime - -
Deleted boolean - -
DeletedDiscounts string - -
DeliveryClockIn datetime - -
DeliveryClockOut datetime - -
DeliveryDistance int - -
DeliveryDuration int - -
DeliveryEmployee string - -
DeliveryEmployeeID int User → ID -
DeliveryEstimatedDistance int - -
DeviceID string - -
DevicePosStationID int PosStation → ID -
DiningOption int - -
Discount string - -
DiscountID int Discount → ID -
DiscountAmount decimal - -
DiscountCode string - -
DiscountNontaxableSurchargeIncluded decimal - -
DiscountReason string - -
DiscountRuleAmount decimal - -
DiscountRuleType int - -
DiscountTaxAmount decimal - -
DiscountTaxAmountIncluded decimal - -
DiscountTaxed boolean - -
DiscountTotalAmount decimal - -
DiscountedBy string - -
DiscountedByID int User → ID -
Establishment string - -
EstablishmentID int Establishment → ID -
ExchangeDiscount boolean - -
Exchanged boolean - -
ExternalSync int - -
FinalTotal decimal - -
GiftRewardData string - -
Gratuity decimal - -
GratuityType int - -
HaApplied boolean - -
HasDeliveryInfo boolean - -
HasHistory boolean - -
HasItems boolean - -
InvoiceDate datetime - -
IsDiscounted boolean - -
IsInvoice boolean - -
IsReadonly boolean - -
IsUnpaid boolean - -
LastUpdatedAt string - -
LastUpdatedAtPosStationID int PosStation → ID -
LocalID string - -
Notes string - -
NotificationEmailSent boolean - -
NotificationTextSent boolean - -
NumberOfPeople int - -
PickupTime datetime - -
PointsAdded int - -
PointsRedeemed int - -
PosMode string - -
PrevailingSurcharge decimal - -
PrevailingTax decimal - -
Printed boolean - -
RegistryData string - -
RegistryDataID int OrderRegistryData → ID -
RemainingDue decimal - -
ReportingID int - -
RoundingDelta decimal - -
RunningTaxNumber string - -
Sent boolean - -
ServiceCharge decimal - -
ServiceFeeTax decimal - -
ServiceFeeTaxed decimal - -
ServiceFeeUntaxed decimal - -
Subtotal decimal - -
Surcharge decimal - -
SurchargeExcluded decimal - -
Table string - -
TableID int Table → ID -
TableOwner string - -
TableOwnerID int User → ID -
Tax decimal - -
TaxCountry string - -
TaxExcludedAmount decimal - -
TaxRebate boolean - -
TaxRoundingModel int - -
TaxableSurcharge decimal - -
TaxableSurchargeExcluded decimal - -
Uuid guid - -
Vehicle string - -
VehicleID int CustomerVehicle → ID -
Version int - -
WebOrder boolean - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

OrderItem

Documentation: https://api-sandbox.revelup.com/apidoc/OrderItem/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Appointment string - -
AppointmentID int Appointment → ID -
AppointmentRefUuid guid - -
BillParent string - -
BillParentID int OrderItem → ID -
CateringComplete boolean - -
CateringDeliveryDate datetime - -
ComboFractionPart int - -
ComboProductSet string - -
ComboProductSetID int ComboProductSet → ID -
ComboSavingAmount decimal - -
ComboType int - -
ComboUsed string - -
ComboUsedID int Product → ID -
ComboUuid guid - -
CommissionAmount decimal - -
Cost decimal - -
CourseNumber int - -
CrvValue decimal - -
CupQty int - -
CupWeight decimal - -
DatePaid datetime - -
Deleted boolean - -
DeletedDate datetime - -
DiningOption int - -
Discount string - -
DiscountID int Discount → ID -
DiscountAmount decimal - -
DiscountCode string - -
DiscountReason string - -
DiscountRuleAmount decimal - -
DiscountRuleType int - -
DiscountTaxAmountIncluded decimal - -
DiscountTaxed boolean - -
DiscountedBy string - -
DiscountedByID int User → ID -
DynamicCombo string - -
DynamicComboID int DynamicCombo → ID -
DynamicComboSlot string - -
DynamicComboSlotID int DynamicComboSlot → ID -
ErvcType int - -
EventDate datetime - -
ExchangeDiscount boolean - -
Exchanged boolean - -
ExcludeFromDiscounts boolean - -
Expedited datetime - -
GiftCardNumber string - -
InitialPrice decimal - -
InvoiceDocumentUuid guid - -
IsCold boolean - -
IsDiscounted boolean - -
IsLayaway boolean - -
IsStoreCredit boolean - -
ItemType int - -
KitchenCompleted datetime - -
ManualUnitPriceAdjustment decimal - -
ModifierAmount decimal - -
ModifierCost decimal - -
NotReturnable boolean - -
OnHold boolean - -
OnLayaway decimal - -
Order string - -
OrderID int Order → ID -
OrderLocalID string - -
Package string - -
PackageID int Package → ID -
PackageUuid guid - -
ParentComboUuid guid - -
ParentUuid guid - -
Price decimal - -
PriceToDisplay decimal - -
Printed boolean - -
Product string - -
ProductID int Product → ID -
ProductNameOverride string - -
PumpDate datetime - -
PumpNumber int - -
PureSales decimal - -
Quantity int - -
ReferenceDiscount string - -
ReferenceDiscounts string - -
ReturnedEstablishment string - -
ReturnedEstablishmentID int Establishment → ID -
SalesTaxExemptionReason string - -
ScannedBarcode string - -
SeatNumber int - -
Sent boolean - -
SerialNumber string - -
ServiceFeeTax decimal - -
ServiceFeeTaxed decimal - -
ServiceFeeUntaxed decimal - -
ServiceProvider string - -
ServiceProviderID int User → ID -
Shared int - -
SoldByWeight boolean - -
SpecialRequest string - -
SplitParts decimal - -
SplitType int - -
SplitWithSeat int - -
StartTime datetime - -
Station string - -
StationID int PosStation → ID -
TaxAmount decimal - -
TaxIncluded boolean - -
TaxRate decimal - -
TaxRebate decimal - -
TaxedFlag boolean - -
TempSort int - -
Uom string - -
Uuid guid - -
VoidRefUuid guid - -
VoidedBy string - -
VoidedByID int User → ID -
VoidedDate datetime - -
VoidedReason string - -
Weight decimal - -
WholesaleSavingAmount decimal - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

Package

Documentation: https://developer.revelsystems.com/revelsystems/reference/getpackages/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Weight decimal - -
ServiceName string - -
Packaging string - -
Rate decimal - -
TaxOption int - -
ActualShipDate datetime - -
Uuid guid - -
State int - -
ShippingCharge decimal - -
ExternalShippingAddressID int AppliedAddress → ID -
ShippingLabel string - -
SignatureRequired boolean - -
AddressID int AppliedAddress → ID -
TargetShipDate datetime - -
ServiceCode string - -
Notes string - -
TrackingNumber string - -
ShippingCompany int - -
Order string - -
OrderID int Order → ID -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

Payment

Documentation: https://api-sandbox.revelup.com/apidoc/Payment/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Amount decimal - -
AmountAuthorized decimal - -
Bill int - -
CardType int - -
CashDrawer int - -
CcFirstName string - -
CcLastName string - -
First4CcDigits string - -
Last4CcDigits string - -
Change decimal - -
CurrencyAmount decimal - -
CurrencyTip decimal - -
CurrencyType int - -
Deleted boolean - -
Establishment string - -
EstablishmentID int Establishment → ID -
Exchanged boolean - -
Executed boolean - -
Gratuity decimal - -
InvoiceTransitionDate datetime - -
InvoiceTransitionDateUtc datetime - -
Online boolean - -
Order string - -
OrderID int Order → ID -
PaymentType int CustomPaymentType → ID -
OtherPaymentType string - -
OtherPaymentTypeID int CustomPaymentType → ID -
PayerID int - -
PaymentDate datetime - -
PaymentDateUtc datetime - -
ProcessorAccepted boolean - -
ProcessorResponse string - -
Rate decimal - -
ReceiptEmail string - -
RefundTransactionID string - -
Refunded boolean - -
RoundingDelta decimal - -
SignatureImgUrl string - -
SourceType int - -
Station string - -
StationID int PosStation → ID -
TillOwner string - -
TillOwnerID int User → ID -
Tip decimal - -
TransactionCaptured boolean - -
TransactionData string - -
TransactionID string - -
TransactionStatus string - -
Uuid guid - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

Payout

Documentation: https://api-sandbox.revelup.com/apidoc/Payout/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Deleted boolean - -
Type int - -
CashDrop boolean - -
TillOwner string - -
TillOwnerID int User → ID -
Till string - -
TillID int Till → ID -
Amount decimal - -
LocalID string - -
DrawerNumber int - -
Employee string - -
EmployeeID int User → ID -
Station string - -
StationID int PosStation → ID -
VersionDate datetime - -
PayoutReason string - -
Establishment string - -
EstablishmentID int Establishment → ID -
Uuid guid - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

PosStation

Documentation: https://api-sandbox.revelup.com/apidoc/PosStation/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Uuid guid - -
PosMode string - -
TestStation boolean - -
PosLastAccessed datetime - -
LocationID string - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

PriceTier

Documentation: https://api-sandbox.revelup.com/apidoc/PriceTier/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
IsAdmin boolean - -
Sorting int - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

Product

Documentation: https://api-sandbox.revelup.com/apidoc/Product/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Description string - -
Export boolean - -
FlatTaxUnits int - -
HappyHourPrice decimal - -
IsCold boolean - -
IsCombo int - -
IsDrink boolean - -
IsFood boolean - -
ItemNo int - -
KitchenDescription string - -
KitchenPrintName string - -
LabelDate datetime - -
LimitType int - -
LimitValue decimal - -
Manufacturer string - -
MaxPrice decimal - -
MaxThresholdPrice decimal - -
MinPrice decimal - -
Msrp decimal - -
NegativeSalesRestricted boolean - -
NotReturnable boolean - -
OriginalPrice decimal - -
PercentMarkup decimal - -
PointRedeem decimal - -
PointValue int - -
PrepRecipe boolean - -
PrepYield decimal - -
PreparationTime int - -
PreventSales boolean - -
Price decimal - -
PriceEmbedded boolean - -
PrintTags boolean - -
ProductBrand string - -
ProductHeight decimal - -
ProductHeightUnit string - -
ProductLength decimal - -
ProductLengthUnit string - -
ProductPriceInCombo decimal - -
ProductWeight decimal - -
ProductWeightUnit int - -
ProductWidth decimal - -
ProductWidthUnit string - -
PromotionalProduct boolean - -
PromptForQuantity boolean - -
PurchaseProductAge int - -
PurchaseProductAgeMsg string - -
PurchaseRewardMultiplier decimal - -
QuickPickGroup string - -
ReceiptText string - -
RedemptionLevel string - -
RequireSerialNumber boolean - -
Retail string - -
RtiCombo boolean - -
SeasonalItem boolean - -
ServiceDuration int - -
SetPricePerGroupForCombos boolean - -
ShelfLabelQuantity int - -
ShopifySku string - -
ShowOnPos boolean - -
SizeChart string - -
Sku string - -
SoldByWeight boolean - -
Sorting int - -
StartDate datetime - -
Surcharge decimal -
  • 24 Jun 2020 Be careful, this returns as a string but the docs say its decimal
Tare decimal - -
TaxClass int - -
TaxIncluded boolean - -
ThirdPartyID string - -
TrackInInventory boolean - -
Type int - -
UnitSize string - -
Uom string - -
UpsellComboPrice decimal - -
Uuid guid - -
VariablePricing boolean - -
VariablePricingBy int - -
ComboUpcharge decimal - -
Comments string - -
Commission decimal - -
CommissionType int - -
Cost decimal - -
CourseNumber int - -
CrvEnabled boolean - -
CrvLabel string - -
CrvValue decimal - -
DefaultInventory boolean - -
DeliveryMethod int - -
Dept string - -
DiningOptions string - -
DisableModifierPopup boolean - -
Discountable boolean - -
DisplayOnKiosk boolean - -
DisplayOnline boolean - -
AllowPriceOverride boolean - -
Attribute1 string - -
Attribute1ID int Attribute → ID -
Attribute1Name string - -
Attribute2 string - -
Attribute2ID int Attribute → ID -
Attribute2Name string - -
AttributeParent string - -
AttributeParentID int Product → ID -
AttributeType int - -
AttributeValue1 string - -
AttributeValue1ID int AttributeValue → ID -
AttributeValue2 string - -
AttributeValue2ID int AttributeValue → ID -
Barcode string - -
BinValue string - -
Category string - -
CategoryID int ProductCategory → ID -
ColorCode int - -
ComboProduct1 string - -
ComboProduct1ID int Product → ID -
ComboProduct2 string - -
ComboProduct2ID int Product → ID -
ComboProduct3 string - -
ComboProduct3ID int Product → ID -
ComboProduct4 string - -
ComboProduct4ID int Product → ID -
ComboProduct5 string - -
ComboProduct5ID int Product → ID -
ComboProduct6 string - -
ComboProduct6ID int Product → ID -
ComboProduct7 string - -
ComboProduct7ID int Product → ID -
ComboProduct8 string - -
ComboProduct8ID int Product → ID -
ComboSavingProductset string ComboProductSet → ID -
DynamicCombo string - -
DynamicComboID int DynamicCombo → ID -
EbtNo boolean - -
EligibleForPurchaseRewards boolean - -
EndDate datetime - -
Establishment string - -
EstablishmentID int Establishment → ID -
ParentDynamicCombo string - -
ParentDynamicComboID int DynamicCombo → ID -
ParentProduct string - -
ParentProductID int Product → ID -
Productclass string - -
ProductClassID int ProductClass → ID -
TaxID int Tax → ID -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

ProductCategory

Documentation: https://api-sandbox.revelup.com/apidoc/ProductCategory/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Description string - -
ColorCode int - -
Establishment string - -
EstablishmentID int Establishment → ID -
EventInfo string - -
EventInfoID int -
  • 15 Jun 2020 Foreign Key - References EventInfo (not implemented). APIDoc URL returns 404
ImgUrl string - -
IsService boolean - -
LockAddProduct int - -
LockAddSubcategory int - -
Parent string - -
ParentProductCategoryID int ProductCategory → ID -
Sorting int - -
ThirdPartyID string - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

ProductClass

Documentation: https://api-sandbox.revelup.com/apidoc/ProductClass/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
AdminClassKey string - -
Deleted boolean - -
ExcludeFromDiscounts boolean - -
IsAdminClass boolean - -
Parent string - -
ParentProductClassID int ProductClass → ID -
Sorting int - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

ProductGroup

Documentation: https://api-sandbox.revelup.com/apidoc/ProductGroup/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Discounts boolean - -
Display boolean - -
Establishment string - -
EstablishmentID int Establishment → ID -
Sorting decimal - -
TaxRule int -
  • 8 Jun 2020 The attribute exists in the sample data but not in the documentation.
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

ProductPriceTierPrice

Documentation: https://api-sandbox.revelup.com/apidoc/ProductPriceTierPrice/detail/

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Price decimal - -
PriceTier string - -
PriceTierID int PriceTier → ID -
Product string - -
ProductID int Product → ID -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

ProductRecipe

Documentation: https://api-sandbox.revelup.com/apidoc/ProductRecipe/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Sort int - -
Product string - -
ProductID int Product → ID -
Quantity decimal - -
DiningOption string -
  • 16 Jul 2024 Foreign Key - Refers to `Dining option` (not implemented).
MainProduct string - -
MainProductID int Product → ID -
Ingredient string - -
IngredientID int Ingredient → ID -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

Surcharge

Documentation: https://api-sandbox.revelup.com/apidoc/Surcharge/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
ResourceUri string - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

Table

Documentation: https://api-sandbox.revelup.com/apidoc/Table/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Capacity decimal - -
Establishment string - -
EstablishmentID int Establishment → ID -
QrCodeText string - -
Rotation decimal - -
Section string - -
SectionID int TableSection → ID -
TableType string - -
XValue decimal - -
YValue decimal - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

Tax

Documentation: https://api-sandbox.revelup.com/apidoc/Tax/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Agency string - -
AgencyID int TaxAgency → ID -
DiningOptions string - -
Establishment string - -
EstablishmentID int Establishment → ID -
FiscalRate int - -
MaxQuantityThreshold int - -
MaxThreshold decimal - -
MinQuantityThreshold int - -
MinThreshold decimal - -
RoundingType int - -
TaxType int - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

TaxAgency

Documentation: https://api-sandbox.revelup.com/apidoc/TaxAgency/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Establishment string - -
EstablishmentID int Establishment → ID -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

Till

Documentation: https://api-sandbox.revelup.com/apidoc/Till/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
AmountInBankDrop decimal - -
AmountInSafe decimal - -
AmountPresent decimal - -
AmountShouldBe decimal - -
AmountTillSet decimal - -
CashDrawer int - -
CashRefunds decimal - -
CashTransactions decimal - -
Closed datetime - -
ClosedByEmployee string - -
ClosedByEmployeeID int User → ID -
CurrencyType int - -
Employee string - -
EmployeeID int User → ID -
Establishment string - -
EstablishmentID int Establishment → ID -
HeldByEmployee string - -
HeldByEmployeeID int User → ID -
HeldDate datetime - -
Opened datetime - -
PosStation string - -
PosStationID int PosStation → ID -
TillManager string - -
TillManagerID int User → ID -
TillOwner string - -
TillOwnerID int User → ID -
Uuid guid - -
Variance decimal - -
VersionDate datetime - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

TimeSchedule

Documentation: https://api-sandbox.revelup.com/apidoc/TimeSchedule/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
BreakType int - -
Department string - -
Employee string - -
EmployeeID int Employee → ID -
Establishment string - -
EstablishmentID int Establishment → ID -
ExemptSalaried boolean - -
Role string - -
RoleWage decimal - -
Stage int - -
ShiftBeginTime datetime - -
ShiftBeginTimeUtc datetime - -
ShiftEndTime datetime - -
ShiftEndTimeUtc datetime - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

TimeSheetEntry

Documentation: https://api-sandbox.revelup.com/apidoc/TimeSheetEntry/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
BreakLength decimal - -
BreakType int - -
ClockIn datetime - -
ClockInUtc datetime - -
ClockOut datetime - -
ClockOutUtc datetime - -
DepartmentName string - -
Employee string - -
EmployeeID int Employee → ID -
Establishment string - -
EstablishmentID int Establishment → ID -
ExemptSalaried boolean - -
IsAutoClockOut boolean - -
Parent string - -
ParentTimesheetEntryID int TimeSheetEntry → ID -
Remarks string - -
ReturnedDate datetime - -
RoleName string - -
RoleWage decimal - -
Stage int - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

User

Documentation: https://api-sandbox.revelup.com/apidoc/User/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
RUID string - -
AdditionalData string - -
Auth0ID string - -
DateJoined datetime - -
FirstName string - -
HasEmsAccess boolean - -
IsActive boolean - -
IsBillTo boolean - -
IsGlobalSuperuser boolean - -
IsReseller boolean - -
IsSoldTo boolean - -
IsStaff boolean - -
LastLogin datetime - -
LastName string - -
Username string - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

Vendor

Documentation: https://api-sandbox.revelup.com/apidoc/Vendor/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
AccountNumber string - -
Address1 string - -
Address2 string - -
BilledFromAddress1 string - -
BilledFromAddress2 string - -
BilledFromCity string - -
BilledFromCountry string - -
BilledFromState string - -
BilledFromZip string - -
City string - -
ContactName string - -
Country string - -
Email string - -
Email2 string - -
Facebook string - -
Fax string - -
Fob decimal - -
Linkedin string - -
PaymentTerms string - -
PhoneMobile string - -
PhoneNumber string - -
PhoneOther string - -
PrintNameOnCheckAs string - -
ShippingTerms string - -
SkypeID string - -
State string - -
Twitter string - -
Url2 string - -
Url3 string - -
Url4 string - -
VatID string - -
VendorEligibleFor1099 boolean - -
VendorName string - -
VendorTaxID string - -
VendorType string - -
Website string - -
Zip string - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

VendorEstablishment

Documentation: https://api-sandbox.revelup.com/apidoc/VendorEstablishment/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Establishment string - -
EstablishmentID int Establishment → ID -
Vendor string - -
VendorID int Vendor → ID -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

VendorOrderableItem

Documentation: https://api-sandbox.revelup.com/apidoc/VendorOrderableItem/detail/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
ConversionFactor string - -
DefaultPrice decimal - -
DefaultQuantity decimal - -
GstID string - -
Ingredient string - -
IngredientID int Ingredient → ID -
PrimaryStockUnit boolean - -
PrimaryVendor boolean - -
Product string - -
ProductID int Product → ID -
ReorderTaxRate decimal - -
ReorderToPar boolean - -
ReorderUnit string - -
ReorderUnitType string - -
ReorderUnitTypeID int InventoryUnit → ID -
TaxedOnReorder boolean - -
Vendor string - -
VendorID int Vendor → ID -
VendorItemID string - -
Active boolean - -
CreatedDate datetime -
  • 25 Sep 2020 known bug We have observed date values coming down from Revel as '0001-01-01T00:00:00'. Typically this is an indication of a NULL value being coerced into a date (ie. 1 Jan 0001).
  • 24 Nov 2021 known bug We have observed values coming down which are invalid in the given time zone. e.g. Failed to convert '10/3/2021 2:16:27 AM to timezone '(UTC+10:00) Canberra, Melbourne, Sydney'
UpdatedDate datetime - -
CreatedBy string - -
CreatedByID int User → ID -
UpdatedBy string - -
UpdatedByID int User → ID -

BrandEstablishment

Column Type Relates to Notes
RemoteID string - -
BrandRemoteID string Brand → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
BrandID int Brand → ID -
EstablishmentID int Establishment → ID -

ComboProductSetProduct

Column Type Relates to Notes
RemoteID string - -
ComboProductSetRemoteID string ComboProductSet → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ComboProductSetID int ComboProductSet → ID -
ProductID int Product → ID -

CustomerCustomerGroup

Column Type Relates to Notes
RemoteID string - -
CustomerRemoteID string Customer → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CustomerID int Customer → ID -
CustomerGroupID int CustomerGroup → ID -

DiscountModifierClass

Column Type Relates to Notes
RemoteID string - -
DiscountRemoteID string Discount → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
DiscountID int Discount → ID -
ModifierClassID int ModifierClass → ID -

DiscountVolumeModifierClass

Column Type Relates to Notes
RemoteID string - -
DiscountRemoteID string Discount → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
DiscountID int Discount → ID -
ModifierClassID int ModifierClass → ID -

DiscountProductClass

Column Type Relates to Notes
RemoteID string - -
DiscountRemoteID string Discount → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
DiscountID int Discount → ID -
ProductClassID int ProductClass → ID -

DiscountVolumeProductClass

Column Type Relates to Notes
RemoteID string - -
DiscountRemoteID string Discount → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
DiscountID int Discount → ID -
ProductClassID int ProductClass → ID -

DiscountProductGroup

Column Type Relates to Notes
RemoteID string - -
DiscountRemoteID string Discount → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
DiscountID int Discount → ID -
ProductGroupID int ProductGroup → ID -

DiscountVolumeProductGroup

Column Type Relates to Notes
RemoteID string - -
DiscountRemoteID string Discount → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
DiscountID int Discount → ID -
ProductGroupID int ProductGroup → ID -

DiscountLevelDiscount

Column Type Relates to Notes
RemoteID string - -
DiscountLevelRemoteID string DiscountLevel → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
DiscountLevelID int DiscountLevel → ID -
DiscountID int Discount → ID -

DynamicComboUpsellSlotComboItem

Column Type Relates to Notes
RemoteID string - -
DynamicComboUpsellSlotRemoteID string DynamicComboUpsellSlot → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Product string - -
ProductID int Product → ID -
Sorting int - -
DynamicComboUpsellSlotID int DynamicComboUpsellSlot → ID -

DynamicComboUpsellSlotProduct

Column Type Relates to Notes
RemoteID string - -
DynamicComboUpsellSlotRemoteID string DynamicComboUpsellSlot → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
DynamicComboUpsellSlotID int DynamicComboUpsellSlot → ID -
ProductID int Product → ID -

DynamicComboUpsellSlotDefaultProduct

Column Type Relates to Notes
RemoteID string - -
DynamicComboUpsellSlotRemoteID string DynamicComboUpsellSlot → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
DynamicComboUpsellSlotID int DynamicComboUpsellSlot → ID -
ProductID int Product → ID -

DynamicComboUpsellSlotProductSubstitution

Column Type Relates to Notes
RemoteID string - -
DynamicComboUpsellSlotRemoteID string DynamicComboUpsellSlot → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
DynamicComboUpsellSlotID int DynamicComboUpsellSlot → ID -
ProductID int Product → ID -

OrderDiscount

Column Type Relates to Notes
RemoteID string - -
OrderRemoteID string Order → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Discount string -
  • 30 Jun 2020 Will be NULL if the user created a discount on-the-fly
DiscountID int Discount → ID
  • 30 Jun 2020 We have been unable to test the API with real discounts applied, so this calculated field is a best-guess
DiscountAmount decimal - -
DiscountCode string - -
DiscountFunction string - -
DiscountedBy string - -
Order string - -
OrderID int Order → ID -
Qty decimal - -
RuleAmount decimal - -
RuleType string - -
StackableType string - -
TaxAmountIncluded decimal - -
Taxed boolean - -
Uuid guid - -

OrderItemModifier

Column Type Relates to Notes
RemoteID string - -
OrderItemRemoteID string OrderItem → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Uuid guid - -
OrderItemID int OrderItem → ID -
ModifierID int Modifier → ID -
IsDiscounted boolean - -
IsSubstituted boolean - -
ModType int - -
ModifierCost decimal - -
ModifierPrice decimal - -
NoModifierSubstitute boolean - -
Qty decimal - -
QtyType int - -

ProductProductGroup

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID int Product → ID -
ProductGroupID int ProductGroup → ID -

Need more?

SyncHub lives and breathes APIs and data. Keep exploring using the links below.

Connect your own Revel data Querying Revel using regular SQL