GET v1/Policies/{policyId}/DownPayment
Returns the down payment information for a policy
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| policyId |
Id of the policy |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Down payment information
DownPaymentDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| DownPayment |
Down payment |
decimal number |
None. |
| DueToAgency |
Whether due to agency |
boolean |
None. |
| PolicyId |
Policy ID |
integer |
None. |
| MinimumDownEntity |
Minimum down entity |
string |
None. |
| MinimumDown |
Minimum down |
decimal number |
None. |
| TotalAgencyFees |
Total agency fees |
decimal number |
None. |
| TotalDownPayment |
Total down payment |
decimal number |
None. |
| ShowDueToAgency |
Whether to show due to agency |
boolean |
None. |
| DownPaymentLocked |
Whether down payment is locked |
boolean |
None. |
| Premium |
Premium |
decimal number |
None. |
Response Formats
application/json, text/json
Sample:
{
"DownPayment": 1.0,
"DueToAgency": true,
"PolicyId": 3,
"MinimumDownEntity": "sample string 4",
"MinimumDown": 5.0,
"TotalAgencyFees": 6.0,
"TotalDownPayment": 7.0,
"ShowDueToAgency": true,
"DownPaymentLocked": true,
"Premium": 10.0
}
application/xml, text/xml
Sample:
<DownPaymentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies"> <DownPayment>1</DownPayment> <DownPaymentLocked>true</DownPaymentLocked> <DueToAgency>true</DueToAgency> <MinimumDown>5</MinimumDown> <MinimumDownEntity>sample string 4</MinimumDownEntity> <PolicyId>3</PolicyId> <Premium>10</Premium> <ShowDueToAgency>true</ShowDueToAgency> <TotalAgencyFees>6</TotalAgencyFees> <TotalDownPayment>7</TotalDownPayment> </DownPaymentDTO>