Equipment

Create Equipment

Creates a new Equipment

post/equipment

Request

Request body

namestring required

The name for this Equipment.

brandstring

The name of the brand which makes this Equipment.

modelstring

The model name of this Equipment.

serial_numberstring

The serial number of this Equipment.

type_idinteger required
status_idinteger required
group_idinteger nullable
group_hierarchystring

A pipe delimited group hierarchy. Ex: "Level 1|Level 2|Level 3". Where Level 1 is the parent of Level 2, and 2 is the parent of 3. Any missing nodes in the hierarchy will be created.

purchase_vendor_idinteger nullable
purchase_pricenumber

The price at which the Equipment was purchased.

purchase_datestring date

We recommend using ISO-8601 formatted dates to avoid ambiguity.

warranty_expiration_datestring date

The date on which the Equipment warranty expires.

purchase_commentsstring

Any comments about the purchase of this Equipment.

in_service_datestring date

We recommend using ISO-8601 formatted dates to avoid ambiguity.

estimated_service_lifeinteger

The estimated duration in months of the service life for this Equipment.

estimated_resale_pricenumber

The estimated resale price of this Equipment.

out_of_service_datestring date

We recommend using ISO-8601 formatted dates to avoid ambiguity.

linked_vehicle_idinteger nullable
assignee_idinteger nullable
default_imagestring uri nullable

The default image URL for this Equipment.

custom_fieldsCustomFields nullable

*Full details on working with Custom Fields here.

Example request

{
  "purchase_date": "2023-03-14",
  "warranty_expiration_date": "2023-03-14",
  "in_service_date": "2023-03-14",
  "out_of_service_date": "2023-03-14"
}

Response

OK

idinteger required
created_atstring date-time required

The date and time at which this record was created.

updated_atstring date-time required

The date and time at which this record was most recently updated.

account_idinteger required

The ID of the Account this Equipment belongs to.

namestring required

The name for this Equipment.

brandstring nullable required

The name of the brand which makes this Equipment.

modelstring nullable required

The model name of this Equipment.

serial_numberstring nullable required

The serial number of this Equipment.

equipment_type_idinteger required
equipment_status_idinteger required
group_idinteger nullable required
purchase_vendor_idinteger nullable required
purchase_price_centsnumber nullable required

The purchase price in cents.

purchase_datestring date nullable required

The date on which the Equipment was purchased.

warranty_expiration_datestring date nullable required

The date on which the Equipment warranty expires.

purchase_commentsstring nullable required

Any comments about the purchase of this Equipment.

custom_fieldsCustomFields nullable

*Full details on working with Custom Fields here.

in_service_datestring date nullable required

The date on which the Equipment was put into service.

estimated_service_lifeinteger nullable required

The estimated duration in months of the service life for this Equipment.

out_of_service_datestring date nullable required

The estimated date on which the Equipment will be retired from service.

archived_atstring date-time nullable required

The date and time at which the Equipment was archived.

current_location_entry_idinteger nullable
watchers_countinteger required

The number of users watching this Equipment.

watchable_optionsobject
bulk_watch_recordboolean

Whether or not to bulk watch this Equipment.

estimated_resale_price_centsinteger nullable

The estimated resale price of this Equipment.

label_liststring[]

A list of any labels applied to this Equipment.

skip_automatic_watchers_callbacksboolean

Whether or not to skip automatic watchers callbacks on this Equipment.

comments_countinteger required

The number of Comments on this Equipment.

documents_countinteger required

The number of documents attached to this Equipment.

images_countinteger required

The number of images attached to this Equipment.

Example response

{
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "purchase_date": "2023-03-14",
  "warranty_expiration_date": "2023-03-14",
  "in_service_date": "2023-03-14",
  "out_of_service_date": "2023-03-14"
}

Changes

No recorded changes to this operation across all 6 revisions of this API.