POST api/Payment/GetPreviousPayments

Get Previous Payments For PrimaryMember

Request Information

URI Parameters

None.

Body Parameters

PreviousPaymentsRequestModel
NameDescriptionTypeAdditional 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: 
<PreviousPaymentsRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.MemberPortal.Data.Models.Payment">
  <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>
</PreviousPaymentsRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of PreviousPaymentsResponseModel
NameDescriptionTypeAdditional 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": "2025-05-02T07:58:15.4046486-07:00",
        "RVFReferenceId": "sample string 8",
        "Invoices": [
          {
            "InvoiceId": 1,
            "InvoiceDate": "2025-05-02T07:58:15.4046486-07:00",
            "DueDate": "2025-05-02T07:58:15.4046486-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": "2025-05-02T07:58:15.4046486-07:00",
            "DueDate": "2025-05-02T07:58:15.4046486-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": "2025-05-02T07:58:15.4046486-07:00",
        "RVFReferenceId": "sample string 8",
        "Invoices": [
          {
            "InvoiceId": 1,
            "InvoiceDate": "2025-05-02T07:58:15.4046486-07:00",
            "DueDate": "2025-05-02T07:58:15.4046486-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": "2025-05-02T07:58:15.4046486-07:00",
            "DueDate": "2025-05-02T07:58:15.4046486-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": "2025-05-02T07:58:15.4046486-07:00",
    "PaymentDate": "2025-05-02T07:58:15.4046486-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": "2025-05-02T07:58:15.4046486-07:00",
        "RVFReferenceId": "sample string 8",
        "Invoices": [
          {
            "InvoiceId": 1,
            "InvoiceDate": "2025-05-02T07:58:15.4046486-07:00",
            "DueDate": "2025-05-02T07:58:15.4046486-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": "2025-05-02T07:58:15.4046486-07:00",
            "DueDate": "2025-05-02T07:58:15.4046486-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": "2025-05-02T07:58:15.4046486-07:00",
        "RVFReferenceId": "sample string 8",
        "Invoices": [
          {
            "InvoiceId": 1,
            "InvoiceDate": "2025-05-02T07:58:15.4046486-07:00",
            "DueDate": "2025-05-02T07:58:15.4046486-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": "2025-05-02T07:58:15.4046486-07:00",
            "DueDate": "2025-05-02T07:58:15.4046486-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": "2025-05-02T07:58:15.4046486-07:00",
    "PaymentDate": "2025-05-02T07:58:15.4046486-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: 
<ArrayOfPreviousPaymentsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.MemberPortal.Data.Models.Payment">
  <PreviousPaymentsResponseModel>
    <Amount>2</Amount>
    <ConfirmationCode>sample string 10</ConfirmationCode>
    <Currency>sample string 7</Currency>
    <DueDate>2025-05-02T07:58:15.4046486-07:00</DueDate>
    <DueId>1</DueId>
    <EntityId>1</EntityId>
    <OrderId>sample string 8</OrderId>
    <PaymentDate>2025-05-02T07:58:15.4046486-07:00</PaymentDate>
    <PaymentMethod>sample string 5</PaymentMethod>
    <Policies xmlns:d3p1="http://schemas.datacontract.org/2004/07/GBG.MemberPortal.Web.Models.Payments">
      <d3p1:PaymentPolicy>
        <d3p1:Amount>7</d3p1:Amount>
        <d3p1:AmountAssigned>1</d3p1:AmountAssigned>
        <d3p1:Currency>sample string 6</d3p1:Currency>
        <d3p1:EffectiveDate>2025-05-02T07:58:15.4046486-07:00</d3p1:EffectiveDate>
        <d3p1:Invoices>
          <InvoiceDetails>
            <AmountCancelled>5</AmountCancelled>
            <AppliedAmount>4</AppliedAmount>
            <DueDate>2025-05-02T07:58:15.4046486-07:00</DueDate>
            <InvoiceDate>2025-05-02T07:58:15.4046486-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>2025-05-02T07:58:15.4046486-07:00</DueDate>
            <InvoiceDate>2025-05-02T07:58:15.4046486-07:00</InvoiceDate>
            <InvoiceDueAmount>1</InvoiceDueAmount>
            <InvoiceId>1</InvoiceId>
            <InvoicedAmount>1</InvoicedAmount>
            <PaidAmount>2</PaidAmount>
            <PayStatus>sample string 6</PayStatus>
            <WriteOffAmount>3</WriteOffAmount>
          </InvoiceDetails>
        </d3p1:Invoices>
        <d3p1:PolicyCategory>sample string 1</d3p1:PolicyCategory>
        <d3p1:PolicyId>sample string 4</d3p1:PolicyId>
        <d3p1:PolicyNo>sample string 5</d3p1:PolicyNo>
        <d3p1:PolicyType>sample string 2</d3p1:PolicyType>
        <d3p1:ProductName>sample string 3</d3p1:ProductName>
        <d3p1:RVFReferenceId>sample string 8</d3p1:RVFReferenceId>
      </d3p1:PaymentPolicy>
      <d3p1:PaymentPolicy>
        <d3p1:Amount>7</d3p1:Amount>
        <d3p1:AmountAssigned>1</d3p1:AmountAssigned>
        <d3p1:Currency>sample string 6</d3p1:Currency>
        <d3p1:EffectiveDate>2025-05-02T07:58:15.4046486-07:00</d3p1:EffectiveDate>
        <d3p1:Invoices>
          <InvoiceDetails>
            <AmountCancelled>5</AmountCancelled>
            <AppliedAmount>4</AppliedAmount>
            <DueDate>2025-05-02T07:58:15.4046486-07:00</DueDate>
            <InvoiceDate>2025-05-02T07:58:15.4046486-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>2025-05-02T07:58:15.4046486-07:00</DueDate>
            <InvoiceDate>2025-05-02T07:58:15.4046486-07:00</InvoiceDate>
            <InvoiceDueAmount>1</InvoiceDueAmount>
            <InvoiceId>1</InvoiceId>
            <InvoicedAmount>1</InvoicedAmount>
            <PaidAmount>2</PaidAmount>
            <PayStatus>sample string 6</PayStatus>
            <WriteOffAmount>3</WriteOffAmount>
          </InvoiceDetails>
        </d3p1:Invoices>
        <d3p1:PolicyCategory>sample string 1</d3p1:PolicyCategory>
        <d3p1:PolicyId>sample string 4</d3p1:PolicyId>
        <d3p1:PolicyNo>sample string 5</d3p1:PolicyNo>
        <d3p1:PolicyType>sample string 2</d3p1:PolicyType>
        <d3p1:ProductName>sample string 3</d3p1:ProductName>
        <d3p1:RVFReferenceId>sample string 8</d3p1:RVFReferenceId>
      </d3p1: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>
  </PreviousPaymentsResponseModel>
  <PreviousPaymentsResponseModel>
    <Amount>2</Amount>
    <ConfirmationCode>sample string 10</ConfirmationCode>
    <Currency>sample string 7</Currency>
    <DueDate>2025-05-02T07:58:15.4046486-07:00</DueDate>
    <DueId>1</DueId>
    <EntityId>1</EntityId>
    <OrderId>sample string 8</OrderId>
    <PaymentDate>2025-05-02T07:58:15.4046486-07:00</PaymentDate>
    <PaymentMethod>sample string 5</PaymentMethod>
    <Policies xmlns:d3p1="http://schemas.datacontract.org/2004/07/GBG.MemberPortal.Web.Models.Payments">
      <d3p1:PaymentPolicy>
        <d3p1:Amount>7</d3p1:Amount>
        <d3p1:AmountAssigned>1</d3p1:AmountAssigned>
        <d3p1:Currency>sample string 6</d3p1:Currency>
        <d3p1:EffectiveDate>2025-05-02T07:58:15.4046486-07:00</d3p1:EffectiveDate>
        <d3p1:Invoices>
          <InvoiceDetails>
            <AmountCancelled>5</AmountCancelled>
            <AppliedAmount>4</AppliedAmount>
            <DueDate>2025-05-02T07:58:15.4046486-07:00</DueDate>
            <InvoiceDate>2025-05-02T07:58:15.4046486-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>2025-05-02T07:58:15.4046486-07:00</DueDate>
            <InvoiceDate>2025-05-02T07:58:15.4046486-07:00</InvoiceDate>
            <InvoiceDueAmount>1</InvoiceDueAmount>
            <InvoiceId>1</InvoiceId>
            <InvoicedAmount>1</InvoicedAmount>
            <PaidAmount>2</PaidAmount>
            <PayStatus>sample string 6</PayStatus>
            <WriteOffAmount>3</WriteOffAmount>
          </InvoiceDetails>
        </d3p1:Invoices>
        <d3p1:PolicyCategory>sample string 1</d3p1:PolicyCategory>
        <d3p1:PolicyId>sample string 4</d3p1:PolicyId>
        <d3p1:PolicyNo>sample string 5</d3p1:PolicyNo>
        <d3p1:PolicyType>sample string 2</d3p1:PolicyType>
        <d3p1:ProductName>sample string 3</d3p1:ProductName>
        <d3p1:RVFReferenceId>sample string 8</d3p1:RVFReferenceId>
      </d3p1:PaymentPolicy>
      <d3p1:PaymentPolicy>
        <d3p1:Amount>7</d3p1:Amount>
        <d3p1:AmountAssigned>1</d3p1:AmountAssigned>
        <d3p1:Currency>sample string 6</d3p1:Currency>
        <d3p1:EffectiveDate>2025-05-02T07:58:15.4046486-07:00</d3p1:EffectiveDate>
        <d3p1:Invoices>
          <InvoiceDetails>
            <AmountCancelled>5</AmountCancelled>
            <AppliedAmount>4</AppliedAmount>
            <DueDate>2025-05-02T07:58:15.4046486-07:00</DueDate>
            <InvoiceDate>2025-05-02T07:58:15.4046486-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>2025-05-02T07:58:15.4046486-07:00</DueDate>
            <InvoiceDate>2025-05-02T07:58:15.4046486-07:00</InvoiceDate>
            <InvoiceDueAmount>1</InvoiceDueAmount>
            <InvoiceId>1</InvoiceId>
            <InvoicedAmount>1</InvoicedAmount>
            <PaidAmount>2</PaidAmount>
            <PayStatus>sample string 6</PayStatus>
            <WriteOffAmount>3</WriteOffAmount>
          </InvoiceDetails>
        </d3p1:Invoices>
        <d3p1:PolicyCategory>sample string 1</d3p1:PolicyCategory>
        <d3p1:PolicyId>sample string 4</d3p1:PolicyId>
        <d3p1:PolicyNo>sample string 5</d3p1:PolicyNo>
        <d3p1:PolicyType>sample string 2</d3p1:PolicyType>
        <d3p1:ProductName>sample string 3</d3p1:ProductName>
        <d3p1:RVFReferenceId>sample string 8</d3p1:RVFReferenceId>
      </d3p1: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>
  </PreviousPaymentsResponseModel>
</ArrayOfPreviousPaymentsResponseModel>