Skip to content
Navigation

Consulter un document

Renvoie les informations d’un document de la liste, ou d’un justificatif référencé par une absence ou une variable de paie. Téléchargez son fichier avec GET /public/v1/documents/{documentId}/download.

GET
https://api.puncto.fr/public/v1/documents/{documentId}

Authentification

  • bearerAuth
    HTTP
    requis

Path parameters

  • documentId
    string
    requis

    Identifiant Puncto du document.

Retour

200

Document

JSON
  • 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

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

Document introuvable dans l’entreprise ou non exposé par l’API
JSON
  • error
    string
    requis

    Message lisible, en français.

  • errorCode
    optionnel
    string

    Code stable, sur certaines erreurs.

Type to search…

↑↓ navigate↵ selectEsc close