GET api/Policy360PaymentsGeneral/GetPolicy360PaymentDetailsForPayments?policyId={policyId}&effectiveDate={effectiveDate}

Get Policy360 payment details for Online Payments

Request Information

URI Parameters

NameDescriptionTypeAdditional information
policyId

string

Required
effectiveDate

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of Invoice
NameDescriptionTypeAdditional information
InvoiceId

integer

None.
InvoiceDate

date

None.
InvoicedAmount

decimal number

None.
PaidAmount

decimal number

None.
WriteOffAmount

decimal number

None.
AppliedAmount

decimal number

None.
AmountCancelled

decimal number

None.
InvoiceDueAmount

decimal number

None.
PayStatus

string

None.
TotalPaidAmount

decimal number

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "InvoiceId": 1,
    "InvoiceDate": "2024-04-28T10:45:12.4357072-07:00",
    "InvoicedAmount": 1.0,
    "PaidAmount": 2.0,
    "WriteOffAmount": 3.0,
    "AppliedAmount": 4.0,
    "AmountCancelled": 5.0,
    "InvoiceDueAmount": 1.0,
    "PayStatus": "sample string 6",
    "TotalPaidAmount": 1.0
  },
  {
    "InvoiceId": 1,
    "InvoiceDate": "2024-04-28T10:45:12.4357072-07:00",
    "InvoicedAmount": 1.0,
    "PaidAmount": 2.0,
    "WriteOffAmount": 3.0,
    "AppliedAmount": 4.0,
    "AmountCancelled": 5.0,
    "InvoiceDueAmount": 1.0,
    "PayStatus": "sample string 6",
    "TotalPaidAmount": 1.0
  }
]

application/xml, text/xml

Sample: 
<ArrayOfInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.AS.AgentPortal.Data.Models.Policy">
  <Invoice>
    <AmountCancelled>5</AmountCancelled>
    <AppliedAmount>4</AppliedAmount>
    <InvoiceDate>2024-04-28T10:45:12.4357072-07:00</InvoiceDate>
    <InvoiceDueAmount>1</InvoiceDueAmount>
    <InvoiceId>1</InvoiceId>
    <InvoicedAmount>1</InvoicedAmount>
    <PaidAmount>2</PaidAmount>
    <PayStatus>sample string 6</PayStatus>
    <TotalPaidAmount>1</TotalPaidAmount>
    <WriteOffAmount>3</WriteOffAmount>
  </Invoice>
  <Invoice>
    <AmountCancelled>5</AmountCancelled>
    <AppliedAmount>4</AppliedAmount>
    <InvoiceDate>2024-04-28T10:45:12.4357072-07:00</InvoiceDate>
    <InvoiceDueAmount>1</InvoiceDueAmount>
    <InvoiceId>1</InvoiceId>
    <InvoicedAmount>1</InvoicedAmount>
    <PaidAmount>2</PaidAmount>
    <PayStatus>sample string 6</PayStatus>
    <TotalPaidAmount>1</TotalPaidAmount>
    <WriteOffAmount>3</WriteOffAmount>
  </Invoice>
</ArrayOfInvoice>