Skip to content
Navigation

Consulter la période d’essai

Renvoie la période d’essai du contrat (initiale et renouvellement éventuel), sa fin effective et si elle peut être renouvelée, avec la date de fin maximale du renouvellement.

La fin effective est prolongée par les absences validées (recalcul chaque nuit) ou avancée par une validation anticipée. Sans période d’essai (stage, mandat social, période non renseignée), la liste est vide et la raison de l’impossibilité de renouveler est donnée.

GET
https://api.puncto.fr/public/v1/contracts/{contractId}/trial-period

Authentification

  • bearerAuth
    HTTP
    requis

Path parameters

  • contractId
    string
    requis

    Identifiant Puncto du contrat. Pour partir de votre identifiant, retrouvez-le avec GET /public/v1/contracts?collaboratorForeignErpId=….

Retour

200

Période d’essai du contrat

JSON
  • contractId
    string
    requis

    Identifiant Puncto du contrat

  • collaboratorId
    string
    requis

    Identifiant Puncto du collaborateur

  • collaboratorForeignErpId
    string | null
    requis

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

  • workerType
    requis

    Type de contrat, null pour un contrat en cours de création

    One of the following:

    • WorkerType
    • null
  • contractStartDate
    requis

    Date de début du contrat, null pour un contrat en cours de création

    One of the following:

    • string
    • null
  • trialPeriods
    tableau de
    object
    requis

    Périodes d'essai du contrat (initiale puis renouvellement), par date de fin croissante ; vide sans période d'essai

    • id
      string
      requis

      Identifiant Puncto de la période d'essai

    • type
      initial
      ou
      renewal
      requis

      Période initiale ou renouvellement

    • initialEndDate
      string
      requis

      Fin nominale : celle prévue au contrat, ou choisie au renouvellement

      format: date
    • recalculatedEndDate
      requis

      Fin prolongée des absences validées, ou date de la validation anticipée ; null avant le premier recalcul

      One of the following:

      • string
      • null
    • recalculationDate
      requis

      Date du dernier recalcul de la fin

      One of the following:

      • string
      • null
    • validationDate
      requis

      Date de validation anticipée par l'employeur, null tant que la période n'est pas validée.

      One of the following:

      • string
      • null
    • notificationSentAt
      requis

      Date d'envoi du rappel de fin de période d'essai à l'entreprise

      One of the following:

      • string
      • null
    • createdAt
      string
      requis

      Date d'enregistrement de la période dans Puncto

      format: date-time
  • endDate
    requis

    Fin effective de la période d'essai : celle de la dernière période, prolongée des absences ou avancée par une validation anticipée. Null sans période d'essai.

    One of the following:

    • string
    • null
  • validationDate
    requis

    Date de la validation anticipée de la dernière période, null si elle n'a pas été validée

    One of the following:

    • string
    • null
  • isRenewed
    boolean
    requis

    La période d'essai a été renouvelée

  • isOver
    boolean
    requis

    La période d'essai est terminée : endDate est passée (jour calendaire de Paris)

  • renewal
    object
    requis

    Renouvellement de la période d'essai

    • isPossible
      boolean
      requis

      La période d'essai peut être renouvelée maintenant

    • refusalReason
      string | null
      requis

      Raison pour laquelle le renouvellement est impossible, en français ; null s'il est possible

    • maxEndDate
      requis

      Fin nominale la plus tardive du renouvellement, et sa valeur par défaut : même durée que la période initiale, comptée à partir du lendemain de la fin actuelle. Null si le renouvellement est impossible.

      One of the following:

      • string
      • null
    • projectedEndDate
      requis

      Fin du renouvellement à maxEndDate, prolongée des absences validées déjà connues pendant le renouvellement. Null si le renouvellement est impossible.

      One of the following:

      • string
      • null

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

Contrat introuvable dans l’entreprise
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