GuidesDiscussionsAPI ReferenceChangelogMy Application
HomeGuidesAPI ReferenceChangelogDiscussions
GuidesDiscussionsAPI ReferenceChangelogMy ApplicationLog In
API Reference

Add a new AppliedServiceFee

post
https://qa2.revelup.com/resources/AppliedServiceFee/

Add a new AppliedServiceFee

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

AppliedServiceFee object that needs to be added.

string
required

Rule amount used for calculation total money amount

integer
enum
required

Type: Item = 0, Order = 1

Service Fee Application Types:

  • 0 - ITEM
  • 1 - ORDER
Allowed:
integer
enum
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
Allowed:
date-time
required

Date and time when this object created

boolean
required

Flag reflecting if service fee was deleted or voided from the order

int64

ID of the object

integer
enum

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
Allowed:
uuid
uri

Relation to OrderItem if Service fee was applied to OrderItem

int64

Id of original service fee object (object that configured on Revel backend)

string
required

Name of service fee was applied

uri

Relation to Order if Service fee was applied to Order

uuid

Reference to parent service fee in case of split bills

string

Additional amount to service fee total amount in case of specific shipping provider

integer
enum

Type: Uber = 0, Postmates = 1

Service Fee Passthrough Type Options:

  • 0 - TYPE_UBERRUSH
  • 1 - TYPE_POSTMATES
Allowed:
integer
enum

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
Allowed:
boolean
required

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). No default provided.

uri

URI of this object

integer
required

Sort number for display in the order

string
required

Tax amount from service fee

boolean
required

Flag reflecting if service fee should be taxed

string
required

Calculated service fee total amount.

integer
enum
required

Type: Amount = 0, Percent = 1

Service Fee Type Options:

  • 0 - SERVICE_FEE_TYPE_AMOUNT
  • 1 - SERVICE_FEE_TYPE_PERCENT
Allowed:
date-time
required

Date and time when this object was updated

uuid
required

Unique identifier is used for searching object

Responses
201

Successful operation

400

Bad request. Usually not valid data provided.

401

Authorization required

Updated over 2 years ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated over 2 years ago