How to obtain Monthly Reports - Cobee by Pluxee - Partners API Documentation

This guide explains how to obtain all consumptions for all employees for a closed payroll cycle (e.g., end of month). Steps:

Get the list of employees:
- Use GET /companies/{companyId}/employees to retrieve all employees in the company.
Get consumptions for each employee:
- Iterate through the list of employees and use GET /companies/{companyId}/employees/{employeeId}/consumptions?payroll=YYYY-MM to retrieve confirmed consumptions for the desired payroll cycle (Format: YYYY-MM).

How to Correctly Query Employee Consumption Data

Important Notice
Ensure you use the correct payroll parameter (e.g., 2023-11) to get data for the specific closed cycle.

Key Points

If the payroll parameter is not provided, the API works with the ongoing cycle.

Important Notice
For more details on each endpoint, refer to their respective documentation links above.