Skip to content
Navigation

Envoyer un document

Envoie un document (contrat ou avenant signé, convention de stage, DPAE faite hors de Puncto…) en multipart/form-data.

  • Rattaché à un collaborateur, il est visible tout de suite par les administrateurs et dans son espace, sans notification.
  • Un foreignErpId déjà utilisé dans l’entreprise renvoie 409 avec le documentId existant. Pour remplacer un fichier, utilisez PUT /public/v1/documents/{documentId}.

Voir le guide Documents.

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

Authentification

  • bearerAuth
    HTTP
    requis

Corps de la requête FORM-DATA requis

  • file
    string
    requis

    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
  • fileType
    DPAE
    ou
    CONTRACT
    ou
    INTERNSHIP_AGREEMENT
    ou
    OTHER
    requis

    Type de document. Les types DPAE, CONTRACT, INTERNSHIP_AGREEMENT concernent un collaborateur : collaboratorId est alors requis.

    • DPAE : DPAE
    • CONTRACT : Contrat
    • INTERNSHIP_AGREEMENT : Convention de stage
    • OTHER : Autre
  • displayFileName
    optionnel
    string

    Nom affiché dans Puncto. Par défaut, le nom du fichier envoyé.

    minLength: 1
  • collaboratorId
    optionnel
    string

    Identifiant Puncto du collaborateur.

    minLength: 1
  • foreignErpId
    optionnel
    string

    Identifiant du document dans votre système, unique dans l’entreprise.

    maxLength: 255 · minLength: 1

Retour

201

Document créé

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

Collaborateur introuvable dans l’entreprise
JSON
  • error
    string
    requis

    Message lisible, en français.

  • errorCode
    optionnel
    string

    Code stable, sur certaines erreurs.

409

Un document de l’entreprise porte déjà ce foreignErpId
JSON
  • error
    string
    requis

    Message lisible, en français.

  • documentId
    string | null
    requis

    Identifiant Puncto du document qui porte déjà ce foreignErpId.

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