GET v1/Payment/PaidReceipt/PolicyNumber/{policyNumber}
Retrieve a Paid Receipt
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| policyNumber | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Retrieve a Paid Receipt
PaidReceiptOutboundDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| PolicyNumber | string |
String length: inclusive between 0 and 30 |
|
| EffectiveDate | date |
None. |
|
| ExpirationDate | date |
None. |
|
| WrittenPremium | decimal number |
None. |
|
| PolicyFee | decimal number |
None. |
|
| StateFeeOrTax | decimal number |
None. |
|
| BillingFee | decimal number |
None. |
|
| PolicyBalance | decimal number |
None. |
|
| LastPaymentAmount | decimal number |
None. |
|
| PaidInFull | string |
None. |
|
| InsuredCommercialName | string |
None. |
|
| InsuredFirstName | string |
None. |
|
| InsuredMiddleName | string |
None. |
|
| InsuredLastName | string |
None. |
|
| Address1 | string |
None. |
|
| Address2 | string |
None. |
|
| City | string |
None. |
|
| StateCode | string |
None. |
|
| Zipcode1 | string |
None. |
|
| Zipcode2 | string |
None. |
|
| RiskAddress1 | string |
None. |
|
| RiskAddress2 | string |
None. |
|
| RiskCity | string |
None. |
|
| RiskStateCode | string |
None. |
|
| RiskZipcode | string |
None. |
|
| RiskCityStZip | string |
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:
{
"PolicyNumber": "sample string 1",
"EffectiveDate": "2026-02-06T07:50:48.8854482-10:00",
"ExpirationDate": "2026-02-06T07:50:48.8854482-10:00",
"WrittenPremium": 1.0,
"PolicyFee": 1.0,
"StateFeeOrTax": 1.0,
"BillingFee": 1.0,
"PolicyBalance": 1.0,
"LastPaymentAmount": 1.0,
"PaidInFull": "sample string 2",
"InsuredCommercialName": "sample string 3",
"InsuredFirstName": "sample string 4",
"InsuredMiddleName": "sample string 5",
"InsuredLastName": "sample string 6",
"Address1": "sample string 7",
"Address2": "sample string 8",
"City": "sample string 9",
"StateCode": "sample string 10",
"Zipcode1": "sample string 11",
"Zipcode2": "sample string 12",
"RiskAddress1": "sample string 13",
"RiskAddress2": "sample string 14",
"RiskCity": "sample string 15",
"RiskStateCode": "sample string 16",
"RiskZipcode": "sample string 17",
"RiskCityStZip": "sample string 18",
"Id": 19
}
application/xml, text/xml
Sample:
<PaidReceiptOutboundDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound"> <Id>19</Id> <Address1>sample string 7</Address1> <Address2>sample string 8</Address2> <BillingFee>1</BillingFee> <City>sample string 9</City> <EffectiveDate>2026-02-06T07:50:48.8854482-10:00</EffectiveDate> <ExpirationDate>2026-02-06T07:50:48.8854482-10:00</ExpirationDate> <InsuredCommercialName>sample string 3</InsuredCommercialName> <InsuredFirstName>sample string 4</InsuredFirstName> <InsuredLastName>sample string 6</InsuredLastName> <InsuredMiddleName>sample string 5</InsuredMiddleName> <LastPaymentAmount>1</LastPaymentAmount> <PaidInFull>sample string 2</PaidInFull> <PolicyBalance>1</PolicyBalance> <PolicyFee>1</PolicyFee> <PolicyNumber>sample string 1</PolicyNumber> <RiskAddress1>sample string 13</RiskAddress1> <RiskAddress2>sample string 14</RiskAddress2> <RiskCity>sample string 15</RiskCity> <RiskCityStZip>sample string 18</RiskCityStZip> <RiskStateCode>sample string 16</RiskStateCode> <RiskZipcode>sample string 17</RiskZipcode> <StateCode>sample string 10</StateCode> <StateFeeOrTax>1</StateFeeOrTax> <WrittenPremium>1</WrittenPremium> <Zipcode1>sample string 11</Zipcode1> <Zipcode2>sample string 12</Zipcode2> </PaidReceiptOutboundDTO>