Claim Object

Claim objects represent the top-level "container" for all claim-related records, some of which are stored as attributes on the Claim object itself and others are stored in nested objects.

Attribute	Data Type	Description
id	Integer	The unique ID for the claim given by Claimable.
title	String	The title of the claim. If blank, the claimant name will be used.
type	String	Claimable slug for the claim type.
incident_type	String	Claimable slug for the incident type.
sub_incident_type	String	Claimable slug for the sub-incident type.
claimant	Object	A `ClaimParty` object.
insured	Object	A `ClaimParty` object.
reported_at	Timestamp	The date/time the incident/claim was reported to your organisation.
incident_occurred_at	Timestamp	The date/time the incident occurred.
status	String	One of: `open`, `closed` Default: `open`
status_changed_by	Integer	Read Only The ID of the user who last closed or re-opened the claim.
opened_at	Timestamp	Read Only A timestamp showing when the claim status was last changed to open.
closed_at	Timestamp	A timestamp showing when the claim status was last changed to closed.
claim_duration	Integer	Read Only The elapsed time in days since the claim was created to the current date, if the claim is open, or until `closed_at`, if the claim is closed.
incident_description	String	A description of the incident and how the claim came about.
claim_ref	String	An alternative claim reference, besides the ID assigned by Claimable. Useful if you have an internal claim numbering/referencing system.
external_claim_ref	String	The claim reference of the client, insurer, broker, underwriter, or any other external company who has issued their own claim reference.
incident_location_address_line1	String	The first line of the incident/claim location address.
incident_location_address_line2	String	The second line of the incident/claim location address.
incident_location_address_line3	String	The third line of the incident/claim location address.
incident_location_address_city	String	The town/city of the incident/claim location address.
incident_location_address_state	String	The state/county of the incident/claim location address.
incident_location_address_postcode	String	The postcode/zipcode of the incident/claim location address.
incident_location_address_country	String	Read Only The country of the incident/claim location address. Set via `incident_location_address_country_code`.
incident_location_address_country_code	String	The ISO 3166-1 alpha-3 3-letter country code for the country of the incident/claim location address (e.g. 'gbr' = United Kingdom). Sets `incident_location_address_country`.
incident_location_description	String	A brief description of the location if a street address is not relevant, or simply to provide more specifics.
policy_no	String	The policy number or reference under which this claim is being intimated, if applicable.
estimated_claim_cost	Integer	The estimated claim cost in cents.
actual_claim_cost	Integer	The actual claim cost in cents.
settled_amount	Integer	The settled amount in cents.
reserve_amount	Integer	The total claim reserve in cents.
excess_amount	Integer	The claim/policy excess in cents.
total_reserve	Integer	Read Only The sum of all reserves in cents.
total_paid	Integer	Read Only The sum of all payments in cents.
outstanding_reserve	Integer	Read Only The difference between the total reserve and total paid, in cents.
assigned_to	Integer	The id of the user who is assigned as the claim handler.
assigned_at	Timestamp	Read Only When the claim was assigned to the `assigned_to` user.
conversations_count	Integer	The number of all conversations on the claim.
open_conversations_count	Integer	The number of open conversations on the claim.
closed_conversations_count	Integer	The number of closed conversations on the claim.
tasks_count	Integer	The number of all tasks on the claim.
outstanding_tasks_count	Integer	The number of open tasks on the claim.
completed_tasks_count	Integer	The number of completed tasks on the claim.
client	Integer	The id of the client linked to the claim.
broker	Integer	The id of the broker linked to the claim.
insurer	Integer	The id of the insurer linked to the claim.
last_activity_at	Timestamp	Read Only A timestamp showing when the most recent activity was performed on the claim.
last_activity_key	String	Read Only A string that represents what the most recent activity is.
last_activity_description	String	Read Only A description of the most recent activity.
last_activity_by	Integer	Read Only The ID of the user who performed the last activity on the claim.

Example `Claim` Object

{
  "id": 1,
  "title": "David Smith",
  "type": "property",
  "labels": [
    "awaiting-repairs",
    "approved"
  ],
  "incident_type": "theft",
  "sub_incident_type": "break_in",
  "claimant": {
    "first_name": "John",
    "last_name": "Smith",
    "email": "john.smith@gmail.com",
    "id": 1,
    "match_existing": true,
    "role": "main_contact"
  },
  "insured": {
    "first_name": "John",
    "last_name": "Smith",
    "email": "john.smith@gmail.com",
    "id": 1,
    "match_existing": true,
    "role": "main_contact"
  },
  "reported_at": "2020-12-13T09:45:12Z",
  "incident_occurred_at": "2020-12-12T16:32:34Z",
  "status": "open",
  "status_changed_by": 1234,
  "opened_at": "2023-05-11T14:55:58.934Z",
  "closed_at": null,
  "claim_duration": 84,
  "incident_description": "Break in via kitchen windown and stolen TV.",
  "claim_ref": "ABC123",
  "external_claim_ref": "XYZ789",
  "incident_location_address_line1": "1 Mentmore Terrace",
  "incident_location_address_line2": "",
  "incident_location_address_line3": "",
  "incident_location_address_city": "London",
  "incident_location_address_state": "London",
  "incident_location_address_postcode": "E8 3PN",
  "incident_location_address_country": "United Kingdom",
  "incident_location_address_country_code": "gbr",
  "incident_location_description": "Lower ground floor kitchen.",
  "policy_no": "XXX-111-222",
  "estimated_claim_cost": 100000,
  "actual_claim_cost": 100000,
  "settled_amount": 100000,
  "reserve_amount": 100000,
  "excess_amount": 100000,
  "total_reserve": 200000,
  "total_paid": 100000,
  "outstanding_reserve": 100000,
  "last_activity_at": "2023-06-09T14:54:32.575Z",
  "last_activity_key": "claim.note.create",
  "last_activity_description": "Created note",
  "last_activity_by": 9,
  "conversations_count": 55,
  "open_conversations_count": 2,
  "closed_conversations_count": 48,
  "tasks_count": 44,
  "outstanding_tasks_count": 13,
  "completed_tasks_count": 31,
  "assigned_to": 1234,
  "assigned_at": "2023-06-08T13:51:12.575Z",
  "client": 111,
  "broker": 222,
  "insurer": 333
}

The `ClaimParty` Object

The ClaimParty object defines a contact or company who can be either or both claimant and insured on a claim.

Attribute	Data Type	Description
id	Integer	The Claimable contact ID if linking an existing contact. \n \nIf present, `match_existing` is always true.
first_name	String	Required - unless `is_business` is true. \n \nThe first name of the contact to create or link. If `is_business` is true, this becomes the first name of the primary contact person for that business.
last_name	String	Required - unless `is_business` is true. \n \nThe last name of the contact to create or link. If `is_business` is true, this becomes the last name of the primary contact person for that business.
business_name	String	Required - if `is_business` is true. \n \nThe name of the business to create or link if `is_business` is true, indicating the contact is refers to a business entity rather than an individual. \n \nIf `is_business` is false, the `business_name` refers to the business to which the individual is related to.
is_business	Boolean	Default: false \n \nIndicates if the contact to create or link refers to an individual (false) or business (true).
email	String	The email of the contact to create or link.
match_existing	Boolean	Default: true \n \nIf true, use the existing contact if an existing record can be found (exact match). Otherwise, create new.
role	String	Claimable slug for the contact role.
liability	String	Claimable slug for the contact liability.