claim_estimations

Download schema

cancel_claim_estimation

POST

/api/v2/claim_estimations/cancel_claim_estimation

Cancel an estimation.

cancel_claim_estimation › Request Body

Request Schema for /api/v2/claim_estimations/cancel_claim_estimation

request-cancel_claim_estimation

estimation_id

string · uuid · required

Estimation ID

cancel_claim_estimation › Responses

200

Response Schema for /api/v2/claim_estimations/cancel_claim_estimation

response-cancel_claim_estimation

claim_estimation-def · required

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/claim_estimations/cancel_claim_estimation

curl --request POST \
  --url /api/v2/claim_estimations/cancel_claim_estimation \
  --header 'Content-Type: application/json' \
  --data '
{
  "estimation_id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "estimation_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "claim_id": "00000000-0000-0000-0000-000000000000",
    "xact_assignment_id": "xact_assignment_id",
    "assignment_type": "initial",
    "xact_analysis_status": "xact_analysis_status",
    "sent_date": "2024-08-25T15:00:00Z",
    "sent_by": "00000000-0000-0000-0000-000000000000",
    "assignment_date": "2024-08-25T15:00:00Z",
    "inspection_date": "2024-08-25T15:00:00Z",
    "contact_date": "2024-08-25T15:00:00Z",
    "estimate_date": "2024-08-25T15:00:00Z",
    "appointment_date": "2024-08-25T15:00:00Z",
    "estimate_approval_date": "2024-08-25T15:00:00Z",
    "building_estimate_amount": 0,
    "contents_estimate_amount": 0,
    "icc_estimate_amount": 0,
    "status": "requested",
    "canceled_by": "00000000-0000-0000-0000-000000000000",
    "canceled_date": "2024-08-25T15:00:00Z",
    "is_canceled": true
  },
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

get_claim_estimation

POST

/api/v2/claim_estimations/get_claim_estimation

Get a specific estimation.

get_claim_estimation › Request Body

Request Schema for /api/v2/claim_estimations/get_claim_estimation

request-get_claim_estimation

estimation_id

string · uuid · required

Estimation ID

get_claim_estimation › Responses

200

Response Schema for /api/v2/claim_estimations/get_claim_estimation

response-get_claim_estimation

claim_estimation-def · required

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/claim_estimations/get_claim_estimation

curl --request POST \
  --url /api/v2/claim_estimations/get_claim_estimation \
  --header 'Content-Type: application/json' \
  --data '
{
  "estimation_id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "estimation_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "claim_id": "00000000-0000-0000-0000-000000000000",
    "xact_assignment_id": "xact_assignment_id",
    "assignment_type": "initial",
    "xact_analysis_status": "xact_analysis_status",
    "sent_date": "2024-08-25T15:00:00Z",
    "sent_by": "00000000-0000-0000-0000-000000000000",
    "assignment_date": "2024-08-25T15:00:00Z",
    "inspection_date": "2024-08-25T15:00:00Z",
    "contact_date": "2024-08-25T15:00:00Z",
    "estimate_date": "2024-08-25T15:00:00Z",
    "appointment_date": "2024-08-25T15:00:00Z",
    "estimate_approval_date": "2024-08-25T15:00:00Z",
    "building_estimate_amount": 0,
    "contents_estimate_amount": 0,
    "icc_estimate_amount": 0,
    "status": "requested",
    "canceled_by": "00000000-0000-0000-0000-000000000000",
    "canceled_date": "2024-08-25T15:00:00Z",
    "is_canceled": true
  },
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

list_claim_estimations

POST

/api/v2/claim_estimations/list_claim_estimations

List all estimations for a claim.

list_claim_estimations › Request Body

Request Schema for /api/v2/claim_estimations/list_claim_estimations

request-list_claim_estimations

claim_id

string · uuid · required

Claim ID

list_claim_estimations › Responses

200

Response Schema for /api/v2/claim_estimations/list_claim_estimations

response-list_claim_estimations

claim_estimation-def[] · required

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/claim_estimations/list_claim_estimations

curl --request POST \
  --url /api/v2/claim_estimations/list_claim_estimations \
  --header 'Content-Type: application/json' \
  --data '
{
  "claim_id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "claim_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "claim_id": "00000000-0000-0000-0000-000000000000",
      "xact_assignment_id": "xact_assignment_id",
      "assignment_type": "initial",
      "xact_analysis_status": "xact_analysis_status",
      "sent_date": "2024-08-25T15:00:00Z",
      "sent_by": "00000000-0000-0000-0000-000000000000",
      "assignment_date": "2024-08-25T15:00:00Z",
      "inspection_date": "2024-08-25T15:00:00Z",
      "contact_date": "2024-08-25T15:00:00Z",
      "estimate_date": "2024-08-25T15:00:00Z",
      "appointment_date": "2024-08-25T15:00:00Z",
      "estimate_approval_date": "2024-08-25T15:00:00Z",
      "building_estimate_amount": 0,
      "contents_estimate_amount": 0,
      "icc_estimate_amount": 0,
      "status": "requested",
      "canceled_by": "00000000-0000-0000-0000-000000000000",
      "canceled_date": "2024-08-25T15:00:00Z",
      "is_canceled": true
    }
  ],
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

request_claim_estimation

POST

/api/v2/claim_estimations/request_claim_estimation

Create a new estimation for a claim.

request_claim_estimation › Request Body

Request Schema for /api/v2/claim_estimations/request_claim_estimation

request-request_claim_estimation

claim_id

string · uuid · required

Claim ID

assignment_type

string · enum · required

Type of assignment

Enum values:

initial

supplemental

request_claim_estimation › Responses

200

response-request_claim_estimation

claim_id

string · uuid · required

id

string | null · uuid · readOnly

xact_assignment_id

string · readOnly

assignment_type

string · enum

Enum values:

initial

supplemental

xact_analysis_status

string

sent_date

string · date-time · readOnly

sent_by

string · uuid · readOnly

assignment_date

string · date-time

inspection_date

string · date-time

contact_date

string · date-time

estimate_date

string · date-time

appointment_date

string · date-time

estimate_approval_date

string · date-time

building_estimate_amount

number

contents_estimate_amount

number

icc_estimate_amount

number

status

string · enum

Enum values:

requested

canceled

completed

canceled_by

string · uuid · readOnly

canceled_date

string · date-time · readOnly

is_canceled

boolean · readOnly

POST/api/v2/claim_estimations/request_claim_estimation

curl --request POST \
  --url /api/v2/claim_estimations/request_claim_estimation \
  --header 'Content-Type: application/json' \
  --data '
{
  "claim_id": "00000000-0000-0000-0000-000000000000",
  "assignment_type": "initial"
}
'

Example Request Body

{
  "claim_id": "00000000-0000-0000-0000-000000000000",
  "assignment_type": "initial"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "claim_id": "00000000-0000-0000-0000-000000000000",
  "xact_assignment_id": "xact_assignment_id",
  "assignment_type": "initial",
  "xact_analysis_status": "xact_analysis_status",
  "sent_date": "2024-08-25T15:00:00Z",
  "sent_by": "00000000-0000-0000-0000-000000000000",
  "assignment_date": "2024-08-25T15:00:00Z",
  "inspection_date": "2024-08-25T15:00:00Z",
  "contact_date": "2024-08-25T15:00:00Z",
  "estimate_date": "2024-08-25T15:00:00Z",
  "appointment_date": "2024-08-25T15:00:00Z",
  "estimate_approval_date": "2024-08-25T15:00:00Z",
  "building_estimate_amount": 0,
  "contents_estimate_amount": 0,
  "icc_estimate_amount": 0,
  "status": "requested",
  "canceled_by": "00000000-0000-0000-0000-000000000000",
  "canceled_date": "2024-08-25T15:00:00Z",
  "is_canceled": true
}

json

application/json

update_claim_estimation

POST

/api/v2/claim_estimations/update_claim_estimation

Update an existing estimation.

update_claim_estimation › Request Body

Request Schema for /api/v2/claim_estimations/update_claim_estimation

request-update_claim_estimation

claim_estimation-def · required

update_claim_estimation › Responses

200

Response Schema for /api/v2/claim_estimations/update_claim_estimation

response-update_claim_estimation

claim_estimation-def · required

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/claim_estimations/update_claim_estimation

curl --request POST \
  --url /api/v2/claim_estimations/update_claim_estimation \
  --header 'Content-Type: application/json' \
  --data '
{
  "claim_estimation": {
    "id": "00000000-0000-0000-0000-000000000000",
    "claim_id": "00000000-0000-0000-0000-000000000000",
    "xact_assignment_id": "xact_assignment_id",
    "assignment_type": "initial",
    "xact_analysis_status": "xact_analysis_status",
    "sent_date": "2024-08-25T15:00:00Z",
    "sent_by": "00000000-0000-0000-0000-000000000000",
    "assignment_date": "2024-08-25T15:00:00Z",
    "inspection_date": "2024-08-25T15:00:00Z",
    "contact_date": "2024-08-25T15:00:00Z",
    "estimate_date": "2024-08-25T15:00:00Z",
    "appointment_date": "2024-08-25T15:00:00Z",
    "estimate_approval_date": "2024-08-25T15:00:00Z",
    "building_estimate_amount": 0,
    "contents_estimate_amount": 0,
    "icc_estimate_amount": 0,
    "status": "requested",
    "canceled_by": "00000000-0000-0000-0000-000000000000",
    "canceled_date": "2024-08-25T15:00:00Z",
    "is_canceled": true
  }
}
'

Example Request Body

{
  "claim_estimation": {
    "id": "00000000-0000-0000-0000-000000000000",
    "claim_id": "00000000-0000-0000-0000-000000000000",
    "xact_assignment_id": "xact_assignment_id",
    "assignment_type": "initial",
    "xact_analysis_status": "xact_analysis_status",
    "sent_date": "2024-08-25T15:00:00Z",
    "sent_by": "00000000-0000-0000-0000-000000000000",
    "assignment_date": "2024-08-25T15:00:00Z",
    "inspection_date": "2024-08-25T15:00:00Z",
    "contact_date": "2024-08-25T15:00:00Z",
    "estimate_date": "2024-08-25T15:00:00Z",
    "appointment_date": "2024-08-25T15:00:00Z",
    "estimate_approval_date": "2024-08-25T15:00:00Z",
    "building_estimate_amount": 0,
    "contents_estimate_amount": 0,
    "icc_estimate_amount": 0,
    "status": "requested",
    "canceled_by": "00000000-0000-0000-0000-000000000000",
    "canceled_date": "2024-08-25T15:00:00Z",
    "is_canceled": true
  }
}

json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "claim_id": "00000000-0000-0000-0000-000000000000",
    "xact_assignment_id": "xact_assignment_id",
    "assignment_type": "initial",
    "xact_analysis_status": "xact_analysis_status",
    "sent_date": "2024-08-25T15:00:00Z",
    "sent_by": "00000000-0000-0000-0000-000000000000",
    "assignment_date": "2024-08-25T15:00:00Z",
    "inspection_date": "2024-08-25T15:00:00Z",
    "contact_date": "2024-08-25T15:00:00Z",
    "estimate_date": "2024-08-25T15:00:00Z",
    "appointment_date": "2024-08-25T15:00:00Z",
    "estimate_approval_date": "2024-08-25T15:00:00Z",
    "building_estimate_amount": 0,
    "contents_estimate_amount": 0,
    "icc_estimate_amount": 0,
    "status": "requested",
    "canceled_by": "00000000-0000-0000-0000-000000000000",
    "canceled_date": "2024-08-25T15:00:00Z",
    "is_canceled": true
  },
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

claim_dates claim_exposures