Documentation API – Payroll

Payroll API

Accédez aux données de paie à travers différents systèmes ERP avec une API REST unifiée.
Extrayez les informations de paie des employés.

GET/Entity/Payroll

Aperçu

L’entité Payroll (Paie) représente les données de paie d’un employé dans votre système ERP.
Cette API permet d’effectuer des opérations de lecture (GET) sur les fiches de paie, incluant les en-têtes de période
et les lignes de détail (salaires, avantages, déductions, retenues à la source, contributions employeur).

L’API utilise des endpoints REST standards avec les méthodes HTTP appropriées :

GET /Entity/Payroll – Récupérer une liste de fiches de paie

Matrice de Support

Opérations CRUD supportées pour l’entité Payroll par système ERP :

Système ERP	GET	POST	PUT
Acomba	✗ Non	✗ Non	✗ Non
Avantage	✓ Oui	✗ Non	✗ Non
QuickBooks Online	✗ Non	✗ Non	✗ Non
Sage 50	✗ Non	✗ Non	✗ Non
Servex	✗ Non	✗ Non	✗ Non
Servicentre	✗ Non	✗ Non	✗ Non

GET Payroll

Récupère une liste de fiches de paie avec support de filtrage par date et sélection de champs.

GET/Entity/Payroll

Paramètres de requêtes

Paramètre	Type	Requis	Description
$filter	string	Optionnel	Expression de filtrage de style OData. Supporte les filtres de dates pour limiter la période.
$select	string	Optionnel	Champs à retourner (séparés par des virgules)
$orderby	string	Optionnel	Permet de trier les résultats (ex: `date_Emission desc`)
$top	integer	Optionnel	Nombre maximum de résultats
$skip	integer	Optionnel	Nombre de résultats à ignorer (pagination)

💡 Note pour composer une requête

Pour plus de détails, veuillez consulter cet article : Composer une requête à l’API d’ERP Connector

Get Payroll

GET /Entity/Payroll?$filter=date_Emission ge '2024-01-01' and date_Emission le '2024-12-31'
Host: https://v4.api.onlineerp.solution.quebec/api
Content-Type: application/json

Response (200 OK) – Avantage

[
    {
        "NoUniqueSystemeSource": "1542",
        "int_NoPeriode": 3,
        "date_DebutPeriodPaie": "2024-02-01T00:00:00",
        "date_FinPeriodPaie": "2024-02-15T00:00:00",
        "date_Emission": "2024-02-20T00:00:00",
        "MontantBrut": 3200.00,
        "MontantNet": 2340.75,
        "EmployePaie": {
            "NoUniqueSystemeSource": "0025",
            "NoEmploye": "0025",
            "NomEmploye": "GAGNON",
            "PrenomEmploye": "JULIE",
            "NomCompletEmploye": "JULIE GAGNON",
            "NoAssuranceSocial": "***-***-***",
            "EmailEmploye": "j.gagnon@exemple.com",
            "Departement": "Comptabilité"
        },
        "ListeLignePaie": [
            {
                "NoRubrique": "100",
                "NomRubrique": "Salaire de base",
                "TypeLignePAie": 100,
                "QteOuPourcent": 80.00,
                "MontantUnitaire": 40.00,
                "Valeur": 3200.00
            },
            {
                "NoRubrique": "400",
                "NomRubrique": "RQAP Employeur",
                "TypeLignePAie": 400,
                "Valeur": 24.32
            },
            {
                "NoRubrique": "910",
                "NomRubrique": "Impôt fédéral",
                "TypeLignePAie": 900,
                "Valeur": -425.00
            },
            {
                "NoRubrique": "920",
                "NomRubrique": "Impôt provincial",
                "TypeLignePAie": 900,
                "Valeur": -389.25,
                "ImposableImpotProvincial": true
            }
        ],
        "ListeTransactionBanqueRH": []
    }
]

Modèle de Données Complet

En-tête de Paie (EntetePaie)

Propriété	Type	Description
NoUniqueSystemeSource	string	Identifiant unique du système source ERP
int_NoPeriode	int	Numéro de la période de paie
date_DebutPeriodPaie	DateTime	Date de début de la période de paie
date_FinPeriodPaie	DateTime	Date de fin de la période de paie
date_Emission	DateTime	Date d’émission du chèque de paie
MontantBrut	decimal	Montant brut total de la paie
MontantNet	decimal	Montant net de la paie (après déductions)
EmployePaie	Employe	Objet Employé associé à cette paie
ListeLignePaie	List<LignePaie>	Liste des lignes de détail de la paie
ListeTransactionBanqueRH	List<TransactionBanqueRH>	Liste des transactions de banques RH (vacances, maladie, etc.)
ListeRepartitionProjets	List<RepartitionProjet>	Répartition de la paie par projet

Ligne de Paie (LignePaie)

Propriété	Type	Description
NoRubrique	string	Numéro de la rubrique de paie
NomRubrique	string	Nom/description de la rubrique
TypeLignePAie	TypeLignePaie (enum)	Type de ligne (voir tableau des types ci-dessous)
Valeur	decimal	Montant de la ligne (positif pour gains, négatif pour déductions)
ValeurSommaire	decimal	Valeur cumulative depuis le début de l’année
QteOuPourcent	decimal	Quantité (heures) ou pourcentage selon le type de rubrique
MontantUnitaire	decimal	Taux horaire ou montant unitaire
Departement	Departement	Département associé à cette ligne
Fonction	Fonction	Fonction de l’employé associée à cette ligne
ImposableImpotProvincial	bool	Indique si la ligne est imposable au provincial

Types de Ligne de Paie (TypeLignePaie)

Code	Nom	Description
100	SALAIRES	Salaires réguliers, temps supplémentaire, primes
200	REMBOURSEMENT_DEPENSES	Remboursement de dépenses (kilométrage, repas, etc.)
300	AVANTAGES_IMPOSABLES	Avantages imposables (voiture, logement, etc.)
400	CONTRIBUTIONS_EMPLOYEUR	Contributions de l’employeur (RQAP, RRQ, AE, etc.)
700	DEDUCTIONS_EMPLOYE	Déductions volontaires (assurance, REER, cotisations syndicales)
900	RETENUES_SOURCE	Retenues à la source (impôts fédéral et provincial, RRQ, AE, RQAP)
1000	AUTRES	Autres types de lignes
1100	BANQUES_TEMPS	Banques de temps (vacances accumulées, congés)

Transaction Banque RH (TransactionBanqueRH)

Propriété	Type	Description
NoBanque	string	Numéro de la banque RH
NomBanque	string	Nom de la banque (Vacances, Maladie, etc.)
NoPeriode	int	Numéro de période associé
TypeTransaction	TypeTransactionBanqueRH	Type de transaction (Entrée ou Sortie)
Valeur	decimal	Valeur de la transaction (heures ou montant)
ValeurCumul	decimal	Solde cumulatif de la banque
Fonction	Fonction	Fonction associée à la banque RH

Employé (Employe) – Propriétés principales

Propriété	Type	Description
NoUniqueSystemeSource	string	Identifiant unique du système source
NoEmploye	string	Numéro de l’employé
NomEmploye	string	Nom de famille de l’employé
PrenomEmploye	string	Prénom de l’employé
NomCompletEmploye	string (readonly)	Nom complet formaté (Prénom + Nom)
NoAssuranceSocial	string	Numéro d’assurance sociale (masqué)
EmailEmploye	string	Adresse courriel de l’employé
Departement	string	Département de l’employé

Département

Propriété	Type	Description
NoUniqueSystemeSource	string	Identifiant unique du système source
NoDepartement	string	Numéro du département
NomDepartement	string	Nom du département

Fonction

Propriété	Type	Description
NoUniqueSystemeSource	string	Identifiant unique du système source
NoFonction	string	Numéro de la fonction
NomFonction	string	Nom de la fonction (ex: Technicien, Consultant)