Authentication
All requests require anx-api-key header.
POST /tip/pool/create — Create a tip pool
Create a new tip pool from a set of recorded tips and define how the total will be distributed among participants.Request body
string
required
A name for this tip pool. Example:
Sunday Lunch Poolarray
required
An array of tip IDs to include in the pool.
string
required
How the pooled total will be split among participants. One of:
equal, weighted, hours_basedarray
required
An array of employees eligible to receive a share. Each entry requires
employeeId and employeeName.Code example
POST /tip/pool/distribute — Distribute a tip pool
Trigger distribution of a previously created tip pool. The engine calculates each participant’s share using the distribution method defined at pool creation and records individual payouts in the audit trail.Request body
string
required
The ID of the tip pool to distribute. Returned when the pool was created.