Damage

Record damage for claims and keep track of reserves.

Damages are a way to capture what was damaged as a result of the claim they belong to. Each damage has a damage type to categorise it along with a description for additional information.

Reserves can also be recorded against each damage, keyed by reserve category.

Damages must belong to a claim and can't exist outside of a claim.

The Damage Object

AttributeData TypeDescription
idIntegerThe unique ID for the damage given by Claimable.
damage_typeStringRequired

The key assigned to one of the available damage types.
descriptionStringA free text description of the damage.
reservesObjectThe Reserves object.
created_atTimestampRead Only

The date/time the damage was created.
Example Damage Object
{
  "description": "Scratch to paintwork.",
  "damage_type": "scratch",
  "reserves": {
    "own_damage": {
      "amount": 100000,
      "created_at": "2020-12-17T18:30:10.869Z",
      "updated_at": "2020-12-17T18:30:10.877Z"
    },
    "third_party_damage": {
      "amount": 97500,
      "created_at": "2020-12-17T18:30:10.869Z",
      "updated_at": "2020-12-17T18:30:10.877Z"
    },
    "legal_fees": {
      "amount": 50000,
      "created_at": "2020-12-17T18:30:10.869Z",
      "updated_at": "2020-12-17T18:30:10.877Z"
    },
    "admin_fees": {
      "amount": 17500,
      "created_at": "2020-12-17T18:30:10.869Z",
      "updated_at": "2020-12-17T18:30:10.877Z
    }
  },
  "created_at": "2020-12-07T13:26:24.637Z"
}

The Reserves Object

AttributeData TypeDescription
keyIntegerThe key representing the reserve category.
amountIntegerThe current reserve amount in cents.
created_atTimestampRead Only

The date/time the reserve was created.
updated_atTimestampRead Only

The date/time the reserve was updated.
Example Reserves Object
{
  "reserves": {
    "own_damage": {
      "amount": 100000,
      "created_at": "2020-12-17T18:30:10.869Z",
      "updated_at": "2020-12-17T18:30:10.877Z"
    },
    "third_party_damage": {
      "amount": 97500,
      "created_at": "2020-12-17T18:30:10.869Z",
      "updated_at": "2020-12-17T18:30:10.877Z"
    },
    // etc...
  }
}