Lire un paiement de paie par ID

GET

/api/payroll/payments/by-id/{id}

Retourne un paiement de paie à partir de son identifiant interne, qu'il soit annulé ou non : employé, mode, montant, date, compte de banque, salaires réglés et état. Les coordonnées bancaires sont masquées sans l'autorisation « données sensibles de paie » de la clé API. La paie réglée se lit via /api/payroll/pays/by-id/{id}.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Path 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/payments/by-id/' \
--header 'x-api-key: <api-key>'

Response Example

{
    "_links": {
        "employee": "/api/payroll/employees/by-id/42",
        "pay": "/api/payroll/pays/by-id/2107"
    },
    "amount": 892.35,
    "bank": {
        "id": 175,
        "number": 1015
    },
    "banking": {
        "account_number": "***5678",
        "branch_number": "*0042",
        "institution_number": "***"
    },
    "date_printed": "2026-07-23",
    "employee": {
        "code": "118",
        "first_name": "Marie",
        "id": 42,
        "last_name": "Tremblay"
    },
    "id": 1204,
    "metadata": {
        "sdk_interface": "PaymentPA",
        "unique_id": 1204,
        "updated_at": "2026-07-17T11:36:20-04:00",
        "updated_by_user_id": 7
    },
    "pay": {
        "id": 2107,
        "unique": 20318
    },
    "payment_mode": 2,
    "payment_mode_code": "direct_deposit",
    "payment_mode_label": "Dépôt direct",
    "payment_number": 19302,
    "period_number": 30,
    "salary_refs": [
        2312
    ],
    "status": {
        "is_deleted": false,
        "is_transferred_to_gl": true,
        "is_void": false
    },
    "unique": 1204
}

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

Lister les paiements de paie

Lister les paiements de paie annulés