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

GET

/api/payroll/summary

Agrège la paie de tous les employés sur une période : salaire brut, retenues, net, charges patronales, coût employeur et heures supplémentaires, avec le détail par département, par fonction, par mois et par période de paie. Choisissez la période avec year et period_number (ou period_from/period_to), ou avec from_date/to_date sur la date de paiement ; sans année ni dates, la requête porte sur l'année comptable courante. Le coût employeur est donné en version comptable (provisions de vacances et CNESST comprises) et décaissée ; view=rh ou all ajoute le détail par code de paie. Conventions communes (cache, force_refresh, _links, metadata) : 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

Sommaire de la paie de la période

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://relay.exostack.cloud//api/payroll/summary?period_number=&period_from=&period_to=&year=&from_date=&to_date=&include_temporary=&include_archived=&view=&force_refresh=' \
--header 'x-api-key: <api-key>'

Response Example

{
    "_links": {
        "self": "/api/payroll/summary?from_date=2026-08-01&to_date=2026-08-31&view=all",
        "voided_payments": "/api/payroll/voided-payments?from_date=2026-08-01&to_date=2026-08-31"
    },
    "by_department": [
        {
            "department": {
                "description": "Chantier",
                "id": 1,
                "number": 1
            },
            "employee_deductions_ccq": 0,
            "employee_deductions_gov": 3712.6,
            "employee_deductions_other": 410.2,
            "employees_count": 11,
            "employer_burden_ccq": 0,
            "employer_burden_standard": 2405.35,
            "expense_refund": 0,
            "gross_pay_paid": 16248.1,
            "overtime_pct": 6.79,
            "pays_count": 11,
            "provisions_in_burden": 571.3,
            "salaries_count": 13,
            "taxable_benefits": 731.5,
            "total_employee_deductions": 4122.8,
            "total_employer_burden_accrued": 2405.35,
            "total_employer_burden_cash": 1834.05,
            "total_employer_cost_accrued": 18653.45,
            "total_employer_cost_cash": 18082.15,
            "total_net_pay": 12125.3,
            "total_overtime": 1104
        },
        {
            "department": {
                "description": "Rénovation",
                "id": 2,
                "number": 2
            },
            "employee_deductions_ccq": 0,
            "employee_deductions_gov": 497.75,
            "employee_deductions_other": 76,
            "employees_count": 3,
            "employer_burden_ccq": 0,
            "employer_burden_standard": 283.8,
            "expense_refund": 0,
            "gross_pay_paid": 2202.5,
            "overtime_pct": 0,
            "pays_count": 3,
            "provisions_in_burden": 71.5,
            "salaries_count": 3,
            "taxable_benefits": 180.9,
            "total_employee_deductions": 573.75,
            "total_employer_burden_accrued": 283.8,
            "total_employer_burden_cash": 212.3,
            "total_employer_cost_accrued": 2486.3,
            "total_employer_cost_cash": 2414.8,
            "total_net_pay": 1628.75,
            "total_overtime": 0
        }
    ],
    "by_function": [
        {
            "employee_deductions_ccq": 0,
            "employee_deductions_gov": 2280.15,
            "employee_deductions_other": 245.1,
            "employees_count": 8,
            "employer_burden_ccq": 0,
            "employer_burden_standard": 1452.6,
            "expense_refund": 0,
            "function": {
                "description": "Charpentier-menuisier",
                "id": 401,
                "reference": 1
            },
            "gross_pay_paid": 9820.4,
            "overtime_pct": 8.8,
            "pays_count": 8,
            "provisions_in_burden": 348.9,
            "salaries_count": 8,
            "taxable_benefits": 402.1,
            "total_employee_deductions": 2525.25,
            "total_employer_burden_accrued": 1452.6,
            "total_employer_burden_cash": 1103.7,
            "total_employer_cost_accrued": 11273,
            "total_employer_cost_cash": 10924.1,
            "total_net_pay": 7295.15,
            "total_overtime": 864
        }
    ],
    "by_period": [
        {
            "employee_deductions_ccq": 0,
            "employee_deductions_gov": 4210.35,
            "employee_deductions_other": 486.2,
            "employees_count": 14,
            "employer_burden_ccq": 0,
            "employer_burden_standard": 2689.15,
            "expense_refund": 0,
            "gross_pay_paid": 18450.6,
            "overtime_pct": 5.98,
            "pays_count": 14,
            "period_number": 32,
            "period_pay_date": "2026-08-06",
            "provisions_in_burden": 642.8,
            "salaries_count": 16,
            "taxable_benefits": 912.4,
            "total_employee_deductions": 4696.55,
            "total_employer_burden_accrued": 2689.15,
            "total_employer_burden_cash": 2046.35,
            "total_employer_cost_accrued": 21139.75,
            "total_employer_cost_cash": 20496.95,
            "total_net_pay": 13754.05,
            "total_overtime": 1104,
            "year": 2026
        }
    ],
    "cache": {
        "age_seconds": 0,
        "cached_at": "2026-10-07T13:18:47-04:00",
        "expires_at": "2026-10-08T13:18:47-04:00",
        "force_refreshed": false,
        "key_hash": "sha1:6b7a3d747eb07e7c2ac62e561e2f50fba545b881",
        "status": "miss",
        "ttl_policy": "historical_24h",
        "ttl_remaining_seconds": 86399
    },
    "filters": {},
    "metadata": {
        "extracted_at": "2026-10-07T13:18:47-04:00",
        "organisation_id": "construction_demo",
        "scope": "include_temporary=False,include_archived=True",
        "sdk_indexes_used": {
            "pay": "Idx 1",
            "payment_pa": "Idx 3",
            "salary": "Idx 1"
        },
        "version": "v3-period"
    },
    "monthly_breakdown": [
        {
            "employee_deductions_ccq": 0,
            "employee_deductions_gov": 4210.35,
            "employee_deductions_other": 486.2,
            "employees_count": 14,
            "employer_burden_ccq": 0,
            "employer_burden_standard": 2689.15,
            "expense_refund": 0,
            "gross_pay_paid": 18450.6,
            "month": "2026-08",
            "month_number": 8,
            "overtime_pct": 5.98,
            "pays_count": 14,
            "provisions_in_burden": 642.8,
            "salaries_count": 16,
            "taxable_benefits": 912.4,
            "total_employee_deductions": 4696.55,
            "total_employer_burden_accrued": 2689.15,
            "total_employer_burden_cash": 2046.35,
            "total_employer_cost_accrued": 21139.75,
            "total_employer_cost_cash": 20496.95,
            "total_net_pay": 13754.05,
            "total_overtime": 1104,
            "year": 2026
        }
    ],
    "period": {
        "from": "2026-08-01",
        "months": 0,
        "to": "2026-08-31"
    },
    "rh_breakdown": {
        "by_line": {
            "contribution": [
                {
                    "amount_type": {
                        "unit": "$/paie",
                        "value": 2
                    },
                    "code": 401,
                    "description": "RRQ",
                    "label": "RRQ ($/paie)",
                    "total": 1098.4
                }
            ],
            "income": [
                {
                    "amount_type": {
                        "unit": "$/heure",
                        "value": 1
                    },
                    "code": 102,
                    "description": "Salaire régulier horaire",
                    "label": "Salaire régulier horaire ($/heure)",
                    "total": 16240.6
                },
                {
                    "amount_type": {
                        "unit": "$/heure",
                        "value": 1
                    },
                    "code": 103,
                    "description": "Temps et demi",
                    "label": "Temps et demi ($/heure)",
                    "total": 1104
                }
            ]
        },
        "by_section": {
            "benefit": 912.4,
            "ccq_contribution": 0,
            "ccq_deduction": 0,
            "contribution": 2689.15,
            "deduction": 486.2,
            "expense": 0,
            "government_deduction": 4210.35,
            "income": 18450.6,
            "report": 0
        }
    },
    "totals": {
        "employee_deductions_ccq": 0,
        "employee_deductions_gov": 4210.35,
        "employee_deductions_other": 486.2,
        "employer_burden_ccq": 0,
        "employer_burden_standard": 2689.15,
        "expense_refund": 0,
        "gross_pay_paid": 18450.6,
        "overtime_pct": 5.98,
        "provisions_in_burden": 642.8,
        "taxable_benefits": 912.4,
        "total_employee_deductions": 4696.55,
        "total_employees": 14,
        "total_employer_burden_accrued": 2689.15,
        "total_employer_burden_cash": 2046.35,
        "total_employer_cost_accrued": 21139.75,
        "total_employer_cost_cash": 20496.95,
        "total_net_pay": 13754.05,
        "total_overtime": 1104,
        "total_payments": 14,
        "total_payments_amount": 13754.05,
        "total_pays": 14,
        "total_salaries": 16
    },
    "view": "all"
}

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

Consulter le journal de vérification de paie

Calculer les retenues à remettre par agence