Lister les paiements de paie annulés

GET

/api/payroll/voided-payments

Retourne les chèques et dépôts directs de paie annulés, du plus récent au plus ancien, pour un audit. Filtrez par date du paiement avec from_date et to_date, et paginez avec limit et offset ; summary couvre toute la fenêtre, pas seulement la page. Les données sont lues en direct (sans cache) 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 des paiements annulés.

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://relay.exostack.cloud//api/payroll/voided-payments?from_date=&to_date=&limit=&offset=' \
--header 'x-api-key: <api-key>'

Response Example

{
    "_links": {
        "payments_active": "/api/payroll/payments",
        "self": "/api/payroll/voided-payments",
        "summary": "/api/payroll/summary"
    },
    "items": [
        {
            "_links": {
                "employee": "/api/payroll/employees/by-id/42"
            },
            "amount": 0,
            "bank": {
                "id": 175,
                "number": 1015
            },
            "banking": {
                "account_number": "***5678",
                "branch_number": "*0042",
                "institution_number": "***"
            },
            "date_printed": "2026-07-16",
            "employee": {
                "code": "118",
                "first_name": "Marie",
                "id": 42,
                "last_name": "Tremblay"
            },
            "id": 1166,
            "metadata": {
                "sdk_interface": "PaymentPA",
                "unique_id": 1166,
                "updated_at": "2026-07-14T06:51:00-04:00",
                "updated_by_user_id": 7
            },
            "pay": {},
            "payment_mode": 2,
            "payment_mode_code": "direct_deposit",
            "payment_mode_label": "Dépôt direct",
            "payment_number": 19264,
            "period_number": 29,
            "salary_refs": [],
            "status": {
                "is_deleted": false,
                "is_transferred_to_gl": true,
                "is_void": true
            },
            "unique": 1166
        }
    ],
    "metadata": {
        "extracted_at": "2026-10-07T13:18:26-04:00",
        "organisation_id": "demo_construction",
        "scope": "voided_only (PPVoid=1)",
        "sdk_indexes_used": {
            "payment_pa": "Idx 5 (chèques voided) + Idx 6 (DD voided)"
        }
    },
    "period": {},
    "summary": {
        "by_payment_mode": [
            {
                "amount": 0,
                "count": 3,
                "label": "Chèque",
                "mode": 1
            },
            {
                "amount": 0,
                "count": 9,
                "label": "Dépôt direct",
                "mode": 2
            }
        ],
        "count": 12,
        "has_more": false,
        "limit_applied": 50,
        "offset_applied": 0,
        "total_amount": 0
    }
}

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

Lire un paiement de paie par ID

Lister les lignes de temps