Rechercher des rémunérations et aides

Présentation

Cette ressource permet d'obtenir la liste des rémunérations et aides possibles en fonction du profil du bénéficiaire et des caractéristiques de la formation et du type de financement

Description de la requête

Point d'accès

POST https://api.emploi-store.fr/partenaire/simulateurfinancement/v1/remuneration-aide

Paramètres d'entrée

En-tête(s)	Valeur
Authorization	Bearer [Access token]

Corps de la requête

Code	Cardinalité	Format	Description
beneficiaire	0..1	Sous-balise	Informations sur le bénéficiaire
beneficiaire.droit_prive	0..1	Booléen	Indique si le bénéficiaire est salarié d'une entreprise de droit privé
beneficiaire.inscrit_pe	0..1	Booléen	Indique si le bénéficiaire est inscrit à Pôle emploi commme demandeur d'emploi
beneficiaire.solde_cpf	0..1	Integer	Solde du compte CPF du bénéficiaire
beneficiaire.remuneration	0..1	Integer	Rémunération actuelle en euros
beneficiaire.allocation	0..1	Integer	Montant de l'allocation en euros
beneficiaire.type_allocation	0..1	String	Type d'allocation Valeurs possibles : `are` `ass` `rsa` `ata` `asr` `atp` `asp` `aex`
beneficiaire.fin_allocation	0..1	Date	Date de fin de l'allocation
beneficiaire.naissance	0..1	Date	Date de naissance du bénéficiaire
beneficiaire.age	0..1	Integer	Age du bénéficiaire
beneficiaire.parent_isole	0..1	Booléen	Indique si le bénéficiaire est un parent isolé
beneficiaire.mere_trois_enfants	0..1	Booléen	Indique si le bénéficiaire est une mère de famille ayant au moins trois enfants
beneficiaire.veuve_ou_divorcee	0..1	Booléen	Indique si le bénéficiaire est une femme divorcée, veuve ou séparée judiciairement depuis moins de trois ans
beneficiaire.creation_entreprise	0..1	Booléen	Indique si le bénéficiaire est en situation de création d'entreprise
beneficiaire.contrat_aide_actuel	0..1	Booléen	Indique si le bénéficiaire a un contrat aidé en cours
beneficiaire.contrat_aide_passe	0..1	Booléen	Indique si le bénéficiaire a achevé un contrat aidé
beneficiaire.experience_professionnelle	0..1	Integer	Nombre de mois travaillés
beneficiaire.experience_professionnelle_5_dernieres_annees	0..1	Integer	Nombre de mois travaillés dans les cinq dernières années
beneficiaire.mois_travailles_en_cdd	0..1	Integer	Nombre de mois travaillés sur un contrat CDD sur les 12 derniers mois
beneficiaire.jours_travailles	0..1	Integer	Nombre de jours travaillés dans les cinq dernières années (pour les intermittents)
beneficiaire.heures_travaillees	0..1	Integer	Nombre d'heures travaillées dans les 18 derniers mois (pour les intérimaires)
beneficiaire.contrat	0..1	String	Type de contrat du bénéficiaire Valeurs possibles : `cdd` `cdi` `intermittent` `interim`
beneficiaire.mois_entreprise	0..1	Integer	Ancienneté en mois dans l'entreprise actuelle
beneficiaire.heures_entreprise	0..1	Integer	Ancienneté en heures dans l'entreprise
beneficiaire.commune	0..1	String	Code INSEE de la commune où réside le bénéficiaire
beneficiaire.departement	0..1	String	Code INSEE du département où réside le bénéficiaire
beneficiaire.niveau_scolaire	0..1	Integer	Niveau scolaire du bénéficiaire (voir https://www.service-public.fr/particuliers/vosdroits/F199) Valeurs possibles : `0` `1` `2` `3` `4` `5` `6` `7` `8`
beneficiaire.th	0..1	Booléen	Indique si le bénéficiaire est en situation d'handicap
beneficiaire.a_travaille_six_mois	0..1	Booléen	Indique si le bénéficiaire a déjà travaillé six mois sur une période de douze mois
beneficiaire.a_travaille_douze_mois	0..1	Booléen	Indique si le bénéficiaire a travaillé pendant douze mois dont au moins six mois consécutifs dans les trois ans qui précèdent l'entrée en formation
beneficiaire.entreprise	0..1	Sous-balise	Informations sur l'entreprise du bénéficiaire
beneficiaire.entreprise.naf	0..1	String	Identifiant NAF/APE de l'entreprise
beneficiaire.entreprise.idcc	0..1	String	Identifiant de convention collective de l'établissement
beneficiaire.entreprise.commune	0..1	String	Code INSEE de la commune de l'établissement du bénéficiaire
beneficiaire.entreprise.opca	0..1	String	L'OPCA auquel est rattaché l'établissement du bénéficiaire. Optionnel, habituellement déduit de l'IDCC.
beneficiaire.entreprise.opacif	0..1	String	L'OPACIF auquel est rattaché l'établissement du bénéficiaire. Optionnel, habituellement déduit de l'IDCC.
formation	0..1	Sous-balise	Informations sur la formation
formation.numero	0..1	String	Identifiant INTERCARIF de la formation
formation.code_financeur	0..1	Array	Liste des codes financeurs de la formation
formation.region	0..1	String	Code INSEE de la région où se déroule la formation
financement	0..1	Sous-balise	Information sur le financement
financement.identifiant	0..1	String	Identifiant du financement

Exemple d'appel

POST https://api.emploi-store.fr/partenaire/simulateurfinancement/v1/remuneration-aide

Authorization: Bearer [Access token]

{
   "beneficiaire": {
       "age": 40
   },
   "formation": {
       "code_financeur": [2],
"region": 27
   },
"financement": {
"identifiant": "dispositif 7"
}
}

Description de la réponse

Lors de la réponse de l'API, une redirection (code HTTP 302 Found) est réalisée du domaine https://api.emploi-store.fr/partenaire/simulateurfinancement/v1/remuneration-aide vers le domaine http://trefle.pole-emploi.fr/api-moteur/0.8/remuneration-aide.

Vous devez explicitement indiquer à votre client HTTP de suivre les redirections car il ne le fait probablement pas par défaut. Par exemple pour le client curl, il est nécéssaire d'utiliser curl --location (ou curl -L).

Données retournées

Code	Cardinalité	Format	Description
remunerations	0..n	Tableau	Liste des rémunérations
remunerations.remuneration	0..1	Float	Rémunération applicable
remunerations.remuneration_annee_2	0..1	Float	Rémunération applicable la deuxième année
remunerations.remuneration_annee_3	0..1	Float	Rémunération applicable la troisième année
remunerations.remuneration_texte	0..1	String	Texte de la rémunération
remunerations.indemnite_conges_payes	0..1	Integer	Indemnité compensatrice de congés payés
remunerations.plafond_remuneration	0..1	Integer	Plafond de la rémunération applicable
remunerations.rff	0..1	Float	Montant de la RFF si applicable
remunerations.debut_rff	0..1	Date	Date de début de la RFF si applicable
remunerations.fin_rff	0..1	Date	Date de fin de la RFF si applicable
remunerations.fin_remuneration	0..1	Date	Date de fin de la rémunération
remunerations.droit_aide_complementaire	0..1	Booléen	Le bénéficiaire a droit à une aide complémentaire
remunerations.montant_aide_complementaire	0..1	Float	Le montant de l'aide complémentaire
remunerations.description_aide_complementaire	0..1	String	Texte de description de l'aide complémentaire
remunerations.droit_aide_transport	0..1	Booléen	Le bénéficiaire a droit à une aide au transport
remunerations.montant_aide_transport	0..1	Float	Le montant de l'aide au transport
remunerations.description_aide_transport	0..1	String	Texte de description de l'aide au transport
remunerations.droit_aide_hebergement	0..1	Booléen	Le bénéficiaire a droit à une aide à l'hébergement
remunerations.montant_aide_hebergement	0..1	Float	Le montant de l'aide à l'hébergement
remunerations.description_aide_hebergement	0..1	String	Texte de description de l'aide à l'hébergement

Exemple de retour

HTTP 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache

{
   "remunerations": [{
       "remuneration": 0,
       "fin_remuneration": null,
       "indemnite_conges_payes": 0,
"intitule_remuneration": "Aides et rémunération mobilisable par la région Bourgogne Franche Comté",
"droit_aide_complementaire": true,
"montant_aide_transport": "98,78€ par mois (sous condition)",
"description_aide_transport": "Si la distance vers le lieu de votre formation est supérieure ou égale à 16km. Alors vous pouvez bénéficier d'une aide au transport."
   }]
}

Cas d'erreurs possibles

Retrouvez la liste des cas d'erreurs possibles sur la page Erreurs Types.