Tax Definition

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

query

$top

int32

No

The maximum documents to return

query

$skip

int32

No

The documents to skip before returning

query

$filter

string

No

A filter expression in OData v4 format

query

$orderby

string

No

An order by expression in OData v4 format

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_mappings

boolean

No

Include the mappings for the document in the response

query

include_entities

[ csv of string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

query

include_inactive

boolean

No

Includes the documents that inactive for the current sites

total

integer

items

[ array, object ]

name

string

The name of the tax (For example, NC sales tax)

type

string

Specifies the type of the tax rate. The possible values are "fixed_amount" or "fixed_rate."

value

number

The value is either a percentage or a fixed amount based on the type value

based_on

string

The possible values are "price" or "quantity."

tax_inclusive

boolean

If active: Hide the tax amounts both in the guest check and within the order entry

filter

object

item_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

destinations

[ string ]

The list of destinations

destination_entity_ids

[ string, object ]

The list of destination entity identifiers

modifier_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

tender_tags

[ array, string ]

The list of tender type names to filter on

discount_tags

[ array, string ]

The list of discount tags to filter on

condition

object

Specifies the condition around items that satisfy the filter tags

scope

string

The scope of the conditions. The possible values are "order," "item," or "tender." The scope of the condition is the whole order if the scope is "order," limited to the current item and child items if the scope is "item," and limited to the tender type if the scope is "tender."

total_on

string

The possible values are "price" or "count." The total is the price of the items across the check if the scope is "order," the total price of the current item and children if the scope is "item," or the total approved amount if the scope is "tender."

operator

string

The condition sign ( ==, >, <, >=, <= )

target_value

string

The target value for the condition

consumption_types

[ array, string ]

The consumption types. The possible values are "OnPremises" or "OffPremises."

min_base_amount

number

max_base_amount

number

initial_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

pattern_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

active

boolean

The flag that indicates if the tax rule is active or not

tax_on_tax

boolean

The possible values "Yes" or "No." The default value is "No."

If "Yes," the tax on tax is calculated after calculating all the regular taxes first, and then loop back and calculate the tax on tax on the total taxes. For example, on a single item $1.00 order where three 10% tax rates apply with the second two having tax on tax value "Yes," tax1 would be $0.10, and tax2 and tax3 would be $0.13, which is 10% of $1.00 + 10% of (0.10+0.10+0.10).

rounding

string

The possible values are "roundup," "rounddown," or "nearest." The default value is "nearest." It is the rounding method to apply on each tax value.

collective_rounding

boolean

The tax buckets which have this value as "True" are collectively rounded instead of individually rounded to calculate the total tax

allowed_order_source_entity_ids

[ string, object ]

An array of allowed Order Source entity identifiers

allowed_order_source_ids

[ array, string ]

An array of allowed Order Source identifiers

_id

string

The auto-assigned system document identifier

company_id

string

The identifier of the company that owns the document

entity_id

string

The auto-assigned unique identifier (UID) of the entity, set on creation. All future versions of the entity share the same entity_id.

is_master

boolean

is_active

boolean

Marking property is the essence of active documents. Sets in true by default.

external_id

string

created_by

string

The identifier of the OPRA user or site that created the document

updated_by

string

The identifier of the OPRA user or site that last updated the document

created_at

string

The last date and time (date-time) the document was updated

updated_at

string

The last date and time (date-time) the document was updated

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[ csv of string ]

No

The unique identifiers (UIDs) of the site to manage data for

query

$filter

string

No

A filter expression in OData v4 format

query

$top

int32

No

The maximum documents to return

query

$skip

int32

No

The documents to skip before returning

query

$orderby

string

No

An order by expression in OData v4 format

query

effective_date

string

Yes

The date and time to query against

query

entity_ids

[ string ]

No

An array of entity identifiers

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_mappings

boolean

No

Include the mappings for the document in the response

query

include_mappings_for_entities

[ csv of string ]

No

Specifies entity types for which mappings are presented as a part of the response (For example, include_mappings_for_entities_param=&#39;product&#39;,&#39;product-price&#39;, etc).

query

include_entities

[ csv of string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

query

include_audit

boolean

No

Adds audit fields to each document when returning a result (is_active, is_master, created_at, created_by, updated_at, updated_by)

query

include_inactive

boolean

No

Includes the documents that are inactive for the current sites

total

integer

items

[ array, object ]

name

string

The name of the tax ( For example, NC sales tax)

type

string

The possible valudes are "fixed_amount" or "fixed_rate."

Specifies the type of the tax rate.

value

number

The value is either a percentage or a fixed amount based on the type value

based_on

string

The possible values are "price" or "quantity"

tax_inclusive

boolean

If active: Hide the tax amounts both in the guest check and within the order entry

filter

object

item_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

destinations

[ string ]

The list of destinations

destination_entity_ids

[ string, object ]

The list of destination entity identifiers

modifier_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

tender_tags

[ array, string ]

The list of tender type names to filter on

discount_tags

[ array, string ]

The list of discount tags to filter on

condition

object

Specifies the condition around items that satisfy the filter tags

scope

string

The scope of the conditions. The possible values are "order," "item," and "tender."

The scope of the condition is the whole order if the scope is "order." It is limited to the current item and child items if the scope is "item," and it is limited to the tender type if the scope is "tender."

total_on

string

The possible values are "price" and "count."

The total of the price of the items across the check if the scope is "order," if the total price of the current item and the child items if the scope is "item," or the total approved amount if the scope is "tender."

operator

string

The condition sign ( ==, >, <, >=, <= )

target_value

string

The target value for the condition

consumption_types

[ array, string ]

The possible valudes are "OnPremises" or "OffPremises"

min_base_amount

number

max_base_amount

number

initial_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

pattern_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

active

boolean

The flag that indicates if the tax rule is active or not

tax_on_tax

boolean

The possible values are "Yes" or "No." The default value is "No."

If "Yes," the tax on tax is calculated after calculating all the regular taxes first then loop back and calculate tax on tax on the total taxes. For example, on a single item $1.00 order where three 10% tax rates apply with the second two having tax on tax value the "Yes," tax1 would be $0.10, and tax2 and tax3 would be $0.13, which is 10% of $1.00 + 10% of (0.10+0.10+0.10).

rounding

string

The possible values are "roundup," "rounddown," or "nearest." The default value is "nearest." It is the rounding method to apply on each tax value .

collective_rounding

boolean

The tax buckets which have this value as true are collectively rounded instead of individually rounded to calculate the total tax

allowed_order_source_entity_ids

[ string, object ]

An array of allowed Order Source entity identifiers

allowed_order_source_ids

[ array, string ]

An array of allowed Order Source identifiers

_id

string

The auto-assigned system document identifier

company_id

string

The identifier of the company that owns the document

entity_id

string

The auto-assigned UID of the entity, set on creation. All future versions of the entity share the same entity_id.

is_master

boolean

is_active

boolean

Marking property is the essence of active documents. Sets in true by default.

external_id

string

created_by

string

The identifier of the OPRA user or site that created the document

updated_by

string

The identifier of the OPRA user or site that last updated the document

created_at

string

The date and time (date-time) the document was created

updated_at

string

The last date and time (date-time) the document was updated

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

array, csv of string

No

The identifiers of the site to manage data for

Yes

query

$filter

string

No

A filter expression in OData v4 format

query

$top

int32

No

The maximum documents to return

query

$skip

int32

No

The documents to skip before returning

query

$orderby

string

No

An order by expression in OData v4 format

query

effective_date

string

Yes

The date and time to query against

query

entity_ids

string

No

An array of entity identifiers

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_entities

array, csv of string

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

query

include_audit

boolean

No

Adds audit fields to each document when returning a result (is_active, is_master, created_at, created_by, updated_at, updated_by)

query

include_inactive

boolean

No

Includes the documents that are inactive for the current sites

query

include_mappings_for_entities

array, csv of string

No

Specifies entity types for which mappings are presented as a part of the response (For example, include_mappings_for_entities_param=&#39;product&#39;,&#39;product-price&#39;, etc).

total

integer

items

[ array, object ]

name

string

The name of the tax (For example, NC sales tax)

type

string

Specifies the type of the tax rate. The possible values are "fixed_amount" or "fixed_rate."

value

number

The value is either a percentage or a fixed amount based on the type value

based_on

string

The possible values are "price" or "quantity."

tax_inclusive

boolean

If active: Hide the tax amounts both in the guest check and within the order entry

filter

object

item_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

destinations

[ string ]

The list of destinations

destination_entity_ids

[ string, object ]

The list of destination entity identifiers

modifier_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

tender_tags

[ array, string ]

The list of tender type names to filter on

discount_tags

[ array, string ]

The list of discount tags to filter on

condition

object

Specifies the condition around items that satisfy filter tags

scope

string

The scope of the conditions. The possible values are "order," "item," or "tender." The scope of the condition is the whole order if the scope is "order," limited to the current item and child items if the scope is "item," and limited to the tender type if the scope is "tender."

total_on

string

The possible values are "price" or "count." The total is the price of the items across the check if the scope is "order," the total price of the current item and child items if the scope is "item," or the total approved amount if the scope is "tender."

operator

string

The condition sign ( ==, >, <, >=, <= )

target_value

string

The target value for the condition

consumption_types

[ array, string ]

The consumption types. The possible values are "OnPremises" or "OffPremises."

min_base_amount

number

max_base_amount

number

initial_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

pattern_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

active

boolean

The flag that indicates if the tax rule is active or not

tax_on_tax

boolean

The possible values are "Yes" or "No." The default value is "No."

If "Yes," the tax on tax is calculated after calculating all the regular taxes first, and then loop back and calculate the tax on tax on the total taxes. For example, on a single item $1.00 order where three 10% tax rates apply with the second two having tax on tax value "Yes," tax1 would be $0.10, and tax2 and tax3 would be $0.13, which is 10% of $1.00 + 10% of (0.10+0.10+0.10).

rounding

string

The possible values are "roundup," "rounddown," or "nearest." The default value is "nearest." The rounding method to apply on each tax value.

collective_rounding

boolean

The tax buckets which have this value as "True" are collectively rounded instead of individually rounded to calculate total tax

allowed_order_source_entity_ids

[ string, object ]

An array of allowed Order Source entity identifiers

allowed_order_source_ids

[ array, string ]

An array of allowed Order Source identifiers

_id

string

The auto-assigned system document identifier

company_id

string

The identifier of the company that owns the document

entity_id

string

The auto-assigned unique identifier (UID) of the entity, set on creation. All future versions of the entity share the same entity_id.

is_master

boolean

is_active

boolean

Marking property is the essence of active documents. Sets in true by default.

external_id

string

created_by

string

The identifier of the OPRA user or site that created the document

updated_by

string

The identifier of the OPRA user or site that last updated the document

created_at

string

The last date and time (date-time) the document was updated

updated_at

string

The last date and time (date-time) the document was updated

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_entities

[ csv of string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

body

body

Yes

The JSON formatted request

name

string

The name of the tax (For example, NC sales tax)

type

string

Specifies the type of the tax rate. The possible values are "fixed_amount" or "fixed_rate."

value

number

The value is either a percentage or a fixed amount based on the type value

based_on

string

The possible values are "price" or "quantity"

tax_inclusive

boolean

If active: Hide the tax amounts both in the guest check and within the order entry

filter

object

item_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

destinations

[ string ]

The list of destinations

destination_entity_ids

[ string, object ]

The list of destination entity identifiers

modifier_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

tender_tags

[ array, string ]

The list of tender type names to filter on

discount_tags

[ array, string ]

The list of discount tags to filter on

condition

object

Specifies the condition around items that satisfy the filter tags

scope

string

The scope of the conditions. The possible values are "order," "item," or "tender." The scope of the condition is the whole order if the scope is "order," limited to the current item and child items if the scope is "item," and limited to the tender type if the scope is "tender."

total_on

string

The possible values are "price" or "count." The total is the price of the items across the check if the scope is "order," the total price of the current item and child items if the scope is "item," or the total approved amount if the scope is "tender."

operator

string

The condition sign ( ==, >, <, >=, <= )

target_value

string

The target value for the condition

consumption_types

[ array, string ]

The consumption types. The possible values are "OnPremises" or "OffPremises."

min_base_amount

number

max_base_amount

number

initial_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

pattern_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

active

boolean

The flag that indicates if the tax rule is active or not

tax_on_tax

boolean

The possible values are "Yes" or "No." The default value is "No."

If "Yes," the tax on tax is calculated after calculating all the regular taxes first, and then loop back and calculate the tax on tax on the total taxes. For example, on a single item $1.00 order where three 10% tax rates apply with the second two having tax on tax value "Yes," tax1 would be $0.10, and tax2 and tax3 would be $0.13, which is 10% of $1.00 + 10% of (0.10+0.10+0.10).

rounding

string

The possible values are "roundup," "rounddown," or "nearest." The default value is "nearest." It is the rounding method to apply on each tax value.

collective_rounding

boolean

The tax buckets which have this value as "True" are collectively rounded instead of individually rounded to calculate total tax

allowed_order_source_entity_ids

[ string, object ]

An array of allowed Order Source entity identifiers

allowed_order_source_ids

[ array, string ]

An array of allowed Order Source identifiers

entity_id

string

The auto-assigned unique identifier (UID) of the entity, set on creation. All future versions of the entity share the same entity_id.

external_id

string

name

string

The name of the tax (For example, NC sales tax)

type

string

Specifies the type of the tax rate. The possible values are "fixed_amount" or "fixed_rate."

value

number

The value is either a percentage or a fixed amount based on the type value

based_on

string

The possible values are "price" or "quantity"

tax_inclusive

boolean

If active: Hide the tax amounts both in the guest check and within the order entry

filter

object

item_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

destinations

[ string ]

The list of destinations

destination_entity_ids

[ string, object ]

The list of destination entity identifiers

modifier_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

tender_tags

[ array, string ]

The list of tender type names to filter on

discount_tags

[ array, string ]

The list of discount tags to filter on

condition

object

Specifies the condition around items that satisfy the filter tags

scope

string

The scope of the conditions. The possible values are "order," "item," or "tender." The scope of the condition is the whole order if the scope is "order," limited to current item and child items if the scope is "item," and limited to the tender type if the scope is "tender."

total_on

string

The possible values are "price" or "count." The total is the price of the items across the check if the scope is "order," the total price of the current item and child items if the scope is "item," or the total approved amount if the scope is "tender."

operator

string

The condition sign ( ==, >, <, >=, <= )

target_value

string

The target value for the condition

consumption_types

[ array, string ]

The consumption types. The possible values are "OnPremises" or "OffPremises."

min_base_amount

number

max_base_amount

number

initial_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

pattern_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

active

boolean

The flag that indicates if the tax rule is active or not

tax_on_tax

boolean

The possible values are "Yes" or "No.> The default value is "No."

If "Yes," the tax on tax is calculated after calculating all the regular taxes first, and then loop back and calculate the tax on tax on the total taxes. For example, on a single item $1.00 order where three 10% tax rates apply with the second two having tax on tax value "Yes," tax1 would be $0.10, and tax2 and tax3 would be $0.13, which is 10% of $1.00 + 10% of (0.10+0.10+0.10).

rounding

string

The possible values are "roundup," "rounddown," or "nearest." The default value is "nearest." It is the rounding method to apply on each tax value.

collective_rounding

boolean

The tax buckets which have this value as "True" are collectively rounded instead of individually rounded to calculate total tax

allowed_order_source_entity_ids

[ string, object ]

An array of allowed Order Source entity identifiers

allowed_order_source_ids

[ array, string ]

An array of allowed Order Source identifiers

_id

string

The auto-assigned system document identifier

company_id

string

The identifier of the company that owns the document

entity_id

string

The auto-assigned UID of the entity, set on creation. All future versions of the entity share the same entity_id.

is_master

boolean

is_active

boolean

Marking property is the essence of active documents. Sets in true by default.

external_id

string

created_by

string

The identifier of the OPRA user or site that created the document

updated_by

string

The identifier of the OPRA user or site that last updated the document

created_at

string

The last date and time (date-time) the document was updated

updated_at

string

The last date and time (date-time) the document was updated

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

entity_id

string

Yes

The identifier of the entity

body

body

Yes

The JSON formatted request

name

string

The name of the tax (For example, NC sales tax)

type

string

Specifies the type of tax rate.

The possible values are "fixed_amount" or "fixed_rate."

value

number

The value is either a percentage or a fixed amount based on the type value

based_on

string

The possible values are "price" or "quantity"

tax_inclusive

boolean

If active: Hide the tax amounts both in the guest check and within the order entry

filter

object

item_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

destinations

[ string ]

The list of destinations

destination_entity_ids

[ string, object ]

The list of destination entity identifiers

modifier_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

tender_tags

[ array, string ]

The list of tender type names to filter on

discount_tags

[ array, string ]

The list of discount tags to filter on

condition

object

Specifies the condition around items that satisfy the filter tags

scope

string

The scope of the conditions. The possible values are "order," "item," or "tender."

The scope of the condition is the whole order if the scope is "order," limited to the current item and child items if the scope is "item," and limited to the tender type if the scope is "tender."

total_on

string

The possible values are "price" or "count." The total is the price of the items across the check if the scope is "order," the total price of the current item and child items if the scope is "item," or the total approved amount if the scope is "tender."

operator

string

The condition sign ( ==, >, <, >=, <= )

target_value

string

The target value for the condition

consumption_types

[ array, string ]

The possible values are "OnPremises"or "OffPremises."

min_base_amount

number

max_base_amount

number

initial_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

pattern_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

active

boolean

The flag that indicates if the tax rule is active or not

tax_on_tax

boolean

The possible values are "Yes" or "No." The default value is "No."

If "Yes," the tax on tax is calculated after calculating all the regular taxes first, and then loop back and calculate the tax on tax on the total taxes. For example, on a single item $1.00 order where three 10% tax rates apply with the second two having tax on tax value "Yes," tax1 would be $0.10, and tax2 and tax3 would be $0.13, which is 10% of $1.00 + 10% of (0.10+0.10+0.10).

rounding

string

The possible values are "roundup," "rounddown," or "nearest." The default value is "nearest." It is the rounding method to apply on each tax value .

collective_rounding

boolean

The tax buckets which have this value as "True" are collectively rounded instead of individually rounded to calculate total tax

allowed_order_source_entity_ids

[ string, object ]

An array of allowed Order Source entity identifiers

allowed_order_source_ids

[ array, string ]

An array of allowed Order Source identifiers

entity_id

string

The auto-assigned unique identifier (UID) of the entity, set on creation. All future versions of the entity share the same entity_id.

external_id

string

name

string

The name of the tax (For example NC sales tax)

type

string

Specifies the type of tax rate.

The possible values are "fixed_amount" or "fixed_rate."

value

number

The value is either a percentage or a fixed amount based on the type value

based_on

string

The possible values are "price" or "quantity"

tax_inclusive

boolean

If active: Hide the tax amounts both in the guest check and within the order entry

filter

object

item_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

destinations

[ string ]

The list of destinations

destination_entity_ids

[ string, object ]

The list of destination entity identifiers

modifier_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

tender_tags

[ array, string ]

The list of tender type names to filter on

discount_tags

[ array, string ]

The list of discount tags to filter on

condition

object

Specifies the condition around items that satisfy the filter tags

scope

string

The scope of the conditions. The possible values are "order," "item," or "tender." The scope of the condition is the whole order if the scope is "order," limited to current item and child items if the scope is "item," and limited to the tender type if the scope is "tender."

total_on

string

The possible values are "price" or "count." The total is the price of the items across the check if the scope is "order," the total price of the current item and child items if the scope is "item," or the total approved amount if the scope is "tender."

operator

string

The condition sign ( ==, >, <, >=, <= )

target_value

string

The target value for the condition

consumption_types

[ array, string ]

The possible values are "OnPremises" or "OffPremises"

min_base_amount

number

max_base_amount

number

initial_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

pattern_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

active

boolean

The flag that indicates if the tax rule is active or not

tax_on_tax

boolean

The possible values are "Yes" or "No." The default value is "No".

If "Yes," the tax on tax is calculated after calculating all the regular taxes first, and then loop back and calculate the tax on tax on the total taxes. For example, on a single item $1.00 order where three 10% tax rates apply with the second two having tax on tax value "Yes," tax1 would be $0.10, and tax2 and tax3 would be $0.13, which is 10% of $1.00 + 10% of (0.10+0.10+0.10).

rounding

string

The possible values are "roundup," "rounddown," or "nearest." The default value is "nearest." It is the rounding method to apply on each tax value.

collective_rounding

boolean

The tax buckets which have this value as "True" are collectively rounded instead of individually rounded to calculate total tax

allowed_order_source_entity_ids

[ string, object ]

An array of allowed Order Source entity identifiers

allowed_order_source_ids

[ array, string ]

An array of allowed Order Source identifiers

_id

string

The auto-assigned system document identifiers

company_id

string

The identifier of the company who owns the document

entity_id

string

The auto-assigned unique identifier (UID) of the entity, set on creation. All future versions of the entity share the same entity_id.

is_master

boolean

is_active

boolean

Marking property is the essence of active documents. Sets in true by default.

external_id

string

created_by

string

The identifier of the OPRA user or site that created the document

updated_by

string

The identifier of the OPRA user or site that updated the document

created_at

string

The date and time (date-time) the document was created

updated_at

string

The last date and time (date-time) the document was updated

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

entity_id

string

Yes

The identifier of the entity

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[ csv of string ]

No

The unique identifiers (UIDs) of the site to manage data for

body

body

Yes

Supports the mappings field (array/boolean) for each document. With mappings: True mappings are created for the current date and sites from the X-SITE-IDs header.

name

string

The name of the tax (For example, NC sales tax)

type

string

Specifies the type of tax rate.

The possible values are "fixed_amount" or "fixed_rate."

value

number

The value is either a percentage or a fixed amount based on the type value

based_on

string

The possible values are "price" or "quantity"

tax_inclusive

boolean

If active: Hide the tax amounts both in the guest check and within the order entry

filter

object

item_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

destinations

[ string ]

The list of destinations

destination_entity_ids

[ string, object ]

The list of destination entity identifiers

modifier_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

tender_tags

[ array, string ]

The list of tender type names to filter on

discount_tags

[ array, string ]

The list of discount tags to filter on

condition

object

Specifies the condition around items that satisfy the filter tags

scope

string

The scope of the conditions. The possible values are "order," "item," or "tender."

The scope of the condition is the whole order if the scope is "order," limited to current item and child items if the scope is "item," and limited to the tender type if the scope is "tender."

total_on

string

The possible values are "price" or "count." The total is the price of the items across the check if the scope is "order," the total price of the current item and child items if the scope is "item," or the total approved amount if the scope is "tender."

operator

string

The condition sign ( ==, >, <, >=, <= )

target_value

string

The target value for the condition

consumption_types

[ array, string ]

The possible values are "OnPremises" or "OffPremises"

min_base_amount

number

max_base_amount

number

initial_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

pattern_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

active

boolean

The flag that indicates if the tax rule is active or not

tax_on_tax

boolean

The possible values are "Yes" or "No." The default value is "No."

If "Yes," the tax on tax is calculated after calculating all the regular taxes first, and then loop back and calculate the tax on tax on the total taxes. For example, on a single item $1.00 order where three 10% tax rates apply with the second two having tax on tax value "Yes," tax1 would be $0.10, and tax2 and tax3 would be $0.13, which is 10% of $1.00 + 10% of (0.10+0.10+0.10).

rounding

string

The possible values are "roundup," "rounddown," or "nearest." The default value is "nearest." It is the rounding method to apply on each tax value.

collective_rounding

boolean

The tax buckets which have this value as "True" are collectively rounded instead of individually rounded to calculate total tax

allowed_order_source_entity_ids

[ string, object ]

An array of allowed Order Source entity identifiers

allowed_order_source_ids

[ array, string ]

An array of allowed Order Source identifiers

entity_id

string

The auto-assigned UID of the entity, set on creation. All future versions of the entity share the same entity_id.

external_id

string

total

integer

items

[ array, object ]

name

string

The name of the tax (For example, NC sales tax)

type

string

Specifies the type of the tax rate.

The possible values are "fixed_amount" or "fixed_rate."

value

number

The value is either a percentage or a fixed amount based on the type value

based_on

string

The possible values are "price" or "quantity"

tax_inclusive

boolean

If active: Hide the tax amounts both in the guest check and within the order entry

filter

object

item_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

destinations

[ string ]

The list of destinations

destination_entity_ids

[ string, object ]

The list of destination entity identifiers

modifier_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

tender_tags

[ array, string ]

The list of tender type names to filter on

discount_tags

[ array, string ]

The list of discount tags to filter on

condition

object

Specifies the condition around items that satisfy the filter tags

scope

string

The scope of the conditions. The possible values are "order," "item," or "tender."

The scope of the condition is the whole order if the scope is "order," limited to current item and child items if the scope is "item," and limited to the tender type if the scope is "tender."

total_on

string

The possible values are "price" and "count."

The total is the price of the items across the check if the scope is "order," the total price of the current item and child items if the scope is "item," or the total approved amount if the scope is "tender."

operator

string

The condition sign ( ==, >, <, >=, <= )

target_value

string

The target value for the condition

consumption_types

[ array, string ]

The possible values are "OnPremises" or "OffPremises"

min_base_amount

number

max_base_amount

number

initial_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

pattern_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

active

boolean

The flag that indicates if the tax rule is active or not

tax_on_tax

boolean

The possible values are "Yes" or "No." The default value is "No."

If "Yes," the tax on tax is calculated after calculating all the regular taxes first, and then loop back and calculate the tax on tax on the total taxes. For example, on a single item $1.00 order where three 10% tax rates apply with the second two having tax on tax value "Yes," tax1 would be $0.10, and tax2 and tax3 would be $0.13, which is 10% of $1.00 + 10% of (0.10+0.10+0.10).

rounding

string

The possible values are "roundup," "rounddown," or "nearest." The default value is "nearest." It is the rounding method to apply on each tax value.

collective_rounding

boolean

The tax buckets which have this value as "True" are collectively rounded instead of individually rounded to calculate total tax

allowed_order_source_entity_ids

[ string, object ]

An array of allowed Order Source entity identifiers

allowed_order_source_ids

[ array, string ]

An array of allowed Order Source identifiers

_id

string

The auto-assigned system document identifier

company_id

string

The identifier of the company that owns the document

entity_id

string

The auto-assigned UID of the entity, set on creation. All future versions of the entity share the same entity_id.

is_master

boolean

is_active

boolean

Marking property is the essence of active documents. Sets in true by default.

external_id

string

created_by

string

The identifier of the OPRA user or site that created the document

updated_by

string

The identifier of the OPRA user or site that last updated the document

created_at

string

The date and time (date-time) the document was created

updated_at

string

The last date and time (date-time) the document was updated

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

_id

string

Yes

The identifier of the document

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_entities

[ csv of string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

name

string

The name of the tax (For example, NC sales tax )

type

string

Specifies the type of the tax rate. The possible values are "fixed_amount" or "fixed_rate."

value

number

The value is either a percentage or a fixed amount based on the type value

based_on

string

The possible values are "price" or "quantity"

tax_inclusive

boolean

If active: Hide the tax amounts both in the guest check and within the order entry

filter

object

item_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

destinations

[ string ]

The list of destinations

destination_entity_ids

[ string, object ]

The list of destination entity identifiers

modifier_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

tender_tags

[ array, string ]

The list of tender type names to filter on

discount_tags

[ array, string ]

The list of discount tags to filter on

condition

object

Specifies the condition around items that satisfy filter tags

scope

string

The scope of the conditions. The possible values are "order," "item," or "tender." The scope of the condition is the whole order if the scope is "order," limited to the current item and child items if the scope is "item," and limited to the tender type if the scope is "tender."

total_on

string

The possible values are "price" or "count." The total is the price of the items across the check if the scope is "order," the total price of the current item and child items if the scope is "item," or the total approved amount if the scope is "tender."

operator

string

The condition sign ( ==, >, <, >=, <= )

target_value

string

The target value for the condition

consumption_types

[ array, string ]

The consumption types. The possible values are "OnPremises" or "OffPremises."

min_base_amount

number

max_base_amount

number

initial_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

pattern_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

active

boolean

The flag that indicates if the tax rule is active or not

tax_on_tax

boolean

The possible values are "Yes" or "No". The default value is "No."

If "Yes," the tax on tax is calculated after calculating all the regular taxes first, and then loop back and calculate the tax on tax on the total taxes. For example, on a single item $1.00 order where three 10% tax rates apply with the second two having tax on tax value "Yes," tax1 would be $0.10, and tax2 and tax3 would be $0.13, which is 10% of $1.00 + 10% of (0.10+0.10+0.10).

rounding

string

The possible values are "roundup," "rounddown," or "nearest." The default value is "nearest." The rounding method to apply on each tax value.

collective_rounding

boolean

The tax buckets which have this value as true are collectively rounded instead of individually rounded to calculate total tax

allowed_order_source_entity_ids

[ string, object ]

An array of allowed Order Source entity identifiers

allowed_order_source_ids

[ array, string ]

An array of allowed Order Source identifiers

_id

string

The auto-assigned system document identifier

company_id

string

The identifier of the company that owns the document

entity_id

string

The auto-assigned unique identifier (UID) of the entity, set on creation. All future versions of the entity share the same entity_id.

is_master

boolean

is_active

boolean

Marking property is the essence of active documents. Sets in true by default.

external_id

string

created_by

string

The identifier of the OPRA user or site that created the document

updated_by

string

The identifier of the OPRA user or site that last updated the document

created_at

string

The last date and time (date-time) the document was updated

updated_at

string

The last date and time (date-time) the document was updated

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

_id

string

Yes

The identifier of the document

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_entities

[ csv of string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

body

body

Yes

The JSON of the category being patched

name

string

The name of the tax (For example, NC sales tax)

type

string

Specifies the type of the tax rate.

The possible values are "fixed_amount" or "fixed_rate."

value

number

The value is either a percentage or a fixed amount based on the type value

based_on

string

The possible values are "price" or "quantity"

tax_inclusive

boolean

If active: Hide the tax amounts both in the guest check and within the order entry

filter

object

item_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

destinations

[ string ]

The list of destinations to filter on

destination_entity_ids

[ string, object ]

The list of destination entity identifiers to filter on

modifier_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

tender_tags

[ array, string ]

The list of tender type names to filter on

discount_tags

[ array, string ]

The list of discount tags to filter on

condition

object

Specifies the condition around items that satisfy the filter tags

scope

string

scope (string) (optional)

The scope of the conditions. The possible values are "order," "item," or "tender." The scope of the condition is the whole order if the scope is "order," limited to the current item and child items if the scope is "item," and limited to the tender type if the scope is "tender."

total_on

string

The possible values are "price" or "count." The total is the price of the items across the check if the scope is "order," the total price of the current item and child items if the scope is "item," or the total approved amount if the scope is "tender."

operator

string

The condition sign ( ==, >, <, >=, <= )

target_value

string

The target value for the condition

consumption_types

[ string ]

The possible values are "OnPremises" or "OffPremises"

min_base_amount

number

max_base_amount

number

initial_break_points

[ string, object ]

id

string

range_start

number

range_end

number

amount

number

pattern_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

active

boolean

The flag that indicates if the tax rule is active or not

tax_on_tax

boolean

The possible values are "Yes" or "No." The default value is "No."

If "Yes," the tax on tax is calculated after calculating all the regular taxes first, and then loop back and calculate the tax on tax on the total taxes. For example, on a single item $1.00 order where three 10% tax rates apply with the second two having tax on tax value "Yes," tax1 would be $0.10, and tax2 and tax3 would be $0.13, which is 10% of $1.00 + 10% of (0.10+0.10+0.10).

rounding

string

The possible values are "roundup," "rounddown," or "nearest." The default value is "nearest." It is the rounding method to apply on each tax value.

collective_rounding

boolean

The tax buckets which have this value as "True" are collectively rounded instead of individually rounded to calculate total tax

allowed_order_source_entity_ids

[ string, object ]

An array of allowed Order Source entity identifiers

allowed_order_source_ids

[ string ]

An array of allowed Order Source identifiers

external_id

string

type

string

Specifies the type of the tax rate.

The possible values are "fixed_amount" or "fixed_rate."

value

number

The value is either a percentage or a fixed amount based on the type value

based_on

string

The possible values are "price" or "quantity"

tax_inclusive

boolean

If active: Hide the tax amounts both in the guest check and within the order entry

filter

object

item_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

destinations

[ string ]

The list of destinations to filter on

destination_entity_ids

[ string, object ]

The list of destination entity identifiers to filter on

modifier_tax_groups

[ string, object ]

The list of item names or tax category names to filter on

tender_tags

[ array, string ]

The list of tender type names to filter on

discount_tags

[ array, string ]

The list of discount tags to filter on

condition

object

Specifies the condition around items that satisfy the filter tags

scope

string

scope (string) (optional)

The scope of the conditions. The possible values are "order," "item," or "tender." The scope of the condition is the whole order if the scope is "order," limited to the current item and child items if the scope is "item," and limited to the tender type if the scope is "tender."

total_on

string

The possible values are "price" or "count." The total is the price of the items across the check if the scope is "order," the total price of the current item and child items if the scope is "item," or the total approved amount if the scope is "tender."

operator

string

The condition sign ( ==, >, <, >=, <= )

target_value

string

The target value for the condition

consumption_types

[ string ]

The possible values are "OnPremises" or "OffPremises"

min_base_amount

number

max_base_amount

number

initial_break_points

[ string, object ]

id

string

range_start

number

range_end

number

amount

number

pattern_break_points

[ array, object ]

id

string

range_start

number

range_end

number

amount

number

active

boolean

The flag that indicates if the tax rule is active or not

tax_on_tax

boolean

The possible values are "Yes" or "No." The default value is "No."

If "Yes," the tax on tax is calculated after calculating all the regular taxes first, and then loop back and calculate the tax on tax on the total taxes. For example, on a single item $1.00 order where three 10% tax rates apply with the second two having tax on tax value "Yes," tax1 would be $0.10, and tax2 and tax3 would be $0.13, which is 10% of $1.00 + 10% of (0.10+0.10+0.10).

rounding

string

The possible values are "roundup," "rounddown," or "nearest." The default value is "nearest." It is the rounding method to apply on each tax value.

collective_rounding

boolean

The tax buckets which have this value as "True" are collectively rounded instead of individually rounded to calculate total tax

allowed_order_source_entity_ids

[ string, object ]

An array of allowed Order Source entity identifiers

allowed_order_source_ids

[ string ]

An array of allowed Order Source identifiers

external_id

string

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

_id

string

Yes

The identifier of the document

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[ csv of string ]

No

The unique identifiers (UIDs) of the site to manage data for

path

entity_id

string

Yes

The identifier of the entity

query

$top

int32

No

The maximum documents to return

query

$skip

int32

No

The documents to skip before returning

query

$filter

string

No

A filter expression in OData v4 format

query

$orderby

string

No

An order by expression in OData v4 format

query

include_inactive

boolean

No

Includes the documents that inactive for the current sites

total

integer

items

[ array, object ]

(object) _id (string) (optional) The auto-assigned system document identifier.

_id

string

The auto-assigned system document identifier

company_id

string

The identifier of the company that owns the document

site_id

string

The identifier of the site associated with the document

entity_id

string

The auto-assigned UID of the entity, set on creation. All future versions of the entity share the same entity_id.

document_id

string

The identifier of the document in the collection the mapping refers to

created_by

string

The identifier of the OPRA user or site that created the document

updated_by

string

The identifier of the OPRA user or site that last updated the document

created_at

string

The last date and time the document was updated

updated_at

string

The last date and time the document was updated

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[ csv of string ]

No

The unique identifiers (UIDs) of the site to manage data for

path

entity_id

string

Yes

The identifier of the entity

body

body

Yes

The array of the tax definition mappings being added

total

integer

items

[ array, object ]

_id

string

The auto-assigned system document identifier

company_id

string

The identifier of the company that owns the document

site_id

string

The identifier of the site associated with the document

entity_id

string

The auto-assigned UID of the entity, set on creation. All future versions of the entity share the same entity_id.

document_id

string

The identifier of the document in the collection the mapping refers to

created_by

string

The identifier of the OPRA user or site that created the document

updated_by

string

The identifier of the OPRA user or site that last updated the document

created_at

string

The last date and time (date-time) the document was created

updated_at

string

The last date and time (date-time) the document was updated

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

body

body

Yes

The JSON of the tax definition mapping being added

document_id

string

The identifier of the document in the collection the mapping refers to

entity_id

string

The auto-assigned unique identifier (UID) of the entity, set on creation. All future versions of the entity share the same entity_id.

effective_date

string

The date and time the document becomes "current"

site_ids

[ string ]

The identifier of the site associated with the document

total

integer

items

[ array, object ]

_id

string

The auto-assigned system document identifier

company_id

string

The identifier of the company that owns the document

site_id

string

The identifier of the site associated with the document

entity_id

string

The auto-assigned UID of the entity, set on creation. All future versions of the entity share the same entity_id.

document_id

string

The identifier of the document in the collection the mapping refers to

created_by

string

The identifier of the OPRA user or site that created the document

updated_by

string

The identifier of the OPRA user or site that last updated the document

created_at

string

The last date and time (date-time) the document was created

updated_at

string

The last date and time (date-time) the document was updated

name

string

Yes

The name of the tax (For example, NC sales tax)

type

string

Yes

Specifies the type of the tax rate. The possible values are "fixed_amount" or "fixed_rate."

value

number

Yes

The value is either a percentage or a fixed amount based on the type value

based_on

string

Yes

The possible values are "price" or "quantity"

tax_inclusive

boolean

Yes

If active: Hide the tax amounts both in the guest check and within the order entry

external_id

external_id

No

check_marketplace_liability

boolean

No

If active, this tax is liable to the marketplace facilitator when ordered from a tax liable marketplace facilitator source

tax_class

string

No

The main tax classes that are applied to the restaurant business.

The possible values are "sales_tax," "meal_tax," or "bag_tax."

jurisdiction_entity_id

string, object

No

Describes the administrative level that imposes a specific tax. The jurisdiction names are shown within the list.

filter

object

No

min_base_amount

number (currency)

No

max_base_amount

number (currency)

No

initial_break_points

No

pattern_break_points

No

active

boolean

No

The flag that indicates if the tax rule is active or not

tax_on_tax

boolean

No

The possible values are "Yes" or "No." The default value is "No."

If "Yes," the tax on tax is calculated after calculating all the regular taxes first, and then loop back and calculate the tax on tax on the total taxes. For example, on a single item $1.00 order where three 10% tax rates apply, with the second two having tax on tax value "Yes," tax1 would be $0.10, and tax2 and tax3 would be $0.13, which is 10% of $1.00 + 10% of (0.10+0.10+0.10).

rounding

string

No

The rounding method to apply on each tax value. The possible values are "roundup," "rounddown," or "nearest." The default value is "nearest."

collective_rounding

boolean

No

The tax buckets which have this value as "True" are collectively rounded instead of individually rounded to produce total tax

allowed_order_source_entity_ids

[ string, object ]

No

An array of allowed Order Source entity identifiers

allowed_order_source_ids

[ string ]

No

An array of allowed Order Source identifiers

_id

_id

No

company_id

company_id

No

entity_id

entity_id

No

is_master

is_master

No

is_active

is_active

No

created_by

created_by

No

updated_by

updated_by

No

created_at

created_at

No

updated_at

updated_at

No

name

string

Yes

The name of the tax (For example, NC sales tax)

type

string

Yes

Specifies the type of the tax rate. Possible values are "fixed_amount" or "fixed_rate."

value

number

Yes

The value is either a percentage or a fixed amount based on the type value

based_on

string

Yes

The possible values are "price" or "quantity"

tax_inclusive

boolean

Yes

If active: Hide the tax amounts both in the guest check and within the order entry

external_id

external_id

No

check_marketplace_liability

boolean

No

If active, this tax is liable to the marketplace facilitator when ordered from a tax liable marketplace facilitator source

tax_class

string

No

The main tax classes that are applied to the restaurant business.

The possible values are "sales_tax," "meal_tax," or "bag_tax."

jurisdiction_entity_id

string, object

No

Describes the administrative level that imposes a specific tax. The jurisdiction names are shown within the list.

filter

object

No

min_base_amount

number (currency)

No

max_base_amount

number (currency)

No

initial_break_points

No

pattern_break_points

No

active

boolean

No

The flag that indicates if the tax rule is active or not

tax_on_tax

boolean

No

The possible values are "Yes" or "No." The default value is "No."

If "Yes," the tax on tax is calculated after calculating all the regular taxes first, and then loop back and calculate the tax on tax on the total taxes. For example, on a single item $1.00 order where three 10% tax rates apply, with the second two having tax on tax value "Yes," tax1 would be $0.10, and tax2 and tax3 would be $0.13, which is 10% of $1.00 + 10% of (0.10+0.10+0.10).

rounding

string

No

The rounding method to apply on each tax value. The possible values are "roundup," "rounddown," or "nearest." The default value is "nearest."

collective_rounding

boolean

No

The tax buckets which have this value as "True" are collectively rounded instead of individually rounded to produce total tax

allowed_order_source_entity_ids

[ string, object ]

No

An array of allowed Order Source entity identifiers

allowed_order_source_ids

[ string ]

No

An array of allowed Order Source identifiers

entity_id

entity_id

No

name

string

The name of the tax (For example, NC sales tax)

type

string

Specifies the type of the tax rate. The possible values are "fixed_amount" or "fixed_rate."

value

number

The value is either a percentage or a fixed amount based on the type value

based_on

string

The possible values are "price" or "quantity"

tax_inclusive

boolean

If active: Hide the tax amounts both in the guest check and within the order entry

external_id

external_id

check_marketplace_liability

boolean

If active, this tax is liable to the marketplace facilitator when ordered from a tax liable marketplace facilitator source

tax_class

string

The main tax classes that are applied to the restaurant business.

The possible values are "sales_tax," "meal_tax," or "bag_tax."

jurisdiction_entity_id

string, object

Describes the administrative level that imposes a specific tax. The jurisdiction names are shown within the list.

filter

object

min_base_amount

number (currency)

max_base_amount

number (currency)

initial_break_points

pattern_break_points

active

boolean

The flag that indicates if the tax rule is active or not

tax_on_tax

boolean

The possible values are "Yes" or "No." The default value is "No." If "Yes," the tax on tax is calculated after calculating all the regular taxes first, and then loop back and calculate the tax on tax on the total taxes. For example, on a single item $1.00 order where three 10% tax rates apply, with the second two having tax on tax value "Yes," tax1 would be $0.10, and tax2 and tax3 would be $0.13, which is 10% of $1.00 + 10% of (0.10+0.10+0.10).

rounding

string

The rounding method to apply on each tax value. The possible values are "roundup," "rounddown," or "nearest." The default value is "nearest."

collective_rounding

boolean

The tax buckets which have this value as "True" are collectively rounded instead of individually rounded to produce total tax

allowed_order_source_entity_ids

[ string, object ]

An array of allowed Order Source entity identifiers

allowed_order_source_ids

[ string ]

An array of allowed Order Source identifiers

total

integer

items

[tax_definition ]

name

string

external_id

string

_id

string

The auto-assigned system document identifier

company_id

string

The identifier of the company that owns the document

entity_id

string

The auto-assigned unique ID of this entity, set on creation. All future versions of this entity will share the same entity_id

is_master

boolean

is_active

boolean

Marking property is the essence of active documents. Sets in true by default.

created_by

string

The identifier of the OPRA user or site that created the document

updated_by

string

The identifier of the OPRA user or site that last updated the document

created_at

string

The date and time (date-time) the document was created

updated_at

string

The last date and time (date-time) the document was updated