Skip to content
Navigation

Lister les mois de paie

Liste les mois de paie de chaque établissement, du plus récent au plus ancien, avec l’état de leur DSN mensuelle. Seuls les mois ouverts dans Puncto sont listés, pas ceux repris de votre ancien logiciel de paie.

Un mois rouvert crée une nouvelle révision : l’ancienne passe à SUPERSEDED et supersededById désigne la nouvelle.

GET
https://api.puncto.fr/public/v1/payroll-months

Authentification

  • bearerAuth
    HTTP
    requis

Query parameters

  • page
    optionnel
    integer

    Numéro de page, à partir de 1.

    minimum: 1 · default: 1
  • perPage
    optionnel
    integer

    Nombre d’éléments par page, 200 au plus.

    maximum: 200 · minimum: 1 · default: 50
  • year
    optionnel
    integer

    Année du mois de paie.

    maximum: 2100 · minimum: 2000
  • month
    optionnel
    integer

    Mois de paie, de 1 (janvier) à 12.

    maximum: 12 · minimum: 1
  • establishmentId
    optionnel
    string

    Identifiant Puncto de l’établissement.

  • status[]
    optionnel
    tableau de
    string

    Statuts à garder. Répétez le paramètre pour en passer plusieurs.

Retour

200

Page de mois de paie

JSON
  • data
    tableau de
    object
    requis
    • payrollMonthId
      string
      requis

      Identifiant Puncto du mois de paie

    • establishmentId
      string
      requis

      Établissement du mois de paie

    • year
      number
      requis

      Année

    • month
      number
      requis

      Mois (1-12)

    • status
      STARTED
      ou
      CLOSED
      ou
      SUPERSEDED
      requis

      STARTED : en cours ; CLOSED : clôturé, bulletins validés ; SUPERSEDED : révision remplacée après une réouverture

    • revision
      number
      requis

      Numéro de révision : 1, puis augmenté de 1 à chaque réouverture du mois

    • closedAt
      requis

      Date de clôture, null tant que le mois n'est pas clôturé

      One of the following:

      • string
      • null
    • reopenedAt
      requis

      Révision ouverte par une réouverture : date de la réouverture, null sinon

      One of the following:

      • string
      • null
    • reopenReason
      string | null
      requis

      Révision ouverte par une réouverture : motif saisi, null sinon

    • supersededById
      requis

      Révision remplacée (SUPERSEDED) : identifiant de la révision qui la remplace, null sinon

      One of the following:

      • string
      • null
    • dsn
      requis

      DSN mensuelle de la révision, null tant qu'elle n'est pas lancée

      One of the following:

      • PublicApiPayrollMonthDsn
        • declarationTrackingId
          string
          requis

          Identifiant Puncto du suivi, celui de GET /public/v1/declaration-trackings?source=dsn

        • status
          queued
          ou
          dsn-file-error
          ou
          dsn-file-created
          ou
          dsnval-pending
          ou
          dsnval-error
          ou
          dsnval-ok
          +3 de plus
          requis

          Étape du dépôt de la déclaration

        • simplifiedStatus
          in-progress
          ou
          sent
          ou
          confirmed
          ou
          error
          requis

          Statut simplifié : en cours, transmise, confirmée ou en erreur

        • crmStatus
          ok
          ou
          error
          ou
          handled
          ou
          null
          requis

          Synthèse des comptes rendus des organismes (CRM) : ok, error (anomalie à traiter), handled (anomalies traitées), null sans retour

        • idFlux
          string | null
          requis

          Identifiant du dépôt attribué par net-entreprises, null avant le dépôt

        • documentId
          requis

          Fichier de la déclaration, téléchargeable avec GET /public/v1/documents/{documentId}/download, null tant qu'il n'est pas généré

          One of the following:

          • string
          • null
        • createdAt
          string
          requis

          Date de création du suivi

          format: date-time
        • updatedAt
          string
          requis

          Date de dernière mise à jour du suivi

          format: date-time
      • null
    • createdAt
      string
      requis

      Date de création du mois de paie

      format: date-time
    • updatedAt
      string
      requis

      Date de dernière modification du mois de paie

      format: date-time
  • meta
    object
    requis
    • total
      integer
      requis

      Nombre total d’éléments.

    • page
      integer
      requis

      Page renvoyée.

    • perPage
      integer
      requis
    • currentPage
      integer
      requis
    • firstPage
      integer
      requis
    • lastPage
      integer
      requis

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.

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