Skip to main content
GET
Find employee consumptions

​
Overview

Retrieves all confirmed transactions of a specific employee for the current payroll cycle.
Deprecated parameters
The parameter payrollCycleId is deprecated. Please use the property payroll instead.
Important: By default, consumptions are returned for the current (open) payroll cycle. To retrieve a previous cycle, provide it through payroll property.
Important: The payload can be transformed depending on categories and groupBy. Choose the options that better suit your integration.
Important: category is a stable slug for core benefits (e.g., meal-benefit). For custom benefits, category is the company-configured full name (e.g., Wellness Bonus) and cannot be used to filter through the categories query parameter. If a custom benefit has no configured name, its identifier (UUID) is returned unchanged. See Consumption Reports for details.
Important: For text/csv we can select two formats through csvFormat options. When lines is selected, each row corresponds to a single consumption record. When columns is selected, each row corresponds to the total consumptions of an employee, and each consumption type is represented as a separate column.
Important: In columns format the consumption columns are derived from the data: a column only appears when there is consumption for it, so a missing column means there was no consumption. As an exception, when groupBy=category and categories are provided, the CSV is guaranteed to contain one column per requested category — in the same order as requested — with 0 when there is no consumption.
Important: if the requested payroll cycle is not closed yet, then the property end will be the current date. Otherwise, end will correspond to the last day of the cycle.
Example responses based on csvFormat and categories:

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Accept
enum<string>

The response file type. It can be application/json or text/csv.

Available options:
application/json,
text/csv

Path Parameters

​
companyId
string<uuid>
required

The unique identifier of the company

​
employeeId
string
required

The unique identifier of the employee

Query Parameters

​
payrollCycleId
string<uuid>

The unique identifier of the payroll cycle. If not provided, the open payroll cycle will be used. This parameter is deprecated, use payroll instead.

​
payroll
string

The fiscal year and month (YYYY-MM) of the payroll cycle the consumptions belong to (e.g. 2025-03).

Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])$
Example:

"2025-03"

​
csvFormat
enum<string>

The format of the resulting consumptions request. Lines: as many lines as benefits for each employee, Columns: one line for each employee and as many columns as benefits In columns format the columns are derived from the data, so a missing column means no consumption. When combined with groupBy=category and categories, every requested category is guaranteed to appear as a column.

Available options:
lines,
columns
​
categories
string

List of core benefit category slugs to include in the response. Custom benefit names cannot be used as filters. When requesting text/csv with csvFormat=columns and groupBy=category, every requested category is guaranteed to appear as a column, in the requested order, with 0 when there is no consumption.

​
groupBy
string

Consumptions can be grouped to return data that is more similar to how your system works. The consumptions can be grouped by:

  • category: it will calculate the sum of expenses minus withdrawals for all the consumptions in a category,
  • category,behaviour: sum of all expenses minus withdrawals for all the consumptions in category and behaviour.

Response

Employee consumptions successfully retrieved

​
company
object
required