Lister les paiements de paie

GET

/api/payroll/payments

Retourne la liste paginée des paiements de paie de tous les employés : chèques, dépôts directs et comptant. Filtrez par employé, mode de paiement, compte de banque, période ou date du paiement ; les paiements annulés sont exclus, sauf avec include_voided=true. Chaque élément porte aussi payment_mode_code (none, check, direct_deposit, cash), et les coordonnées bancaires sont masquées sans l'autorisation « données sensibles de paie » de la clé API.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Query Params

Responses

🟢200

application/json

Liste paginée des paiements de paie

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?page=&page_size=&employee_id=&employee_code=&payment_mode=&period_number=&period_from=&period_to=&year=&from_date=&to_date=&bank_id=&include_voided=&include_deleted=' \
--header 'x-api-key: <api-key>'

Response Example

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

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

Lister les paiements d'une paie

Lire un paiement de paie par ID