Skip to main content
Skip table of contents

Champs personnalisés (API)

PRÉSENTATION

Plusieurs entités peuvent être complétées avec des champs personnalisés permettant de stocker des informations n'ayant pas de champ dédié en standard. Ces champs sont nommés « custom_X » ou X est un nombre.

Attention
Pour pouvoir être utilisé, un champ personnalisé doit d'abord avoir été créé depuis l'interface. Cela signifie que si vous renseignez par exemple le champ « custom_2 » d'un client via l'API, mais que ce champ n'a pas été configuré sur les clients depuis l'interface d'administration de la plateforme, la valeur renseignée ne sera pas visible lors de la consultation de la fiche depuis l'interface.

ENTITÉS CONCERNÉES

  • Contact

  • Partenaire

  • Compagnie

  • Client

  • Devis

  • Contrat

  • Sinistres

LISTES PERSONNALISÉES

Liste personnalisées standards

Des listes personnalisées sont disponibles en standard et peuvent être modifiées depuis l'interface. Leurs valeurs peuvent ensuite être utilisées pour alimenter des données à insérer sur des clients, devis, contrats, sinistres, etc.

Intitulé

Utilisable sur les entités

Code de la liste

Type de contact

Contact

Catégorie socio-professionnelle

Contact
Client

Origine de l'affaire

Devis
Contrat

ORIGIN

Motif de la suspension/résiliation

Contrat

CANCEL

Raison de l'avenant

Avenant

AMENDMENT_REASON

Raison du changement d'immatriculation

Véhicule

REGISTRATION_CHANGE_REASON

Raison de sortie d'un véhicule

Véhicule

BENEFICIARY_CANCELLATION_REASON

Rôles

Utilisateur

USER_ROLES

Probabilité de remporter l'affaire

Devis

ESTIMATES_SUCCESS_PROBABILITY

Types d'évènement

Évènements

EVENTS_TYPES

Sous-statut du contrat

Contrat

POLICIES_ADDITIONAL_STATUS

Catégories de véhicules

Véhicule

VEHICLES_TYPES_CATEGORIES

Type d'appartenance

Client

AFFILIATION_TYPE

Forme juridique

Client

LEGAL_FORMS

Obtenir les valeurs d'une liste personnalisée

URL du service

Syntaxe attendue :

CODE
https://{domaine}/{langue}/api/{version}/custom_lists/{code de la liste}

Exemple :

CODE
https://app.modulr-courtage.fr/fr/api/1.0/custom_lists/CANCEL

Méthode

GET

Paramètres

Le code est transmis dans l'URL. Aucun autre paramètre n'est nécessaire.

Réponse

L'intégralité des éléments de la liste est retransmise en réponse.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.