GET v1/Payment/BillSummary?PolicyNumber={PolicyNumber}

Retrieve Bill Summary for a Policy

Request Information

URI Parameters

Name	Description	Type	Additional information
PolicyNumber		string	Required

Body Parameters

None.

Response Information

Resource Description

Retrieve Bill Summary for a Policy

Collection of BillSummaryOutboundDTO

Name	Description	Type	Additional information
PolicyNumber	Policy Number	string	String length: inclusive between 0 and 30
BillPlan	Bill Plan	string	String length: inclusive between 0 and 60
BillingCycle	Billing Cycle	string	String length: inclusive between 0 and 267
AutopayMethod	Autopay Method	string	String length: inclusive between 0 and 254
LastPaymentDate	Last Payment Date	date	None.
LastPaymentType	Last Payment Type	string	String length: inclusive between 0 and 254
LastPaymentAmount	Last Payment Amount	decimal number	None.
CurrentBillDate	Current Bill Date	date	None.
CurrentDueDate	Current Due Date	date	None.
PaidThruDate	Paid Thru Date	date	None.
CurrentAmountDue	Current Amount Due	decimal number	None.
PolicyBalance	Policy Balance	decimal number	None.
BillingMethod	Billing Method	string	String length: inclusive between 0 and 254
LastPaymentLast4Digits	Last Payment Last 4 digits	string	String length: inclusive between 0 and 4
LastPaymentConfirmationNumber	Last Payment Confirmation Number	string	String length: inclusive between 0 and 30
TotalPayment	Total Payment	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PolicyNumber": "sample string 1",
    "BillPlan": "sample string 2",
    "BillingCycle": "sample string 3",
    "AutopayMethod": "sample string 4",
    "LastPaymentDate": "2025-04-03T10:41:16.6004369-10:00",
    "LastPaymentType": "sample string 5",
    "LastPaymentAmount": 1.0,
    "CurrentBillDate": "2025-04-03T10:41:16.6004369-10:00",
    "CurrentDueDate": "2025-04-03T10:41:16.6004369-10:00",
    "PaidThruDate": "2025-04-03T10:41:16.6004369-10:00",
    "CurrentAmountDue": 1.0,
    "PolicyBalance": 1.0,
    "BillingMethod": "sample string 6",
    "LastPaymentLast4Digits": "sample string 7",
    "LastPaymentConfirmationNumber": "sample string 8",
    "TotalPayment": 1.0
  },
  {
    "PolicyNumber": "sample string 1",
    "BillPlan": "sample string 2",
    "BillingCycle": "sample string 3",
    "AutopayMethod": "sample string 4",
    "LastPaymentDate": "2025-04-03T10:41:16.6004369-10:00",
    "LastPaymentType": "sample string 5",
    "LastPaymentAmount": 1.0,
    "CurrentBillDate": "2025-04-03T10:41:16.6004369-10:00",
    "CurrentDueDate": "2025-04-03T10:41:16.6004369-10:00",
    "PaidThruDate": "2025-04-03T10:41:16.6004369-10:00",
    "CurrentAmountDue": 1.0,
    "PolicyBalance": 1.0,
    "BillingMethod": "sample string 6",
    "LastPaymentLast4Digits": "sample string 7",
    "LastPaymentConfirmationNumber": "sample string 8",
    "TotalPayment": 1.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfBillSummaryOutboundDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <BillSummaryOutboundDTO>
    <AutopayMethod>sample string 4</AutopayMethod>
    <BillPlan>sample string 2</BillPlan>
    <BillingCycle>sample string 3</BillingCycle>
    <BillingMethod>sample string 6</BillingMethod>
    <CurrentAmountDue>1</CurrentAmountDue>
    <CurrentBillDate>2025-04-03T10:41:16.6004369-10:00</CurrentBillDate>
    <CurrentDueDate>2025-04-03T10:41:16.6004369-10:00</CurrentDueDate>
    <LastPaymentAmount>1</LastPaymentAmount>
    <LastPaymentConfirmationNumber>sample string 8</LastPaymentConfirmationNumber>
    <LastPaymentDate>2025-04-03T10:41:16.6004369-10:00</LastPaymentDate>
    <LastPaymentLast4Digits>sample string 7</LastPaymentLast4Digits>
    <LastPaymentType>sample string 5</LastPaymentType>
    <PaidThruDate>2025-04-03T10:41:16.6004369-10:00</PaidThruDate>
    <PolicyBalance>1</PolicyBalance>
    <PolicyNumber>sample string 1</PolicyNumber>
    <TotalPayment>1</TotalPayment>
  </BillSummaryOutboundDTO>
  <BillSummaryOutboundDTO>
    <AutopayMethod>sample string 4</AutopayMethod>
    <BillPlan>sample string 2</BillPlan>
    <BillingCycle>sample string 3</BillingCycle>
    <BillingMethod>sample string 6</BillingMethod>
    <CurrentAmountDue>1</CurrentAmountDue>
    <CurrentBillDate>2025-04-03T10:41:16.6004369-10:00</CurrentBillDate>
    <CurrentDueDate>2025-04-03T10:41:16.6004369-10:00</CurrentDueDate>
    <LastPaymentAmount>1</LastPaymentAmount>
    <LastPaymentConfirmationNumber>sample string 8</LastPaymentConfirmationNumber>
    <LastPaymentDate>2025-04-03T10:41:16.6004369-10:00</LastPaymentDate>
    <LastPaymentLast4Digits>sample string 7</LastPaymentLast4Digits>
    <LastPaymentType>sample string 5</LastPaymentType>
    <PaidThruDate>2025-04-03T10:41:16.6004369-10:00</PaidThruDate>
    <PolicyBalance>1</PolicyBalance>
    <PolicyNumber>sample string 1</PolicyNumber>
    <TotalPayment>1</TotalPayment>
  </BillSummaryOutboundDTO>
</ArrayOfBillSummaryOutboundDTO>