Rechercher des financements

Présentation

Cette ressource permet d'obtenir la liste des financements possibles (coûts et rémunération) en fonction du profil du bénéficiaire et des caractéristiques de la formation.

 

Description de la requête

Point d'accès

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

 

Paramètres d'entrée

Code Cardinalité Format Description
eligible

0..1

Booléen

 Permet de filtrer les financements selon leur éligibilité.

Valeurs possibles :

  • true → seuls les financements éligibles sont retournés
  • false → seuls les financements non-éligibles sont retournés

explain

0..1 Booléen

Permet d'obtenir l'explication de l'application des règles dans chacun des financements

Valeurs possibles :

  • true → l'explication des règles est retournée
  • false → l'explication des règles n'est pas retournée

 

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

 

Exemple d'appel

POST https://api.emploi-store.fr/partenaire/simulateurfinancement/v1/financement?eligible=false&explain=true

Authorization: Bearer [Access token]

{
    "beneficiaire": {
        "droit_prive": false,
        "inscrit_pe": true,
        "naissance": "2000-10-12"
    },
    "formation": {
        "numero": "03_1702030F"
    }
}

 

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/financement vers le domaine http://trefle.pole-emploi.fr/api-moteur/0.7/financement.

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
financements 0..n Tableau

Liste des financements

financements.intitule 1 String

Intitulé du financement

financements.financee_pe 0..1 Booléen

Indique si le financement est fait par Pôle emploi

financements.tags 1 Tableau

Liste de tags

financements.cpf_mobilisable 0..1 Booléen

Indique si le CPF du bénéficiaire est mobilisable

financements.cumulable 0..1

Booléen

Indique si le financement est compatible avec d'autres financements
financements.sigle 0..1

String

Sigle du financement
financements.eligible

1

Booléen Définit si le financement est éligible
financements.description

0..1

String Description du financement
financements.en_savoir_plus

0..1

String Description du financement
financements.demarches

0..1

String Démarches à accomplir pour obtenir le financement
financements.remuneration

0..1

Float Rémunération applicable
financements.remuneration_annee_2

0..1

Float Rémunération applicable la deuxième année
financements.remuneration_annee_3

0..1

Float Rémunération applicable la troisième année
financements.remuneration_texte

0..1

String Texte de la rémunération
financements.indemnite_conges_payes

0..1

Integer Indemnité compensatrice de congés payés
financements.plafond_remuneration

0..1

Integer Plafond de la rémunération applicable
financements.prise_en_charge

0..1

Integer Valeur définie seulement si le prix horaire de la formation est défini
financements.prise_en_charge_texte

0..1

String Texte de la prise en charge
financements.plafond_prise_en_charge

0..1

Integer Ce champ est défini quand on ne connaît pas le prix horaire de la formation. C'est donc une prise en charge maximale théorique, la prise en charge réelle dépendra du prix exact de la formation.
financements.plafond_prix_horaire

0..1

Float Prix horaire maximum
financements.heures

0..1

Integer Nombre d'heures effectivement prises en charge
financements.reste_a_charge

0..1

Float Reste à charge applicable
financements.rff

0..1

Float Montant de la RFF si applicable
financements.debut_rff

0..1

Date Date de début de la RFF si applicable
financements.fin_rff

0..1

Date Date de fin de la RFF si applicable
financements.fin_remuneration

0..1

Date Date de fin de la rémunération
financements.ressources

0..n

String Liste d'adresses Internet pour en savoir plus sur le sujet.
financements.explain

0..n

Tableau Liste de conditions nécessaires pour rendre ce financement éligible
financements.explain.condition

0..1

String

Texte de la condition à évaluer

financements.explain.status

0..1

Booléen Résultat de l'évaluation de la condition
financements.explain.connective

0..1

String Dépendance logique avec la condition suivante
financements.explain.reason

0..1

String Raison invoquée pour une condition fausse
financements.explain.params

0..n

String Paramètres identifiés de la condition
financements.explain.terms

0..n

String Liste des termes pour une condition composée
financements.explain.children

0..n

String Liste des conditions filles pour une condition
financements.organisme

0..1

Sous-balise Organisme du financement
financements.organisme.nom

0..1

String Nom de l'organisme
financements.organisme.adresse

0..1

String Adresse de l'organisme
financements.organisme.telephone

0..1

String Numéro de téléphone de l'organisme
financements.organisme.web

0..1

String Adresse du site web de l'organisme

 

Exemple de retour

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

{
    "financements": [{
        "type_lbf": "cpf",
        "priorite_lbf": 0,
        "tags": ["CPF", "DE", "individuel","national"],
        "cpf_mobilisable": true,
        "financee_pe": false,
        "cumulable": true,
        "intitule": "Compte Personnel de Formation (CPF)",
        "eligible": true,
        "explain": null,
        "reste_a_charge": 0,
        "prise_en_charge": null,
        "plafond_prix_horaire": 0,
        "plafond_prise_en_charge": 0,
        "remuneration": 0,
        "fin_remuneration": null,
        "indemnite_conges_payes": 0,
        "heures": 0,
        "prise_en_charge_texte": "Formation totalement ou partiellement financée dans la limite de votre solde cpf et à hauteur de 15 euros de l'heure. Dans le cas d'un financement partiel, vous pouvez prendre en charge vous-même le reste du montant ou faire appel à des cofinancements. Un abondement de votre compte est possible dans certains cas, demandez les conditions à votre conseiller en évolution professionnelle.",
        "demarches": "1. Contactez votre conseiller référent emploi pour valider avec lui votre projet de formation.\n2. Consultez votre compte CPF sur le site https://www.moncompteactivite.gouv.fr",
        "description": "Le CPF peut financer totalement ou partiellement une formation certifiante. NB : dans le cas d'une formation cofinancée par la région ou Pôle emploi, le compte personnel de formation (CPF) pourra être mobilisé.",
        "en_savoir_plus": "",
        "remuneration_texte": ""
    }]
}

 

Cas d'erreurs possibles

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