Lister les paies

GET

/api/payroll/pays

Retourne la liste paginée des paies (une paie = un employé pour une période de paie). Filtrez par employé, par numéro ou plage de périodes, par année ou plage de dates de paiement, et par état (temporaire, archivée). Le format résumé (par défaut) est léger ; brief=false ajoute le nom de l'employé, un bloc totals par paie (brut, net, retenues, coût employeur, paiements) et un bloc cache dans la réponse, au prix d'environ 150 ms par paie (page de 20 au plus recommandée). Le détail d'une paie se lit via /by-id/{id}/salaries et /by-id/{id}/payments.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Query Params

Responses

🟢200

application/json

Liste paginée des paies

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://relay.exostack.cloud//api/payroll/pays?page=&page_size=&brief=&employee_id=&employee_code=&period_number=&period_from=&period_to=&year=&from_date=&to_date=&is_temporary=&is_archived=&include_deleted=&force_refresh=' \
--header 'x-api-key: <api-key>'

Response Example

200 - Format résumé (brief=true, défaut)

{
    "items": [
        {
            "id": 2107,
            "unique": 20318,
            "employee": {
                "id": 42,
                "code": "118"
            },
            "period_number": 30,
            "period_start": "2026-07-12",
            "period_end": "2026-07-18",
            "period_pay_date": "2026-07-23",
            "is_temporary": false,
            "is_archived": false,
            "is_transferred_to_gl": true,
            "updated_at": "2026-07-17T09:28:57-04:00",
            "_links": {
                "self": "/api/payroll/pays/by-id/2107",
                "salaries": "/api/payroll/pays/by-id/2107/salaries",
                "payments": "/api/payroll/pays/by-id/2107/payments"
            }
        }
    ],
    "page": 1,
    "page_size": 20,
    "total": 30,
    "total_pages": 2
}

Modified at 2026-10-10 14:01:59

Calculer le calendrier de paie

Lire une paie par ID