Tippable Staff API: Sample Use Cases and Flows

This article presents a possible use case and corresponding sample flow that you can support. This can be a helpful jumping off point as you plan your implementation.

Implement a staff performance dashboard

You can evaluate staff performance based on various metrics, including tips received.

To implement a staff performance dashboard:

1. Call List Tippable Staff to retrieve all tippable staff and save their IDs.
2. Calculate the total tip amount for each staff member in your desired time range. Call Sum Tip Distributions and filter using the relevant staff ID and your desired range for createdDate. Alternatively, call Query Tip Distributions with the same filter and calculate the total tip per staff.
3. Display each staff member's information and their associated tip total.