Récupérer les données administratives

Introduction

📘

Nous proposons sur cette page des méthodes pour faciliter la récupération des informations techniques et fonctionnelles nécessaires pour transmettre des informations à notre API.

Idéalement nous vous invitons à conserver les identifiants techniques des entités créés dans notre référentiel pour ne pas avoir à les rechercher par la suite.

Nous avons listé des méthodes de récupération d'information "en masse" (l'ensemble de vos établissements, l'ensemble des périodes d'un établissement...). Si vous êtes à la recherche d'un attribut lié à une entité spécifique (un établissement en particulier) ou un petit groupe d'entités, nous vous conseillons de requêter directement l'entité voulue et non pas de passer par une extraction "en masse".

📘

Rappel :

Un utilisateur ne peut consulter ou modifier que des éléments sur lesquels il a des droits. Lorsqu'un partenaire crée un établissement, les droits de gestion de cet établissement et des éléments associés (salariés, contrats...) sont accordés au compte ayant servi pour la création.

Récupérer la liste de vos établissements

Il est possible de filter la recherche sur le SIREN de l'entreprise en ajoutant ?entreprise.siren=<SIREN recherché>

curl --location --request GET "<Environnement>/api/etablissements" \
--header 'Authorization: Bearer <Token>'\
--header 'accept: application/json'
Retour
[
  {
    "entreprise": {
      "raisonSociale": "!Raison Sociale 1"
      "siren": "!SIREN 1!",
      "id": "!ID Entreprise 1!"
    },
    "nic": "!NIC 1!",
    "id": "!ID Etablissement 1!",
    "currentPeriodDate": "!Période courante de paie 1!"
  },
  {
    "entreprise": {
      "raisonSociale": "!Raison Sociale 2"
      "siren": "!SIREN 2!",
      "id": "!ID Entreprise 2!"
    },
    "nic": "!NIC 2!",
    "id": "!ID Etablissement 2!",
    "currentPeriodDate": "!Période courante de paie 2!"
  }
]

Grâce à la récupération de la période courante, vous pouvez déterminer si l'établissement a clôturé le mois en cours, le mois précédent ou une autre période.

Récupérer les informations d'une période

curl --location --request GET "<Environnement>/api/periods/<ID période>" \
--header 'Authorization: Bearer <Token>'\
--header 'accept: application/json'
Retour
{
  "startDate": "!Premier jour de la période!",
  "endDate": "!Premier jour de la période suivante!",
  "closed": true, "#true si la période est clôturée, false sinon",
  "etablissement": "/api/etablissements/!ID établissement!"
}

Récupérer la liste des périodes d'un établissement

curl --location --request GET "<Environnement>/api/etablissements/<ID établissement>/periods" \
--header 'Authorization: Bearer <Token>'\
--header 'accept: application/json'
Retour
[
  {
  "startDate": "!Premier jour de la période 1!",
  "endDate": "!Premier jour de la période suivante!",
  "closed": true, "#true si la période est clôturée, false sinon"
    },
  {
  "startDate": "!Premier jour de la période 2!",
  "endDate": "!Premier jour de la période suivante!",
  "closed": true, "#true si la période est clôturée, false sinon"
    }
]

Récupérer la liste des salariés d'un établissement

curl --location --request GET "<Environnement>/api/etablissements/<ID Etablissement>/employees" \
--header 'Authorization: Bearer <Token>'\
--header 'accept: application/json'
Retour
[
  {
    "matricule": "!Matricule 1!",
    "prenom": "!Prenom 1!",
    "nomNaissance": "!Nom naissance 1!",
    "nomUsage": "!Nom usage 1!",
    "email": "!Email 1!",
    "etablissement": "/api/etablissements/<ID Etablissement>",
    "genre": "MALE", "#MALE ou FEMALE",
    "dateNaissance": "!Date naissance 1!",
    "lieuNaissance": "!Ville naissance 1!",
    "adresse": {
      "adresse": "!Adresse 1!",
      "codePostal": "!Code postal 1!",
      "ville": "!Ville 1!",
      "complementAdresse": "!Complément adresse 1!",
      "codeINSEE": "!Code INSEE 1!"
    },
    "coordonneesBancaires": {
      "bankId": "!RIB 1!",
      "iban": "!IBAN 1!",
      "bic": "!Bic 1!",
      "methodePaiement": "VIREMENT",
      "jourVirement": 31,
      "moisVirement": "MOIS_COURANT"
    },
    "numeroSecuriteSociale": "!Numéro sécurité sociale 1!",
    "numeroTechniqueTemporaire": null, "#Nécessaire dans le cas où le salarié n'a pas de numéro de sécurité sociale",
    "periodDebutNumeroSecuriteSociale": "/api/periods/!ID période!",
    "isFamilyLeader": false, "#true si il y plusieurs ayants droits sur le contrat de mutuelle du salarié",
    "contrats": [
      "/api/contrat_salaries/!ID Contrat!" "#Le salarié peut avoir une liste de contrats",
    ],
    "id": "!ID Salarié 1!",
    "name": "!Nom affiché!",
    "contratActif": null, "#null si le salarié n'a pas de contrat actif, !ID Contrat actif! dans le cas contraire",
    "contratAffichage": "/api/contrat_salaries/!ID Contrat afiché par défaut pour ce salarié!",
    "lastContratSalarie": "/api/contrat_salaries/!ID du dernier Contrat!",
    "lastContratApprenti": null, "#null si le salarié n'a pas eu de contrat d'apprentissage ou de professionnalisation, !ID Contrat concerné! dans le cas contraire",
    "lastMandate": null,
    "lastConventionDeStage": null, "#null si le salarié n'était pas déclaré en tant que stagiaire auparavant, !ID Contrat concerné! dans le cas contraire",
    "etatEmploye": "contrat futur" "#<contrat actif> si le salarié a un contrat en cours, <contrat futur> si le salarié a un contrat débutant dans le futur, <contrat passé> si le salarié a uniquement un contrat passé",
  }
 ]

Did this page help you?