GET v1/Ledger?PolicyNumber={PolicyNumber}&ItemNumber={ItemNumber}&AccountingDate={AccountingDate}&Description={Description}&PaymentType={PaymentType}&PaymentSource={PaymentSource}&EffectiveDate={EffectiveDate}&Amount={Amount}&ItemBalance={ItemBalance}&TransactionDetailId={TransactionDetailId}&TransactionType={TransactionType}&Limit={Limit}&Offset={Offset}&Total={Total}&SortDirection={SortDirection}&Sort={Sort}&Expand={Expand}

Ledger Search

Request Information

URI Parameters

Name	Description	Type	Additional information
PolicyNumber	Policy number to retrieve associated payment history for	string	Required String length: inclusive between 0 and 30
ItemNumber	Item Number	string	None.
AccountingDate	Accounting Date	string	None.
Description	Description	string	None.
PaymentType	Payment Type	string	None.
PaymentSource	Payment Source	string	None.
EffectiveDate	EffectiveDate	string	None.
Amount	Amount	string	None.
ItemBalance	Item Balance	string	None.
TransactionDetailId	Transaction Detail Id	string	None.
TransactionType	Transaction Detail Id	AmendTransTypeCustomEnum	None.
Limit	Maximum number of records to return	integer	Range: inclusive between 1 and 2147483647
Offset	Number of records to skip during search, useful for pagination	integer	Range: inclusive between 0 and 2147483647
Total	Flag to indicate if the total number of records matching the search should be computed. Default: False. WARNING: Setting to True will considerably slow down search performance when searching large datasets.	boolean	None.
SortDirection	Direction of sort: Ascending or Descending	SortDirection	None.
Sort	Comma separated list of field names to sort by	string	None.
Expand	Comma separated list of expansions to include in results	string	None.

Body Parameters

None.

Response Information

Resource Description

LedgerListResponse

Name	Description	Type	Additional information
Limit	Echoed limit of request	integer	None.
Offset	Echoed offset of request	integer	None.
Total	Total records matching search, if requested	integer	None.
Data	List of records matching the search	Collection of LedgerEntryDTO	None.

Response Formats

application/json, text/json

Sample:

{
  "Limit": 1,
  "Offset": 1,
  "Total": 1,
  "Data": [
    {
      "ItemNumber": 1,
      "AccountingDate": "2024-09-16T11:41:32.4040518-10:00",
      "Description": "sample string 1",
      "TransactionType": "NewPolicy",
      "PaymentType": "sample string 2",
      "PaymentSource": "sample string 3",
      "EffectiveDate": "2024-09-16T11:41:32.4040518-10:00",
      "Amount": 4.0,
      "ItemBalance": 5.0,
      "TransactionDetailId": 6
    },
    {
      "ItemNumber": 1,
      "AccountingDate": "2024-09-16T11:41:32.4040518-10:00",
      "Description": "sample string 1",
      "TransactionType": "NewPolicy",
      "PaymentType": "sample string 2",
      "PaymentSource": "sample string 3",
      "EffectiveDate": "2024-09-16T11:41:32.4040518-10:00",
      "Amount": 4.0,
      "ItemBalance": 5.0,
      "TransactionDetailId": 6
    }
  ]
}

application/xml, text/xml

Sample:

<LedgerListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <Data>
    <LedgerEntryDTO>
      <Id>7</Id>
      <AccountingDate>2024-09-16T11:41:32.4040518-10:00</AccountingDate>
      <Amount>4</Amount>
      <Description>sample string 1</Description>
      <EffectiveDate>2024-09-16T11:41:32.4040518-10:00</EffectiveDate>
      <ItemBalance>5</ItemBalance>
      <ItemNumber>1</ItemNumber>
      <PaymentSource>sample string 3</PaymentSource>
      <PaymentType>sample string 2</PaymentType>
      <TransactionDetailId>6</TransactionDetailId>
      <TransactionType>NewPolicy</TransactionType>
    </LedgerEntryDTO>
    <LedgerEntryDTO>
      <Id>7</Id>
      <AccountingDate>2024-09-16T11:41:32.4040518-10:00</AccountingDate>
      <Amount>4</Amount>
      <Description>sample string 1</Description>
      <EffectiveDate>2024-09-16T11:41:32.4040518-10:00</EffectiveDate>
      <ItemBalance>5</ItemBalance>
      <ItemNumber>1</ItemNumber>
      <PaymentSource>sample string 3</PaymentSource>
      <PaymentType>sample string 2</PaymentType>
      <TransactionDetailId>6</TransactionDetailId>
      <TransactionType>NewPolicy</TransactionType>
    </LedgerEntryDTO>
  </Data>
  <Limit>1</Limit>
  <Offset>1</Offset>
  <Total>1</Total>
</LedgerListResponse>