Get Fees

get https://{environment}.appetize.com/ordering/venues/{venue_id}/vendors/{vendor_id}/fees

This endpoint returns the fees associated to the vendor_id and venue_id

Responses

Response body

object

fees

array of objects

fees

object

string

Identifier given to fee upon creation in Connect

name

string

Fee name provided to connect at the time of creation, Updatable, non-unique

hash

string

Unique hash identifier generated by connect

fee_basis

float

Value used as a basis for calculation. If a fee is 5%, the fee_basis will be 0.05. If it is $2.00, the fee_basis will be 2.00

taxable

boolean

Indicates if fee is taxable or not. Value set in Connect to enable/disable taxable. Fees that are taxable will be included in the total used to calculate taxes. Non-taxable fees are not included.

taxes

array of objects

taxes

object

string

Unique identifier of the tax rate in Connect

order

integer

Order in which the tax rates should be sorted.

is_active

boolean

Flag that indicates if a tax rate is active and can be applied

is_geo_tax

boolean

Flag that indicates if the tax rate is a geotax. GeoTax is a an inclusive tax type that allows users to apply an inclusive tax rate to a defined geo-fence.

type

string

The type of the tax rate. Type directly influences how a tax rate is charged.
Possible values:

EXCLUSIVE: Tax rates explicitly added to an item. They are calculated over the item cost and always modify the order total.
INCLUSIVE: Tax rates implicitly added to an item. They are included in the item cost and never modify the order total

INCLUSIVE EXCLUSIVE

value_type

string

The type in which the tax rate value is expressed.
Possible values:

PERCENTAGE: The amount representes a percentage of the item cost
FLAT: The amount represents a flat, invariable amount
TABLE: The amount represents a specific value of a given tax table.

PERCENTAGE FLAT TABLE

threshold_logic

string

When enabled, the tax will be applied to the item only if the cart fullfils the threshold logic.
Possible values:

NOT SET: No threshold is configured. The logic cannot be applied
FULL: When the price of the item is greater or equal than the threshold value, the threshold logic will apply.

NOT SET FULL

rate

number

The amount of the tax to be applied. It could represent a percentual or flat amount

price_threshold

object

This object defines the amount the item has to cost in order for the threshold logic to apply

name

string

The name of the tax rate. It can be configured in Connect

code

string

A configurable code for the tax rate. Is empty by default. Can be configured in Connect.

generated_id

number

Documentation Forthcoming

auto_apply

boolean

Value set in Connect to enable/disable auto apply. Fees set to auto-apply are automatically applied to every transaction for the vendor to which they're assigned. Fees without auto-apply are manually applied.

apply_before_discount

boolean

Applies to net or gross

fee_class

string

Fee Class field in Connect. Can be fee, gratuity, service charge, or tip.

fee_level

string

Item or order level

print_tips

boolean

whether the device should print the tip amount on the receipt or not if the fee is of type tip

print_suggested_tip_amount

boolean

whether the device should print the suggested tip amount on the receipt or not if the fee is of type tip

removal_requires_approval

boolean

Flag from Connect. When enabled, removing the fee from a transaction requires approval from a manager-level account

external_id

string

External identifier provided to Connect at creation

exclusive_tax_total

float

deprecated, will be removed in a future version

inclusive_tax_total

float

deprecated, will be removed in a future version

is_available_for_refund

boolean

Determines whether or not the fee can be refunded.

is_item_level

boolean

Determines whether or not it is item level fee. this will be true if fee_level is item

print_on_reciept

boolean

deprecated, will be removed in a future version

purchase_order_id

string

deprecated, will be removed in a future version

receipted

boolean

deprecated, will be removed in a future version

refunding

boolean

deprecated, will be removed in a future version

stage

string

deprecated, will be removed in a future version

tax_examt

boolean

deprecated, will be removed in a future version

uid

string

deprecated, will be removed in a future version

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://environment.appetize.com/ordering/venues//vendors//fees?account_type=employee' \
3
     --header 'accept: application/com.appetize.oapi.cart.v1+json'

Click Try It! to start a request and see the response here! Or choose an example:

application/com.appetize.oapi.cart.v1+json

application/vnd.appetize+json;version=1

application/json

200Get Fees Response

400Bad Request.

401Unauthorized