Consulter le journal de vérification de paie

GET

/api/payroll/reports/pay-verif-breakdown

Journal de vérification de paie : tableau croisé des montants par code de paie, par employé et fonction (ou par employé, fonction, département ou métier selon group_by), sur une plage de périodes de paie. mode=range cumule de (from_year, from_period) à (to_year, to_period) ; mode=compare met deux périodes A et B côte à côte, avec l'écart par code. Chaque cellule by_code[code] donne le montant et, selon codes[].value_kind, la quantité (heures ou pourcentage) ; group_by=occupation regroupe les fonctions de même libellé en métiers, filtrables avec occupation=<code>. Conventions communes : voir la présentation de la section Tableaux de bord.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Query Params

Responses

🟢200

application/json

Journal de vérification 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/reports/pay-verif-breakdown?mode=&group_by=&codes=&department=&employee=&function=&occupation=&include_deleted=&only_nonzero_codes=&force_refresh=&from_year=&from_period=&to_year=&to_period=&a_year=&a_period=&b_year=&b_period=' \
--header 'x-api-key: <api-key>'

Response Example

200 - Plage de périodes (mode=range)

{
    "scope": {
        "mode": "range",
        "group_by": "employee_function",
        "filters": {},
        "include_deleted": false,
        "periods_included": [
            {
                "year": 2026,
                "period": 32,
                "pay_date": "2026-08-06"
            }
        ],
        "from": {
            "year": 2026,
            "period": 32
        },
        "to": {
            "year": 2026,
            "period": 32
        }
    },
    "codes": [
        {
            "code": 102,
            "section": "income",
            "label": "Salaire régulier horaire ($/heure)",
            "description": "Salaire régulier horaire",
            "amount_type": {
                "value": 1,
                "unit": "$/heure"
            },
            "value_kind": "hours"
        },
        {
            "code": 103,
            "section": "income",
            "label": "Temps et demi ($/heure)",
            "description": "Temps et demi",
            "amount_type": {
                "value": 1,
                "unit": "$/heure"
            },
            "value_kind": "hours"
        },
        {
            "code": 901,
            "section": "government_deduction",
            "label": "Impôt fédéral ($/paie)",
            "description": "Impôt fédéral",
            "amount_type": {
                "value": 2,
                "unit": "$/paie"
            },
            "value_kind": "amount"
        }
    ],
    "rows": [
        {
            "key": "empfn:42|cp:401",
            "employee": {
                "id": 42,
                "code": "1042",
                "name": "Marie Tremblay"
            },
            "function": {
                "id": 401,
                "reference": 1,
                "description": "Charpentier-menuisier"
            },
            "by_code": {
                "102": {
                    "amount": 1520,
                    "quantity": 40
                },
                "103": {
                    "amount": 171,
                    "quantity": 3
                },
                "901": {
                    "amount": 198.42
                }
            },
            "net": 1188.36,
            "salaries_count": 1
        }
    ],
    "code_totals": {
        "102": {
            "amount_total": 1520,
            "quantity_total": 40,
            "rows_count": 1,
            "employees_count": 1,
            "amount_min": 1520,
            "amount_max": 1520,
            "amount_avg": 1520
        }
    },
    "grand_total": {
        "net": 1188.36,
        "by_code": {
            "102": {
                "amount": 1520,
                "quantity": 40
            },
            "103": {
                "amount": 171,
                "quantity": 3
            },
            "901": {
                "amount": 198.42
            }
        },
        "by_section": {
            "income": 1691,
            "government_deduction": 198.42
        },
        "employees": 1,
        "functions": 1,
        "rows": 1,
        "salaries_scanned": 1,
        "pays_scanned": 1
    },
    "verification": {
        "net_reconciliation": {
            "sum_net_calculated": 1188.36,
            "sum_sdk_net": 1188.36,
            "net_diff": 0
        },
        "outliers": []
    },
    "metadata": {
        "organisation_id": "construction_demo",
        "extracted_at": "2026-10-07T13:19:35-04:00",
        "sdk_indexes_used": {
            "pay": 1,
            "salary": 1,
            "control_payroll": "get_card"
        }
    },
    "_links": {
        "self": "/api/payroll/reports/pay-verif-breakdown",
        "periods": "/api/payroll/periods"
    },
    "cache": {
        "status": "miss",
        "key_hash": "sha1:31a43eb7e306bf3903f795fd2a76d918a92cd27b",
        "cached_at": "2026-10-07T13:19:35-04:00",
        "expires_at": "2026-10-07T17:19:35-04:00",
        "age_seconds": 0,
        "ttl_remaining_seconds": 14399,
        "ttl_policy": "current_4h",
        "force_refreshed": false
    }
}

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

Consulter l'historique des paies d'un employé par code

Consulter le sommaire de la paie d'une période