Skip to content
Navigation

Consulter une variable de paie

Renvoie une variable de paie, désignée par son identifiant Puncto ou par son foreignErpId.

GET
https://api.puncto.fr/public/v1/payroll-variables/{payrollVariableId}

Authentification

  • bearerAuth
    HTTP
    requis

Path parameters

  • payrollVariableId
    string
    requis

    Identifiant Puncto de la variable de paie, ou son foreignErpId avec matchingBy=BY_FOREIGN_ERP_ID.

Query parameters

  • matchingBy
    optionnel
    BY_PUNCTO_ID
    ou
    BY_FOREIGN_ERP_ID

    Façon de lire payrollVariableId.

    default: "BY_PUNCTO_ID"

Retour

200

Variable de paie

JSON
  • payrollVariableId
    string
    requis

    Identifiant Puncto de la variable de paie

  • foreignErpId
    string | null
    requis

    Identifiant de la variable dans votre système, null si elle n'en a pas

  • contractId
    string
    requis

    Contrat qui porte la variable

  • collaboratorId
    string
    requis

    Collaborateur titulaire du contrat

  • collaboratorForeignErpId
    string | null
    requis

    Identifiant du collaborateur dans votre système, null s'il n'a pas été renseigné

  • year
    number
    requis

    Année du mois de paie

  • month
    number
    requis

    Mois de paie, de 1 (janvier) à 12

  • status
    PENDING
    ou
    VALIDATED
    ou
    REJECTED
    requis

    Seules les variables VALIDATED entrent dans le bulletin

  • data
    requis

    Contenu de la variable

    One of the following:

    • PublicApiPayrollVariablePrimeData
      • type
        string
        requis

        Prime

      • name
        string
        requis

        Libellé imprimé sur le bulletin

      • amount
        number
        requis

        Montant brut, en euros

      • primeType
        HOLIDAY_BONUS
        ou
        END_OF_CONTRACT_BONUS
        ou
        LEGAL_DISMISSAL_BONUS
        ou
        SYNTEC_DISMISSAL_BONUS
        ou
        PPV
        ou
        JNT_COMPENSATION_BONUS
        +14 de plus
        requis

        Type de prime, qui détermine sa déclaration en DSN

      • isAbsenceSensitive
        boolean
        requis

        La prime est proratisée en fonction des absences du mois

      • base
        optionnel
        number

        Base imprimée sur le bulletin, quand la prime en a une (jours d'une indemnité de fin de contrat, par exemple)

      • attachmentPeriod
        optionnel
        object

        Période de rattachement DSN, quand elle ne se déduit pas du mois de paie (régularisation du dixième des congés payés)

        • startDate
          string
          requis

          Premier jour de la période

          format: date
        • endDate
          string
          requis

          Dernier jour de la période

          format: date
    • PublicApiPayrollVariableSalaryDeductionData
      • type
        string
        requis

        Retenue sur salaire

      • name
        string
        requis

        Libellé imprimé sur le bulletin

      • amount
        number
        requis

        Montant retenu, en euros

      • deductionType
        LAST_MONTH_NEGATIVE_PAY_ADVANCE
        ou
        NET_REDUCTION
        ou
        BRUT_REDUCTION
        requis

        Nature de la retenue : sur le net, sur le brut, ou avance de salaire négative du mois précédent

    • PublicApiPayrollVariableInKindBenefitData
      • type
        string
        requis

        Avantage en nature

      • name
        string
        requis

        Libellé imprimé sur le bulletin

      • amount
        number
        requis

        Valeur de l'avantage, en euros

      • benefitType
        MEALS
        ou
        HOUSING
        ou
        VEHICLE
        ou
        NTIC
        ou
        OTHER
        requis

        Nature de l'avantage

      • actualExpensesVehicle
        optionnel
        object

        Véhicule évalué aux dépenses réelles : amount est alors l'usage personnel évalué, avant abattement et participation

        • isElectric
          boolean
          requis

          Véhicule électrique

        • employeeMonthlyContribution
          number
          requis

          Participation mensuelle du salarié, en euros, déduite de l'avantage après l'abattement

        • contributionWithheldFromPay
          boolean
          requis

          La participation du salarié est retenue sur son net à payer

        • retainedDuringLeave
          boolean
          requis

          L'avantage est conservé pendant les congés

        • assignedOn
          optionnel
          string

          Date de mise à disposition (AAAA-MM-JJ), requise pour un véhicule électrique

        • isEcoScoreEligible
          optionnel
          boolean

          Éco-score requis pour l'abattement des véhicules électriques mis à disposition depuis le 1er février 2025

    • PublicApiPayrollVariableOvertimeData
      • type
        string
        requis

        Heures supplémentaires

      • name
        string
        requis

        Libellé imprimé sur le bulletin

      • hours
        number
        requis

        Nombre d'heures supplémentaires

      • overtimeDate
        string
        requis

        Jour où les heures ont été effectuées : il détermine leur semaine, donc leur taux de majoration

        format: date
    • PublicApiPayrollVariableMonthlyOvertimeData
      • type
        string
        requis

        Heures supplémentaires

      • name
        string
        requis

        Libellé imprimé sur le bulletin

      • hours
        number
        requis

        Nombre d'heures supplémentaires

      • majorationRate
        25
        ou
        50
        ou
        100
        requis

        Taux de majoration, en % : 25, 50 ou 100 (dimanche, jour férié, nuit)

    • PublicApiPayrollVariableRemoteWorkDayData
      • type
        string
        requis

        Jours de télétravail

      • name
        string
        requis

        Libellé fixe

      • days
        number
        requis

        Nombre de jours, par demi-journée, négatif pour retirer des jours au décompte automatique

    • PublicApiPayrollVariableMealAllowanceAdjustmentData
      • type
        string
        requis

        Ajustement des primes de panier

      • name
        string
        requis

        Libellé fixe

      • mealAllowanceType
        ON_SITE
        ou
        OFF_SITE
        ou
        TRAVEL_RESTAURANT
        requis

        Situation du repas, qui fixe la limite d'exonération par repas

      • count
        number
        requis

        Nombre de repas, négatif pour en retirer

      • label
        optionnel
        string

        Libellé de la ligne du bulletin (60 caractères au plus), « Régularisation prime de panier » par défaut

    • PublicApiPayrollVariableMealVoucherAdjustmentData
      • type
        string
        requis

        Ajustement des titres restaurant

      • name
        string
        requis

        Libellé fixe

      • count
        number
        requis

        Nombre de titres, négatif pour en retirer

      • label
        optionnel
        string

        Libellé de la ligne du bulletin (60 caractères au plus), « Régularisation titres restaurant » par défaut

    • PublicApiPayrollVariableSalaryAdvanceData
      • type
        string
        requis

        Acompte sur salaire

      • name
        string
        requis

        Libellé fixe

      • amount
        number
        requis

        Montant versé, en euros

      • paymentDate
        string
        requis

        Date de versement de l'acompte, dans le mois de paie

        format: date
    • PublicApiPayrollVariableProfitSharingData
      • type
        string
        requis

        Intéressement

      • name
        string
        requis

        Libellé imprimé sur le bulletin

      • amount
        number
        requis

        Montant attribué, en euros

      • paidAmount
        number
        requis

        Part versée sur la paie, en euros

      • peeAmount
        number
        requis

        Part placée sur le plan d'épargne entreprise (PEE), en euros

      • perAmount
        number
        requis

        Part placée sur le plan d'épargne retraite (PER), en euros

    • PublicApiPayrollVariableHolidayVoucherData
      • type
        string
        requis

        Chèques-vacances

      • name
        string
        requis

        Libellé imprimé sur le bulletin

      • voucherValue
        number
        requis

        Valeur des titres remis, en euros

      • employerAmount
        number
        requis

        Participation de l'employeur, en euros

      • employeeAmount
        number
        requis

        Part payée par le salarié, en euros

      • exemptAmount
        number
        requis

        Part de la participation employeur exonérée de cotisations sociales, en euros

      • taxableExemptAmount
        number
        requis

        Part de exemptAmount au-delà de l'exonération annuelle d'impôt sur le revenu, en euros

      • subjectAmount
        number
        requis

        Part de la participation employeur soumise à cotisations sociales, en euros

      • taxExemptSubjectAmount
        number
        requis

        Part de subjectAmount sous l'exonération annuelle d'impôt sur le revenu, en euros

    • PublicApiPayrollVariablePrevoyanceIjData
      • type
        string
        requis

        IJ de prévoyance

      • name
        string
        requis

        Libellé

      • startDate
        string
        requis

        Premier jour indemnisé du mois

        format: date
      • endDate
        string
        requis

        Dernier jour indemnisé du mois

        format: date
      • grossAmount
        number
        requis

        IJ brute de ces jours, en euros

      • employerRate
        number
        requis

        Part de l'IJ financée par l'employeur, en % : elle est soumise à cotisations comme du salaire

    • PublicApiPayrollVariableOnCallData
      • type
        string
        requis

        Astreinte

      • name
        string
        requis

        Libellé du type d'astreinte à la saisie

      • onCallTypeId
        string
        requis

        Type d'astreinte de l'entreprise

      • start
        string
        requis

        Début, heure légale française YYYY-MM-DDTHH:mm

      • end
        string
        requis

        Fin, heure légale française YYYY-MM-DDTHH:mm

      • units
        number
        requis

        Nombre d'unités indemnisées : heures de la période (unité HOUR) ou nombre de périodes (unité PERIOD)

      • compensation
        object
        requis

        Contrepartie de l'astreinte

        • mode
          string
          requis

          Montant fixe par unité

        • unit
          PERIOD
          ou
          HOUR
          requis

          Unité indemnisée : la période entière ou l'heure

        • amount
          number
          requis

          Montant brut par unité, en euros

      • interventions
        tableau de
        object
        requis

        Interventions pendant la période

        • start
          string
          requis

          Début, heure légale française YYYY-MM-DDTHH:mm, temps de déplacement compris

        • end
          string
          requis

          Fin, heure légale française YYYY-MM-DDTHH:mm

        • location
          REMOTE
          ou
          ON_SITE
          requis

          Intervention à distance ou sur site

        • dayCount
          optionnel
          NONE
          ou
          HALF_DAY
          ou
          FULL_DAY

          Décompte au forfait jours, absent pour un contrat en heures où l'intervention est payée en heures supplémentaires

        • compensationMode
          optionnel
          PAYMENT
          ou
          REST

          Contrat en heures : REST quand l'intervention est compensée en repos (compteur RCR, majoration comprise) au lieu d'être payée

    • PublicApiPayrollVariableExpenseNoteData
      • type
        string
        requis

        Indemnité non soumise à cotisations

      • name
        string
        requis

        Libellé imprimé sur le bulletin

      • amountTotal
        number
        requis

        Montant TTC de la dépense, en euros

      • amountReimbursed
        number
        requis

        Montant remboursé au salarié, en euros

      • indemnityType
        string
        requis

        Note de frais

      • expenseDate
        string
        requis

        Date de la dépense

        format: date
      • expenseType
        HOTEL_LOGEMENT
        ou
        MEALS
        ou
        KILOMETRIC_INDEMNITIES
        ou
        TRANSPORT
        ou
        EQUIPMENT
        ou
        SERVICES
        +1 de plus
        requis

        Nature de la dépense

      • vatAmounts
        object
        requis

        Montants de TVA de la dépense

        • vatAmount2_1
          number
          requis

          TVA à 2,1 %

        • vatAmount5_5
          number
          requis

          TVA à 5,5 %

        • vatAmount10
          number
          requis

          TVA à 10 %

        • vatAmount20
          number
          requis

          TVA à 20 %

      • kilometric
        optionnel
        object

        Trajet des indemnités kilométriques

        • vehicleCategory
          CAR
          ou
          MOTORCYCLE
          ou
          SCOOTER
          requis

          Catégorie du véhicule

        • energyType
          THERMIC_HYDROGEN_HYBRID
          ou
          ELECTRIC
          requis

          Énergie du véhicule

        • fiscalPower
          number | null
          requis

          Puissance fiscale du véhicule, en chevaux fiscaux

        • departureAddress
          string
          requis

          Adresse de départ

        • arrivalAddress
          string
          requis

          Adresse d'arrivée

        • distance
          number
          requis

          Distance du trajet, en kilomètres

        • isRoundTrip
          boolean
          requis

          Aller-retour : la distance compte deux fois

    • PublicApiPayrollVariablePersonalTransportData
      • type
        string
        requis

        Indemnité non soumise à cotisations

      • name
        string
        requis

        Libellé imprimé sur le bulletin

      • amountTotal
        number
        requis

        Montant total des frais, en euros

      • amountReimbursed
        number
        requis

        Montant pris en charge par l'employeur, en euros

      • indemnityType
        string
        requis

        Transport personnel

      • personalTransportType
        FORFAIT_MOBILITES_DURABLES
        ou
        PRIME_TRANSPORT
        requis

        Forfait mobilités durables ou prime de transport

      • primeTransportType
        optionnel
        FUEL
        ou
        ELECTRIC_VEHICLE_CHARGING

        Nature de la prime de transport, présente quand personalTransportType vaut PRIME_TRANSPORT

      • fmdTransportType
        optionnel
        PERSONAL_BIKE
        ou
        CARPOOLING
        ou
        RENTED_OR_SHARED_VEHICLES
        ou
        LOW_EMISSION_CAR_SHARING
        ou
        MOTORIZED_PERSONAL_TRANSPORT_DEVICES
        ou
        PUBLIC_TRANSPORT_WITHOUT_SUBSCRIPTION

        Mode de transport du forfait, présent quand personalTransportType vaut FORFAIT_MOBILITES_DURABLES

    • PublicApiPayrollVariableOtherTaxFreeIndemnityData
      • type
        string
        requis

        Indemnité non soumise à cotisations

      • name
        string
        requis

        Libellé imprimé sur le bulletin

      • amountTotal
        number
        requis

        Montant total des frais, en euros

      • amountReimbursed
        number
        requis

        Montant pris en charge par l'employeur, en euros

      • indemnityType
        PUBLIC_TRANSPORT
        ou
        PERSONAL_TRANSPORT
        ou
        SPORT_SUBSCRIPTION
        ou
        OTHER
        requis

        Nature de l'indemnité

      • titleType
        optionnel
        NAVIGO
        ou
        IMAGINE_R
        ou
        VELIB
        ou
        TER_SNCF
        ou
        OTHER

        Titre de transport public, qui fixe le taux de prise en charge de l'employeur

      • periodicity
        optionnel
        MONTHLY
        ou
        ANNUAL

        Mensuelle sur une variable de paie : un abonnement annuel est une variable récurrente

      • startMonth
        optionnel
        string

        Premier mois d'un abonnement annuel, YYYY-MM

  • proofFiles
    tableau de
    object
    requis

    Justificatifs, dans leur ordre d'ajout

    • documentId
      string
      requis

      Identifiant Puncto du document

    • displayFileName
      string
      requis

      Nom du document affiché dans Puncto

    • fileType
      PAYSLIP
      ou
      PAYSLIP_ARCHIVED
      ou
      DSN_MONTHLY
      ou
      DSN_WORK_STOPPAGE
      ou
      DSN_WORK_STOPPAGE_RESUMPTION
      ou
      DSN_FCTU
      +40 de plus
      requis

      Type de document

    • mimeType
      requis

      Type MIME du fichier

      One of the following:

      • ImageMimeType
      • OtherMimeType
    • createdAt
      string
      requis

      Date d'enregistrement du document dans Puncto

      format: date-time
  • businessMealParticipantContractIds
    tableau de
    string
    requis

    Note de frais de repas d'affaires : contrats des participants, dont les titres restaurant du mois sont réduits dès l'enregistrement de la note, quel que soit son statut

  • origin
    ENTRY
    ou
    VARIABLE_BATCH
    ou
    TIMESHEET
    ou
    ON_CALL_PERIOD
    ou
    PROFIT_SHARING
    ou
    HOLIDAY_BONUS
    +3 de plus
    requis

    Parcours de Puncto qui a créé la variable :

    • ENTRY : saisie dans Puncto ou importée par l'API ; aussi les indemnités générées par la clôture d'un contrat (celles du mois du solde de tout compte se modifient depuis la clôture) et le report d'un net négatif, généré à la clôture du mois sur le mois suivant (retenue LAST_MONTH_NEGATIVE_PAY_ADVANCE) ;
    • VARIABLE_BATCH : import d'un fichier de variables dans Puncto, modifiable comme une saisie ;
    • TIMESHEET : heures supplémentaires payées d'une feuille de temps validée, modifiables seulement depuis la feuille ;
    • ON_CALL_PERIOD : période d'astreinte, modifiable par l'import des périodes d'astreinte ;
    • PROFIT_SHARING : versement d'intéressement, modifiable seulement depuis ce versement ;
    • HOLIDAY_BONUS, HOLIDAY_VOUCHER_ATTRIBUTION : prime de vacances ou chèques-vacances de la page Primes, modifiables seulement depuis cette page ;
    • VALUE_SHARING_BONUS : versement de prime de partage de la valeur (PPV) de la page Primes ; comme dans l'application, la variable peut changer de statut ou être supprimée ;
    • PREVOYANCE_IJ_SLIP : part d'un bordereau de paiement prévoyance, modifiable seulement depuis ce bordereau.
  • isLocked
    boolean
    requis

    Plus aucune modification n'est possible : le mois de paie est clôturé et aucune paie ouverte ne peut porter la régularisation (lockState.state vaut BLOCKED)

  • lockState
    requis

    Effet d'une modification de la variable : sur la paie du mois, ou en saisie tardive régularisée par une paie ultérieure

    One of the following:

    • object
    • object
    • object
  • createdAt
    string
    requis

    Date de création de la variable

    format: date-time
  • updatedAt
    string
    requis

    Date de dernière modification de la variable

    format: date-time

401

Clé d’API absente, invalide ou révoquée
JSON
  • error
    string
    requis

    Message lisible, en français.

  • errorCode
    optionnel
    string

    Code stable, sur certaines erreurs.

403

Opération hors de l’accès de la clé d’API
JSON
  • error
    string
    requis

    Message lisible, en français.

  • errorCode
    optionnel
    string

    Code stable, sur certaines erreurs.

404

Variable de paie introuvable dans l’entreprise. Si l’identifiant désigne une variable récurrente, le message donne son identifiant Puncto et la route à utiliser.
JSON
  • error
    string
    requis

    Message lisible, en français.

  • errorCode
    optionnel
    string

    Code stable, sur certaines erreurs.

422

Paramètres invalides
JSON
  • errors
    tableau de
    object
    requis
    • message
      string
      requis
    • rule
      string
      requis

      Règle de validation en échec.

    • field
      string
      requis

      Chemin du champ, par exemple absences.0.type.

Type to search…

↑↓ navigate↵ selectEsc close