AppliedServiceCharge

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

• appliedTaxes:
  Array of objects (AppliedTaxRate)

  Taxes applied to the service charge.

• chargeAmount:
  number <double>

  The final applied amount excluding tax. Required if chargeType is OPEN.

• chargeType:
  string

  The type of service charge. Response only.

  Valid values:

  • FIXED - The service charge is for a specific currency amount.

  • PERCENT - The service charge is for a percentage of the check amount.

  • OPEN - The service charge is not configured with an amount. The amount is specified by the restaurant employee.

  Enum: "FIXED" "PERCENT" "OPEN"
• delivery:
  boolean

  Whether this service charge is a delivery charge. Response only.

• dineIn:
  boolean

  Whether this service charge is a dine-in charge. Response only.

• entityType required:
  string

  The type of object this is. Response only.

• externalId:
  string

  External identifier string that is prefixed by the naming authority. You can use the orders API to set an externalId for an order and then GET the order with that externalId.

• gratuity:
  boolean

  Whether this service charge is a gratuity. Can be used to derive required tip amount on the check. Response only.

• guid required:
  string

  The GUID maintained by the Toast platform.

• name:
  string

  The configured human readable label for the service charge. Response only.

• paymentGuid:
  string

  The Toast platform unique identifier for the payment the fee is linked to. The paymentGuid value is always null unless the serviceChargeCategory object value is CREDIT_CARD_SURCHARGE. Response only.

• refundDetails:
  object (RefundDetails)

  Information about refunded currency amounts for an item selection, modifier option, or service charge. The refund information includes separate values for the pre-tax value being refunded and the tax amount being refunded.

• serviceCharge required:
  object (ExternalReference)

  A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

• serviceChargeCalculation:
  string

  Defines whether a PERCENT service charge is applied before (PRE_DISCOUNT) or after (POST_DISCOUNT) discounts.

  This field is null for FIXED and OPEN service charges.

  Enum: "PRE_DISCOUNT" "POST_DISCOUNT"
• serviceChargeCategory:
  string

  The type of service charge. Default is SERVICE_CHARGE. Response only.

  Valid values:

  • SERVICE_CHARGE - The default type for a service charge.

  • CREDIT_CARD_SURCHARGE - A fee assessed only on payment transactions that use a credit card.

  • FUNDRAISING_CAMPAIGN - Service charge associated with fundraising.

  Enum: "SERVICE_CHARGE" "CREDIT_CARD_SURCHARGE" "FUNDRAISING_CAMPAIGN"
• takeout:
  boolean

  Whether this service charge is a takeout charge. Response only.

• taxable:
  boolean

  Whether this service charge is taxable. Response only.

{
  "guid": "string",
  "entityType": "string",
  "externalId": "string",
  "chargeAmount": 0,
  "serviceCharge": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string"
  },
  "chargeType": "FIXED",
  "name": "string",
  "delivery": true,
  "takeout": true,
  "dineIn": true,
  "gratuity": true,
  "taxable": true,
  "appliedTaxes": [
    {
      "guid": "string",
      "entityType": "string",
      "taxRate": {
        "guid": "string",
        "entityType": "string"
      },
      "name": "string",
      "rate": 0,
      "taxAmount": 0,
      "type": "PERCENT",
      "facilitatorCollectAndRemitTax": true,
      "displayName": "string",
      "jurisdiction": "string",
      "jurisdictionType": "string"
    }
  ],
  "serviceChargeCalculation": "PRE_DISCOUNT",
  "refundDetails": {
    "refundAmount": 0,
    "taxRefundAmount": 0,
    "refundTransaction": {
      "guid": "string",
      "entityType": "string"
    }
  },
  "serviceChargeCategory": "SERVICE_CHARGE",
  "paymentGuid": "string"
}