Skip to content
Navigation

Lister les documents

Liste paginée des documents de l’entreprise, du plus récent au plus ancien : documents envoyés par l’API ou dans Puncto (contrats signés, conventions de stage…) et documents générés par Puncto (bulletins, DPAE, DSN, documents de fin de contrat, documents comptables…). Téléchargez un fichier avec GET /public/v1/documents/{documentId}/download.

Les fichiers techniques (retours DPAE, CRM), les factures Puncto et les archives d’export ne sont pas exposés. Un filtre collaborateur exclut les documents sans collaborateur.

GET
https://api.puncto.fr/public/v1/documents

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
  • type[]
    optionnel
    tableau de
    string

    Types de document à garder. Répétez le paramètre pour en passer plusieurs.

  • collaboratorId
    optionnel
    string

    Identifiant Puncto du collaborateur. Ne pas combiner avec collaboratorForeignErpId.

  • collaboratorForeignErpId
    optionnel
    string

    Identifiant du collaborateur dans votre système (foreignErpId). Ne pas combiner avec collaboratorId.

  • minCreationDate
    optionnel
    string

    Documents enregistrés à partir de cette date (ISO 8601).

    format: date-time
  • maxCreationDate
    optionnel
    string

    Documents enregistrés jusqu’à cette date (ISO 8601).

    format: date-time
  • foreignErpId
    optionnel
    string

    Identifiant du document dans votre système, renseigné à son envoi.

Retour

200

Page de documents

JSON
  • data
    tableau de
    object
    requis
    • documentId
      string
      requis

      Identifiant Puncto du document

    • foreignErpId
      string | null
      requis

      Identifiant du document dans votre système, renseigné à l'envoi par l'API ; null sinon

    • displayFileName
      string
      requis

      Nom du document affiché dans Puncto

    • fileName
      string
      requis

      Nom du fichier téléchargé, extension comprise : le nom du document, suivi de l'extension du fichier s'il ne se termine pas déjà par une extension

    • 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, application/octet-stream pour un format que Puncto ne connaît pas (docx, xlsx...)

      One of the following:

      • ImageMimeType
      • OtherMimeType
    • collaboratorId
      requis

      Collaborateur concerné, null pour un document de l'entreprise

      One of the following:

      • string
      • null
    • collaboratorForeignErpId
      string | null
      requis

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

    • createdAt
      string
      requis

      Date d'enregistrement du document dans Puncto

      format: date-time
    • updatedAt
      string
      requis

      Date de la dernière modification, par exemple le remplacement du fichier par un nouvel envoi

      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.

404

Collaborateur du filtre introuvable
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