Vous êtes ici :
InsPolicyService:createPaymentSchedule
Le service InsPolicyService:createPaymentSchedule crée un calendrier de paiement (et éventuellement une transaction de paiement initiale) pour la stratégie cible. Cela s'applique uniquement à l'objet Police d'assurance. L'objet Police (actif) n'est pas pris en charge.
Méthode : createPaymentSchedule
Fonctionnement
-
Le service prend un ID InsurancePolicy et crée un calendrier de paiement en utilisant les informations de la police et les paramètres facultatifs.
-
Si l'ID de police d'origine de la police a déjà un calendrier de paiement existant, le service renvoie un message d'erreur.
-
En cas de paiement initial, une transaction de police d'assurance est créée.
-
Lors de l'enregistrement du calendrier de paiement, les enregistrements sont liés à l'ID de police d'origine de la police.
-
Le calendrier de paiement est ajouté au résultat JSON.
Options distantes
Option distante |
Description |
|---|---|
coolingOffPeriod
|
Facultatif Le nombre de jours pendant lesquels vous pouvez retarder la première entrée au calendrier de paiement. Avec la période de réflexion, la date du premier calendrier de paiement de la police est calculée sur la base de la date effective + le nombre de jours. Par exemple, il existe une fréquence de paiement mensuelle où la date effective est le 5 janvier et la date du premier calendrier de paiement est le 5 janvier. Si nous appliquons une période de réflexion de 14 jours, la première entrée du calendrier de paiement change du 5 au 19 janvier. Les dates restantes du calendrier de paiement mensuel restent inchangées.  Remarque La période de réflexion doit être comprise entre 1 et 28 jours à compter de la date de début de la police. |
|
Facultatif. La classe personnalisée à utiliser pour récupérer l'enregistrement Police d'assurance. La valeur par défaut est GetInsurancePolicy. |
|
Facultatif. Le Mappeur de données Omnistudio utilisé pour récupérer le calendrier de paiement. |
|
Facultatif. La règle de paiement utilisée pour le paiement initial. Exemple : Jours, Mois ou Pourcentage. |
|
Facultatif. Le nom de la transaction. Par défaut, utilisez la même valeur que |
|
Facultatif. Le type de transaction. La valeur par défaut est Frais Premium. |
|
Facultatif. La valeur Pourcentage, ou le nombre de mois ou de jours. Obligatoire si |
|
Facultatif. Remplace la valeur Méthode de calcul des primes de la police. |
|
Facultatif. Remplace la valeur Fréquence Premium de la police. |
|
Facultatif. La date de la première entrée du calendrier de paiement. Par défaut, la date d'entrée en vigueur de la police. |
|
Facultatif. Remplace la valeur Type de paiement de la police. |
|
Obligatoire. L'ID de InsurancePolicy utilisé pour créer le calendrier de paiement. |
|
Facultatif. La classe personnalisée à utiliser pour enregistrer le calendrier de paiement. Par défaut PostInsurancePolicyPaymentSchedule |
|
Facultatif. Le Data Mapper utilisé pour enregistrer le calendrier de paiement. |
|
Facultatif. True si les enregistrements du calendrier de paiement sont enregistrés. La valeur par défaut est |
Sorties
Sortie |
Description |
|---|---|
|
La liste des enregistrements Entrée au calendrier de paiement de la police d'assurance. |
JSON d'entrée
{
"policyId": "0YT5w000000UHv6GAG",
"paymentFrequency": "Monthly",
"paymentCalculationMethod": "Daily",
"paymentType": "Advanced",
"paymentStartDate": "1/1/2020",
"initialPaymentRule": "Percentage",
"initialPaymentValue": "10",
"initialPaymentTransactionType": "Premium Charge",
"initialPaymentTransactionName": "",
"postPaymentSchedule": "true"
}JSON de sortie
{
"output": {
"paymentSchedule": [
{
"totalAmount": 571.5,
"toDelete": null,
"taxAmount": 51.5,
"scheduleDate": "2020-06-21",
"premiumAmount": 515,
"insTransaction": {
"type": "Premium Charge",
"transactionNumber": null,
"transactionDate": null,
"totalAmount": 571.5,
"taxAmount": 51.5,
"postDate": null,
"name": "Premium Charge",
"Id": null,
"feeAmount": 5,
"amount": 515,
"additionalInfo": null
},
"Id": null,
"feeAmount": 5
},
{
"totalAmount": 2578.79,
"toDelete": null,
"taxAmount": 232.38,
"scheduleDate": "2020-09-21",
"premiumAmount": 2323.85,
"insTransaction": null,
"Id": null,
"feeAmount": 22.56
},
{
"totalAmount": 1268.27,
"toDelete": null,
"taxAmount": 114.29,
"scheduleDate": "2020-12-21",
"premiumAmount": 1142.88,
"insTransaction": null,
"Id": null,
"feeAmount": 11.1
},
{
"totalAmount": 1296.44,
"toDelete": null,
"taxAmount": 116.83,
"scheduleDate": "2021-03-21",
"premiumAmount": 1168.27,
"insTransaction": null,
"Id": null,
"feeAmount": 11.34
}
],
"errorCode": "INVOKE-200",
"error": "OK"
}
}