OfficeGest
Workshop/Claims

Create workshop claim

Creates an insurance claim for a vehicle. The customer defaults to the vehicle owner when omitted.

POST
/workshop/claims
AuthorizationBearer <token>

In: header

platestring

Vehicle plate.

status_idnumber

Claim status ID.

warehouse_idnumber

Warehouse code.

process_numberstring

Insurance process number.

Lengthlength <= 25
customer_id?number

Customer code. Defaults to the vehicle owner.

insurer_id?number

Insurer ID.

name?string

Short label shown as the designation column of the claims list.

Lengthlength <= 30
description?string

Claim description.

repair_days?number

Estimated repair days.

claim_date?string

Claim date in Y-m-d format.

Formatdate
report_date?string

Report date in Y-m-d format.

Formatdate
expected_entry_date?string

Expected vehicle entry date in Y-m-d format.

Formatdate
expected_service_order_date?string

Expected service order date in Y-m-d format.

Formatdate

Response Body

curl -X POST "https://og-tenant1.test:8003/api/v2/workshop/claims" \
  -H "Content-Type: application/json" \
  -d '{
    "plate": "string",
    "status_id": 0,
    "warehouse_id": 0,
    "process_number": "string"
  }'
{
  "data": {
    "id": 0,
    "process_number": "string",
    "name": "string",
    "description": "string",
    "plate": "string",
    "customer_id": 0,
    "insurer_id": 0,
    "status_id": 0,
    "warehouse_id": 0,
    "policy_number": "string",
    "responsibility_percentage": 0,
    "budget_value": 0,
    "excess_value": 0,
    "repair_value": 0,
    "indemnified_value": 0,
    "repair_days": 0,
    "claim_date": "2019-08-24T14:15:22Z",
    "report_date": "2019-08-24T14:15:22Z",
    "expected_entry_date": "2019-08-24T14:15:22Z",
    "expected_service_order_date": "2019-08-24T14:15:22Z",
    "closed_at": "2019-08-24T14:15:22Z",
    "observations": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "status": {
      "id": 0,
      "description": "string",
      "has_associated_documents": true,
      "sort_order": 0
    },
    "vehicle": {
      "resource": "string"
    },
    "customer": {
      "resource": "string"
    }
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}