InsPolicyService:modifyPaymentSchedule

Class: InsPolicyService

Method: modifyPaymentSchedule

How It Works

1. The service accepts an insurance policy ID and the effective date of the policy's payment schedule change.

2. 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.

3. 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 paymentFrequency isn't provided as input, the service uses the policy's Premium Frequency.

4. When saving the payment schedule, the service links records to the policy's Original Policy Id.

5. The service adds the payment schedule to the JSON result.

Remote Options

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"
}