Skip to content
Navigation

Modifier un collaborateur

Modifie un collaborateur : identité, coordonnées, enfants à charge, numéro de sécurité sociale, mode de paiement, foreignErpId, manager. Tout ou rien ; les champs absents ne changent pas. PATCH est aussi accepté.

PUT
https://api.puncto.fr/public/v1/collaborators/{collaboratorId}

Authentification

  • bearerAuth
    HTTP
    requis

Path parameters

  • collaboratorId
    string
    requis

    Identifiant Puncto du collaborateur.

Corps de la requête JSON requis

  • identity
    optionnel
    object
    • firstName
      optionnel
      string
      maxLength: 100
    • usageFirstName
      optionnel
      string | null

      Prénom d’usage. null le retire.

      maxLength: 100
    • lastName
      optionnel
      string
      maxLength: 100
    • usageLastName
      optionnel
      string | null

      Nom d’usage. null le retire.

      maxLength: 100
    • birthDate
      optionnel
      string

      Date de naissance.

      format: date
    • birthCountryCode
      optionnel
      FR
      ou
      GP
      ou
      BL
      ou
      MF
      ou
      MQ
      ou
      GF
      +199 de plus

      Pays de naissance.

    • birthCity
      optionnel
      string
      maxLength: 100
    • birthDepartmentCode
      optionnel
      string

      Département de naissance, obligatoire avec birthCountryCode à FR.

      maxLength: 3
    • nationality
      optionnel
      FR
      ou
      GP
      ou
      BL
      ou
      MF
      ou
      MQ
      ou
      GF
      +199 de plus
  • contact
    optionnel
    object

    contact.personalEmail (identifiant de connexion) ne se modifie pas par l’API : 400.

    • address
      optionnel
      string

      Adresse postale : lettres, chiffres, espace, apostrophe, tiret et point seulement (norme DSN).

      maxLength: 250
    • addressDetails
      optionnel
      string | null

      Complément d’adresse. null le retire.

      maxLength: 250
    • postalCode
      optionnel
      string
      maxLength: 10
    • city
      optionnel
      string
      maxLength: 100
    • countryCode
      optionnel
      FR
      ou
      GP
      ou
      BL
      ou
      MF
      ou
      MQ
      ou
      GF
      +199 de plus
    • professionalEmail
      optionnel
      string
      format: email · maxLength: 250 · minLength: 3
    • phoneNumber
      optionnel
      string | null

      null le retire.

      maxLength: 15 · minLength: 8
  • dependentChildrenCount
    optionnel
    integer
    maximum: 9 · minimum: 0
  • disabledDependentChildrenCount
    optionnel
    integer

    Parmi dependentChildrenCount, les enfants à charge handicapés.

    maximum: 9 · minimum: 0
  • maritalStatus
    optionnel
    SINGLE
    ou
    MARRIED
    ou
    CIVIL_PARTNERSHIP
    ou
    COHABITING
    ou
    SEPARATED
    ou
    DIVORCED
    +2 de plus

    Situation matrimoniale. null la retire.

    • SINGLE : Célibataire
    • MARRIED : Marié(e)
    • CIVIL_PARTNERSHIP : Pacsé(e)
    • COHABITING : En concubinage
    • SEPARATED : Séparé(e)
    • DIVORCED : Divorcé(e)
    • WIDOWED : Veuf ou veuve
  • socialSecurityNumber
    optionnel
    string

    NIR ou NIA, avec ou sans clé ni espaces, avec identityType. S’applique à partir du prochain mois de paie ouvert.

  • identityType
    optionnel
    NIR
    ou
    NIA

    Nature de socialSecurityNumber, à envoyer avec lui.

  • paymentOptionType
    optionnel
    virement
    ou
    check
    ou
    cash

    Mode de paiement du salaire. virement demande iban et bic.

  • iban
    optionnel
    string

    IBAN du compte de paiement, avec bic. Sans paymentOptionType, le mode passe à virement.

  • bic
    optionnel
    string
  • foreignErpId
    optionnel
    string | null

    Identifiant du collaborateur dans votre système, unique dans l’entreprise. null le retire.

    maxLength: 100 · minLength: 1
  • managerId
    optionnel
    string | null

    Identifiant Puncto du manager (autre collaborateur de l’entreprise). null retire le manager.

    minLength: 1

Retour

200

Collaborateur modifié

JSON
  • collaboratorId
    string
    requis

    Identifiant Puncto

  • companyId
    string
    requis

    Identifiant Puncto

  • establishmentId
    requis

    Établissement du contrat courant — null pour un collaborateur sans contrat

    One of the following:

    • string
    • null
  • firstName
    string
    requis
  • lastName
    string
    requis
  • usageFirstName
    string | null
    requis
  • usageLastName
    string | null
    requis
  • email
    string | null
    requis
  • phoneNumber
    string | null
    requis
  • birthDate
    string
    requis
    format: date
  • birthCity
    string
    requis
  • birthDepartmentCode
    string
    requis

    Pour les salariés nés dans les TOM : code 98

    Pour les personnes nées à l'étranger : code 99

  • birthCountryCode
    FR
    ou
    GP
    ou
    BL
    ou
    MF
    ou
    MQ
    ou
    GF
    +199 de plus
    requis
  • nationality
    FR
    ou
    GP
    ou
    BL
    ou
    MF
    ou
    MQ
    ou
    GF
    +199 de plus
    requis
  • originUeCodification
    01
    ou
    02
    ou
    03
    ou
    04
    requis
  • identity
    requis

    Identité sociale en vigueur (NIR, NIA ou NTT). Pour un collaborateur dont l'embauche n'a pas encore commencé, sa première identité, qui prend effet le 1er du mois de son entrée.

    One of the following:

    • ApiCollaboratorIdentity
      • type
        NTT
        ou
        NIA
        ou
        NIR
        requis
      • numero
        string
        requis
      • startDate
        string
        requis
        format: date
    • null
  • socialSecurityNumber
    string | null
    requis

    NIR ou NIA

  • ntt
    string | null
    requis

    NTT = NIR temporaire en l'absence de NIA

  • sex
    FEMALE
    ou
    MALE
    ou
    null
    requis

    Sexe, déduit du premier chiffre du NIR, du NIA ou du NTT (impair : homme, pair : femme). Null quand il ne peut pas en être déduit.

  • address
    object
    requis
    • id
      string
      requis

      Identifiant Puncto

    • address
      string
      requis
    • postalCode
      string
      requis
    • city
      string
      requis
    • addressDetails
      string | null
      requis
    • countryCode
      FR
      ou
      GP
      ou
      BL
      ou
      MF
      ou
      MQ
      ou
      GF
      +199 de plus
      requis
  • dependentChildrenCount
    number
    requis

    Situation familiale

  • disabledDependentChildrenCount
    number
    requis

    Parmi dependentChildrenCount, les enfants à charge handicapés

  • maritalStatus
    requis

    Null tant qu'elle n'est pas renseignée

    One of the following:

    • MaritalStatus
    • null
  • isBoeth
    boolean
    requis
  • boethStatus
    requis

    One of the following:

    • OnboardingHandicapValue
    • null
  • seniorityDate
    requis

    One of the following:

    • string
    • null
  • paymentOption
    requis

    One of the following:

    • VirementPaymentOption
      • type
        string
        requis
      • iban
        string
        requis
      • bic
        string
        requis
    • CheckPaymentOption
      • type
        string
        requis
    • CashPaymentOption
      • type
        string
        requis
  • matriculeRh
    string
    requis
  • conventionalPosition
    requis

    Position Syntec de l'avenant en vigueur du contrat courant (pour un contrat qui n'a pas encore commencé : de son premier avenant) — null sans contrat ni position

    One of the following:

    • SyntecPosition
    • null
  • coefficient
    number | null
    requis
  • foreignErpId
    string | null
    requis

    Identifiant du collaborateur dans votre système, unique dans l'entreprise

  • managerId
    requis

    Manager du collaborateur, null s'il n'en a pas

    One of the following:

    • string
    • null
  • createdAt
    string
    requis
    format: date-time
  • updatedAt
    string
    requis
    format: date-time

400

Champ non modifiable, numéro de sécurité sociale déjà utilisé, ou manager introuvable ou égal au collaborateur
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

Collaborateur introuvable
JSON
  • error
    string
    requis

    Message lisible, en français.

  • errorCode
    optionnel
    string

    Code stable, sur certaines erreurs.

409

Le foreignErpId appartient déjà à un autre collaborateur
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