GET v1/PaymentPlan?policyId={policyId}
Get Payment Plan Info by policy id
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| policyId |
Id of the policy |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Payment Plan information
PaymentPlanDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| PolicyQuoteID | integer |
None. |
|
| PlanTypeCode | string |
None. |
|
| PlanType | string |
None. |
|
| DayofMonthPaymentisDue | integer |
None. |
|
| DepositAmount | decimal number |
None. |
|
| DownPaymentPercentage | decimal number |
None. |
|
| NumberofPayments | integer |
None. |
|
| NumberofMonthsBetweenPayments | integer |
None. |
|
| InstallmentFee | decimal number |
None. |
|
| InstallmentPercentage | decimal number |
None. |
|
| AmountCollectedByAgent | decimal number |
None. |
|
| MethodofPaymentCode | string |
None. |
|
| MethodofPayment | string |
None. |
|
| PaymentCurrencyCode | string |
None. |
|
| NextTermPaymentPlanTypeCode | string |
None. |
|
| NextTermPaymentPlanType | string |
None. |
|
| RequiredDepositAmount | decimal number |
None. |
|
| ReturnPremiumMailedCode | string |
None. |
|
| ReturnPremiumPayeeCode | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"PolicyQuoteID": 1,
"PlanTypeCode": "sample string 2",
"PlanType": "sample string 3",
"DayofMonthPaymentisDue": 1,
"DepositAmount": 1.0,
"DownPaymentPercentage": 1.1,
"NumberofPayments": 1,
"NumberofMonthsBetweenPayments": 1,
"InstallmentFee": 1.0,
"InstallmentPercentage": 1.1,
"AmountCollectedByAgent": 1.0,
"MethodofPaymentCode": "sample string 4",
"MethodofPayment": "sample string 5",
"PaymentCurrencyCode": "sample string 6",
"NextTermPaymentPlanTypeCode": "sample string 7",
"NextTermPaymentPlanType": "sample string 8",
"RequiredDepositAmount": 1.0,
"ReturnPremiumMailedCode": "sample string 9",
"ReturnPremiumPayeeCode": "sample string 10"
}
application/xml, text/xml
Sample:
<PaymentPlanDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies"> <AmountCollectedByAgent>1</AmountCollectedByAgent> <DayofMonthPaymentisDue>1</DayofMonthPaymentisDue> <DepositAmount>1</DepositAmount> <DownPaymentPercentage>1.1</DownPaymentPercentage> <InstallmentFee>1</InstallmentFee> <InstallmentPercentage>1.1</InstallmentPercentage> <MethodofPayment>sample string 5</MethodofPayment> <MethodofPaymentCode>sample string 4</MethodofPaymentCode> <NextTermPaymentPlanType>sample string 8</NextTermPaymentPlanType> <NextTermPaymentPlanTypeCode>sample string 7</NextTermPaymentPlanTypeCode> <NumberofMonthsBetweenPayments>1</NumberofMonthsBetweenPayments> <NumberofPayments>1</NumberofPayments> <PaymentCurrencyCode>sample string 6</PaymentCurrencyCode> <PlanType>sample string 3</PlanType> <PlanTypeCode>sample string 2</PlanTypeCode> <PolicyQuoteID>1</PolicyQuoteID> <RequiredDepositAmount>1</RequiredDepositAmount> <ReturnPremiumMailedCode>sample string 9</ReturnPremiumMailedCode> <ReturnPremiumPayeeCode>sample string 10</ReturnPremiumPayeeCode> </PaymentPlanDTO>