OfficeGest
Workshop/Claims

List workshop claims

Returns a paginated list of insurance claims with status, vehicle and customer details.

GET
/workshop/claims
AuthorizationBearer <token>

In: header

Query Parameters

order?string
sorder?string
Value in"ASC" | "DESC"
sort?string

Sort field (prefix - for DESC). Allowed: id, claim_date, report_date, status_id, created_at

limit?integer

Items per page. Default 50, maximum 250; a larger value is truncated to 250.

Default50
Range1 <= value <= 250
status_id?integerDeprecated

Filter by claim status ID (eq, in)

plate?stringDeprecated

Filter by vehicle plate (eq, ct, sw)

customer_id?integerDeprecated

Filter by customer ID (eq)

insurer_id?integerDeprecated

Filter by insurer ID (eq)

warehouse_id?integerDeprecated

Filter by warehouse ID (eq)

process_number?stringDeprecated

Filter by insurance process number (eq, ct)

claim_date?stringDeprecated

Filter by claim date (eq, gte, lte)

Formatdate
search?string

Free text search on process number and plate

page?integer

Page number. Default 1; a value below 1 counts as 1.

Default1
Range1 <= value
filter[status_id][operator]?integer

Operators: eq, neq, gt, gte, lt, lte, like, ct, nlike, sw, ew, in, nin. Example: filter[status_id][eq]=value

filter[plate][operator]?string

Operators: eq, neq, gt, gte, lt, lte, like, ct, nlike, sw, ew, in, nin. Example: filter[plate][eq]=value

filter[customer_id][operator]?integer

Operators: eq, neq, gt, gte, lt, lte, like, ct, nlike, sw, ew, in, nin. Example: filter[customer_id][eq]=value

filter[insurer_id][operator]?integer

Operators: eq, neq, gt, gte, lt, lte, like, ct, nlike, sw, ew, in, nin. Example: filter[insurer_id][eq]=value

filter[warehouse_id][operator]?integer

Operators: eq, neq, gt, gte, lt, lte, like, ct, nlike, sw, ew, in, nin. Example: filter[warehouse_id][eq]=value

filter[process_number][operator]?string

Operators: eq, neq, gt, gte, lt, lte, like, ct, nlike, sw, ew, in, nin. Example: filter[process_number][eq]=value

filter[claim_date][operator]?string

Operators: eq, neq, gt, gte, lt, lte, like, ct, nlike, sw, ew, in, nin. Example: filter[claim_date][eq]=value

Formatdate

Response Body

curl -X GET "https://og-tenant1.test:8003/api/v2/workshop/claims?order=string&sorder=ASC&sort=string&limit=50&status_id=0&plate=string&customer_id=0&insurer_id=0&warehouse_id=0&process_number=string&claim_date=2019-08-24&search=string&page=1&filter%5Bstatus_id%5D%5Boperator%5D=0&filter%5Bplate%5D%5Boperator%5D=string&filter%5Bcustomer_id%5D%5Boperator%5D=0&filter%5Binsurer_id%5D%5Boperator%5D=0&filter%5Bwarehouse_id%5D%5Boperator%5D=0&filter%5Bprocess_number%5D%5Boperator%5D=string&filter%5Bclaim_date%5D%5Boperator%5D=2019-08-24"
{
  "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"
      }
    }
  ],
  "meta": {
    "per_page": 50,
    "current_page": 1,
    "has_more": true
  }
}
{
  "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"
  }
}