Skip to content
Navigation

Modifier un document

Remplace le fichier et/ou le nom d’un document envoyé par l’API, en multipart/form-data ; un champ omis ne change pas. Le collaborateur, le type et le foreignErpId restent.

  • L’ancien fichier est supprimé : envoyez chaque avenant signé comme un nouveau document.
  • Refusé (400) pour les documents générés par Puncto ou ajoutés dans l’application, les justificatifs de variables de paie et les fichiers liés à une DPAE.
PUT
https://api.puncto.fr/public/v1/documents/{documentId}

Authentification

  • bearerAuth
    HTTP
    requis

Path parameters

  • documentId
    string
    requis

    Identifiant Puncto du document.

Corps de la requête FORM-DATA requis

  • file
    optionnel
    string

    Nouveau fichier du document, 20 Mo au plus. Extensions acceptées : pdf, jpg, jpeg, png, webp, heic, txt, csv, xml, json, xlsx, doc, docx, zip.

    format: binary
  • displayFileName
    optionnel
    string

    Nouveau nom du document affiché dans Puncto.

    minLength: 1

Retour

200

Document modifié

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

400

Document que l’API n’a pas envoyé
JSON
  • error
    string
    requis

    Message lisible, en français.

  • errorCode
    optionnel
    string

    Code stable, sur certaines erreurs.

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.

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