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

Get Policy360 Invoice details for Online Payments

Request Information

URI Parameters

NameDescriptionTypeAdditional information
policyId

string

Required
effectiveDate

string

Required

Body Parameters

None.

Response Information

Resource Description

PolicyPaymentData
NameDescriptionTypeAdditional information
PolicyDetails

PolicyDetailForPayment

None.
PolicyInvoice

Collection of Invoice

None.
PolicyCredits

PolicyPremiumDues

None.

Response Formats

application/json, text/json

Sample: 
{
  "PolicyDetails": {
    "MembershipId": "sample string 1",
    "PolicyCategory": "sample string 2",
    "PolicyType": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "PaymentAmount": 6.0,
    "Address": "sample string 7",
    "City": "sample string 8",
    "State": "sample string 9",
    "StateList": "sample string 10",
    "Country": "sample string 11",
    "Zip": "sample string 12",
    "PhoneNumber": "sample string 13",
    "Fax": "sample string 14",
    "Email": "sample string 15",
    "Currency": "sample string 16",
    "LangCd": "sample string 17",
    "PolicyHolderId": 18,
    "PolicyId": 19,
    "EffectiveDate": "2024-04-28T09:14:07.1191742-07:00",
    "PaymentGateway": "sample string 21",
    "ProductName": "sample string 22",
    "PolicyNo": "sample string 23",
    "IsTrustPolicy": true,
    "InitiatedScreen": "sample string 25"
  },
  "PolicyInvoice": [
    {
      "InvoiceId": 1,
      "InvoiceDate": "2024-04-28T09:14:07.1191742-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-28T09:14:07.1191742-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
    }
  ],
  "PolicyCredits": {
    "PolicyId": 1,
    "EffectiveDate": "2024-04-28T09:14:07.1191742-07:00",
    "PremiumDue": 1.0,
    "Credits": 1.0,
    "PaidAmount": 1.0,
    "Balance": 1.0,
    "OutstandingBalance": 1.0
  }
}

application/xml, text/xml

Sample: 
<PolicyPaymentData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.AS.AgentPortal.Data.Models.Policy">
  <PolicyCredits>
    <Balance>1</Balance>
    <Credits>1</Credits>
    <EffectiveDate>2024-04-28T09:14:07.1191742-07:00</EffectiveDate>
    <OutstandingBalance>1</OutstandingBalance>
    <PaidAmount>1</PaidAmount>
    <PolicyId>1</PolicyId>
    <PremiumDue>1</PremiumDue>
  </PolicyCredits>
  <PolicyDetails>
    <Address>sample string 7</Address>
    <City>sample string 8</City>
    <Country>sample string 11</Country>
    <Currency>sample string 16</Currency>
    <EffectiveDate>2024-04-28T09:14:07.1191742-07:00</EffectiveDate>
    <Email>sample string 15</Email>
    <Fax>sample string 14</Fax>
    <FirstName>sample string 4</FirstName>
    <InitiatedScreen>sample string 25</InitiatedScreen>
    <IsTrustPolicy>true</IsTrustPolicy>
    <LangCd>sample string 17</LangCd>
    <LastName>sample string 5</LastName>
    <MembershipId>sample string 1</MembershipId>
    <PaymentAmount>6</PaymentAmount>
    <PaymentGateway>sample string 21</PaymentGateway>
    <PhoneNumber>sample string 13</PhoneNumber>
    <PolicyCategory>sample string 2</PolicyCategory>
    <PolicyHolderId>18</PolicyHolderId>
    <PolicyId>19</PolicyId>
    <PolicyNo>sample string 23</PolicyNo>
    <PolicyType>sample string 3</PolicyType>
    <ProductName>sample string 22</ProductName>
    <State>sample string 9</State>
    <StateList>sample string 10</StateList>
    <Zip>sample string 12</Zip>
  </PolicyDetails>
  <PolicyInvoice>
    <Invoice>
      <AmountCancelled>5</AmountCancelled>
      <AppliedAmount>4</AppliedAmount>
      <InvoiceDate>2024-04-28T09:14:07.1191742-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-28T09:14:07.1191742-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>
  </PolicyInvoice>
</PolicyPaymentData>