An overview of the various object types available via the Claimable API.
The Claimable API exposes various objects through a series of endpoints. Each object has attributes in a JSON format, that can be sent and received, via a request to an API endpoint.
The following list is a summary of all objects, but you can see the full object definition, with attribute explanations, on the detail page for each one.
Summary of Objects
| Object | Overview |
|---|---|
| Claim | 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. |
| Contact |
Contacts can also be linked to companies to indicate they belong to that company in some capacity, such as an employee or member of staff. |
| Company | Company objects provide a way to link claims to organisations that your business has a commercial relationship with. For example this could be clients, insurers, brokers, suppliers, repairers, adjusters etc. |
| Task | Task objects provide a way to manage per-claim workflow and productivity. They reside on claim checklists and can be assigned to users and given due dates. |
| Letter | Letter objects provide a way to generate on-demand, pre-populated PDF documents on a per-claim basis, from your library of installed letter templates in Claimable. |
| Damage | Damage objects represent damage caused to the subject of the claim, along with any reserve amounts. They can only exist nested within a claim and therefore must belong to a parent Claim object. |
| Vehicle | Vehicle objects represent cars, trucks, bikes etc. (any vehicle) involved in claims. There can be multiple vehicles per claim and any one of them can become the subject of auto/motor claims. |
| Payment | Payment objects represent payments or transactions relating to claims. They can only exist nested within a claim and therefore must belong to a parent Claim object. |
| Document | Document objects are metadata wrappers for files uploaded to their parent object. They must belong to a parent object, which can be either a Claim, Contact or Company. |
| Note | Note objects provide a way to record a text-based narrative about a parent object. They must belong to a parent object, which can be either a Claim, Contact or Company. |
| Conversation | Conversation objects represent message threads between two or more participants, relating to a Claim. |
| ConversationParticipant | ConversationParticipant objects describe a single participant in a Conversation who can send messages and receive replies. |
| Message | Message objects represent a reply to an existing Conversation or the message that originated a new Conversation. |
| Branch | Branch objects provide a way to organise and group your claims based on your organisation's structure and they can represent offices, sites, locations or departments. |
| Label | Label objects represent labels that are used within the Claimable UI to group, categorise or tag claims, contacts, companies & documents. |
| User | User objects represent a person who has access to your Claimable account. Users are referred to by other objects, such as to indicate who is the creator or assignee of a given record. |

