Assets

Model

Asset Model

object "asset"
The enum value identifying this as an asset model.

status string
The current status of the asset, can be in_use, in_storage, on_loan, in_repair, in_transit, in_pipeline, lost, missing, stolen, donated, disposed, out_of_service, for_sale or sold.

attributes string[]
Attributes of the asset item, can be alcohol, marijuana, pharma, dry_ice, or lithium.

color string
The color of the asset item.

created_at integer
Time in epoch seconds when this asset was created.

currency string
The three-letter ISO string for the currency. Defaults to "USD".

id string
Unique identifier for this asset.

description string
The description of the asset item.

images Array.<object>
A list of image objects for this asset. Each object contains name (the image file name), url (the image URL), and is_public (boolean indicating if the image is publicly accessible). Falls back to the associated item's images if no asset-level images are set.

image_urls string[]
A flat array of image URLs for this asset. Convenience field that mirrors the images array URLs.

gtin string
The Global Trade Item Number of the asset item.

serial_number string
The serial number of the asset.

harmonized_code string
The harmonized code of the asset item.

item_id string
The ID of the item associated with this asset.

location_id string
The ID of the location where the asset is stored.

layout_id string
The ID of the layout where the asset is placed.

metadata object
Additional metadata associated with the asset.

name string
The name of the asset item.

origin_country string
The country of origin of the asset item.

organization_id string
The ID of the organization associated with this asset.

vendor string
The vendor of the asset item.

size string
The size of the asset item.

sku string
The Stock Keeping Unit (SKU) of the asset item.

length number
The length of the asset item.

width number
The width of the asset item.

height number
The height of the asset item.

weight number
The weight of the asset item.

packaged_length number
The length of the packaged asset item.

packaged_width number
The width of the packaged asset item.

packaged_height number
The height of the packaged asset item.

packaged_weight number
The weight of the packaged asset item.

value number
The monetary value of the asset in cents.

updated_at integer
Time in epoch seconds when this asset was last updated.

updated_by string
The ID of the user who last updated this asset.

barcode string
The barcode associated with this asset.

category string
The category of the asset item.

sub_category string
The sub-category of the asset item.

assignee Contact | null
The contact assigned to this asset, returned as a full Contact object. Null if no contact is assigned.

archived boolean
Indicates if the asset is archived or not.

initial_value number
The initial monetary value of the asset in cents.

purchased_at integer
Time in epoch seconds when this asset was purchased.

layout_name string
The full nested path of the layout where the asset is placed (e.g., Aisle A > Shelf B > Bin 3).

layout_code string
The short code of the layout where the asset is placed.

location_name string
The name of the location where the asset is stored.

linked_documents AssetDocument[]
An array of documents associated with this asset.

Show Details


Object.object `string` The enum for this object
Object.id `string` The unique ID of the document
Object.document_type `string` Describes the type of the document like `warranty_card`, `user_manual`, `invoice`, `transfer_order`, `POD`, `asset_request`, `other`
Object.document_url `string` The bucket URL for the document
Object.document_name `string` The name of the document
Object.created_at `integer` Time in epoch seconds when the document was created
Object.updated_at `integer` Time in epoch seconds when the document was last updated
Object.updated_by `string` The ID of the user or key that last updated the document

warranty_details AssetWarrantyModel
The warranty details of the asset.

Show Details


Object.object `"asset_warranty"` The enum value identifying this as a warranty model.
Object.warranty_expires_at `integer` Time in epoch seconds until which the warranty is valid.
Object.is_warranty_valid `boolean` Current validity status of the asset warranty.

maintenance_details AssetMaintenanceModel
The maintenance details of the asset.

Show Details


Object.object `"asset_maintenance"` The enum value identifying this as a maintenance model.
Object.maintenance_schedule `string` How often maintenance is to be performed. Can be `daily`, `weekly`, `monthly`, `quarterly`, or `yearly`.
Object.maintenance_status `string` The current maintenance status. Can be `good`, `upcoming`, `required`, or `ongoing`.
Object.next_maintenance_at `integer` Time in epoch seconds of the next scheduled maintenance.

disposal_details AssetDisposalModel
The disposal details of the asset.

Show Details


Object.object `"asset_disposal"` The enum value identifying this as a disposal model.
Object.disposed_at `integer` Time in epoch seconds at which the asset was disposed.
Object.disposal_reason_code `string` The reason code for asset disposal.
Object.disposal_comment `string` Comments or note at the time of disposal.

checksum string
An MD5 checksum of the asset's properties. This value changes whenever the asset is modified, making it useful for detecting changes without comparing individual fields.

For managing asset serial number sequences, see Sequences.

Model

# Asset Model

Asset Model