Lire les soldes de banques RH d'un employé par ID

GET

/api/payroll/employees/by-id/{id}/hr-bank-balances

Retourne les soldes de banques RH (vacances, congés, maladie, heures accumulées…) de l'employé, un par couple (fonction, banque) : le solde disponible est dans totals.balance, et current_value est la valeur par défaut ajoutée à chaque inscription de paie ou de lot. Les soldes supprimés sont exclus et la lecture est faite en direct, sans cache. summary regroupe les soldes par unité de banque (heures, jours, montant, quantité). Disponible aussi par numéro d'employé via /{code}/hr-bank-balances.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Path Params

Responses

🟢200

application/json

Soldes de banques RH 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/by-id//hr-bank-balances' \
--header 'x-api-key: <api-key>'

Response Example

{
    "_links": {
        "employee": "/api/payroll/employees/by-id/57",
        "overview": "/api/payroll/employees/by-id/57/overview",
        "pay_history": "/api/payroll/employees/by-id/57/pay-history",
        "self": "/api/payroll/employees/by-id/57/hr-bank-balances"
    },
    "employee": {
        "code": "1042",
        "id": 57,
        "name": "Tremblay Marie"
    },
    "items": [
        {
            "bank": {
                "applicable_to": 2,
                "code": 1,
                "description": "Vacances",
                "format": 1,
                "format_label": "Heure",
                "id": 4
            },
            "current_value": 3.08,
            "function": {
                "description": "Charpentier-menuisier",
                "id": 31,
                "reference": 1
            },
            "id": 12,
            "totals": {
                "balance": 55.5,
                "credits": 80,
                "debits": 24.5
            },
            "updated_at": "2026-09-14T10:22:05-04:00"
        },
        {
            "bank": {
                "applicable_to": 1,
                "code": 3,
                "description": "Congés personnels",
                "format": 3,
                "format_label": "Montant",
                "id": 6
            },
            "current_value": 50,
            "function": {
                "id": 0,
                "reference": 0
            },
            "id": 13,
            "last_batch": "2026-09-01",
            "totals": {
                "balance": 200,
                "credits": 300,
                "debits": 100
            },
            "updated_at": "2026-09-01T06:00:12-04:00"
        }
    ],
    "metadata": {
        "extracted_at": "2026-10-07T13:47:48-04:00",
        "organisation_id": "construction_demo",
        "scope": "non_deleted",
        "sdk_indexes_used": {
            "function_x": "GetCard (resolve)",
            "hr_bank": "GetCard (resolve)",
            "hr_bank_balances": "Idx 1 scoped Key_BBEmployeeCP"
        }
    },
    "summary": {
        "by_format": [
            {
                "count": 1,
                "format": 1,
                "label": "Heure",
                "total_value": 3.08
            },
            {
                "count": 1,
                "format": 3,
                "label": "Montant",
                "total_value": 50
            }
        ],
        "count": 2
    }
}

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

Modifier une fonction d'un employé

Lire les soldes de banques RH d'un employé par code