Skip to main content
GET
List committed expenses
Coming soon: this endpoint is still under review and may change before release.

Overview

Retrieves the committed expenses — amounts an employee has committed to spend over several payroll cycles (for example, nursery) — either for a single employee (?employee={id}) or for a whole company (?company={id}). Provide exactly one of the two. Results are grouped by fiscal year and benefit (for example, “300 € committed in nursery for 2026”). You can optionally narrow the results to a single fiscalYear.
Important: use this endpoint to know how much an employee has committed so you can adjust their limits. Committed expenses count against the employee’s flexible-benefit limit from the moment they are committed. Nursery has an annual limit, so its committed expenses are reported per fiscal year.
Important: each individual monthly charge of a committed expense is charged at the start of its payroll cycle and is reported as a regular consumption by the consumptions endpoints and by the employee.consumption.registered webhook event. This endpoint reports the committed expense itself: the total committed and how much is still pending.
Important: the employee.committed-expense.* and employee.committed-expense.payment.* webhook events notify you when a committed expense is requested, finished, or cancelled (as a whole or one payment at a time). Like every other webhook, they only identify what changed — call this endpoint after receiving one to get the current committedAmountInCents / pendingAmountInCents and compute the employee’s remaining limit.
Important: recipient identifies the person the committed expense applies to when that person is different from the employee. It is omitted when the committed expense applies directly to the employee, so the employee’s identifier is not duplicated. When present, recipient.id contains the dependent’s identifier.

Authorizations

Authorization
string
header
required

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

Query Parameters

employeeId
string<uuid>

The unique identifier of the employee. Provide either employee or company, not both.

companyId
string<uuid>

The unique identifier of the company. Provide either employee or company, not both.

fiscalYear
string

Restrict the results to a single fiscal year (e.g. 2026). If not provided, all fiscal years with committed expenses are returned.

Pattern: ^[0-9]{4}$
Example:

"2026"

Response

Committed expenses successfully retrieved. The response is scoped to an employee or to a company depending on the filter used.

company
object
required