Premium Schedules API

List Premium Schedules

GET https://www.clarinetlive.com/api/v3/cases/{casePublicId}/premium-schedules?page=<page>&pageSize=<page size>&isForPayments=<isForPayments>

Request

No body.

Route parameters:

• casePublicId - required UUID. The PublicID of the case to get schedules for

Query parameters:

• page optional number. The 1-based page number to return. Defaults to 1 when not specified.
• pageSize optional number. The number of entries to return up to 500. Defaults to 100 when not specified.
• isForPayments optional boolean
  • true - return the premium schedule which is used for servicing/payments
  • false - returns the premium schedules which are not used for servicing/payments
  • Default/not specified - return all premium schedules

The Accept header should be populated with either application/xml or pplication/json to get XML or JSON respectively.

Response

Code	Message	Description
404	Not Found	The case was not found.
200	OK	The case was found. Example content listed below.

A list of premium schedules

[
  {
    "publicId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "pricingDate": "2025-01-15",
    "startDate": "2025-01-15",
    "description": "string",
    "isPaymentSchedule": true,
    "premiumMode": "Annual",
    "illustration": {
      "publicID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "description": "string",
      "date": "2025-01-15"
    },
    "policyVerification": {
      "publicID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "description": "string",
      "date": "2025-01-15"
    },
    "premiumScheduleType": "ClearLifeCalculated"
  }
]

Get Premium Schedule

GET https://www.clarinetlive.com/api/v3/cases/{casePublicId}/premium-schedules/{premiumSchedulePublicId}

Request

No body.

Route parameters:

• casePublicId - required UUID. The PublicID of the case
• premiumSchedulePublicId - required UUID. The PublicID of the premium schedule

The Accept header should be populated with either application/xml or pplication/json to get XML or JSON respectively.

Response

Below are listed some specific responses for this endpoint. General information about responses, status codes and errors can be found in Responses and Errors.

Code	Message	Description
404	Not Found	The case or premium schedule was not found.
200	OK	The premium schedule was found. Example content listed below.

OK response content:

{
  "publicId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "pricingDate": "2025-01-15T09:12:51.892Z",
  "startDate": "2025-01-15",
  "description": "A description",
  "isPaymentSchedule": true,
  "illustration": {
    "publicID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "description": "An illustration",
    "date": "2025-01-15"
  },
  "policyVerification": {
    "publicID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "description": "A verification",
    "date": "2025-01-15"
  },
  "premiumScheduleType": "ClearLifeCalculated",
  "approved": true,
  "noLapseGuaranteeImplemented": true,
  "noLapseGuaranteeFrom": "2025-01-15",
  "noLapseGuaranteeTo": "2025-01-15",
  "noLapseGuaranteeOptimizationType": "Optimization type",
  "noLapseGuaranteeCarrierConfirmed": true,
  "totalPremiumsPaidAmount": 10000,
  "totalPremiumsPaidDate": "2025-01-15",
  "comments": "A comment",
  "accountValueAtCoverageEnd": 1000,
  "premiumMode": "Annual",
  "cashWithdrawals": [
    {
      "date": "2025-01-15",
      "grossPaymentAmount": 100,
      "surrenderCharge": 10,
      "netPaymentAmount": 90,
      "policyYear": 10
    }
  ],
  "loanRepayments": [
    {
      "date": "2025-01-15",
      "principalPaymentAmount": 900,
      "interestPaymentAmount": 300,
      "policyYear": 10
    }
  ],
  "premiumPayments": [
    {
      "date": "2025-01-15",
      "amount": 10000,
      "policyYear": 10
    }
  ],
  "netDeathBenefits": [
    {
      "date": "2025-01-15",
      "amount": 1000000,
      "policyYear": 10
    }
  ]
}

Create Premium Schedule

POST https://www.clarinetlive.com/api/v3/cases/{casePublicId}/premium-schedules

Request

{
  "startDate": "2025-01-15",
  "pricingDate": "2025-01-15",
  "description": "A description",
  "isPaymentSchedule": true,
  "approved": true,
  "premiumMode": "Annual",
  "noLapseGuaranteeImplemented": true,
  "noLapseGuaranteeFrom": "2025-01-15",
  "noLapseGuaranteeTo": "2026-01-15",
  "noLapseGuaranteeOptimizationType": "No lapse type description",
  "noLapseGuaranteeCarrierConfirmed": true,
  "totalPremiumsPaidAmount": 10000,
  "totalPremiumsPaidDate": "2025-01-15",
  "comments": "Comments",
  "accountValueAtCoverageEnd": 1000,
  "cashWithdrawals": [
    {
      "date": "2025-01-15",
      "grossPaymentAmount": 100,
      "surrenderCharge": 10,
      "netPaymentAmount": 90
    }
  ],
  "loanRepayments": [
    {
      "date": "2025-01-15",
      "principalPaymentAmount": 900,
      "interestPaymentAmount": 300
    }
  ],
  "premiumPayments": [
    {
      "date": "2025-01-15",
      "amount": 19000
    }
  ],
  "netDeathBenefits": [
    {
      "date": "2025-01-15",
      "amount": 1000000
    }
  ]
}

Route parameters:

• casePublicId - required UUID. The PublicID of the case to add a premium schedule to

The Accept header should be populated with either application/xml or pplication/json to get XML or JSON respectively.

Response

Below are listed some specific responses for this endpoint. General information about responses, status codes and errors can be found in Responses and Errors.

Code	Message	Description
404	Not Found	The case was not found.
400	Bad Request	There was a problem processing the update. The response body will contain details about the failure.
201	Created	The Location header will be set to the URI of the newly created Premium Schedule.

Update Premium Schedule

PATCH https://www.clarinetlive.com/api/v3/cases/{casePublicId}/premium-schedules/{premiumSchedulePublicId}

Request

{
  "description": "New description",
  "approved": true,
  "isPaymentSchedule": true
}

Route parameters:

• casePublicId - required UUID. The PublicID of the case
• premiumSchedulePublicId - required UUID. The PublicID of the premium schedule

The Accept header should be populated with either application/xml or pplication/json to get XML or JSON respectively.

Response

Below are listed some specific responses for this endpoint. General information about responses, status codes and errors can be found in Responses and Errors.

Code	Message	Description
404	Not Found	The requested premium schedule was not found.
200	Ok	The update was applied successfully. Contains no body content.