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

Policy Bill History

Request Information

URI Parameters

NameDescriptionTypeAdditional information
PolicyNumber

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of BillHistoryDTO
NameDescriptionTypeAdditional information
AccountingDate

date

None.

BillPrepDate

date

None.

DueDate

date

None.

PolicyBillType

BillTypeEnum

None.

BillingCycle

BillingCycleEnum

None.

BillPlanDescription

string

None.

AutoPayType

AutopayTypeEnum

None.

AmountDue

decimal number

None.

MinimumAmountDue

decimal number

None.

Id

Primary Id

integer

None.

WarningMessages

List of warning messages encountered while servicing request

Collection of string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "AccountingDate": "2022-01-20T05:08:37.9278722-10:00",
    "BillPrepDate": "2022-01-20T05:08:37.9278722-10:00",
    "DueDate": "2022-01-20T05:08:37.9278722-10:00",
    "PolicyBillType": "Unknown",
    "BillingCycle": "Unknown",
    "BillPlanDescription": "sample string 1",
    "AutoPayType": "Unknown",
    "AmountDue": 2.0,
    "MinimumAmountDue": 3.0,
    "Id": 4
  },
  {
    "AccountingDate": "2022-01-20T05:08:37.9278722-10:00",
    "BillPrepDate": "2022-01-20T05:08:37.9278722-10:00",
    "DueDate": "2022-01-20T05:08:37.9278722-10:00",
    "PolicyBillType": "Unknown",
    "BillingCycle": "Unknown",
    "BillPlanDescription": "sample string 1",
    "AutoPayType": "Unknown",
    "AmountDue": 2.0,
    "MinimumAmountDue": 3.0,
    "Id": 4
  }
]

application/xml, text/xml

Sample:
<ArrayOfBillHistoryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <BillHistoryDTO>
    <Id>4</Id>
    <AccountingDate>2022-01-20T05:08:37.9278722-10:00</AccountingDate>
    <AmountDue>2</AmountDue>
    <AutoPayType>Unknown</AutoPayType>
    <BillPlanDescription>sample string 1</BillPlanDescription>
    <BillPrepDate>2022-01-20T05:08:37.9278722-10:00</BillPrepDate>
    <BillingCycle>Unknown</BillingCycle>
    <DueDate>2022-01-20T05:08:37.9278722-10:00</DueDate>
    <MinimumAmountDue>3</MinimumAmountDue>
    <PolicyBillType>Unknown</PolicyBillType>
  </BillHistoryDTO>
  <BillHistoryDTO>
    <Id>4</Id>
    <AccountingDate>2022-01-20T05:08:37.9278722-10:00</AccountingDate>
    <AmountDue>2</AmountDue>
    <AutoPayType>Unknown</AutoPayType>
    <BillPlanDescription>sample string 1</BillPlanDescription>
    <BillPrepDate>2022-01-20T05:08:37.9278722-10:00</BillPrepDate>
    <BillingCycle>Unknown</BillingCycle>
    <DueDate>2022-01-20T05:08:37.9278722-10:00</DueDate>
    <MinimumAmountDue>3</MinimumAmountDue>
    <PolicyBillType>Unknown</PolicyBillType>
  </BillHistoryDTO>
</ArrayOfBillHistoryDTO>