Add a new ServiceFee

post https://api-sandbox-revel.revelup.com/resources/ServiceFee/

Body Params

ServiceFee object that needs to be added.

active

boolean

Defaults to true

alias

string

amount

string

required

Rule amount used for calculation total money amount

application_type

integer

required

Type: Item = 0, Order = 1

Service Fee Application Types:

0 - ITEM
1 - ORDER

apply_to

integer

required

Integer representing ServiceFee to be applied to subtotal of the order, or post tax or pre discount of the order.

ServiceFeeApplyToTypes:

0 - FEE_APPLY_TOSUBTOTAL
1 - FEE_APPLY_TO_POST_TAX
2 - FEE_APPLY_TO_PRE_DISCOUNT

apply_post_tax

boolean

Flag reflecting the rule of calculation total amount. For percent service fees only. If post tax = true - service fee is calculated from total with tax, otherwise from subtotal (pre tax amount).

autoapply_data

autoapply_type

integer

Available options: 0: Timeslot, 1: Payment type, 2: Guest count, 3; Dining type

Service Fee Autoapply Options:

1 - AUTOAPPLY_TIMESLOT
2 - AUTOAPPLY_PAYMENTTYPE
3 - AUTOAPPLY_GUESTCOUNT
4 - AUTOAPPLY_DININGTYPE

created_by

uri

required

URI of an User API object which is responsible for this object creation

created_date

date-time

Date and time when this object created

dynamic

boolean

Defaults to false

Flag which shows that we should use data from request, not from setting on backend. Used in Online Ordering

establishment

uri

required

Relation to Establishment where this object was created

include_employee_pass_through_fee_in

integer

Integer representing Employee Pass through ServiceFee include options in Payroll, cash due.

EnumIncludeEmployeePassThroughServiceFeeInOptions:

0 - DEFAULT_FEE
1 - PAYROLL_FEE
2 - CASH_DUE_FEE
3 - PAYROLL_AND_CASH_DUE_FEE

max_distance

string

Maximum distance to apply distance based Service fee. Unit is based on Delivery Unit of Measure.

max_threshold

string

Maximum taxable amount

min_distance

string

Minimum distance to apply distance based Service fee. Unit is based on Delivery Unit of Measure.

min_threshold

string

required

Minimum taxable amount

name

string

required

Name of ServiceFee

pass_through_fee_type

integer

Integer representing Pass through ServiceFee for Employee or Thirdparty, including choices for all and not a pass through.

EnumServiceFeePassThroughTypeChoices:

-1 - ALL_PASS_THROUGH_FEES
0 - NOT_A_PASS_THROUGH
1 - FEE_TYPE_THIRD_PARTY
2 - FEE_TYPE_EMPLOYEE
3 - FEE_TYPE_OTHER

password_required

boolean

Defaults to false

Used on POS for checking for permisson on service fee. If the user does not have permission, he will be prompted to enter a password.

pre_discount

boolean

Defaults to false

Flag which shows how we should compare threshold for service fee: from total before or after discount

qualification_product_ids

array of integers

List of ids of products

qualification_product_ids

qualification_type

integer

Used for auto service fee by dining option. Applies only for specific products. 0: none, 1: classes, 2: groups, 3: products

Service Fee Qualification Types:

0 - QUALIFICATION_TYPE_NONE
1 - QUALIFICATION_TYPE_CLASSES
2 - QUALIFICATION_TYPE_GROUPS
3 - QUALIFICATION_TYPE_PRODUCTS

resource_uri

uri

URI of this object

servicefee_type

integer

required

Type: Amount = 0, Percent = 1

Service Fee Type Options:

0 - SERVICE_FEE_TYPE_AMOUNT
1 - SERVICE_FEE_TYPE_PERCENT

taxed

boolean

Defaults to false

Flag reflecting if service fee should be taxed

updated_by

uri

required

URI of the user that last updated this object

updated_date

date-time

Date and time when this object was updated

use_distance

boolean

Defaults to false

Flag. It is used to calculate distance based service fee for delivery. Available for delivery orders only.

variable_fee

boolean

Defaults to false

If true, ServiceFee is variable

use_zone

boolean

Defaults to false

Flag. Zone based service fees are generally used for delivery as an alternative to distance based fees. Fees are assessed against the Customer’s address. In the case of overlapping zones, the lowest fee will be assessed. Currently Zone based service fees can only be applied to delivery orders.

zone_geojson

object

Input your GeoJson delivery zone string here. GeoJson Zones may be generated using a tool like geojson.io. Currently only polygon based zones are supported

Responses

Response body

array of objects

object

active

boolean

Defaults to true

alias

string

amount

string

required

Rule amount used for calculation total money amount

application_type

integer

required

Type: Item = 0, Order = 1

Service Fee Application Types:

0 - ITEM
1 - ORDER

1

apply_to

integer

required

Integer representing ServiceFee to be applied to subtotal of the order, or post tax or pre discount of the order.

ServiceFeeApplyToTypes:

0 - FEE_APPLY_TOSUBTOTAL
1 - FEE_APPLY_TO_POST_TAX
2 - FEE_APPLY_TO_PRE_DISCOUNT

1 2

apply_post_tax

boolean

Flag reflecting the rule of calculation total amount. For percent service fees only. If post tax = true - service fee is calculated from total with tax, otherwise from subtotal (pre tax amount).

autoapply_data

autoapply_type

integer

Available options: 0: Timeslot, 1: Payment type, 2: Guest count, 3; Dining type

Service Fee Autoapply Options:

1 - AUTOAPPLY_TIMESLOT
2 - AUTOAPPLY_PAYMENTTYPE
3 - AUTOAPPLY_GUESTCOUNT
4 - AUTOAPPLY_DININGTYPE

1 2 3 4

created_by

uri

required

URI of an User API object which is responsible for this object creation

created_date

date-time

Date and time when this object created

dynamic

boolean

Defaults to false

Flag which shows that we should use data from request, not from setting on backend. Used in Online Ordering

establishment

uri

required

Relation to Establishment where this object was created

int64

ID of the object

include_employee_pass_through_fee_in

integer

Integer representing Employee Pass through ServiceFee include options in Payroll, cash due.

EnumIncludeEmployeePassThroughServiceFeeInOptions:

0 - DEFAULT_FEE
1 - PAYROLL_FEE
2 - CASH_DUE_FEE
3 - PAYROLL_AND_CASH_DUE_FEE

1 2 3

max_distance

string

Maximum distance to apply distance based Service fee. Unit is based on Delivery Unit of Measure.

max_threshold

string

Maximum taxable amount

min_distance

string

Minimum distance to apply distance based Service fee. Unit is based on Delivery Unit of Measure.

min_threshold

string

required

Minimum taxable amount

name

string

required

Name of ServiceFee

pass_through_fee_type

integer

Integer representing Pass through ServiceFee for Employee or Thirdparty, including choices for all and not a pass through.

EnumServiceFeePassThroughTypeChoices:

-1 - ALL_PASS_THROUGH_FEES
0 - NOT_A_PASS_THROUGH
1 - FEE_TYPE_THIRD_PARTY
2 - FEE_TYPE_EMPLOYEE
3 - FEE_TYPE_OTHER

-1 1 2 3

password_required

boolean

Defaults to false

Used on POS for checking for permisson on service fee. If the user does not have permission, he will be prompted to enter a password.

pre_discount

boolean

Defaults to false

Flag which shows how we should compare threshold for service fee: from total before or after discount

qualification_product_classes

array of integers

List of ids of product classes

qualification_product_classes

qualification_product_groups

array of integers

List of ids of product groups

qualification_product_groups

qualification_product_ids

array of integers

List of ids of products

qualification_product_ids

qualification_type

integer

Used for auto service fee by dining option. Applies only for specific products. 0: none, 1: classes, 2: groups, 3: products

Service Fee Qualification Types:

0 - QUALIFICATION_TYPE_NONE
1 - QUALIFICATION_TYPE_CLASSES
2 - QUALIFICATION_TYPE_GROUPS
3 - QUALIFICATION_TYPE_PRODUCTS

1 2 3

resource_uri

uri

URI of this object

servicefee_type

integer

required

Type: Amount = 0, Percent = 1

Service Fee Type Options:

0 - SERVICE_FEE_TYPE_AMOUNT
1 - SERVICE_FEE_TYPE_PERCENT

1

taxed

boolean

Defaults to false

Flag reflecting if service fee should be taxed

updated_by

uri

required

URI of the user that last updated this object

updated_date

date-time

Date and time when this object was updated

use_distance

boolean

Defaults to false

Flag. It is used to calculate distance based service fee for delivery. Available for delivery orders only.

variable_fee

boolean

Defaults to false

If true, ServiceFee is variable

use_zone

boolean

Defaults to false

zone_geojson

object

Input your GeoJson delivery zone string here. GeoJson Zones may be generated using a tool like geojson.io. Currently only polygon based zones are supported

Has additional fields

400

Bad request. Usually not valid data provided.

401

Authorization required

Language

Credentials


xxxxxxxxxx
25
1
curl --request POST \
2
     --url https://api-sandbox-revel.revelup.com/resources/ServiceFee/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "active": true,
8
  "application_type": 0,
9
  "apply_to": 0,
10
  "autoapply_data": {
11
    "autoapply_timetable": {
12
      "active": false,
13
      "type": 0
14
    }
15
  },
16
  "dynamic": false,
17
  "password_required": false,
18
  "pre_discount": false,
19
  "servicefee_type": 0,
20
  "taxed": false,
21
  "use_distance": false,
22
  "variable_fee": false,
23
  "use_zone": false
24
}
25
'

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

application/json

Service Fee Application Types:

ServiceFeeApplyToTypes:

Service Fee Autoapply Options:

EnumIncludeEmployeePassThroughServiceFeeInOptions:

EnumServiceFeePassThroughTypeChoices:

Service Fee Qualification Types:

Service Fee Type Options:

201Successful operation

Service Fee Application Types:

ServiceFeeApplyToTypes:

Service Fee Autoapply Options:

EnumIncludeEmployeePassThroughServiceFeeInOptions:

EnumServiceFeePassThroughTypeChoices:

Service Fee Qualification Types:

Service Fee Type Options: