This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

How to apply service charges to a check

To apply service charges to a check, include the appliedServiceCharges value in the Check object. Include a serviceCharge value for each service charge that applies to the check.

The orders API does not automatically add any service charges. You must add all of the applicable service charges. If the order does not meet the service charge criteria, the orders API rejects the order.

In each serviceCharge value:

  • Set guid to the Toast platform GUID of the service charge.

  • For an open service charge, include a chargeAmount value to set the amount of the service charge.

    Do not provide a chargeAmount for FIXED or PERCENT service charges. The orders API ignores chargeAmount values for FIXED or PERCENT service charges.