Consulter la vue d'ensemble d'un employé par code

GET

/api/payroll/employees/{code}/overview

Retourne en une seule réponse la synthèse d'un employé, à partir de son numéro d'employé : identité, paies, paiements, feuilles de temps et dernière activité. Disponible aussi par identifiant interne via /by-id/{id}/overview. La période couvre les period_months mois (12 par défaut) qui se terminent à la date as_of (aujourd'hui par défaut) : paies non archivées dont la date de paiement tombe dans la période, paiements non annulés émis pour ces paies (montants nets réellement versés, par mode de paiement), lignes de feuille de temps et dates de dernière activité. Le NAS, les coordonnées bancaires, les exemptions et les cumulatifs ne sont jamais retournés : has_direct_deposit_setup indique seulement si un dépôt direct est configuré. Conventions communes (cache de 4 h si as_of est aujourd'hui, 24 h sinon, 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

Vue d'ensemble de l'employé sur la période

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//overview?as_of=&period_months=&force_refresh=' \
--header 'x-api-key: <api-key>'

Response Example

{
    "_links": {
        "detail": "/api/payroll/employees/by-id/42",
        "payments": "/api/payroll/payments?employee_id=42",
        "pays": "/api/payroll/pays?employee_id=42",
        "self": "/api/payroll/employees/by-id/42/overview",
        "time_sheets": "/api/payroll/time-sheets?employee_id=42"
    },
    "as_of_date": "2026-10-07",
    "cache": {
        "age_seconds": 0,
        "cached_at": "2026-10-07T13:47:28-04:00",
        "expires_at": "2026-10-07T17:47:28-04:00",
        "force_refreshed": false,
        "key_hash": "sha1:8ca51e338d0b792215ec256f48b189a7ab01c4d2",
        "status": "miss",
        "ttl_policy": "current_period_4h",
        "ttl_remaining_seconds": 14400
    },
    "employee": {
        "address_city": "Laval",
        "code": "1042",
        "first_name": "Marie",
        "functions": {
            "active_count": 1,
            "total_count": 2
        },
        "has_direct_deposit_setup": true,
        "hr_hours_per_day": 8,
        "id": 42,
        "is_absent": false,
        "is_active": true,
        "is_archived": false,
        "language": 12,
        "last_name": "Tremblay",
        "name": "Tremblay Marie",
        "payment_mode": 2
    },
    "last_activity": {
        "days_since_last_activity": 76,
        "last_pay_date": "2026-07-23",
        "last_payment_date": "2026-07-23",
        "last_time_sheet_date": "2026-07-13",
        "last_transaction_date": "2026-07-23"
    },
    "metadata": {
        "extracted_at": "2026-10-07T13:47:28-04:00",
        "organisation_id": "construction_demo",
        "scope": "non_archived_only",
        "sdk_indexes_used": {
            "employee": "GetCard",
            "pay": "Idx 2 + Idx 4 scoped Key_PaEmployeeCP",
            "payment_pa": "Idx 3 scoped Key_PPPayCP per pay",
            "time_sheet": "Idx 1 scoped Key_TSEmployeeCP"
        }
    },
    "pay_summary": {
        "archived_count": 0,
        "average_pay_amount": 1113.35,
        "last_pay": {
            "amount": 1124.38,
            "days_ago": 76,
            "id": 1975,
            "period_number": 30,
            "period_pay_date": "2026-07-23",
            "unique": 20256
        },
        "pays_count": 26,
        "salaries_total": 28947.12,
        "temporary_count": 0
    },
    "payments_summary": {
        "by_payment_mode": [
            {
                "amount": 28947.12,
                "count": 26,
                "label": "Dépôt direct",
                "mode": 2
            }
        ],
        "count": 26,
        "last_payment": {
            "amount": 1124.38,
            "date": "2026-07-23",
            "days_ago": 76,
            "id": 1180,
            "payment_mode_code": "direct_deposit",
            "payment_number": 19278
        },
        "total_amount": 28947.12
    },
    "period": {
        "from": "2025-10-07",
        "months": 12,
        "to": "2026-10-07"
    },
    "time_sheets_summary": {
        "assigned_count": 52,
        "count": 52,
        "last_time_sheet": {
            "days_ago": 86,
            "hours": 8,
            "id": 8821,
            "is_assigned": true,
            "start_date": "2026-07-13"
        },
        "total_hours": 416,
        "unassigned_count": 0
    }
}

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

Consulter la vue d'ensemble d'un employé par ID

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