You are here:
InsPolicyService:modifyPaymentSchedule
Use this service to modify an existing payment schedule based on a new Premium Frequency.
This service works with the Salesforce FSC InsurancePolicy object, not the Vlocity Policy (Asset) object.
Method: modifyPaymentSchedule
How It Works
-
The service accepts an insurance policy ID and the effective date of the policy's payment schedule change.
-
If the policy's Original Policy Id has no existing payment schedule, the service returns an error message.
To create a payment schedule, use
InsPolicyService: createPaymentSchedule. -
The service uses the policy's Premium Calculation Method, Payment Type, Standard Premium, Standard Fee, and Standard Tax to generate a modified payment schedule. If
paymentFrequencyisn't provided as input, the service uses the policy's Premium Frequency. -
When saving the payment schedule, the service links records to the policy's Original Policy Id.
-
The service adds the payment schedule to the JSON result.
Remote Options
Remote Option |
Description |
|---|---|
|
Required. The date the modification takes effect. |
|
Optional. The custom class that retrieves the Insurance Policy record. Default is |
|
Optional. The Omnistudio Data Mapper that retrieves the payment schedule. |
|
The new Premium Frequency value for the payment schedule. |
|
The ID of the InsurancePolicy with the payment schedule to modify. |
|
Optional. The custom class that saves the payment schedule. The default value is |
|
Optional. The Data Mapper that saves the payment schedule. |
|
Optional.
The default value is |
Input JSON
{
"policyId": "0YT6g000000MEPEGA4",
"effectiveDate": "3/1/2021",
"paymentFrequency": "Quarterly",
"postPaymentSchedule": "false"
}Output JSON
{
"output": {
"paymentSchedule": [
{
"totalAmount": 298.53,
"toDelete": null,
"taxAmount": 26.75,
"scheduleDate": "2021-01-01",
"premiumAmount": 267.53,
"insTransaction": null,
"Id": "a606g000000R1s7AAC",
"feeAmount": 4.25
},
{
"totalAmount": 269.64,
"toDelete": null,
"taxAmount": 24.16,
"scheduleDate": "2021-02-01",
"premiumAmount": 241.64,
"insTransaction": null,
"Id": "a606g000000R1s8AAC",
"feeAmount": 3.84
},
{
"totalAmount": 433.36,
"toDelete": null,
"taxAmount": 38.84,
"scheduleDate": "2021-03-15",
"premiumAmount": 388.36,
"insTransaction": null,
"Id": null,
"feeAmount": 6.16
},
...
],
"errorCode": "INVOKE-200",
"error": "OK"
}
