GET v1/Invoice?StartDate={StartDate}&EndDate={EndDate}&PolicyNumber={PolicyNumber}&Limit={Limit}&PageNumber={PageNumber}&Total={Total}

Invoice Details

Request Information

URI Parameters

Name	Description	Type	Additional information
StartDate	Start date of date range to search	date	Required
EndDate	End date of date range to search	date	Required
PolicyNumber	Policy Number to search (Optional)	string	None.
Limit	Number of rows per page (Optional)	integer	None.
PageNumber	Page number based on rows of page provided (Optional)	integer	None.
Total	Will return the total number of matching records if true. False if omitted.	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

InvoiceListResponse

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 InvoiceDTO	None.

Response Formats

application/json, text/json

Sample:

{
  "Limit": 1,
  "Offset": 1,
  "Total": 1,
  "Data": [
    {
      "TransactionDetailId": 1,
      "PayeeName": "sample string 2",
      "PayeeId": 1,
      "CustomerName": "sample string 3",
      "CustomerId": 1,
      "AccountingDate": "2024-04-27T16:08:33.9792114-10:00",
      "TransEffectiveDate": "2024-04-27T16:08:33.9792114-10:00",
      "PolicyNumber": "sample string 4",
      "UnderlyingPolicyNumber": "sample string 5",
      "PolicyTotalWrittenPremium": 1.0,
      "AmendFuncDesc": "sample string 6",
      "Amount": 1.0,
      "PolicyEffectiveDate": "2024-04-27T16:08:33.9792114-10:00",
      "PolicyExpirationDate": "2024-04-27T16:08:33.9792114-10:00",
      "CommissionAmount": 1.0,
      "CommissionRate": 1.0,
      "PolicyTermNumber": 1,
      "PolicyTransactionNumber": 1,
      "PolicyId": 1,
      "AmendmentDesc": "sample string 7",
      "Id": 8
    },
    {
      "TransactionDetailId": 1,
      "PayeeName": "sample string 2",
      "PayeeId": 1,
      "CustomerName": "sample string 3",
      "CustomerId": 1,
      "AccountingDate": "2024-04-27T16:08:33.9792114-10:00",
      "TransEffectiveDate": "2024-04-27T16:08:33.9792114-10:00",
      "PolicyNumber": "sample string 4",
      "UnderlyingPolicyNumber": "sample string 5",
      "PolicyTotalWrittenPremium": 1.0,
      "AmendFuncDesc": "sample string 6",
      "Amount": 1.0,
      "PolicyEffectiveDate": "2024-04-27T16:08:33.9792114-10:00",
      "PolicyExpirationDate": "2024-04-27T16:08:33.9792114-10:00",
      "CommissionAmount": 1.0,
      "CommissionRate": 1.0,
      "PolicyTermNumber": 1,
      "PolicyTransactionNumber": 1,
      "PolicyId": 1,
      "AmendmentDesc": "sample string 7",
      "Id": 8
    }
  ]
}

application/xml, text/xml

Sample:

<InvoiceListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Models" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
    <d2p1:InvoiceDTO>
      <Id>8</Id>
      <d2p1:AccountingDate>2024-04-27T16:08:33.9792114-10:00</d2p1:AccountingDate>
      <d2p1:AmendFuncDesc>sample string 6</d2p1:AmendFuncDesc>
      <d2p1:AmendmentDesc>sample string 7</d2p1:AmendmentDesc>
      <d2p1:Amount>1</d2p1:Amount>
      <d2p1:CommissionAmount>1</d2p1:CommissionAmount>
      <d2p1:CommissionRate>1</d2p1:CommissionRate>
      <d2p1:CustomerId>1</d2p1:CustomerId>
      <d2p1:CustomerName>sample string 3</d2p1:CustomerName>
      <d2p1:PayeeId>1</d2p1:PayeeId>
      <d2p1:PayeeName>sample string 2</d2p1:PayeeName>
      <d2p1:PolicyEffectiveDate>2024-04-27T16:08:33.9792114-10:00</d2p1:PolicyEffectiveDate>
      <d2p1:PolicyExpirationDate>2024-04-27T16:08:33.9792114-10:00</d2p1:PolicyExpirationDate>
      <d2p1:PolicyId>1</d2p1:PolicyId>
      <d2p1:PolicyNumber>sample string 4</d2p1:PolicyNumber>
      <d2p1:PolicyTermNumber>1</d2p1:PolicyTermNumber>
      <d2p1:PolicyTotalWrittenPremium>1</d2p1:PolicyTotalWrittenPremium>
      <d2p1:PolicyTransactionNumber>1</d2p1:PolicyTransactionNumber>
      <d2p1:TransEffectiveDate>2024-04-27T16:08:33.9792114-10:00</d2p1:TransEffectiveDate>
      <d2p1:TransactionDetailId>1</d2p1:TransactionDetailId>
      <d2p1:UnderlyingPolicyNumber>sample string 5</d2p1:UnderlyingPolicyNumber>
    </d2p1:InvoiceDTO>
    <d2p1:InvoiceDTO>
      <Id>8</Id>
      <d2p1:AccountingDate>2024-04-27T16:08:33.9792114-10:00</d2p1:AccountingDate>
      <d2p1:AmendFuncDesc>sample string 6</d2p1:AmendFuncDesc>
      <d2p1:AmendmentDesc>sample string 7</d2p1:AmendmentDesc>
      <d2p1:Amount>1</d2p1:Amount>
      <d2p1:CommissionAmount>1</d2p1:CommissionAmount>
      <d2p1:CommissionRate>1</d2p1:CommissionRate>
      <d2p1:CustomerId>1</d2p1:CustomerId>
      <d2p1:CustomerName>sample string 3</d2p1:CustomerName>
      <d2p1:PayeeId>1</d2p1:PayeeId>
      <d2p1:PayeeName>sample string 2</d2p1:PayeeName>
      <d2p1:PolicyEffectiveDate>2024-04-27T16:08:33.9792114-10:00</d2p1:PolicyEffectiveDate>
      <d2p1:PolicyExpirationDate>2024-04-27T16:08:33.9792114-10:00</d2p1:PolicyExpirationDate>
      <d2p1:PolicyId>1</d2p1:PolicyId>
      <d2p1:PolicyNumber>sample string 4</d2p1:PolicyNumber>
      <d2p1:PolicyTermNumber>1</d2p1:PolicyTermNumber>
      <d2p1:PolicyTotalWrittenPremium>1</d2p1:PolicyTotalWrittenPremium>
      <d2p1:PolicyTransactionNumber>1</d2p1:PolicyTransactionNumber>
      <d2p1:TransEffectiveDate>2024-04-27T16:08:33.9792114-10:00</d2p1:TransEffectiveDate>
      <d2p1:TransactionDetailId>1</d2p1:TransactionDetailId>
      <d2p1:UnderlyingPolicyNumber>sample string 5</d2p1:UnderlyingPolicyNumber>
    </d2p1:InvoiceDTO>
  </Data>
  <Limit xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">1</Limit>
  <Offset xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">1</Offset>
  <Total xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">1</Total>
</InvoiceListResponse>