Lire une inscription de paie par ID

GET

/api/payroll/trans-pa/by-id/{id}

Retourne une paie à partir de son identifiant interne : période, état, pensions alimentaires retenues et total net de ses salaires. Le détail des montants par code de paie se lit via /api/payroll/pays/by-id/{id}/salaries, qui partage le même identifiant.

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

Response Example

{
    "_links": {
        "employee": "/api/payroll/employees/by-id/42",
        "pay": "/api/payroll/pays/by-id/6201",
        "self": "/api/payroll/trans-pa/by-id/6201"
    },
    "employee": {
        "code": "118",
        "id": 42
    },
    "id": 6201,
    "metadata": {
        "sdk_interface": "TransPA",
        "unique_id": 19120,
        "updated_at": "2026-03-31T08:42:10-04:00",
        "updated_by_user_id": 7
    },
    "period_end": "2026-03-28",
    "period_number": 14,
    "period_pay_date": "2026-04-02",
    "period_start": "2026-03-22",
    "salaries_summary": {
        "total_net_pay": 1142.37,
        "tp_num_salaries": 1
    },
    "special_payment": {
        "date_from": "2026-03-22",
        "date_to": "2026-03-28",
        "entries": [
            {
                "amount_per_pay": 125,
                "amount_withheld": 125,
                "effective_date": "2025-09-01",
                "forecast_amount": 0,
                "index": 1,
                "percentage_of_pay": 0
            }
        ],
        "form_number": 0,
        "number_of_entries": 1,
        "remittance_state": 0,
        "report_number": 0,
        "use_code": "alimony",
        "use_id": 1,
        "use_label": "Pension alimentaire"
    },
    "status": {
        "is_archived": false,
        "is_deleted": false,
        "is_printing_in_progress": false,
        "is_temporary": false,
        "is_transferred_to_gl": true,
        "remittance_made": false
    },
    "sync": {
        "cursor": {
            "card_pos": 6201,
            "modified_at": "2026-03-31T08:42:10-04:00"
        },
        "extracted_at": "2026-04-03T10:15:00-04:00",
        "organisation_id": "construction_exemple"
    },
    "unique": 19120,
    "year_end_type": 0
}

Modified at 2026-10-09 19:59:12

Lister les inscriptions de paie

Créer une paie temporaire