Lire une banque RH par ID

GET

/api/payroll/hr-banks/by-id/{id}

Retourne la fiche complète d'une banque RH à partir de son identifiant interne : mode de cumul, expiration, valeurs par défaut et codes de paie de base. Disponible aussi par numéro via /{code}.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Path Params

Query Params

Responses

🟢200

application/json

Successful Response

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://relay.exostack.cloud//api/payroll/hr-banks/by-id/?include_empty_defaults=' \
--header 'x-api-key: <api-key>'

Response Example

{
    "_links": {
        "self": "/api/payroll/hr-banks/by-id/2"
    },
    "admissible_lines": [
        101,
        102,
        103
    ],
    "applicable_to": 2,
    "batch_entry": false,
    "batch_frequency": 0,
    "code": 1,
    "condition": 0,
    "default_values": [
        {
            "description": "Taux standard",
            "index": 1,
            "value": 4
        }
    ],
    "description": "Vacances 4 %",
    "earnings_line": 0,
    "expiration": false,
    "expiration_frequency": 0,
    "format": 3,
    "id": 2,
    "metadata": {
        "sdk_index_used": 1,
        "sdk_interface": "HRBank",
        "unique_id": 6,
        "updated_at": "2026-08-21T10:05:33-04:00",
        "updated_by_user_id": 7
    },
    "negative_balance_allowed": false,
    "payroll_debit": false,
    "payroll_entry": true,
    "payroll_entry_type": 3,
    "status": {
        "is_active": true,
        "is_archived": false,
        "is_deleted": false,
        "is_used": true
    },
    "used_by_time_sheet": false
}

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

Créer une banque RH

Modifier une banque RH par ID