Data model: wide_tax
Description
The wide_tax data model provides information essential for analyzing taxes applied to orders. It includes details on tax types, amounts, and percentages, helping users understand the financial impact of various taxes on their business.
Revel Data Connector users utilizing this data model can answer questions such as:
- What are the trends in tax amounts over a selected time period?
- How do different tax types (e.g. sales, service fee, surcharge) compare?
- What is the distribution of tax amounts by tax name?
- How does tax application vary by order source or location?
- etc.
Data Objects
Column name | Data type | Mode | Description | Example |
---|---|---|---|---|
tax_id | int4 | Required | Unique identifier for tax on an order. | 32 |
order_id | int4 | Required | Unique identifier for an order. | 123 |
establishment_id | int4 | Required | Unique identifier for an establishment. | 1 |
tax_name | varchar | Required | Name of the tax assigned to an order. | Prevailing Tax |
tax_name | varchar | Required | Type of tax: - Sales - Service Fee - Surcharge - Pass Through Service Fee - Exchange Sales - Exchange Service Fee - Exchange Surcharge - Exchange Pass Through Service Fee | Sales |
tax_base_type | varchar | Required | Tax identifier: - Percentage - Flat | Flat |
tax_amount | numeric | Required | Tax amount applied for this tax and order, monetary value. | 1.35 |
tax_percent | numeric | Nullable | Tax percentage for 'Percentage' tax_base_type type | 0.06625 |
flat_tax_unit_value | numeric | Nullable | Monetary value for a single flat tax unit for 'Flat' tax_base_type type | 0.45 |
flat_tax_units | int4 | Nullable | Quantity of flat tax units added to an order. | 5 |
order_created_at | timestamp | Required | Order creation date and time in UTC format. | 2019-10-15 7:13:31 |
order_updated_at | timestamp | Required | Order last update date and time in UTC format. | 2019-10-15 7:20:32 |
is_order_paid | bool | Required | Identification if order is paid. | TRUE |
order_source | varchar | Required Unknown | Source channel of the order or pos mode if applicable: - Web Order - Smart Order - Table service - Quick service - Retail - Kiosk - Pizza - Grocery - Donation - Gas station | Web Order |
order_option | varchar | Required Unknown | Identification of order option, e.g. To-Go, Eat-In, Delivery or etc. If it is a custom order option, then value reflects the custom created name. If it is not recognised it is Unknown. | To Go |
order_status | varchar | Required | Last order status, e.g. open or closed. | Open |
is_receiptless_return | bool | Required | Identification if order is receiptless return. Such orders are created, when there is a need to return money to the customer. | TRUE |
pos_station_id | int4 | Required | POS station id | 12 |
pos_station_name | varchar | Required | POS station name. | POS1 |
is_pos_station_active | varchar | Required | Indicates if POS station is active. | TRUE |
revenue_center_name | varchar | N/A | Name of a revenue center a POS station is linked to. | Bar Area |
is_revenue_center_active | varchar | Nullable | Indicates if revenue center is active. | TRUE |
table_id | int4 | Nullable | Table id. | 5 |
table_name | varchar | N/A | Table name. | Table 1 |
section_name | varchar | N/A | Name of the section a table is in. | Section 1 |
capacity | int4 | Nullable | Number of people a table can accommodate. | 4 |
is_table_active | bool | Nullable | Indicates if table is active. | TRUE |
is_section_active | bool | Nullable | Indicates if section is active. | TRUE |
establishment_name | varchar | Required | Establishment Name. | Company - 1 |
establishment_city | varchar | Required | Establishment City. | San Francisco |
establishment_state | varchar | N/A | Establishment State. | CA |
establishment_country | varchar | Required | Establishment Country. | US |
company_name | varchar | Required | Company name. | Company |
company_url | varchar | Required | Company url address. | company.revelup.com |
establishment_latitude | float | Nullable | Establishment Latitude. | 37.7979623 |
establishment_longitude | float | Nullable | Establishment Longitude. | -152.00742 |
establishment_post_code | varchar | Required | Establishment Post Code. | 94100 |
is_establishment_active | bool | Required | Indicates if establishment is active. | TRUE |
timezone | varchar | Required | The configured timezone of the establishment | US/Eastern |
establishment_division | varchar | N/A | Establishment division. If establishment does not belong to a division, then value is N/A. | Division - 1 |
establishment_sub_division | varchar | N/A | Establishment sub-division. If establishment does not belong to a sub-division, then value is N/A. | Sub-division - 1 |
created_by_employee_external_id | varchar | N/A | External id of employee who created an order. If order wasn’t created by employee, then value is N/A | 6 |
created_by_employee_first_name | varchar | N/A | First name of employee who created an order. If order wasn’t created by employee, then value is N/A | John |
created_by_employee_last_name | varchar | N/A | Last name of employee who created an order. If order wasn’t created by employee, then value is N/A | Doe |
created_by_employee_is_active | bool | Nullable | Identification of whether employee is active. If order wasn’t created by employee, then value is NULL | TRUE |
last_updated_by_employee_external_id | varchar | N/A | External id of last employee who updated an order. If order wasn’t created by employee, then value is N/A | 5 |
last_updated_by_employee_first_name | varchar | N/A | First name of last employee who updated an order. If order wasn’t updated by employee, then value is N/A | John |
last_updated_by_employee_last_name | varchar | N/A | Last name of last employee who created an order. If order wasn’t created by employee, then value is N/A | Doe |
last_updated_by_employee_is_active | bool | Nullable | Identification of whether employee is active. If order wasn’t updated by employee, then value is NULL | TRUE |
establishment_group_name_list | varchar | Required | Establishment group name list. | |group1|group67|Group34| |
Updated 4 months ago