GET v1/Payment/ActiveInstallmentSchedule?PolicyNumber={PolicyNumber}

Retrieve Active Installment Schedule

Request Information

URI Parameters

NameDescriptionTypeAdditional information
PolicyNumber

string

Required

Body Parameters

None.

Response Information

Resource Description

ActiveInstallmentScheduleResponse
NameDescriptionTypeAdditional information
PolicyEffectiveDate

date

None.

PolicyExpirationDate

date

None.

TermPremium

decimal number

None.

NSFFeesBilledTotal

decimal number

None.

ServiceFeesBilledTotal

decimal number

None.

OtherFeesBilledTotal

decimal number

None.

NonInsuranceFeesBilledTotal

decimal number

None.

AmountDue

decimal number

None.

ActiveInstallmentId

integer

None.

Installments

Collection of ActiveInstallmentScheduleDTO

None.

Id

Primary Id

integer

None.

WarningMessages

List of warning messages encountered while servicing request

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "PolicyEffectiveDate": "2022-01-20T04:35:12.1921911-10:00",
  "PolicyExpirationDate": "2022-01-20T04:35:12.1921911-10:00",
  "TermPremium": 1.0,
  "NSFFeesBilledTotal": 1.0,
  "ServiceFeesBilledTotal": 1.0,
  "OtherFeesBilledTotal": 1.0,
  "NonInsuranceFeesBilledTotal": 1.0,
  "AmountDue": 1.0,
  "ActiveInstallmentId": 1,
  "Installments": [
    {
      "InstallmentNumber": 1,
      "BillDate": "2022-01-20T04:35:12.1931971-10:00",
      "RecalculationDate": "2022-01-20T04:35:12.1931971-10:00",
      "DueDate": "2022-01-20T04:35:12.1931971-10:00",
      "InstallmentTypeDesc": "sample string 1",
      "Premium": 1.0,
      "NonPremium": 1.0,
      "Received": 1.0,
      "CalculatedOffset": 1.0,
      "CalculatedInstallAmtDue": 1.0,
      "ActiveInstallment": true,
      "Id": 2
    },
    {
      "InstallmentNumber": 1,
      "BillDate": "2022-01-20T04:35:12.1931971-10:00",
      "RecalculationDate": "2022-01-20T04:35:12.1931971-10:00",
      "DueDate": "2022-01-20T04:35:12.1931971-10:00",
      "InstallmentTypeDesc": "sample string 1",
      "Premium": 1.0,
      "NonPremium": 1.0,
      "Received": 1.0,
      "CalculatedOffset": 1.0,
      "CalculatedInstallAmtDue": 1.0,
      "ActiveInstallment": true,
      "Id": 2
    }
  ],
  "Id": 1
}

application/xml, text/xml

Sample:
<ActiveInstallmentScheduleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <Id>1</Id>
  <ActiveInstallmentId>1</ActiveInstallmentId>
  <AmountDue>1</AmountDue>
  <Installments>
    <ActiveInstallmentScheduleDTO>
      <Id>2</Id>
      <ActiveInstallment>true</ActiveInstallment>
      <BillDate>2022-01-20T04:35:12.1931971-10:00</BillDate>
      <CalculatedInstallAmtDue>1</CalculatedInstallAmtDue>
      <CalculatedOffset>1</CalculatedOffset>
      <DueDate>2022-01-20T04:35:12.1931971-10:00</DueDate>
      <InstallmentNumber>1</InstallmentNumber>
      <InstallmentTypeDesc>sample string 1</InstallmentTypeDesc>
      <NonPremium>1</NonPremium>
      <Premium>1</Premium>
      <RecalculationDate>2022-01-20T04:35:12.1931971-10:00</RecalculationDate>
      <Received>1</Received>
    </ActiveInstallmentScheduleDTO>
    <ActiveInstallmentScheduleDTO>
      <Id>2</Id>
      <ActiveInstallment>true</ActiveInstallment>
      <BillDate>2022-01-20T04:35:12.1931971-10:00</BillDate>
      <CalculatedInstallAmtDue>1</CalculatedInstallAmtDue>
      <CalculatedOffset>1</CalculatedOffset>
      <DueDate>2022-01-20T04:35:12.1931971-10:00</DueDate>
      <InstallmentNumber>1</InstallmentNumber>
      <InstallmentTypeDesc>sample string 1</InstallmentTypeDesc>
      <NonPremium>1</NonPremium>
      <Premium>1</Premium>
      <RecalculationDate>2022-01-20T04:35:12.1931971-10:00</RecalculationDate>
      <Received>1</Received>
    </ActiveInstallmentScheduleDTO>
  </Installments>
  <NSFFeesBilledTotal>1</NSFFeesBilledTotal>
  <NonInsuranceFeesBilledTotal>1</NonInsuranceFeesBilledTotal>
  <OtherFeesBilledTotal>1</OtherFeesBilledTotal>
  <PolicyEffectiveDate>2022-01-20T04:35:12.1921911-10:00</PolicyEffectiveDate>
  <PolicyExpirationDate>2022-01-20T04:35:12.1921911-10:00</PolicyExpirationDate>
  <ServiceFeesBilledTotal>1</ServiceFeesBilledTotal>
  <TermPremium>1</TermPremium>
</ActiveInstallmentScheduleResponse>