POST api/Policy360PaymentsGeneral/GetPaymentHistory

Get Previous Payments For PrimaryMember

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
EntityId	integer	None.
DueId	integer	None.
PolicyId	string	None.
DueDate	string	None.
PaymentDate	string	None.
PaymentMethod	string	None.
ConfirmationCode	string	None.
Currency	string	None.
Amount	string	None.
ReceiptId	integer	None.
Status	string	None.
SortParam	integer	None.
PageNumber	integer	None.
PageSize	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "EntityId": 1,
  "DueId": 2,
  "PolicyId": "sample string 3",
  "DueDate": "sample string 4",
  "PaymentDate": "sample string 5",
  "PaymentMethod": "sample string 6",
  "ConfirmationCode": "sample string 7",
  "Currency": "sample string 8",
  "Amount": "sample string 9",
  "ReceiptId": 1,
  "Status": "sample string 10",
  "SortParam": 1,
  "PageNumber": 1,
  "PageSize": 1
}

application/xml, text/xml

Sample:

<PaymentHistoryRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.AS.AgentPortal.Data.Models.Payments">
  <Amount>sample string 9</Amount>
  <ConfirmationCode>sample string 7</ConfirmationCode>
  <Currency>sample string 8</Currency>
  <DueDate>sample string 4</DueDate>
  <DueId>2</DueId>
  <EntityId>1</EntityId>
  <PageNumber>1</PageNumber>
  <PageSize>1</PageSize>
  <PaymentDate>sample string 5</PaymentDate>
  <PaymentMethod>sample string 6</PaymentMethod>
  <PolicyId>sample string 3</PolicyId>
  <ReceiptId>1</ReceiptId>
  <SortParam>1</SortParam>
  <Status>sample string 10</Status>
</PaymentHistoryRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of PaymentHistoryModel

Name	Type	Additional information
EntityId	integer	None.
ResponseId	integer	None.
ReceiptId	integer	None.
RequestId	integer	None.
DueId	integer	None.
PolicyId	integer	None.
Policies	Collection of PaymentPolicy	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-27T18:28:21.0548575-07:00",
        "Invoices": [
          {
            "InvoiceId": 1,
            "InvoiceDate": "2024-04-27T18:28:21.0548575-07:00",
            "DueDate": "2024-04-27T18:28:21.0548575-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-27T18:28:21.0548575-07:00",
            "DueDate": "2024-04-27T18:28:21.0548575-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-27T18:28:21.0548575-07:00",
        "Invoices": [
          {
            "InvoiceId": 1,
            "InvoiceDate": "2024-04-27T18:28:21.0548575-07:00",
            "DueDate": "2024-04-27T18:28:21.0548575-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-27T18:28:21.0548575-07:00",
            "DueDate": "2024-04-27T18:28:21.0548575-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-27T18:28:21.0548575-07:00",
    "PaymentDate": "2024-04-27T18:28:21.0548575-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-27T18:28:21.0548575-07:00",
        "Invoices": [
          {
            "InvoiceId": 1,
            "InvoiceDate": "2024-04-27T18:28:21.0548575-07:00",
            "DueDate": "2024-04-27T18:28:21.0548575-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-27T18:28:21.0548575-07:00",
            "DueDate": "2024-04-27T18:28:21.0548575-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-27T18:28:21.0548575-07:00",
        "Invoices": [
          {
            "InvoiceId": 1,
            "InvoiceDate": "2024-04-27T18:28:21.0548575-07:00",
            "DueDate": "2024-04-27T18:28:21.0548575-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-27T18:28:21.0548575-07:00",
            "DueDate": "2024-04-27T18:28:21.0548575-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-27T18:28:21.0548575-07:00",
    "PaymentDate": "2024-04-27T18:28:21.0548575-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:

<ArrayOfPaymentHistoryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.AS.AgentPortal.Data.Models.Payments">
  <PaymentHistoryModel>
    <Amount>2</Amount>
    <ConfirmationCode>sample string 10</ConfirmationCode>
    <Currency>sample string 7</Currency>
    <DueDate>2024-04-27T18:28:21.0548575-07:00</DueDate>
    <DueId>1</DueId>
    <EntityId>1</EntityId>
    <OrderId>sample string 8</OrderId>
    <PaymentDate>2024-04-27T18:28:21.0548575-07:00</PaymentDate>
    <PaymentMethod>sample string 5</PaymentMethod>
    <Policies>
      <PaymentPolicy>
        <Amount>7</Amount>
        <AmountAssigned>1</AmountAssigned>
        <Currency>sample string 6</Currency>
        <EffectiveDate>2024-04-27T18:28:21.0548575-07:00</EffectiveDate>
        <Invoices>
          <InvoiceDetails>
            <AmountCancelled>5</AmountCancelled>
            <AppliedAmount>4</AppliedAmount>
            <DueDate>2024-04-27T18:28:21.0548575-07:00</DueDate>
            <InvoiceDate>2024-04-27T18:28:21.0548575-07:00</InvoiceDate>
            <InvoiceDueAmount>1</InvoiceDueAmount>
            <InvoiceId>1</InvoiceId>
            <InvoicedAmount>1</InvoicedAmount>
            <PaidAmount>2</PaidAmount>
            <PayStatus>sample string 6</PayStatus>
            <WriteOffAmount>3</WriteOffAmount>
          </InvoiceDetails>
          <InvoiceDetails>
            <AmountCancelled>5</AmountCancelled>
            <AppliedAmount>4</AppliedAmount>
            <DueDate>2024-04-27T18:28:21.0548575-07:00</DueDate>
            <InvoiceDate>2024-04-27T18:28:21.0548575-07:00</InvoiceDate>
            <InvoiceDueAmount>1</InvoiceDueAmount>
            <InvoiceId>1</InvoiceId>
            <InvoicedAmount>1</InvoicedAmount>
            <PaidAmount>2</PaidAmount>
            <PayStatus>sample string 6</PayStatus>
            <WriteOffAmount>3</WriteOffAmount>
          </InvoiceDetails>
        </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>
      </PaymentPolicy>
      <PaymentPolicy>
        <Amount>7</Amount>
        <AmountAssigned>1</AmountAssigned>
        <Currency>sample string 6</Currency>
        <EffectiveDate>2024-04-27T18:28:21.0548575-07:00</EffectiveDate>
        <Invoices>
          <InvoiceDetails>
            <AmountCancelled>5</AmountCancelled>
            <AppliedAmount>4</AppliedAmount>
            <DueDate>2024-04-27T18:28:21.0548575-07:00</DueDate>
            <InvoiceDate>2024-04-27T18:28:21.0548575-07:00</InvoiceDate>
            <InvoiceDueAmount>1</InvoiceDueAmount>
            <InvoiceId>1</InvoiceId>
            <InvoicedAmount>1</InvoicedAmount>
            <PaidAmount>2</PaidAmount>
            <PayStatus>sample string 6</PayStatus>
            <WriteOffAmount>3</WriteOffAmount>
          </InvoiceDetails>
          <InvoiceDetails>
            <AmountCancelled>5</AmountCancelled>
            <AppliedAmount>4</AppliedAmount>
            <DueDate>2024-04-27T18:28:21.0548575-07:00</DueDate>
            <InvoiceDate>2024-04-27T18:28:21.0548575-07:00</InvoiceDate>
            <InvoiceDueAmount>1</InvoiceDueAmount>
            <InvoiceId>1</InvoiceId>
            <InvoicedAmount>1</InvoicedAmount>
            <PaidAmount>2</PaidAmount>
            <PayStatus>sample string 6</PayStatus>
            <WriteOffAmount>3</WriteOffAmount>
          </InvoiceDetails>
        </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>
      </PaymentPolicy>
    </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>
  </PaymentHistoryModel>
  <PaymentHistoryModel>
    <Amount>2</Amount>
    <ConfirmationCode>sample string 10</ConfirmationCode>
    <Currency>sample string 7</Currency>
    <DueDate>2024-04-27T18:28:21.0548575-07:00</DueDate>
    <DueId>1</DueId>
    <EntityId>1</EntityId>
    <OrderId>sample string 8</OrderId>
    <PaymentDate>2024-04-27T18:28:21.0548575-07:00</PaymentDate>
    <PaymentMethod>sample string 5</PaymentMethod>
    <Policies>
      <PaymentPolicy>
        <Amount>7</Amount>
        <AmountAssigned>1</AmountAssigned>
        <Currency>sample string 6</Currency>
        <EffectiveDate>2024-04-27T18:28:21.0548575-07:00</EffectiveDate>
        <Invoices>
          <InvoiceDetails>
            <AmountCancelled>5</AmountCancelled>
            <AppliedAmount>4</AppliedAmount>
            <DueDate>2024-04-27T18:28:21.0548575-07:00</DueDate>
            <InvoiceDate>2024-04-27T18:28:21.0548575-07:00</InvoiceDate>
            <InvoiceDueAmount>1</InvoiceDueAmount>
            <InvoiceId>1</InvoiceId>
            <InvoicedAmount>1</InvoicedAmount>
            <PaidAmount>2</PaidAmount>
            <PayStatus>sample string 6</PayStatus>
            <WriteOffAmount>3</WriteOffAmount>
          </InvoiceDetails>
          <InvoiceDetails>
            <AmountCancelled>5</AmountCancelled>
            <AppliedAmount>4</AppliedAmount>
            <DueDate>2024-04-27T18:28:21.0548575-07:00</DueDate>
            <InvoiceDate>2024-04-27T18:28:21.0548575-07:00</InvoiceDate>
            <InvoiceDueAmount>1</InvoiceDueAmount>
            <InvoiceId>1</InvoiceId>
            <InvoicedAmount>1</InvoicedAmount>
            <PaidAmount>2</PaidAmount>
            <PayStatus>sample string 6</PayStatus>
            <WriteOffAmount>3</WriteOffAmount>
          </InvoiceDetails>
        </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>
      </PaymentPolicy>
      <PaymentPolicy>
        <Amount>7</Amount>
        <AmountAssigned>1</AmountAssigned>
        <Currency>sample string 6</Currency>
        <EffectiveDate>2024-04-27T18:28:21.0548575-07:00</EffectiveDate>
        <Invoices>
          <InvoiceDetails>
            <AmountCancelled>5</AmountCancelled>
            <AppliedAmount>4</AppliedAmount>
            <DueDate>2024-04-27T18:28:21.0548575-07:00</DueDate>
            <InvoiceDate>2024-04-27T18:28:21.0548575-07:00</InvoiceDate>
            <InvoiceDueAmount>1</InvoiceDueAmount>
            <InvoiceId>1</InvoiceId>
            <InvoicedAmount>1</InvoicedAmount>
            <PaidAmount>2</PaidAmount>
            <PayStatus>sample string 6</PayStatus>
            <WriteOffAmount>3</WriteOffAmount>
          </InvoiceDetails>
          <InvoiceDetails>
            <AmountCancelled>5</AmountCancelled>
            <AppliedAmount>4</AppliedAmount>
            <DueDate>2024-04-27T18:28:21.0548575-07:00</DueDate>
            <InvoiceDate>2024-04-27T18:28:21.0548575-07:00</InvoiceDate>
            <InvoiceDueAmount>1</InvoiceDueAmount>
            <InvoiceId>1</InvoiceId>
            <InvoicedAmount>1</InvoicedAmount>
            <PaidAmount>2</PaidAmount>
            <PayStatus>sample string 6</PayStatus>
            <WriteOffAmount>3</WriteOffAmount>
          </InvoiceDetails>
        </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>
      </PaymentPolicy>
    </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>
  </PaymentHistoryModel>
</ArrayOfPaymentHistoryModel>

POST api/Policy360PaymentsGeneral/GetPaymentHistory

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml

URI parameters

Headers | Add header

Body

Status

Headers

Body