Lister les périodes de paie

GET

/api/payroll/periods

Retourne les périodes de paie qui contiennent réellement des paies, regroupées par année de la date de paiement et par numéro de période, avec le nombre de paies et d'employés et des liens vers les paies, le sommaire et les feuilles de temps. Utilisez-le pour alimenter un sélecteur de période plutôt que de supposer 1 à 53 périodes par année ; la période 0 (mise en place), les paies supprimées et les paies sans date de paiement sont exclues. brief=false ajoute par période les indicateurs financiers (brut, net, déductions, charges et coût employeur, temps supplémentaire) et les totaux globaux, mais ce calcul est lourd (plusieurs minutes par année sans cache) : demandez une année à la fois. Le format résumé est mis en cache 4 h si l'année courante est incluse, 24 h sinon ; brief=false réutilise le cache de /api/payroll/summary.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Query Params

Responses

🟢200

application/json

Périodes de paie qui contiennent 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/periods?year=&year_from=&year_to=&include_temporary=&include_archived=&brief=&force_refresh=' \
--header 'x-api-key: <api-key>'

Response Example

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

{
    "filters": {
        "year": 2026,
        "include_temporary": false,
        "include_archived": true,
        "brief": true
    },
    "periods": [
        {
            "year": 2026,
            "period_number": 18,
            "period_pay_date_min": "2026-04-30",
            "period_pay_date_max": "2026-04-30",
            "period_start_min": "2026-04-19",
            "period_end_max": "2026-04-25",
            "pays_count": 42,
            "employees_count": 42,
            "_links": {
                "self": "/api/payroll/periods?year=2026&include_temporary=false&include_archived=true&brief=true",
                "summary": "/api/payroll/summary?year=2026&period_number=18&include_temporary=false&include_archived=true",
                "pays": "/api/payroll/pays?year=2026&period_number=18&is_temporary=false",
                "time_sheets": "/api/payroll/time-sheets?from_date=2026-04-19&to_date=2026-04-25"
            }
        }
    ],
    "summary": {
        "years_available": [
            2026
        ],
        "total_periods": 30,
        "total_pays": 1150,
        "total_employees": 68
    },
    "metadata": {
        "organisation_id": "construction_demo",
        "extracted_at": "2026-10-07T09:00:00-04:00",
        "sdk_indexes_used": {
            "pay": "Idx 1 full scan + filtre Python"
        },
        "scope": "include_temporary=False,include_archived=True,brief=True",
        "version": "v3"
    },
    "cache": {
        "status": "hit",
        "key_hash": "sha1:9b2e4f6a8c0d1e3f5a7b9c1d3e5f7a9b1c3d5e7f",
        "cached_at": "2026-10-07T09:00:00-04:00",
        "expires_at": "2026-10-07T13:00:00-04:00",
        "age_seconds": 1800,
        "ttl_remaining_seconds": 12600,
        "ttl_policy": "current_period_4h",
        "force_refreshed": false
    },
    "_links": {
        "self": "/api/payroll/periods?year=2026&include_temporary=false&include_archived=true&brief=true",
        "summary": "/api/payroll/summary"
    }
}

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

Lister les champs définissables de la paie

Calculer le calendrier de paie