Lire une paie par ID

GET

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

Retourne la fiche complète d'une paie à partir de son identifiant interne : employé (avec son nom), période, état et bloc totals (brut, net, retenues, coût employeur, heures supplémentaires, paiements émis). Le résultat est mis en cache 4 h si la date de paiement n'est pas encore passée, 24 h sinon ; le bloc cache de la réponse en rend compte. Disponible aussi par numéro unique via /by-unique/{unique}.

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/pays/by-id/?force_refresh=' \
--header 'x-api-key: <api-key>'

Response Example

{
    "_links": {
        "employee": "/api/payroll/employees/by-id/42",
        "payments": "/api/payroll/pays/by-id/2107/payments",
        "salaries": "/api/payroll/pays/by-id/2107/salaries",
        "self": "/api/payroll/pays/by-id/2107"
    },
    "cache": {
        "age_seconds": 0,
        "cached_at": "2026-10-07T13:18:04-04:00",
        "expires_at": "2026-10-08T13:18:04-04:00",
        "force_refreshed": false,
        "key_hash": "sha1:3f1c0e9a7b2d4c6e8f0a1b3c5d7e9f1a2b4c6d8e",
        "status": "miss",
        "ttl_policy": "historical_24h",
        "ttl_remaining_seconds": 86399
    },
    "employee": {
        "code": "118",
        "first_name": "Marie",
        "full_name": "Tremblay Marie",
        "id": 42,
        "last_name": "Tremblay"
    },
    "id": 2107,
    "metadata": {
        "sdk_index_used": 0,
        "sdk_interface": "Pay",
        "unique_id": 20318,
        "updated_at": "2026-07-17T09:28:57-04:00",
        "updated_by_user_id": 7
    },
    "period_end": "2026-07-18",
    "period_number": 30,
    "period_pay_date": "2026-07-23",
    "period_start": "2026-07-12",
    "status": {
        "is_archived": false,
        "is_deleted": false,
        "is_printing_in_progress": false,
        "is_temporary": false,
        "is_transferred_to_gl": true,
        "is_used": false,
        "remittance_made": true
    },
    "sync": {
        "cursor": {
            "card_pos": 2107,
            "modified_at": "2026-07-17T09:28:57-04:00"
        },
        "extracted_at": "2026-10-07T13:18:04-04:00",
        "organisation_id": "demo_construction"
    },
    "totals": {
        "gross_pay_paid": 1248.6,
        "payments_amount": 892.35,
        "payments_count": 1,
        "salaries_count": 1,
        "total_employee_deductions": 356.25,
        "total_employer_cost_cash": 1512.4,
        "total_net_pay": 892.35,
        "total_overtime": 0
    },
    "unique": 20318,
    "year_end_type": 0
}

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

Lister les paies

Lire une paie par numéro unique