Tippable Staff API: Sample Use Cases and Flows

This article shares some possible use cases your code could support, as well as a sample flow that could support each use case. This can be a helpful jumping off point as you plan your code's implementation.

Implement a staff performance dashboard

Your code could evaluate staff performance based on various metrics, including tips received.

To implement a staff performance dashboard:

1. Use listTippableStaff() to retrieve all tippable staff and save their IDs.
2. Calculate the total tip amount for each staff member in your desired time range. Use sumTipDistributions() and filter using the relevant staff ID and your desired range for createdDate. Alternatively, you can use queryTipDistributions() with the same filter and calculate the total tip per staff on your servers.
3. Display each staff member's information and their associated tip total to the business owners.