GET v1/Payment/InstallmentSchedule?NumberOfInstallments={NumberOfInstallments}&LineOfBusiness={LineOfBusiness}&StateCode={StateCode}&EffectiveDate={EffectiveDate}&ExpirationDate={ExpirationDate}&TotalPremium={TotalPremium}&ProductType={ProductType}&TotalFees={TotalFees}&IsMortgageeBilling={IsMortgageeBilling}&IsAgencyBilling={IsAgencyBilling}&CurrentStatus={CurrentStatus}

Installment Schedule

Request Information

URI Parameters

NameDescriptionTypeAdditional information
NumberOfInstallments

Number of pay plan installments

integer

Required

LineOfBusiness

Line of business prefix

string

Required

StateCode

State code

string

Required

EffectiveDate

Policy effective date

date

Required

ExpirationDate

Policy expiration date

date

Required

TotalPremium

Total premium amount

decimal number

Required

ProductType

Product type prefix (Use 'N/A' if product types are not used)

string

None.

TotalFees

Total fee amount

decimal number

Default value is 0

IsMortgageeBilling

Is under mortgagee billing

boolean

Default value is False

IsAgencyBilling

Is under agency billing

boolean

Default value is False

CurrentStatus

Current Policy Status

CurrentStatusEnum

Default value is NewPolicy

Body Parameters

None.

Response Information

Resource Description

Collection of InstallmentScheduleDTO
NameDescriptionTypeAdditional information
Number

Item number

integer

None.

DueDate

Due date

date

None.

Amount

Installment amount

decimal number

None.

Fee

Fee amount

decimal number

None.

WarningMessages

List of warning messages encountered while servicing request

Collection of string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Number": 1,
    "DueDate": "2022-01-20T04:10:50.8565603-10:00",
    "Amount": 3.0,
    "Fee": 4.0
  },
  {
    "Number": 1,
    "DueDate": "2022-01-20T04:10:50.8565603-10:00",
    "Amount": 3.0,
    "Fee": 4.0
  }
]

application/xml, text/xml

Sample:
<ArrayOfInstallmentScheduleDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <InstallmentScheduleDTO>
    <Id>5</Id>
    <Amount>3</Amount>
    <DueDate>2022-01-20T04:10:50.8565603-10:00</DueDate>
    <Fee>4</Fee>
    <Number>1</Number>
  </InstallmentScheduleDTO>
  <InstallmentScheduleDTO>
    <Id>5</Id>
    <Amount>3</Amount>
    <DueDate>2022-01-20T04:10:50.8565603-10:00</DueDate>
    <Fee>4</Fee>
    <Number>1</Number>
  </InstallmentScheduleDTO>
</ArrayOfInstallmentScheduleDTO>