API Documentation - Version 0.3.0

Get claim

Returns a claim.


  GET /api/claims/:id

Parameter

Name	Type	Required	Description
id	ID	Yes	The ID of the claim, e.g. YHP17T

Example of request:


  curl -s -H "CS-API-KEY: <your key>" -H "Content-Type: application/json" https://api-staging.claims-online.de/api/claims/X8J7UY

Example of response:


{
  "data": {
    "id": "X8J7UY",
    "type": "claims",
    "attributes": {
      "causer": "same_as_client",
      "claimant": "same_as_client",
      "claimant_charged_freight": false,
      "client": {
        "kind": "client",
        "company_name": "Muster Firma",
        "contact_name": null,
        "street": "Muster Strase",
        "street_number": "123",
        "zip_code": "12345",
        "city": "Muster Stadt",
        "country": "DE",
        "email": null,
        "phone_number": null,
        "id": "IUFYE1"
      },
      "contract_division": "goods",
      "created_at": "2024-10-08T12:28:35Z",
      "damage_amount_amount": 0.0,
      "damage_amount_currency": "EUR",
      "damage_kind": "fire_explosion",
      "damage_visitable": "same_as_client",
      "damaged_on": "2024-10-05",
      "goods_description": "Vase",
      "goods_loaded_by": "sender",
      "goods_quantity": "eine",
      "goods_reloaded": false,
      "goods_unloaded_by": "driver",
      "reported_on": "2024-10-08",
      "status": "draft",
      "transport_delivered_on": "2024-10-04",
      "transport_means": "truck",
      "transport_route_from": "Hamburg",
      "transport_route_to": "Berlin",
      "transport_started_on": "2024-10-03",
      "updated_at": "2024-10-08T12:28:35Z"
    },
    "relationships": {
      "policy": {
        "data": {
          "id": "W1230042",
          "type": "policies"
        },
        "links": {
          "related": "https://api-staging.claims-online.de/api/policies/W1230042"
        }
      },
      "documents": {
        "data": [
          {
            "id": "DD0042",
            "type": "documents"
          },
          {
            "id": "DD4711",
            "type": "documents"
          }
        ],
        "links": {
          "related": "https://api-staging.claims-online.de/api/_claims/X8J7UY/documents"
        }
      }
    }
  },
  "included": [
    {
      "id": "W1230042",
      "type": "policies",
      "attributes": {
        "policy_number": "W1230042",
        "begin_period": "2024-01-01",
        "end_period": "2024-12-31",
        "begin_usage_period": "2023-12-15",
        "end_usage_period": "2025-01-31",
        "in_usage_period": true,
        "currency": "EUR",
        "current": true,
        "contract_division": "goods"
      },
      "links": {
        "self": "https://api-staging.claims-online.de/api/policies/W1230042"
      }
    },
    {
      "id": "DD0042",
      "type": "documents",
      "attributes": {
        "claim_id": "X8J7UY",
        "filename": "transp.pdf",
        "content_type": "application/pdf",
        "size": 12345,
        "kind": "transport_papers",
        "title": "Some title",
        "description": "Some description"
      },
      "links": {
        "self": "https://api-staging.claims-online.de/api/_claims/X8J7UY/documents/DD0042",
        "content": "https://api-staging.claims-online.de/api/_claims/X8J7UY/documents/DD0042/content"
      }
    },
    {
      "id": "DD4711",
      "type": "documents",
      ...
    }
  ],
  "links": {
    "self": "https://api-staging.claims-online.de/api/claims/X8J7UY"
  }
}