| Name | Description | Type | Additional information |
|---|---|---|---|
| CancellationDate |
Required. Date the cancellation takes effect. Also used as the adjustment date. |
date |
None. |
| CancellationReasonID |
Id of the cancellation reason. Valid values are returned by GET v1/Locations/{locationID}/Policies/CancellationReasons. |
integer |
None. |
| CancellationDescription |
Free form description of the cancellation. Stored as the adjustment remarks and included in the activity note generated for the cancellation. |
string |
None. |
| RequestedByID |
Who requested the cancellation. Valid values are "A" (Agent), "C" (Company), "I" (Insured) and "O" (Other). |
string |
None. |
| PolicyReleaseObtainedID |
Whether the policy release was obtained. Valid values are "N" (Not Obtained), "P" (Policy Obtained) and "R" (Release Statement Obtained). |
string |
None. |
| MethodID |
How the unearned amounts were calculated. Valid values are "F" (Flat), "P" (Pro Rata) and "S" (Short). |
string |
None. |
| SubjecttoAudit |
Whether the cancelled policy is subject to audit. |
boolean |
None. |
| OtherLabel |
Free form label used when RequestedByID is "O" (Other). Limited to 50 characters. |
string |
None. |
| PremiumChange |
Premium amount to reverse off the policy. This is the unearned premium expressed as a negative amount: the UI sends -PremiumUnearned. Defaults to 0 when omitted. |
decimal number |
None. |
| CommissionChange |
Commission amount to reverse off the policy. This is the unearned commission expressed as a negative amount: the UI sends -CommissionUnearned. Defaults to 0 when omitted. |
decimal number |
None. |
