Consulter l'historique des paies d'un employé par code

GET

/api/payroll/employees/{code}/pay-history

Retourne l'historique paginé des paies d'un employé, à partir de son numéro d'employé. Disponible aussi par identifiant interne via /by-id/{id}/pay-history. Les paies non archivées dont la date de paiement tombe dans les lookback_months derniers mois (12 par défaut) sont listées de la plus récente à la plus ancienne, chacune avec son net versé (paiements non annulés), sa répartition par mode de paiement et son état (temporaire, reportée au grand livre, remise effectuée). Paginez avec limit et offset en reprenant summary.next_offset (null sur la dernière page) ou suivez _links.next, qui reprend tous les paramètres de l'appel, filtres compris ; les totaux de summary portent sur toute la fenêtre, pas seulement sur la page. Conventions communes (cache de 4 h, force_refresh, _links, metadata) : voir la présentation de la section Tableaux de bord.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Path Params

Query Params

Responses

🟢200

application/json

Historique des paies de l'employé

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://relay.exostack.cloud//api/payroll/employees//pay-history?lookback_months=&limit=&offset=&is_temporary=&is_archived=&force_refresh=' \
--header 'x-api-key: <api-key>'

Response Example

{
    "_links": {
        "employee": "/api/payroll/employees/by-id/42",
        "next": "/api/payroll/employees/by-id/42/pay-history?lookback_months=12&limit=20&offset=20&is_temporary=false",
        "overview": "/api/payroll/employees/by-id/42/overview",
        "self": "/api/payroll/employees/by-id/42/pay-history?lookback_months=12&limit=20&offset=0&is_temporary=false"
    },
    "cache": {
        "age_seconds": 0,
        "cached_at": "2026-10-07T13:48:11-04:00",
        "expires_at": "2026-10-07T17:48:11-04:00",
        "force_refreshed": false,
        "key_hash": "sha1:011200afcb332d06b4453da26de7e47998487a05",
        "status": "miss",
        "ttl_policy": "current_period_4h",
        "ttl_remaining_seconds": 14400
    },
    "employee": {
        "code": "1042",
        "id": 42,
        "name": "Tremblay Marie"
    },
    "items": [
        {
            "_links": {
                "pay": "/api/payroll/pays/by-id/1975",
                "payments": "/api/payroll/pays/by-id/1975/payments",
                "salaries": "/api/payroll/pays/by-id/1975/salaries"
            },
            "by_payment_mode": [
                {
                    "amount": 1124.38,
                    "count": 1,
                    "label": "Dépôt direct",
                    "mode": 2
                }
            ],
            "days_ago": 76,
            "is_archived": false,
            "is_temporary": false,
            "is_transferred_to_gl": true,
            "last_payment_date": "2026-07-23",
            "line_index": 1,
            "net_pay": 1124.38,
            "pay": {
                "id": 1975,
                "period_number": 30,
                "unique": 20256
            },
            "payments_count": 1,
            "period_end": "2026-07-18",
            "period_pay_date": "2026-07-23",
            "period_start": "2026-07-12",
            "remittance_made": true
        }
    ],
    "lookback": {
        "from": "2025-10-07",
        "months": 12,
        "to": "2026-10-07"
    },
    "metadata": {
        "extracted_at": "2026-10-07T13:48:11-04:00",
        "ordering": "period_pay_date_desc",
        "organisation_id": "construction_demo",
        "scope": "non_archived_only_default",
        "sdk_indexes_used": {
            "pay": "Idx 2 + Idx 4 scoped Key_PaEmployeeCP",
            "payment_pa": "Idx 3 scoped Key_PPPayCP per pay"
        }
    },
    "summary": {
        "archived_count": 0,
        "has_more": true,
        "limit_applied": 20,
        "next_offset": 20,
        "offset_applied": 0,
        "temporary_count": 0,
        "total_net_pay": 28947.12,
        "total_pays": 26,
        "transferred_to_gl_count": 26,
        "truncated": true
    }
}

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

Consulter l'historique des paies d'un employé par ID

Consulter le journal de vérification de paie