GET v1/Policy/Cancels?StartDate={StartDate}&EndDate={EndDate}

Get list of policy cancellations

Request Information

URI Parameters

Name	Description	Type	Additional information
StartDate		date	Required
EndDate		date	Required

Body Parameters

None.

Response Information

Resource Description

Get list of policy cancellations

Collection of PolicyCancelOutboundDTO

Name	Description	Type	Additional information
BrokerId	ID of the Agency linked to the policy as the payee	integer	None.
TransactionDate	Date that the cancel transaction occurred	date	None.
CancellationDate	Date that the cancel is effective	date	None.
Currency	Currency	string	None.
ExchangeRate	Exchange rate from USD	decimal number	None.
PolicyId	PolicyId of the related policy transaction	integer	None.
PolicyNumber	Policy Number	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "BrokerId": 1,
    "TransactionDate": "2024-12-21T07:42:32.4441064-10:00",
    "CancellationDate": "2024-12-21T07:42:32.4441064-10:00",
    "Currency": "sample string 3",
    "ExchangeRate": 1.0,
    "PolicyId": 4,
    "PolicyNumber": "sample string 5"
  },
  {
    "BrokerId": 1,
    "TransactionDate": "2024-12-21T07:42:32.4441064-10:00",
    "CancellationDate": "2024-12-21T07:42:32.4441064-10:00",
    "Currency": "sample string 3",
    "ExchangeRate": 1.0,
    "PolicyId": 4,
    "PolicyNumber": "sample string 5"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPolicyCancelOutboundDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <PolicyCancelOutboundDTO>
    <BrokerId>1</BrokerId>
    <CancellationDate>2024-12-21T07:42:32.4441064-10:00</CancellationDate>
    <Currency>sample string 3</Currency>
    <ExchangeRate>1</ExchangeRate>
    <PolicyId>4</PolicyId>
    <PolicyNumber>sample string 5</PolicyNumber>
    <TransactionDate>2024-12-21T07:42:32.4441064-10:00</TransactionDate>
  </PolicyCancelOutboundDTO>
  <PolicyCancelOutboundDTO>
    <BrokerId>1</BrokerId>
    <CancellationDate>2024-12-21T07:42:32.4441064-10:00</CancellationDate>
    <Currency>sample string 3</Currency>
    <ExchangeRate>1</ExchangeRate>
    <PolicyId>4</PolicyId>
    <PolicyNumber>sample string 5</PolicyNumber>
    <TransactionDate>2024-12-21T07:42:32.4441064-10:00</TransactionDate>
  </PolicyCancelOutboundDTO>
</ArrayOfPolicyCancelOutboundDTO>