POST api/Policy360Renewal/GetRenewalPaymentHistory
Get Previous Payments For PrimaryMember
Request Information
URI Parameters
None.
Body Parameters
RenewalPaymentHistoryRequestModelName | Description | Type | Additional information |
---|---|---|---|
PolicyId | integer |
None. |
|
EffectiveDate | string |
None. |
|
PaymentDate | string |
None. |
|
PaymentMethod | string |
None. |
|
Currency | string |
None. |
|
Amount | string |
None. |
|
Status | string |
None. |
|
SortParam | integer |
None. |
|
PageNumber | integer |
None. |
|
PageSize | integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "PolicyId": 1, "EffectiveDate": "sample string 2", "PaymentDate": "sample string 3", "PaymentMethod": "sample string 4", "Currency": "sample string 5", "Amount": "sample string 6", "Status": "sample string 7", "SortParam": 1, "PageNumber": 1, "PageSize": 1 }
application/xml, text/xml
Sample:
<RenewalPaymentHistoryRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.AS.AgentPortal.Data.Models.Renewals"> <Amount>sample string 6</Amount> <Currency>sample string 5</Currency> <EffectiveDate>sample string 2</EffectiveDate> <PageNumber>1</PageNumber> <PageSize>1</PageSize> <PaymentDate>sample string 3</PaymentDate> <PaymentMethod>sample string 4</PaymentMethod> <PolicyId>1</PolicyId> <SortParam>1</SortParam> <Status>sample string 7</Status> </RenewalPaymentHistoryRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of RenewalPaymentHistoryModelName | Description | Type | Additional information |
---|---|---|---|
EntityId | integer |
None. |
|
ResponseId | integer |
None. |
|
ReceiptId | integer |
None. |
|
RequestId | integer |
None. |
|
DueId | integer |
None. |
|
PolicyId | integer |
None. |
|
Policies | Collection of RenewalPaymentPolicy |
None. |
|
Amount | decimal number |
None. |
|
DueDate | date |
None. |
|
PaymentDate | date |
None. |
|
PaymentMethod | string |
None. |
|
Status | string |
None. |
|
Currency | string |
None. |
|
OrderId | string |
None. |
|
SessionKey | string |
None. |
|
ConfirmationCode | string |
None. |
|
TotalCount | integer |
None. |
Response Formats
application/json, text/json
Sample:
[ { "EntityId": 1, "ResponseId": 1, "ReceiptId": 1, "RequestId": 1, "DueId": 1, "PolicyId": 1, "Policies": [ { "PolicyCategory": "sample string 1", "PolicyType": "sample string 2", "ProductName": "sample string 3", "PolicyId": "sample string 4", "PolicyNo": "sample string 5", "Currency": "sample string 6", "Amount": 7.0, "AmountAssigned": 1.0, "EffectiveDate": "2024-04-28T07:39:02.9241597-07:00", "Invoices": [ { "InvoiceId": 1, "InvoiceDate": "2024-04-28T07:39:02.9241597-07:00", "DueDate": "2024-04-28T07:39:02.9241597-07:00", "InvoicedAmount": 1.0, "PaidAmount": 2.0, "WriteOffAmount": 3.0, "AppliedAmount": 4.0, "AmountCancelled": 5.0, "InvoiceDueAmount": 1.0, "PayStatus": "sample string 6" }, { "InvoiceId": 1, "InvoiceDate": "2024-04-28T07:39:02.9241597-07:00", "DueDate": "2024-04-28T07:39:02.9241597-07:00", "InvoicedAmount": 1.0, "PaidAmount": 2.0, "WriteOffAmount": 3.0, "AppliedAmount": 4.0, "AmountCancelled": 5.0, "InvoiceDueAmount": 1.0, "PayStatus": "sample string 6" } ] }, { "PolicyCategory": "sample string 1", "PolicyType": "sample string 2", "ProductName": "sample string 3", "PolicyId": "sample string 4", "PolicyNo": "sample string 5", "Currency": "sample string 6", "Amount": 7.0, "AmountAssigned": 1.0, "EffectiveDate": "2024-04-28T07:39:02.9241597-07:00", "Invoices": [ { "InvoiceId": 1, "InvoiceDate": "2024-04-28T07:39:02.9241597-07:00", "DueDate": "2024-04-28T07:39:02.9241597-07:00", "InvoicedAmount": 1.0, "PaidAmount": 2.0, "WriteOffAmount": 3.0, "AppliedAmount": 4.0, "AmountCancelled": 5.0, "InvoiceDueAmount": 1.0, "PayStatus": "sample string 6" }, { "InvoiceId": 1, "InvoiceDate": "2024-04-28T07:39:02.9241597-07:00", "DueDate": "2024-04-28T07:39:02.9241597-07:00", "InvoicedAmount": 1.0, "PaidAmount": 2.0, "WriteOffAmount": 3.0, "AppliedAmount": 4.0, "AmountCancelled": 5.0, "InvoiceDueAmount": 1.0, "PayStatus": "sample string 6" } ] } ], "Amount": 2.0, "DueDate": "2024-04-28T07:39:02.9241597-07:00", "PaymentDate": "2024-04-28T07:39:02.9241597-07:00", "PaymentMethod": "sample string 5", "Status": "sample string 6", "Currency": "sample string 7", "OrderId": "sample string 8", "SessionKey": "sample string 9", "ConfirmationCode": "sample string 10", "TotalCount": 1 }, { "EntityId": 1, "ResponseId": 1, "ReceiptId": 1, "RequestId": 1, "DueId": 1, "PolicyId": 1, "Policies": [ { "PolicyCategory": "sample string 1", "PolicyType": "sample string 2", "ProductName": "sample string 3", "PolicyId": "sample string 4", "PolicyNo": "sample string 5", "Currency": "sample string 6", "Amount": 7.0, "AmountAssigned": 1.0, "EffectiveDate": "2024-04-28T07:39:02.9241597-07:00", "Invoices": [ { "InvoiceId": 1, "InvoiceDate": "2024-04-28T07:39:02.9241597-07:00", "DueDate": "2024-04-28T07:39:02.9241597-07:00", "InvoicedAmount": 1.0, "PaidAmount": 2.0, "WriteOffAmount": 3.0, "AppliedAmount": 4.0, "AmountCancelled": 5.0, "InvoiceDueAmount": 1.0, "PayStatus": "sample string 6" }, { "InvoiceId": 1, "InvoiceDate": "2024-04-28T07:39:02.9241597-07:00", "DueDate": "2024-04-28T07:39:02.9241597-07:00", "InvoicedAmount": 1.0, "PaidAmount": 2.0, "WriteOffAmount": 3.0, "AppliedAmount": 4.0, "AmountCancelled": 5.0, "InvoiceDueAmount": 1.0, "PayStatus": "sample string 6" } ] }, { "PolicyCategory": "sample string 1", "PolicyType": "sample string 2", "ProductName": "sample string 3", "PolicyId": "sample string 4", "PolicyNo": "sample string 5", "Currency": "sample string 6", "Amount": 7.0, "AmountAssigned": 1.0, "EffectiveDate": "2024-04-28T07:39:02.9241597-07:00", "Invoices": [ { "InvoiceId": 1, "InvoiceDate": "2024-04-28T07:39:02.9241597-07:00", "DueDate": "2024-04-28T07:39:02.9241597-07:00", "InvoicedAmount": 1.0, "PaidAmount": 2.0, "WriteOffAmount": 3.0, "AppliedAmount": 4.0, "AmountCancelled": 5.0, "InvoiceDueAmount": 1.0, "PayStatus": "sample string 6" }, { "InvoiceId": 1, "InvoiceDate": "2024-04-28T07:39:02.9241597-07:00", "DueDate": "2024-04-28T07:39:02.9241597-07:00", "InvoicedAmount": 1.0, "PaidAmount": 2.0, "WriteOffAmount": 3.0, "AppliedAmount": 4.0, "AmountCancelled": 5.0, "InvoiceDueAmount": 1.0, "PayStatus": "sample string 6" } ] } ], "Amount": 2.0, "DueDate": "2024-04-28T07:39:02.9241597-07:00", "PaymentDate": "2024-04-28T07:39:02.9241597-07:00", "PaymentMethod": "sample string 5", "Status": "sample string 6", "Currency": "sample string 7", "OrderId": "sample string 8", "SessionKey": "sample string 9", "ConfirmationCode": "sample string 10", "TotalCount": 1 } ]
application/xml, text/xml
Sample:
<ArrayOfRenewalPaymentHistoryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.AS.AgentPortal.Data.Models.Renewals"> <RenewalPaymentHistoryModel> <Amount>2</Amount> <ConfirmationCode>sample string 10</ConfirmationCode> <Currency>sample string 7</Currency> <DueDate>2024-04-28T07:39:02.9241597-07:00</DueDate> <DueId>1</DueId> <EntityId>1</EntityId> <OrderId>sample string 8</OrderId> <PaymentDate>2024-04-28T07:39:02.9241597-07:00</PaymentDate> <PaymentMethod>sample string 5</PaymentMethod> <Policies> <RenewalPaymentPolicy> <Amount>7</Amount> <AmountAssigned>1</AmountAssigned> <Currency>sample string 6</Currency> <EffectiveDate>2024-04-28T07:39:02.9241597-07:00</EffectiveDate> <Invoices> <RenewalInvoiceDetails> <AmountCancelled>5</AmountCancelled> <AppliedAmount>4</AppliedAmount> <DueDate>2024-04-28T07:39:02.9241597-07:00</DueDate> <InvoiceDate>2024-04-28T07:39:02.9241597-07:00</InvoiceDate> <InvoiceDueAmount>1</InvoiceDueAmount> <InvoiceId>1</InvoiceId> <InvoicedAmount>1</InvoicedAmount> <PaidAmount>2</PaidAmount> <PayStatus>sample string 6</PayStatus> <WriteOffAmount>3</WriteOffAmount> </RenewalInvoiceDetails> <RenewalInvoiceDetails> <AmountCancelled>5</AmountCancelled> <AppliedAmount>4</AppliedAmount> <DueDate>2024-04-28T07:39:02.9241597-07:00</DueDate> <InvoiceDate>2024-04-28T07:39:02.9241597-07:00</InvoiceDate> <InvoiceDueAmount>1</InvoiceDueAmount> <InvoiceId>1</InvoiceId> <InvoicedAmount>1</InvoicedAmount> <PaidAmount>2</PaidAmount> <PayStatus>sample string 6</PayStatus> <WriteOffAmount>3</WriteOffAmount> </RenewalInvoiceDetails> </Invoices> <PolicyCategory>sample string 1</PolicyCategory> <PolicyId>sample string 4</PolicyId> <PolicyNo>sample string 5</PolicyNo> <PolicyType>sample string 2</PolicyType> <ProductName>sample string 3</ProductName> </RenewalPaymentPolicy> <RenewalPaymentPolicy> <Amount>7</Amount> <AmountAssigned>1</AmountAssigned> <Currency>sample string 6</Currency> <EffectiveDate>2024-04-28T07:39:02.9241597-07:00</EffectiveDate> <Invoices> <RenewalInvoiceDetails> <AmountCancelled>5</AmountCancelled> <AppliedAmount>4</AppliedAmount> <DueDate>2024-04-28T07:39:02.9241597-07:00</DueDate> <InvoiceDate>2024-04-28T07:39:02.9241597-07:00</InvoiceDate> <InvoiceDueAmount>1</InvoiceDueAmount> <InvoiceId>1</InvoiceId> <InvoicedAmount>1</InvoicedAmount> <PaidAmount>2</PaidAmount> <PayStatus>sample string 6</PayStatus> <WriteOffAmount>3</WriteOffAmount> </RenewalInvoiceDetails> <RenewalInvoiceDetails> <AmountCancelled>5</AmountCancelled> <AppliedAmount>4</AppliedAmount> <DueDate>2024-04-28T07:39:02.9241597-07:00</DueDate> <InvoiceDate>2024-04-28T07:39:02.9241597-07:00</InvoiceDate> <InvoiceDueAmount>1</InvoiceDueAmount> <InvoiceId>1</InvoiceId> <InvoicedAmount>1</InvoicedAmount> <PaidAmount>2</PaidAmount> <PayStatus>sample string 6</PayStatus> <WriteOffAmount>3</WriteOffAmount> </RenewalInvoiceDetails> </Invoices> <PolicyCategory>sample string 1</PolicyCategory> <PolicyId>sample string 4</PolicyId> <PolicyNo>sample string 5</PolicyNo> <PolicyType>sample string 2</PolicyType> <ProductName>sample string 3</ProductName> </RenewalPaymentPolicy> </Policies> <PolicyId>1</PolicyId> <ReceiptId>1</ReceiptId> <RequestId>1</RequestId> <ResponseId>1</ResponseId> <SessionKey>sample string 9</SessionKey> <Status>sample string 6</Status> <TotalCount>1</TotalCount> </RenewalPaymentHistoryModel> <RenewalPaymentHistoryModel> <Amount>2</Amount> <ConfirmationCode>sample string 10</ConfirmationCode> <Currency>sample string 7</Currency> <DueDate>2024-04-28T07:39:02.9241597-07:00</DueDate> <DueId>1</DueId> <EntityId>1</EntityId> <OrderId>sample string 8</OrderId> <PaymentDate>2024-04-28T07:39:02.9241597-07:00</PaymentDate> <PaymentMethod>sample string 5</PaymentMethod> <Policies> <RenewalPaymentPolicy> <Amount>7</Amount> <AmountAssigned>1</AmountAssigned> <Currency>sample string 6</Currency> <EffectiveDate>2024-04-28T07:39:02.9241597-07:00</EffectiveDate> <Invoices> <RenewalInvoiceDetails> <AmountCancelled>5</AmountCancelled> <AppliedAmount>4</AppliedAmount> <DueDate>2024-04-28T07:39:02.9241597-07:00</DueDate> <InvoiceDate>2024-04-28T07:39:02.9241597-07:00</InvoiceDate> <InvoiceDueAmount>1</InvoiceDueAmount> <InvoiceId>1</InvoiceId> <InvoicedAmount>1</InvoicedAmount> <PaidAmount>2</PaidAmount> <PayStatus>sample string 6</PayStatus> <WriteOffAmount>3</WriteOffAmount> </RenewalInvoiceDetails> <RenewalInvoiceDetails> <AmountCancelled>5</AmountCancelled> <AppliedAmount>4</AppliedAmount> <DueDate>2024-04-28T07:39:02.9241597-07:00</DueDate> <InvoiceDate>2024-04-28T07:39:02.9241597-07:00</InvoiceDate> <InvoiceDueAmount>1</InvoiceDueAmount> <InvoiceId>1</InvoiceId> <InvoicedAmount>1</InvoicedAmount> <PaidAmount>2</PaidAmount> <PayStatus>sample string 6</PayStatus> <WriteOffAmount>3</WriteOffAmount> </RenewalInvoiceDetails> </Invoices> <PolicyCategory>sample string 1</PolicyCategory> <PolicyId>sample string 4</PolicyId> <PolicyNo>sample string 5</PolicyNo> <PolicyType>sample string 2</PolicyType> <ProductName>sample string 3</ProductName> </RenewalPaymentPolicy> <RenewalPaymentPolicy> <Amount>7</Amount> <AmountAssigned>1</AmountAssigned> <Currency>sample string 6</Currency> <EffectiveDate>2024-04-28T07:39:02.9241597-07:00</EffectiveDate> <Invoices> <RenewalInvoiceDetails> <AmountCancelled>5</AmountCancelled> <AppliedAmount>4</AppliedAmount> <DueDate>2024-04-28T07:39:02.9241597-07:00</DueDate> <InvoiceDate>2024-04-28T07:39:02.9241597-07:00</InvoiceDate> <InvoiceDueAmount>1</InvoiceDueAmount> <InvoiceId>1</InvoiceId> <InvoicedAmount>1</InvoicedAmount> <PaidAmount>2</PaidAmount> <PayStatus>sample string 6</PayStatus> <WriteOffAmount>3</WriteOffAmount> </RenewalInvoiceDetails> <RenewalInvoiceDetails> <AmountCancelled>5</AmountCancelled> <AppliedAmount>4</AppliedAmount> <DueDate>2024-04-28T07:39:02.9241597-07:00</DueDate> <InvoiceDate>2024-04-28T07:39:02.9241597-07:00</InvoiceDate> <InvoiceDueAmount>1</InvoiceDueAmount> <InvoiceId>1</InvoiceId> <InvoicedAmount>1</InvoicedAmount> <PaidAmount>2</PaidAmount> <PayStatus>sample string 6</PayStatus> <WriteOffAmount>3</WriteOffAmount> </RenewalInvoiceDetails> </Invoices> <PolicyCategory>sample string 1</PolicyCategory> <PolicyId>sample string 4</PolicyId> <PolicyNo>sample string 5</PolicyNo> <PolicyType>sample string 2</PolicyType> <ProductName>sample string 3</ProductName> </RenewalPaymentPolicy> </Policies> <PolicyId>1</PolicyId> <ReceiptId>1</ReceiptId> <RequestId>1</RequestId> <ResponseId>1</ResponseId> <SessionKey>sample string 9</SessionKey> <Status>sample string 6</Status> <TotalCount>1</TotalCount> </RenewalPaymentHistoryModel> </ArrayOfRenewalPaymentHistoryModel>