Loading
Prepare for Email to Become the Default Login ExperienceRead More
The online Trailblazer Community becomes read-only Oct 30, 2026Read More
Important Advisory: iOS Update Impacting CG Mobile ApplicationRead More
Insurance
InsPolicyService:getPaymentSchedule

InsPolicyService:getPaymentSchedule

The InsPolicyService:getPaymentSchedule service returns the payment schedule of the InsurancePolicy. The Policy (Asset) object is not supported.

Class: InsPolicyService

Method: getPaymentSchedule

How It Works

The service retrieves the InsurancePolicyPaymentScheduleEntry__c records of the InsurancePolicy Id.

Remote Options

Remote Option

Description

getDataCustomClassName

Optional.

The custom class used to retrieve the payment schedule.

Default is GetInsurancePolicyPaymentSchedule.

getDataDRBundleName

Optional.

The Omnistudio Data Mapper used to retrieve the payment schedule.

policyId

Required.

The Id of the InsurancePolicy for which this service retrieves the payment schedule.

returnSObject

Optional.

True if the InsurancePolicyPaymentScheduleEntry__c field name should be used, otherwise, a generic field name is returned.

Default is false.

Input JSON

{
    "policyId": "0YT5w000000UPFWGA4",
    "returnSObject": false,
    "getDataCustomClassName": "GetInsurancePolicyPaymentSchedule"
}

Output JSON

{
  "output": {
    "policyId": "0YT5w000000UPFWGA4",
    "result": [
      {
        "feeAmount": 10.12,
        "Id": "a5u5w0000005u9ZAAQ",
        "insTransaction": {
          "additionalInfo": null,
          "amount": null,
          "feeAmount": null,
          "Id": "a5t5w000002iF4mAAE",
          "name": null,
          "postDate": null,
          "taxAmount": null,
          "totalAmount": null,
          "transactionDate": null,
          "transactionNumber": null,
          "type": null
        },
        "premiumAmount": 1042.88,
        "scheduleDate": "2020-07-15",
        "taxAmount": 104.29,
        "toDelete": null,
        "totalAmount": 1157.29
      },
      {
        "feeAmount": 1.92,
        "Id": "a5u5w0000005u9aAAA",
        "insTransaction": null,
        "premiumAmount": 192.64,
        "scheduleDate": "2020-07-30",
        "taxAmount": 19.2,
        "toDelete": null,
        "totalAmount": 213.76
      },
      ...
    ],
    "errorCode": "INVOKE-200",
    "error": "OK"
  }
}
 
Loading
Salesforce Help | Article