- Category: Specifies the type of benefit being consumed. For core benefits this is a stable machine-readable slug (e.g.,
meal-benefit,transport-benefit). For custom benefits it is the full name configured by the company (e.g.,Wellness Bonus). - Behaviour: Defines how the money flows and its tax implications (e.g., allowance, flex)
- Sum Type: Indicates whether the consumption is an expense or a withdrawal
Categories
Core benefits return one of the fixed slugs below.Custom benefits
Companies can configure their own custom benefits. For a consumption of a custom benefit,category is the full name of that benefit exactly as configured (e.g., Wellness Bonus), not a slug from the table above. Custom names are free text and cannot be used to filter via the categories query parameter.