Consulter les statistiques de paie par année

GET

/api/payroll/periods/stats

Retourne, pour chaque année qui contient des paies, le nombre de périodes, de paies et d'employés distincts ainsi que les dates de la première et de la dernière paie, avec des liens vers /api/payroll/periods et /api/payroll/summary. Le paramètre type choisit la dimension d'agrégation : seule years est prise en charge pour l'instant (liste exposée dans metadata.supported_types). Idéal pour un sélecteur d'année ; le résultat est mis en cache 4 h si la plage inclut l'année courante, 24 h sinon (force_refresh=true pour recalculer).

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Query Params

Responses

🟢200

application/json

Statistiques de paie par année

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://relay.exostack.cloud//api/payroll/periods/stats?type=&year_from=&year_to=&include_temporary=&include_archived=&force_refresh=' \
--header 'x-api-key: <api-key>'

Response Example

{
    "_links": {
        "periods": "/api/payroll/periods",
        "self": "/api/payroll/periods/stats?type=years"
    },
    "cache": {
        "age_seconds": 1800,
        "cached_at": "2026-10-07T09:00:00-04:00",
        "expires_at": "2026-10-07T13:00:00-04:00",
        "force_refreshed": false,
        "key_hash": "sha1:2c4e6a8b0d1f3a5c7e9b1d3f5a7c9e1b3d5f7a9c",
        "status": "hit",
        "ttl_policy": "current_scope_4h",
        "ttl_remaining_seconds": 12600
    },
    "filters": {
        "include_archived": true,
        "include_temporary": false,
        "year_from": 2025,
        "year_to": 2026
    },
    "metadata": {
        "extracted_at": "2026-10-07T09:00:00-04:00",
        "organisation_id": "construction_demo",
        "sdk_indexes_used": {
            "pay": "Idx 1 full scan + agrégat par dimension"
        },
        "supported_types": [
            "years"
        ],
        "version": "v1"
    },
    "stats": [
        {
            "_links": {
                "periods": "/api/payroll/periods?year=2025&brief=true",
                "periods_detailed": "/api/payroll/periods?year=2025&brief=false",
                "summary": "/api/payroll/summary?year=2025"
            },
            "employees_count": 80,
            "pays_count": 2010,
            "period_first": "2025-01-09",
            "period_last": "2025-12-31",
            "periods_count": 52,
            "year": 2025
        },
        {
            "_links": {
                "periods": "/api/payroll/periods?year=2026&brief=true",
                "periods_detailed": "/api/payroll/periods?year=2026&brief=false",
                "summary": "/api/payroll/summary?year=2026"
            },
            "employees_count": 68,
            "pays_count": 1150,
            "period_first": "2026-01-08",
            "period_last": "2026-07-30",
            "periods_count": 30,
            "year": 2026
        }
    ],
    "summary": {
        "total_employees": 96,
        "total_pays": 3160,
        "total_periods": 82,
        "years_count": 2
    },
    "type": "years"
}

Modified at 2026-10-09 19:59:12

Calculer les retenues à remettre par agence

Calculer la prévision de masse salariale