Skip to content
Navigation

Consulter une variable récurrente

Renvoie une variable récurrente, désignée par son identifiant Puncto ou par son foreignErpId.

GET
https://api.puncto.fr/public/v1/recurring-variables/{recurringVariableId}

Authentification

  • bearerAuth
    HTTP
    requis

Path parameters

  • recurringVariableId
    string
    requis

    Identifiant Puncto de la variable récurrente, ou son foreignErpId avec matchingBy=BY_FOREIGN_ERP_ID.

Query parameters

  • matchingBy
    optionnel
    BY_PUNCTO_ID
    ou
    BY_FOREIGN_ERP_ID

    Ce que désigne {recurringVariableId}.

    • BY_PUNCTO_ID : {recurringVariableId} est l’identifiant Puncto (par défaut)
    • BY_FOREIGN_ERP_ID : {recurringVariableId} est le foreignErpId de la variable récurrente

Retour

200

Variable récurrente

JSON
  • recurringVariableId
    string
    requis

    Identifiant Puncto de la variable récurrente

  • foreignErpId
    string | null
    requis

    Identifiant de la variable récurrente dans votre système, null si elle n'a pas été importée

  • contractId
    string
    requis

    Contrat qui verse 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é

  • data
    requis

    Ce que la variable verse chaque mois

    One of the following:

    • PublicApiRecurringPrimeData
      • type
        string
        requis

        Prime

      • name
        string
        requis

        Libellé imprimé sur le bulletin

      • amount
        number
        requis

        Montant brut mensuel, 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 : HOME_OCCUPATION_ALLOWANCE (indemnité d'occupation du domicile) ou OTHER, seuls types qu'un échéancier verse

      • isAbsenceSensitive
        boolean
        requis

        La prime est proratisée selon les absences du mois

    • PublicApiRecurringInKindBenefitData
      • type
        string
        requis

        Avantage en nature

      • name
        string
        requis

        Libellé imprimé sur le bulletin

      • amount
        number
        requis

        Valeur mensuelle de l'avantage, en euros. Pour un véhicule au forfait, valeur calculée par Puncto pour le premier mois de versement : chaque bulletin la recalcule pour son mois. Pour un véhicule aux dépenses réelles, usage personnel évalué avant abattement et participation

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

        Nature de l'avantage

      • vehicle
        requis

        Véhicule évalué au forfait, null pour les autres avantages

        One of the following:

        • PublicApiVehicleBenefit
        • null
      • actualExpensesVehicle
        requis

        Véhicule évalué aux dépenses réelles, null pour les autres avantages

        One of the following:

        • PublicApiActualExpensesVehicle
        • null
    • PublicApiAnnualPublicTransportData
      • type
        string
        requis

        Indemnité non soumise

      • name
        string
        requis

        Libellé imprimé sur le bulletin

      • amountTotal
        number
        requis

        Prix de l'abonnement sur l'année, en euros

      • amountReimbursed
        number
        requis

        Prise en charge de l'employeur sur l'année, en euros

      • indemnityType
        string
        requis

        Transport public

      • titleType
        requis

        Titre de transport, null si non renseigné

        One of the following:

        • TransportTitleType
        • null
      • periodicity
        string
        requis

        Abonnement annuel

      • startMonth
        string
        requis

        Premier mois réel de l'abonnement, YYYY-MM

  • frequency
    string
    requis

    Périodicité des versements

  • status
    PENDING
    ou
    VALIDATED
    ou
    REJECTED
    requis

    Seule une variable validée (VALIDATED) est versée ; une variable en attente (PENDING) attend un administrateur

  • startYear
    number
    requis

    Année du premier mois de versement

  • startMonth
    number
    requis

    Premier mois de versement, de 1 à 12

  • endYear
    number | null
    requis

    Année du dernier mois de versement, null tant que la variable court sans fin

  • endMonth
    number | null
    requis

    Dernier mois de versement inclus, de 1 à 12, null tant que la variable court sans fin

  • lockedThrough
    requis

    Dernier mois de la période déjà verrouillé (paie clôturée ou bulletin validé), null si aucun ou si la variable n'est pas validée. Une variable verrouillée ne se supprime plus et ne se modifie plus : seul son dernier mois de versement peut encore être fixé, après ce mois

    One of the following:

    • PublicApiYearMonth
      • year
        number
        requis

        Année

      • month
        number
        requis

        Mois, de 1 (janvier) à 12

    • null
  • proofFiles
    tableau de
    object
    requis

    Justificatifs joints dans Puncto

    • 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
  • createdAt
    string
    requis

    Date de création dans Puncto

    format: date-time
  • updatedAt
    string
    requis

    Date de dernière modification dans Puncto

    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 récurrente introuvable dans l’entreprise
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