Skip to content

Deel: IT assets schemas

97 Deel schemas with complete fields and constraints.

← IT assets operations · All schemas

Archive an IT asset — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
notestringOptionalOptional human-readable note explaining the reason for archiving.
statusstringRequired within parentTerminal status that describes why the asset is being archived.
One of: ADDED_BY_MISTAKE, BINNED, BROKEN_AT_WAREHOUSE, BROKEN_BY_USER, BROKEN_IN_TRANSIT, DAMAGED_AT_WAREHOUSE, DAMAGED_BY_USER, DAMAGED_IN_TRANSIT, LEFT_WITH_USER, LOST_IN_TRANSIT, RETURNED_TO_DEEL, SHRINKAGE, STOLEN, SUPPLIER_RETURN

Assign asset to new holder — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
collection_addressModelRequired within parentExpand Assign asset to new holder — request body — body data collection address
Location the asset is being collected from before being shipped to the new holder.
delivery_addressModelOptionalExpand Assign asset to new holder — request body — body data delivery address
Delivery address for the target holder. Optional when the target HRIS profile already has a valid delivery address on file.
hris_profile_idstringRequired within parentHRIS profile identifier of the new holder.
Format: uuid
not_beforestringOptionalEarliest date Deel logistics may execute the pickup.
Format: date
shipment_insuranceModelOptionalExpand Assign asset to new holder — request body — body data shipment insurance
Insurance-consent flag and optional purchase details Deel records against the asset. May be omitted (or sent with `is_waived: false` and no `purchase_details`) if the asset already has a purchase price and date on record.

Referenced models: Assign asset to new holder — request body — body data shipment insurance, Assign asset to new holder — request body — body data collection address, Assign asset to new holder — request body — body data delivery address

Assign asset to new holder — request body — body data collection address

FieldTypePresenceDescription and constraints
$objectRootLocation the asset is being collected from before being shipped to the new holder.
countryModelOptionalExpand Assign asset to new holder — request body — body data collection address country
Country the asset is being picked up from. Overrides the country the asset-action validator derives from asset state.

Referenced models: Assign asset to new holder — request body — body data collection address country

Assign asset to new holder — request body — body data collection address country

FieldTypePresenceDescription and constraints
$stringRootCountry the asset is being picked up from. Overrides the country the asset-action validator derives from asset state.
One of: AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW

Assign asset to new holder — request body — body data delivery address

FieldTypePresenceDescription and constraints
$objectRootDelivery address for the target holder. Optional when the target HRIS profile already has a valid delivery address on file.
citystringOptionalCity name
countryModelRequired within parentExpand Assign asset to new holder — request body — body data delivery address country
Country code (ISO 3166 alpha-2)
date_of_birthstringOptionalDate of birth
Format: date
delivery_instructionsstringOptionalDelivery instructions for the courier
line1stringOptionalAddress line 1
line2stringOptionalAddress line 2
passport_numberstringOptionalPassport number
phone_numberstringOptionalPhone number in E.164 format
post_codestringOptionalPost code
statestringOptionalState or region name
tax_id_numberstringOptionalTax ID number

Referenced models: Assign asset to new holder — request body — body data delivery address country

Assign asset to new holder — request body — body data delivery address country

FieldTypePresenceDescription and constraints
$stringRootCountry code (ISO 3166 alpha-2)
One of: AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW

Assign asset to new holder — request body — body data shipment insurance

FieldTypePresenceDescription and constraints
$objectRootInsurance-consent flag and optional purchase details Deel records against the asset. May be omitted (or sent with `is_waived: false` and no `purchase_details`) if the asset already has a purchase price and date on record.
is_waivedbooleanRequired within parentConsent to ship without insurance. When true, `purchase_details` must be omitted and Deel will not record a purchase price against the asset.
purchase_detailsModelOptionalExpand Assign asset to new holder — request body — body data shipment insurance purchase details
Purchase details Deel records against the asset. Omit to fall back to purchase details already stored on the asset, if any. Must be omitted when `is_waived` is true.

Referenced models: Assign asset to new holder — request body — body data shipment insurance purchase details

Assign asset to new holder — request body — body data shipment insurance purchase details

FieldTypePresenceDescription and constraints
$objectRootPurchase details Deel records against the asset. Omit to fall back to purchase details already stored on the asset, if any. Must be omitted when `is_waived` is true.
datestringRequired within parentDate the asset was purchased.
Format: date
priceModelRequired within parentExpand Assign asset to new holder — request body — body data shipment insurance purchase details price
Purchase price paid for the asset.

Referenced models: Assign asset to new holder — request body — body data shipment insurance purchase details price

Assign asset to new holder — request body — body data shipment insurance purchase details price

FieldTypePresenceDescription and constraints
$objectRootPurchase price paid for the asset.
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand Update asset — request body — body data purchase value currency
Three-letter currency code for the price

Referenced models: Update asset — request body — body data purchase value currency

Create a collection for an IT asset — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
collection_addressModelRequired within parentExpand Create a collection for an IT asset — request body — body data collection address
Location the asset is being collected from.
not_beforestringOptionalEarliest date Deel logistics may execute the pickup.
Format: date
shipment_insuranceModelOptionalExpand Assign asset to new holder — request body — body data shipment insurance
Insurance-consent flag and optional purchase details Deel records against the asset. May be omitted (or sent with `is_waived: false` and no `purchase_details`) if the asset already has a purchase price and date on record.
store_and_reuse_locationstringOptionalDeel-managed reuse destination for the collection. Mutually exclusive with `warehouse_id`.
One of: DEEL_HUB, LOCAL_HUB
warehouse_idstringOptionalDestination warehouse identifier for the collection. Mutually exclusive with `store_and_reuse_location`.
Format: uuid

Referenced models: Create a collection for an IT asset — request body — body data collection address, Assign asset to new holder — request body — body data shipment insurance

Create a collection for an IT asset — request body — body data collection address

FieldTypePresenceDescription and constraints
$objectRootLocation the asset is being collected from.
countryModelOptionalExpand Assign asset to new holder — request body — body data collection address country
Country the asset is being picked up from. Overrides the country the asset-action validator derives from asset state.

Referenced models: Assign asset to new holder — request body — body data collection address country

Create a delivery request for an IT asset — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
delivery_addressModelOptionalExpand Create a delivery request for an IT asset — request body — body data delivery address
Delivery address for the recipient. Optional when the HRIS profile already has a valid delivery address on file.
hris_profile_idstringRequired within parentHRIS profile identifier of the recipient.
Format: uuid
is_express_deliverybooleanRequired within parentWhether express delivery is requested. Defaults to false. Charges an express fee where the country supports express delivery.
shipment_insuranceModelOptionalExpand Create a delivery request for an IT asset — request body — body data shipment insurance
Insurance-consent flag and optional purchase details Deel records against the asset. Required for every asset, including one already at a Deel warehouse. Send either purchase details or a waiver. With `is_waived` false, purchase details may be left out only if the asset already has a purchase price and date on record.

Referenced models: Create a delivery request for an IT asset — request body — body data delivery address, Create a delivery request for an IT asset — request body — body data shipment insurance

Create a delivery request for an IT asset — request body — body data delivery address

FieldTypePresenceDescription and constraints
$objectRootDelivery address for the recipient. Optional when the HRIS profile already has a valid delivery address on file.
citystringOptionalCity name
countryModelRequired within parentExpand Assign asset to new holder — request body — body data delivery address country
Country code (ISO 3166 alpha-2)
date_of_birthstringOptionalDate of birth
Format: date
delivery_instructionsstringOptionalDelivery instructions for the courier
line1stringOptionalAddress line 1
line2stringOptionalAddress line 2
passport_numberstringOptionalPassport number
phone_numberstringOptionalPhone number in E.164 format
post_codestringOptionalPost code
statestringOptionalState or region name
tax_id_numberstringOptionalTax ID number

Referenced models: Assign asset to new holder — request body — body data delivery address country

Create a delivery request for an IT asset — request body — body data shipment insurance

FieldTypePresenceDescription and constraints
$objectRootInsurance-consent flag and optional purchase details Deel records against the asset. Required for every asset, including one already at a Deel warehouse. Send either purchase details or a waiver. With `is_waived` false, purchase details may be left out only if the asset already has a purchase price and date on record.
is_waivedbooleanRequired within parentConsent to ship without insurance. When true, `purchase_details` must be omitted and Deel will not record a purchase price against the asset.
purchase_detailsModelOptionalExpand Assign asset to new holder — request body — body data shipment insurance purchase details
Purchase details Deel records against the asset. Omit to fall back to purchase details already stored on the asset, if any. Must be omitted when `is_waived` is true.

Referenced models: Assign asset to new holder — request body — body data shipment insurance purchase details

Create an IT asset — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
brandstringRequired within parentProduct brand. Free-form; well-known values ("Apple", "Microsoft", "Dell",
"Lenovo", "HP") are normalized when passed with common aliases.
categoryModelRequired within parentExpand Create an IT asset — request body — body data category
Product category
end_of_life_onstringOptionalEnd-of-life date for the asset
Format: date
gradestringOptionalCondition grade of the asset. Currently ignored when location is AT_WAREHOUSE.
One of: A, B, C, D, F, NEW
hris_profile_idstringOptionalHRIS profile ID of the user the asset is assigned to.
Required when location is WITH_USER.
Format: uuid
keyboard_layoutModelOptionalExpand Create an IT asset — request body — body data keyboard layout
Keyboard layout of the asset. Required for laptops.
locationstringRequired within parentWhere the asset is located when created. Must be WITH_USER or AT_WAREHOUSE.
One of: AT_WAREHOUSE, WITH_USER
namestringRequired within parentProduct name displayed for the asset
operating_systemstringOptionalOperating system running on the asset. Required for device categories that
support an operating system.
One of: ANDROID_PHONE, ANDROID_TABLET, CHROME_OS, IOS_PHONE, IOS_TABLET, LINUX, MACOS, WINDOWS
purchase_datestringOptionalDate the asset was purchased
Format: date
purchase_valueModelOptionalExpand Update asset — request body — body data purchase value
Price paid for the asset
serial_numberstringOptionalAsset serial number. Required for device categories.
specificationsarrayRequired within parentProduct specifications
specifications[]ModelEach itemExpand Create an IT asset — request body — body data specifications item
storage_location_idstringOptionalID of the organization storage location the asset is stored at.
Required when location is AT_WAREHOUSE.
Format: uuid

Referenced models: Create an IT asset — request body — body data category, Update asset — request body — body data purchase value, Create an IT asset — request body — body data keyboard layout, Create an IT asset — request body — body data specifications item

Create an IT asset — request body — body data category

FieldTypePresenceDescription and constraints
$stringRootProduct category
One of: ADAPTER, CABLE, CHAIR, CHARGER, COMPACT_DESKTOP, DESK, DESKTOP, DESK_RISER, DESK_TIDY, DOCKING_STATION, DONGLE, FOOTREST, HEADSET, KEYBOARD, LAPTOP, LAPTOP_STAND, MICE_TRACKPAD, MOBILE_DEVICE, MONITOR, MONITOR_ARM, OTHER, PRINTER, SHREDDER, STANDING_MAT, TABLET, TASK_LIGHT, WEBCAM, WELCOME_PACK, WIFI_RANGE_EXTENDER

Create an IT asset — request body — body data keyboard layout

FieldTypePresenceDescription and constraints
$stringRootKeyboard layout of the asset. Required for laptops.
One of: ARABIC, BELARUSIAN_JCUKEN, BELGIAN_AZERTY, BRAZILIAN_PORTUGUESE_QWERTY, BULGARIAN, CANADIAN_MULTILINGUAL_STANDARD_QWERTY, COLEMAK, CROATIAN_QWERTZ, CZECH_QWERTY, DANISH_QWERTY, DUTCH_QWERTY, DVORAK_ENGLISH, DVORAK_FRENCH, EGYPTIAN_LOCAL, ENGLISH_RUSSIAN_QWERTY, EU_STANDARD_QWERTY, FRENCH_AZERTY, FRENCH_BEPO, GERMAN_QWERTZ, GREEK, HEBREW, HUNGARIAN_QWERTZ, INDIAN_QWERTY, INTERNATIONAL_ENGLISH_QWERTY, ITALIAN_QWERTY, JAPANESE_QWERTY, KOREAN_QWERTY, LATAM_QWERTY, NORWEGIAN_QWERTY, POLISH_QWERTY, PORTUGUESE_QWERTY, RUSSIAN_JCUKEN, SERBIAN_CYRILLIC, SERBIAN_LATIN_QWERTZ, SLOVAK_QWERTZ, SPANISH_QWERTY, SWEDISH_QWERTY, SWISS_FRENCH_QWERTZ, SWISS_GERMAN_QWERTZ, THAI, TURKISH_QWERTY, UKRAINIAN_JCUKEN, UK_ENGLISH_QWERTY, UNKNOWN, US_ENGLISH_QWERTY, VIETNAMESE, WORKMAN

Create an IT asset — request body — body data specifications item

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentSpecification key
One of: COLOR, DISPLAY, MEMORY, PROCESSOR, STORAGE
valuestringRequired within parentSpecification value

List IT assets — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand List IT assets — 200 response body — data item
has_morebooleanRequired within parentWhether there are more results available
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to the next page
next_cursor (anyOf 2)nullAlternativeCursor to the next page
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of records
Format: int64
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List IT assets — 200 response body — data item

List IT assets — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
assigned_userJSONRequired within parentDetails of the user with asset possession
assigned_user (anyOf 1)ModelAlternativeExpand Retrieve an IT order — 200 response body — data user Details of the user with asset possession
assigned_user (anyOf 2)nullAlternative
assigned_warehouseJSONRequired within parentDetails of the warehouse with asset possession
assigned_warehouse (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data / assigned_warehouse / ownership: DEEL, ORGANIZATION, warehouse type: CLEARANCE, DEEL, ORGANIZATION
assigned_warehouse (anyOf 2)nullAlternative
created_atstringRequired within parentCreation timestamp of the asset
Format: date-time
gradestringRequired within parentThe condition grade of the asset
Known values: A, B, C, D, F, NEW
idstringRequired within parentUnique identifier of the item
Format: uuid
keyboard_layoutJSONRequired within parentKeyboard layout of the asset, null when none is recorded
keyboard_layout (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data keyboard layout string
keyboard_layout (anyOf 2)nullAlternative
locationstringRequired within parentCurrent location type of the asset
Known values: AT_WAREHOUSE, CLEARANCE_WAREHOUSE, DEEL_WAREHOUSE, ORGANIZATION_WAREHOUSE, SUPPLIER, WITH_COURIER, WITH_USER, WRITE_OFF
operating_systemJSONRequired within parentOperating system of the asset, null when none is recorded
operating_system (anyOf 1)stringAlternativeOperating system of the asset, null when none is recorded
Known values: ANDROID_PHONE, ANDROID_TABLET, CHROME_OS, IOS_PHONE, IOS_TABLET, LINUX, MACOS, WINDOWS
operating_system (anyOf 2)nullAlternative
ownershipModelRequired within parentExpand Update asset — 200 response body — data ownership
Asset owner
productModelRequired within parentExpand List IT assets — 200 response body — data item product
Product details
public_idstringRequired within parentPublic identifier of the item
purchase_dateJSONRequired within parent
purchase_date (anyOf 1)stringAlternativePurchase date of the asset
Format: date
purchase_date (anyOf 2)nullAlternativePurchase date of the asset
Format: date
purchase_valueJSONRequired within parentPurchase value of the asset
purchase_value (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data purchase value Purchase value of the asset
purchase_value (anyOf 2)nullAlternative
serial_numberJSONRequired within parent
serial_number (anyOf 1)stringAlternativeAsset serial number
serial_number (anyOf 2)nullAlternativeAsset serial number
statusstringRequired within parentCurrent state of the asset
Known values: ACTIVE, ADDED_BY_MISTAKE, BEING_REPAIRED, BINNED, BROKEN_AT_WAREHOUSE, BROKEN_BY_USER, BROKEN_IN_TRANSIT, CLEARED, DAMAGED_AT_WAREHOUSE, DAMAGED_BY_USER, DAMAGED_IN_TRANSIT, LEFT_WITH_USER, LOST_IN_TRANSIT, RETURNED_TO_DEEL, SHRINKAGE, STOLEN, SUPPLIER_RETURN, USED_AS_SPARE_PART, WAITING_FOR_CLEARANCE
updated_atstringRequired within parentLast update timestamp of the asset
Format: date-time

Referenced models: Update asset — 200 response body — data / assigned_warehouse / ownership: DEEL, ORGANIZATION, warehouse type: CLEARANCE, DEEL, ORGANIZATION, Update asset — 200 response body — data keyboard layout string, Update asset — 200 response body — data ownership, Update asset — 200 response body — data purchase value Purchase value of the asset, Retrieve an IT order — 200 response body — data user Details of the user with asset possession, List IT assets — 200 response body — data item product

List IT assets — 200 response body — data item product

FieldTypePresenceDescription and constraints
$objectRootProduct details
brandstringRequired within parentProduct brand
categoryModelRequired within parentExpand Retrieve a product's catalog details — 200 response body — data category
Product category
idstringRequired within parentUnique identifier of the product
Format: uuid
namestringRequired within parentProduct name

Referenced models: Retrieve a product's catalog details — 200 response body — data category

List IT assets — request body — query keyboard layouts item

FieldTypePresenceDescription and constraints
$stringRootOne of: ARABIC, BELARUSIAN_JCUKEN, BELGIAN_AZERTY, BRAZILIAN_PORTUGUESE_QWERTY, BULGARIAN, CANADIAN_MULTILINGUAL_STANDARD_QWERTY, COLEMAK, CROATIAN_QWERTZ, CZECH_QWERTY, DANISH_QWERTY, DUTCH_QWERTY, DVORAK_ENGLISH, DVORAK_FRENCH, EGYPTIAN_LOCAL, ENGLISH_RUSSIAN_QWERTY, EU_STANDARD_QWERTY, FRENCH_AZERTY, FRENCH_BEPO, GERMAN_QWERTZ, GREEK, HEBREW, HUNGARIAN_QWERTZ, INDIAN_QWERTY, INTERNATIONAL_ENGLISH_QWERTY, ITALIAN_QWERTY, JAPANESE_QWERTY, KOREAN_QWERTY, LATAM_QWERTY, NORWEGIAN_QWERTY, POLISH_QWERTY, PORTUGUESE_QWERTY, RUSSIAN_JCUKEN, SERBIAN_CYRILLIC, SERBIAN_LATIN_QWERTZ, SLOVAK_QWERTZ, SPANISH_QWERTY, SWEDISH_QWERTY, SWISS_FRENCH_QWERTZ, SWISS_GERMAN_QWERTZ, THAI, TURKISH_QWERTY, UKRAINIAN_JCUKEN, UK_ENGLISH_QWERTY, UNKNOWN, US_ENGLISH_QWERTY, VIETNAMESE, WORKMAN

Retrieve an IT asset — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve an IT asset — 200 response body — data

Referenced models: Retrieve an IT asset — 200 response body — data

Retrieve an IT asset — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
actionsModelRequired within parentExpand Update asset — 200 response body — data actions
Actions the caller can execute on this asset, with availability status per action
assigned_userJSONRequired within parentDetails of the user with asset possession
assigned_user (anyOf 1)ModelAlternativeExpand Retrieve an IT order — 200 response body — data user Details of the user with asset possession
assigned_user (anyOf 2)nullAlternative
assigned_warehouseJSONRequired within parentDetails of the warehouse with asset possession
assigned_warehouse (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data / assigned_warehouse / ownership: DEEL, ORGANIZATION, warehouse type: CLEARANCE, DEEL, ORGANIZATION
assigned_warehouse (anyOf 2)nullAlternative
created_atstringRequired within parentCreation timestamp of the asset
Format: date-time
gradestringRequired within parentThe condition grade of the asset
Known values: A, B, C, D, F, NEW
idstringRequired within parentUnique identifier of the item
Format: uuid
keyboard_layoutJSONRequired within parentKeyboard layout of the asset, null when none is recorded
keyboard_layout (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data keyboard layout string
keyboard_layout (anyOf 2)nullAlternative
locationstringRequired within parentCurrent location type of the asset
Known values: AT_WAREHOUSE, CLEARANCE_WAREHOUSE, DEEL_WAREHOUSE, ORGANIZATION_WAREHOUSE, SUPPLIER, WITH_COURIER, WITH_USER, WRITE_OFF
operating_systemJSONRequired within parentOperating system of the asset, null when none is recorded
operating_system (anyOf 1)stringAlternativeOperating system of the asset, null when none is recorded
Known values: ANDROID_PHONE, ANDROID_TABLET, CHROME_OS, IOS_PHONE, IOS_TABLET, LINUX, MACOS, WINDOWS
operating_system (anyOf 2)nullAlternative
ownershipModelRequired within parentExpand Update asset — 200 response body — data ownership
Asset owner
productModelRequired within parentExpand Update asset — 200 response body — data product
Product details
public_idstringRequired within parentPublic identifier of the item
purchase_dateJSONRequired within parent
purchase_date (anyOf 1)stringAlternativePurchase date of the asset
Format: date
purchase_date (anyOf 2)nullAlternativePurchase date of the asset
Format: date
purchase_valueJSONRequired within parentPurchase value of the asset
purchase_value (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data purchase value Purchase value of the asset
purchase_value (anyOf 2)nullAlternative
serial_numberJSONRequired within parent
serial_number (anyOf 1)stringAlternativeAsset serial number
serial_number (anyOf 2)nullAlternativeAsset serial number
statusstringRequired within parentCurrent state of the asset
Known values: ACTIVE, ADDED_BY_MISTAKE, BEING_REPAIRED, BINNED, BROKEN_AT_WAREHOUSE, BROKEN_BY_USER, BROKEN_IN_TRANSIT, CLEARED, DAMAGED_AT_WAREHOUSE, DAMAGED_BY_USER, DAMAGED_IN_TRANSIT, LEFT_WITH_USER, LOST_IN_TRANSIT, RETURNED_TO_DEEL, SHRINKAGE, STOLEN, SUPPLIER_RETURN, USED_AS_SPARE_PART, WAITING_FOR_CLEARANCE
updated_atstringRequired within parentLast update timestamp of the asset
Format: date-time

Referenced models: Update asset — 200 response body — data actions, Update asset — 200 response body — data / assigned_warehouse / ownership: DEEL, ORGANIZATION, warehouse type: CLEARANCE, DEEL, ORGANIZATION, Update asset — 200 response body — data keyboard layout string, Update asset — 200 response body — data ownership, Update asset — 200 response body — data product, Update asset — 200 response body — data purchase value Purchase value of the asset, Retrieve an IT order — 200 response body — data user Details of the user with asset possession

Update asset location — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
hris_profile_idstringOptionalHRIS profile ID of the user the asset is being moved to. Required when
location is WITH_USER; ignored when location is AT_WAREHOUSE.
Format: uuid
locationModelRequired within parentExpand Update asset location — request body — body data location
Target location for the asset. Only WITH_USER and AT_WAREHOUSE are
accepted; other ItemLocation values are managed by Deel logistics and
rejected with 400. Supported values that produce a transition the
underlying self-serve workflow cannot perform (e.g. AT_WAREHOUSE ->
AT_WAREHOUSE) are rejected with 409 by the workflow's own asset_not_*
errors.
warehouse_idstringOptionalID of the organization storage location the asset is being moved to.
Required when location is AT_WAREHOUSE; ignored when location is WITH_USER.
Format: uuid

Referenced models: Update asset location — request body — body data location

Update asset location — request body — body data location

FieldTypePresenceDescription and constraints
$stringRootTarget location for the asset. Only WITH_USER and AT_WAREHOUSE are
accepted; other ItemLocation values are managed by Deel logistics and
rejected with 400. Supported values that produce a transition the
underlying self-serve workflow cannot perform (e.g. AT_WAREHOUSE ->
AT_WAREHOUSE) are rejected with 409 by the workflow's own asset_not_*
errors.
One of: AT_WAREHOUSE, CLEARANCE_WAREHOUSE, DEEL_WAREHOUSE, ORGANIZATION_WAREHOUSE, SUPPLIER, WITH_COURIER, WITH_USER, WRITE_OFF

Update asset — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Update asset — 200 response body — data

Referenced models: Update asset — 200 response body — data

Update asset — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
actionsModelRequired within parentExpand Update asset — 200 response body — data actions
Actions the caller can execute on this asset, with availability status per action
assigned_userJSONRequired within parentDetails of the user with asset possession
assigned_user (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data assigned user Details of the user with asset possession
assigned_user (anyOf 2)nullAlternative
assigned_warehouseJSONRequired within parentDetails of the warehouse with asset possession
assigned_warehouse (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data / assigned_warehouse / ownership: DEEL, ORGANIZATION, warehouse type: CLEARANCE, DEEL, ORGANIZATION
assigned_warehouse (anyOf 2)nullAlternative
created_atstringRequired within parentCreation timestamp of the asset
Format: date-time
gradestringRequired within parentThe condition grade of the asset
Known values: A, B, C, D, F, NEW
idstringRequired within parentUnique identifier of the item
Format: uuid
keyboard_layoutJSONRequired within parentKeyboard layout of the asset, null when none is recorded
keyboard_layout (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data keyboard layout string
keyboard_layout (anyOf 2)nullAlternative
locationstringRequired within parentCurrent location type of the asset
Known values: AT_WAREHOUSE, CLEARANCE_WAREHOUSE, DEEL_WAREHOUSE, ORGANIZATION_WAREHOUSE, SUPPLIER, WITH_COURIER, WITH_USER, WRITE_OFF
operating_systemJSONRequired within parentOperating system of the asset, null when none is recorded
operating_system (anyOf 1)stringAlternativeOperating system of the asset, null when none is recorded
Known values: ANDROID_PHONE, ANDROID_TABLET, CHROME_OS, IOS_PHONE, IOS_TABLET, LINUX, MACOS, WINDOWS
operating_system (anyOf 2)nullAlternative
ownershipModelRequired within parentExpand Update asset — 200 response body — data ownership
Asset owner
productModelRequired within parentExpand Update asset — 200 response body — data product
Product details
public_idstringRequired within parentPublic identifier of the item
purchase_dateJSONRequired within parent
purchase_date (anyOf 1)stringAlternativePurchase date of the asset
Format: date
purchase_date (anyOf 2)nullAlternativePurchase date of the asset
Format: date
purchase_valueJSONRequired within parentPurchase value of the asset
purchase_value (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data purchase value Purchase value of the asset
purchase_value (anyOf 2)nullAlternative
serial_numberJSONRequired within parent
serial_number (anyOf 1)stringAlternativeAsset serial number
serial_number (anyOf 2)nullAlternativeAsset serial number
statusModelRequired within parentExpand Update asset — 200 response body — data status
Current state of the asset
updated_atstringRequired within parentLast update timestamp of the asset
Format: date-time

Referenced models: Update asset — 200 response body — data assigned user Details of the user with asset possession, Update asset — 200 response body — data actions, Update asset — 200 response body — data / assigned_warehouse / ownership: DEEL, ORGANIZATION, warehouse type: CLEARANCE, DEEL, ORGANIZATION, Update asset — 200 response body — data keyboard layout string, Update asset — 200 response body — data ownership, Update asset — 200 response body — data product, Update asset — 200 response body — data purchase value Purchase value of the asset, Update asset — 200 response body — data status

Update asset — 200 response body — data / assigned_warehouse / ownership: DEEL, ORGANIZATION, warehouse type: CLEARANCE, DEEL, ORGANIZATION

FieldTypePresenceDescription and constraints
$objectRootDetails of the warehouse with asset possession
addressModelRequired within parentExpand Update asset — 200 response body — data / assigned_warehouse / ownership: DEEL, ORGANIZATION, warehouse type: CLEARANCE, DEEL, ORGANIZATION address
Warehouse address details
idstringRequired within parentUnique identifier of the warehouse
Format: uuid
namestringRequired within parentWarehouse or storage location name
ownershipstringRequired within parentWarehouse ownership type
Known values: DEEL, ORGANIZATION
public_idstringRequired within parentPublic identifier of the warehouse
warehouse_typestringRequired within parentWarehouse type
Known values: CLEARANCE, DEEL, ORGANIZATION

Referenced models: Update asset — 200 response body — data / assigned_warehouse / ownership: DEEL, ORGANIZATION, warehouse type: CLEARANCE, DEEL, ORGANIZATION address

Update asset — 200 response body — data / assigned_warehouse / ownership: DEEL, ORGANIZATION, warehouse type: CLEARANCE, DEEL, ORGANIZATION address

FieldTypePresenceDescription and constraints
$objectRootWarehouse address details
cityJSONRequired within parent
city (anyOf 1)stringAlternativeCity name
city (anyOf 2)nullAlternativeCity name
countryModelRequired within parentExpand Cancel an IT order — 200 response body — data delivery address country
Country code
date_of_birthJSONRequired within parent
date_of_birth (anyOf 1)stringAlternativeDate of birth (applicable for some address types)
Format: date
date_of_birth (anyOf 2)nullAlternativeDate of birth (applicable for some address types)
Format: date
delivery_instructionsJSONRequired within parent
delivery_instructions (anyOf 1)stringAlternativeSpecial instructions for deliveries
delivery_instructions (anyOf 2)nullAlternativeSpecial instructions for deliveries
idstringRequired within parentUnique identifier of the address
Format: uuid
is_validbooleanRequired within parentWhether the address passes validation
line1JSONRequired within parent
line1 (anyOf 1)stringAlternativeAddress line 1
line1 (anyOf 2)nullAlternativeAddress line 1
line2JSONRequired within parent
line2 (anyOf 1)stringAlternativeAddress line 2
line2 (anyOf 2)nullAlternativeAddress line 2
passport_numberJSONRequired within parent
passport_number (anyOf 1)stringAlternativePassport number (applicable for some address types)
passport_number (anyOf 2)nullAlternativePassport number (applicable for some address types)
phone_numberJSONRequired within parent
phone_number (anyOf 1)stringAlternativePhone number
phone_number (anyOf 2)nullAlternativePhone number
post_codeJSONRequired within parent
post_code (anyOf 1)stringAlternativePost code
post_code (anyOf 2)nullAlternativePost code
stateJSONRequired within parent
state (anyOf 1)stringAlternativeState code or name
state (anyOf 2)nullAlternativeState code or name
tax_id_numberJSONRequired within parent
tax_id_number (anyOf 1)stringAlternativeTax ID number (applicable for some address types)
tax_id_number (anyOf 2)nullAlternativeTax ID number (applicable for some address types)
typestringRequired within parentType of the address
Known values: BILLING, COLLECTION, DELIVERY, ENTITY, PARTIAL, PII, SUPPLIER

Referenced models: Cancel an IT order — 200 response body — data delivery address country

Update asset — 200 response body — data actions

FieldTypePresenceDescription and constraints
$objectRootActions the caller can execute on this asset, with availability status per action
archive_own_assetModelRequired within parentExpand Update asset — 200 response body — data actions archive own asset
Archive an organization-owned asset
asset_countryJSONRequired within parentResolved country used for asset actions. Derived from the asset's country,
its assigned rental contract billing entity country, or the last active
assignment delivery country. Null when the country cannot be determined
(e.g. asset was returned to Deel)
asset_country (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions asset country string
asset_country (anyOf 2)nullAlternative
assign_addon_to_own_assetModelRequired within parentExpand Update asset — 200 response body — data actions assign addon to own asset
Assign an add-on to an organization-owned asset
clear_own_assetModelRequired within parentExpand Update asset — 200 response body — data actions clear own asset
Clear an organization-owned asset from the fleet
manage_end_of_rental_contract_actionsModelRequired within parentExpand Update asset — 200 response body — data actions manage end of rental contract actions
Manage end-of-rental options for a Deel-owned rental asset
purchase_rentalModelRequired within parentExpand Update asset — 200 response body — data actions purchase rental
Purchase a Deel-owned rental asset at end of contract
return_rental_to_deelModelRequired within parentExpand Update asset — 200 response body — data actions return rental to deel
Return a Deel-owned rental asset back to Deel
reuse_own_asset_from_deelModelRequired within parentExpand Update asset — 200 response body — data actions reuse own asset from deel
Redeploy an organization-owned asset stored at a Deel warehouse
reuse_own_asset_from_own_locationModelRequired within parentExpand Update asset — 200 response body — data actions reuse own asset from own location
Redeploy an organization-owned asset from an organization-owned location
store_own_asset_at_deel_for_hubModelRequired within parentExpand Update asset — 200 response body — data actions store own asset at deel for hub
Store an organization-owned asset at a Deel hub warehouse
store_own_asset_at_deel_for_localModelRequired within parentExpand Update asset — 200 response body — data actions store own asset at deel for local
Store an organization-owned asset at a Deel local warehouse
store_own_asset_at_own_locationModelRequired within parentExpand Update asset — 200 response body — data actions store own asset at own location
Store an organization-owned asset at an organization-owned location
store_rental_at_deel_for_localModelRequired within parentExpand Update asset — 200 response body — data actions store rental at deel for local
Store a Deel-owned rental asset at a Deel local warehouse
store_rental_at_deel_for_zone1ModelRequired within parentExpand Update asset — 200 response body — data actions store rental at deel for zone1
Store a Deel-owned rental asset at a Deel zone-1 warehouse
transfer_own_assetModelRequired within parentExpand Update asset — 200 response body — data actions transfer own asset
Transfer an organization-owned asset to another user
transfer_rentalModelRequired within parentExpand Update asset — 200 response body — data actions transfer rental
Transfer a Deel-owned rental asset to another user
unarchive_own_assetModelRequired within parentExpand Update asset — 200 response body — data actions unarchive own asset
Unarchive a previously archived organization-owned asset
update_location_location_to_userModelRequired within parentExpand Update asset — 200 response body — data actions update location location to user
Deprecated: same as update_own_asset_location_location_to_user, kept for published API compatibility
update_location_user_to_locationModelRequired within parentExpand Update asset — 200 response body — data actions update location user to location
Deprecated: same as update_own_asset_location_user_to_location, kept for published API compatibility
update_location_user_to_userModelRequired within parentExpand Update asset — 200 response body — data actions update location user to user
Deprecated: same as update_own_asset_location_user_to_user, kept for published API compatibility
update_own_asset_detailsModelRequired within parentExpand Update asset — 200 response body — data actions update own asset details
Update editable details of an organization-owned asset
update_own_asset_location_location_to_userModelRequired within parentExpand Update asset — 200 response body — data actions update own asset location location to user
Update the location of an organization-owned asset from a warehouse to a user
update_own_asset_location_user_to_locationModelRequired within parentExpand Update asset — 200 response body — data actions update own asset location user to location
Update the location of an organization-owned asset from a user to a warehouse
update_own_asset_location_user_to_userModelRequired within parentExpand Update asset — 200 response body — data actions update own asset location user to user
Update the assigned user of an organization-owned asset that is currently with a user
update_rental_location_user_to_userModelRequired within parentExpand Update asset — 200 response body — data actions update rental location user to user
Update the assigned user of a Deel-owned rental asset handed over in person

Referenced models: Update asset — 200 response body — data actions archive own asset, Update asset — 200 response body — data actions asset country string, Update asset — 200 response body — data actions assign addon to own asset, Update asset — 200 response body — data actions clear own asset, Update asset — 200 response body — data actions manage end of rental contract actions, Update asset — 200 response body — data actions purchase rental, Update asset — 200 response body — data actions return rental to deel, Update asset — 200 response body — data actions reuse own asset from deel, Update asset — 200 response body — data actions reuse own asset from own location, Update asset — 200 response body — data actions store own asset at deel for hub, Update asset — 200 response body — data actions store own asset at deel for local, Update asset — 200 response body — data actions store own asset at own location, Update asset — 200 response body — data actions store rental at deel for local, Update asset — 200 response body — data actions store rental at deel for zone1, Update asset — 200 response body — data actions transfer own asset, Update asset — 200 response body — data actions transfer rental, Update asset — 200 response body — data actions unarchive own asset, Update asset — 200 response body — data actions update location location to user, Update asset — 200 response body — data actions update location user to location, Update asset — 200 response body — data actions update location user to user, Update asset — 200 response body — data actions update own asset details, Update asset — 200 response body — data actions update own asset location location to user, Update asset — 200 response body — data actions update own asset location user to location, Update asset — 200 response body — data actions update own asset location user to user, Update asset — 200 response body — data actions update rental location user to user

Update asset — 200 response body — data actions archive own asset

FieldTypePresenceDescription and constraints
$objectRootArchive an organization-owned asset
detailsJSONRequired within parentAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
details (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions archive own asset details allowed statuses
details (anyOf 2)nullAlternative
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions archive own asset details allowed statuses, Update asset — 200 response body — data actions clear own asset disabled reasons item

Update asset — 200 response body — data actions archive own asset details allowed statuses

FieldTypePresenceDescription and constraints
$objectRootAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
allowed_statusesarrayRequired within parentStatuses that can be passed as the archive reason when archiving the asset
allowed_statuses[]stringEach itemKnown values: ADDED_BY_MISTAKE, BINNED, BROKEN_AT_WAREHOUSE, BROKEN_BY_USER, BROKEN_IN_TRANSIT, DAMAGED_AT_WAREHOUSE, DAMAGED_BY_USER, DAMAGED_IN_TRANSIT, LEFT_WITH_USER, LOST_IN_TRANSIT, RETURNED_TO_DEEL, SHRINKAGE, STOLEN, SUPPLIER_RETURN

Update asset — 200 response body — data actions asset country string

FieldTypePresenceDescription and constraints
$stringRootResolved country used for asset actions. Derived from the asset's country,
its assigned rental contract billing entity country, or the last active
assignment delivery country. Null when the country cannot be determined
(e.g. asset was returned to Deel)
Known values: AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW

Update asset — 200 response body — data actions assign addon to own asset

FieldTypePresenceDescription and constraints
$objectRootAssign an add-on to an organization-owned asset
detailsJSONRequired within parentAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
details (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions assign addon to own asset details addons
details (anyOf 2)nullAlternative
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item, Update asset — 200 response body — data actions assign addon to own asset details addons

Update asset — 200 response body — data actions assign addon to own asset details addons

FieldTypePresenceDescription and constraints
$objectRootAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
addonsarrayRequired within parentAdd-ons that can be assigned to the asset, with a fail reason for those that don't qualify
addons[]ModelEach itemExpand Update asset — 200 response body — data actions assign addon to own asset details addons addons item

Referenced models: Update asset — 200 response body — data actions assign addon to own asset details addons addons item

Update asset — 200 response body — data actions assign addon to own asset details addons addons item

FieldTypePresenceDescription and constraints
$objectRoot
addonModelRequired within parentExpand Update asset — 200 response body — data actions assign addon to own asset details addons addons item addon
Add-on that can be assigned to the asset
fail_reasonJSONRequired within parentReason the add-on cannot be assigned to the asset. Null when assignment is allowed
fail_reason (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions assign addon to own asset details addons addons item fail reason string
fail_reason (anyOf 2)nullAlternative

Referenced models: Update asset — 200 response body — data actions assign addon to own asset details addons addons item addon, Update asset — 200 response body — data actions assign addon to own asset details addons addons item fail reason string

Update asset — 200 response body — data actions assign addon to own asset details addons addons item addon

FieldTypePresenceDescription and constraints
$objectRootAdd-on that can be assigned to the asset
idstringRequired within parentID of the add-on
Format: uuid
namestringRequired within parentPublic display name of the add-on

Update asset — 200 response body — data actions assign addon to own asset details addons addons item fail reason string

FieldTypePresenceDescription and constraints
$stringRootReason the add-on cannot be assigned to the asset. Null when assignment is allowed
Known values: ADDON_NOT_AVAILABLE_TO_ORGANIZATION, ALREADY_ASSIGNED, HAS_ACTIVE_SERVICE_ADDON, INVALID_ASSET_AGE, INVALID_CONTRACT_TYPE, INVALID_DURATION, INVALID_PAYMENT_SCHEMA, INVALID_PLATFORM_TIER, INVALID_PRODUCT_BRAND, INVALID_PRODUCT_CATEGORY, INVALID_PRODUCT_PARENT_CATEGORY, INVALID_RENTAL_TERM, NO_MATCHING_ORGANIZATION_CONTRACT, OTHER

Update asset — 200 response body — data actions clear own asset

FieldTypePresenceDescription and constraints
$objectRootClear an organization-owned asset from the fleet
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item

Update asset — 200 response body — data actions clear own asset disabled reasons item

FieldTypePresenceDescription and constraints
$stringRootKnown values: ARCHIVED, AT_DEEL_WAREHOUSE, BEING_REPAIRED, CONSUMABLE, CONTROLLED_BY_DEEL, COUNTRY_NOT_SUPPORTED_FOR_HUB, COUNTRY_NOT_SUPPORTED_FOR_LOCAL, DEEL_OWNED_ITEM_WITHOUT_RENTAL_CONTRACT, DESKTOP_STORAGE, ENDING_CONTRACT, HUB_IN_SAME_REGION_AS_LOCAL, INACTIVE, INVALID_ITEM_LOCATION, INVALID_ORGANIZATION_STATUS, INVALID_STATE, ITEM_CONDITIONS_TO_UNARCHIVE_NOT_MET, ITEM_NOT_VISIBLE_FOR_ORGANIZATION, NON_DEVICE, NOT_AT_WAREHOUSE, NOT_AVAILABLE_FOR_REUSE, NOT_A_RENTAL, NOT_MANAGEABLE_BY_ORGANIZATION, NOT_WITH_ASSIGNMENT, NOT_WITH_USER, NO_ACTIVE_ADDONS, NO_ACTIVE_STORAGE_CONTRACT, NO_LOCATION_FOR_STORAGE, NO_LOGISTICS_FOR_STORAGE, NO_VALID_ADDONS, ONGOING_SERVICE, OWNED_BY_DEEL, OWNED_BY_ORGANIZATION, OWNED_BY_PARTNER_ORGANIZATION, PARTNER_CHILD_CONTRACT, PENDING_DEVICE_REFRESH, RENTAL_CONTRACT_AND_USER_REGION_DO_NOT_MATCH, TEMPORARILY_UNAVAILABLE, UNKNOWN, USER_HAS_NO_COUNTRY, USER_HAS_NO_SEAT, WAITING_FOR_CLEARANCE, WITH_LOANER_ASSIGNMENT, WITH_NON_COLLECTED_ASSIGNMENT, WITH_NON_DELIVERED_ASSIGNMENT, WITH_PENDING_ASSIGNMENT, WRONG_ASSIGNMENT_STATUS, WRONG_CONTRACT_STATUS, WRONG_TERMS_AND_CONDITIONS

Update asset — 200 response body — data actions manage end of rental contract actions

FieldTypePresenceDescription and constraints
$objectRootManage end-of-rental options for a Deel-owned rental asset
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item

Update asset — 200 response body — data actions purchase rental

FieldTypePresenceDescription and constraints
$objectRootPurchase a Deel-owned rental asset at end of contract
detailsJSONRequired within parentAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
details (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions purchase rental details purchase price, remaining contract value, total purchase price
details (anyOf 2)nullAlternative
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item, Update asset — 200 response body — data actions purchase rental details purchase price, remaining contract value, total purchase price

Update asset — 200 response body — data actions purchase rental details purchase price, remaining contract value, total purchase price

FieldTypePresenceDescription and constraints
$objectRootAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
purchase_priceJSONRequired within parentEstimated price to purchase the asset at the end of the rental contract
purchase_price (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions purchase rental details purchase price, remaining contract value, total purchase price purchase price amount, currency
purchase_price (anyOf 2)nullAlternative
remaining_contract_valueModelRequired within parentExpand Update asset — 200 response body — data actions purchase rental details purchase price, remaining contract value, total purchase price remaining contract value
Estimated remaining value of the rental contract
total_purchase_priceJSONRequired within parentEstimated total price of the purchase, including any remaining contract value
total_purchase_price (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions purchase rental details purchase price, remaining contract value, total purchase price total purchase price amount, currency
total_purchase_price (anyOf 2)nullAlternative

Referenced models: Update asset — 200 response body — data actions purchase rental details purchase price, remaining contract value, total purchase price purchase price amount, currency, Update asset — 200 response body — data actions purchase rental details purchase price, remaining contract value, total purchase price remaining contract value, Update asset — 200 response body — data actions purchase rental details purchase price, remaining contract value, total purchase price total purchase price amount, currency

Update asset — 200 response body — data actions purchase rental details purchase price, remaining contract value, total purchase price purchase price amount, currency

FieldTypePresenceDescription and constraints
$objectRootEstimated price to purchase the asset at the end of the rental contract
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
Three-letter currency code for the price

Referenced models: Retrieve the IT seat subscription — 200 response body — data monthly seat price currency

Update asset — 200 response body — data actions purchase rental details purchase price, remaining contract value, total purchase price remaining contract value

FieldTypePresenceDescription and constraints
$objectRootEstimated remaining value of the rental contract
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
Three-letter currency code for the price

Referenced models: Retrieve the IT seat subscription — 200 response body — data monthly seat price currency

Update asset — 200 response body — data actions purchase rental details purchase price, remaining contract value, total purchase price total purchase price amount, currency

FieldTypePresenceDescription and constraints
$objectRootEstimated total price of the purchase, including any remaining contract value
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
Three-letter currency code for the price

Referenced models: Retrieve the IT seat subscription — 200 response body — data monthly seat price currency

Update asset — 200 response body — data actions return rental to deel

FieldTypePresenceDescription and constraints
$objectRootReturn a Deel-owned rental asset back to Deel
detailsJSONRequired within parentAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
details (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions return rental to deel details end contract price
details (anyOf 2)nullAlternative
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item, Update asset — 200 response body — data actions return rental to deel details end contract price

Update asset — 200 response body — data actions return rental to deel details end contract price

FieldTypePresenceDescription and constraints
$objectRootAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
end_contract_priceModelRequired within parentExpand Update asset — 200 response body — data actions return rental to deel details end contract price end contract price
Estimated end-of-contract price charged when returning the asset

Referenced models: Update asset — 200 response body — data actions return rental to deel details end contract price end contract price

Update asset — 200 response body — data actions return rental to deel details end contract price end contract price

FieldTypePresenceDescription and constraints
$objectRootEstimated end-of-contract price charged when returning the asset
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
Three-letter currency code for the price

Referenced models: Retrieve the IT seat subscription — 200 response body — data monthly seat price currency

Update asset — 200 response body — data actions reuse own asset from deel

FieldTypePresenceDescription and constraints
$objectRootRedeploy an organization-owned asset stored at a Deel warehouse
detailsJSONRequired within parentAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
details (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions reuse own asset from deel details eligible countries, express delivery
details (anyOf 2)nullAlternative
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item, Update asset — 200 response body — data actions reuse own asset from deel details eligible countries, express delivery

Update asset — 200 response body — data actions reuse own asset from deel details eligible countries, express delivery

FieldTypePresenceDescription and constraints
$objectRootAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
eligible_countriesarrayRequired within parentCountries where the asset can be redeployed from Deel
eligible_countries[]ModelEach itemExpand Retrieve a product's catalog details — 200 response body — data variants item available countries item
express_deliveryJSONRequired within parentExpress delivery availability and per-country fees. Null when express delivery is not supported
express_delivery (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions reuse own asset from deel details eligible countries, express delivery express delivery country fees
express_delivery (anyOf 2)nullAlternative

Referenced models: Retrieve a product's catalog details — 200 response body — data variants item available countries item, Update asset — 200 response body — data actions reuse own asset from deel details eligible countries, express delivery express delivery country fees

Update asset — 200 response body — data actions reuse own asset from deel details eligible countries, express delivery express delivery country fees

FieldTypePresenceDescription and constraints
$objectRootExpress delivery availability and per-country fees. Null when express delivery is not supported
country_feesobjectRequired within parentExpress delivery fees keyed by destination country.
Additional keys: see wildcard field
country_fees.*ModelAdditional keysExpand Update asset — 200 response body — data actions reuse own asset from deel details eligible countries, express delivery express delivery country fees country fees value

Referenced models: Update asset — 200 response body — data actions reuse own asset from deel details eligible countries, express delivery express delivery country fees country fees value

Update asset — 200 response body — data actions reuse own asset from deel details eligible countries, express delivery express delivery country fees country fees value

FieldTypePresenceDescription and constraints
$objectRoot
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
Three-letter currency code for the price

Referenced models: Retrieve the IT seat subscription — 200 response body — data monthly seat price currency

Update asset — 200 response body — data actions reuse own asset from own location

FieldTypePresenceDescription and constraints
$objectRootRedeploy an organization-owned asset from an organization-owned location
detailsJSONRequired within parentAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
details (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions reuse own asset from own location details eligible countries, express delivery, service cost
details (anyOf 2)nullAlternative
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item, Update asset — 200 response body — data actions reuse own asset from own location details eligible countries, express delivery, service cost

Update asset — 200 response body — data actions reuse own asset from own location details eligible countries, express delivery, service cost

FieldTypePresenceDescription and constraints
$objectRootAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
eligible_countriesarrayRequired within parentCountries where the asset can be redeployed from an organization-owned location
eligible_countries[]ModelEach itemExpand Retrieve a product's catalog details — 200 response body — data variants item available countries item
express_deliveryJSONRequired within parentExpress delivery availability and per-country fees. Null when express delivery is not supported
express_delivery (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions reuse own asset from deel details eligible countries, express delivery express delivery country fees
express_delivery (anyOf 2)nullAlternative
service_costModelRequired within parentExpand Update asset — 200 response body — data actions transfer rental details eligible countries, transfer cost transfer cost
Cost charged for the transfer service

Referenced models: Retrieve a product's catalog details — 200 response body — data variants item available countries item, Update asset — 200 response body — data actions reuse own asset from deel details eligible countries, express delivery express delivery country fees, Update asset — 200 response body — data actions transfer rental details eligible countries, transfer cost transfer cost

Update asset — 200 response body — data actions store own asset at deel for hub

FieldTypePresenceDescription and constraints
$objectRootStore an organization-owned asset at a Deel hub warehouse
detailsJSONRequired within parentAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
details (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions store own asset at deel for hub details activation cost, destination country, grace period in months, monthly fee
details (anyOf 2)nullAlternative
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item, Update asset — 200 response body — data actions store own asset at deel for hub details activation cost, destination country, grace period in months, monthly fee

Update asset — 200 response body — data actions store own asset at deel for hub details activation cost, destination country, grace period in months, monthly fee

FieldTypePresenceDescription and constraints
$objectRootAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
activation_costModelRequired within parentExpand Update asset — 200 response body — data actions store own asset at deel for hub details activation cost, destination country, grace period in months, monthly fee activation cost
Cost charged to activate storage
destination_countryModelRequired within parentExpand Update asset — 200 response body — data actions store own asset at deel for hub details activation cost, destination country, grace period in months, monthly fee destination country
ISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to
grace_period_in_monthsJSONRequired within parent
grace_period_in_months (anyOf 1)integerAlternativeGrace period in months during which storage is free before monthly fees apply
Format: int64
grace_period_in_months (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
monthly_feeModelRequired within parentExpand Update asset — 200 response body — data actions store own asset at deel for hub details activation cost, destination country, grace period in months, monthly fee monthly fee
Monthly storage fee charged after the grace period

Referenced models: Update asset — 200 response body — data actions store own asset at deel for hub details activation cost, destination country, grace period in months, monthly fee activation cost, Update asset — 200 response body — data actions store own asset at deel for hub details activation cost, destination country, grace period in months, monthly fee destination country, Update asset — 200 response body — data actions store own asset at deel for hub details activation cost, destination country, grace period in months, monthly fee monthly fee

Update asset — 200 response body — data actions store own asset at deel for hub details activation cost, destination country, grace period in months, monthly fee activation cost

FieldTypePresenceDescription and constraints
$objectRootCost charged to activate storage
billing_methodstringRequired within parentHow the action is charged. When "TOKEN", the fees are covered by an
add-on token pool; when "CURRENCY", the fees are billed in the currency
specified in the "fees" field.
Known values: CURRENCY, TOKEN
feesJSONRequired within parentPrice charged for the action. Null when billing method is "TOKEN"
fees (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost fees amount, currency
fees (anyOf 2)nullAlternative
token_usageJSONRequired within parentAdd-on token consumption details. Null when billing method is "CURRENCY"
token_usage (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost token usage addon, cost, tokens left
token_usage (anyOf 2)nullAlternative

Referenced models: Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost fees amount, currency, Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost token usage addon, cost, tokens left

Update asset — 200 response body — data actions store own asset at deel for hub details activation cost, destination country, grace period in months, monthly fee destination country

FieldTypePresenceDescription and constraints
$stringRootISO 3166-1 alpha-2 country of the Deel warehouse the asset will be shipped to
Known values: AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW

Update asset — 200 response body — data actions store own asset at deel for hub details activation cost, destination country, grace period in months, monthly fee monthly fee

FieldTypePresenceDescription and constraints
$objectRootMonthly storage fee charged after the grace period
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
Three-letter currency code for the price

Referenced models: Retrieve the IT seat subscription — 200 response body — data monthly seat price currency

Update asset — 200 response body — data actions store own asset at deel for local

FieldTypePresenceDescription and constraints
$objectRootStore an organization-owned asset at a Deel local warehouse
detailsJSONRequired within parentAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
details (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions store own asset at deel for hub details activation cost, destination country, grace period in months, monthly fee
details (anyOf 2)nullAlternative
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item, Update asset — 200 response body — data actions store own asset at deel for hub details activation cost, destination country, grace period in months, monthly fee

Update asset — 200 response body — data actions store own asset at own location

FieldTypePresenceDescription and constraints
$objectRootStore an organization-owned asset at an organization-owned location
detailsJSONRequired within parentAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
details (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions store own asset at own location details eligible countries, service cost
details (anyOf 2)nullAlternative
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item, Update asset — 200 response body — data actions store own asset at own location details eligible countries, service cost

Update asset — 200 response body — data actions store own asset at own location details eligible countries, service cost

FieldTypePresenceDescription and constraints
$objectRootAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
eligible_countriesarrayRequired within parentCountries where the asset can be stored at an organization-owned location
eligible_countries[]ModelEach itemExpand Retrieve a product's catalog details — 200 response body — data variants item available countries item
service_costModelRequired within parentExpand Update asset — 200 response body — data actions transfer rental details eligible countries, transfer cost transfer cost
Cost charged for the transfer service

Referenced models: Retrieve a product's catalog details — 200 response body — data variants item available countries item, Update asset — 200 response body — data actions transfer rental details eligible countries, transfer cost transfer cost

Update asset — 200 response body — data actions store rental at deel for local

FieldTypePresenceDescription and constraints
$objectRootStore a Deel-owned rental asset at a Deel local warehouse
detailsJSONRequired within parentAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
details (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions store rental at deel for local details activation cost
details (anyOf 2)nullAlternative
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item, Update asset — 200 response body — data actions store rental at deel for local details activation cost

Update asset — 200 response body — data actions store rental at deel for local details activation cost

FieldTypePresenceDescription and constraints
$objectRootAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
activation_costModelRequired within parentExpand Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost
Cost charged to activate local storage

Referenced models: Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost

Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost

FieldTypePresenceDescription and constraints
$objectRootCost charged to activate local storage
billing_methodstringRequired within parentHow the action is charged. When "TOKEN", the fees are covered by an
add-on token pool; when "CURRENCY", the fees are billed in the currency
specified in the "fees" field.
Known values: CURRENCY, TOKEN
feesJSONRequired within parentPrice charged for the action. Null when billing method is "TOKEN"
fees (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost fees amount, currency
fees (anyOf 2)nullAlternative
token_usageJSONRequired within parentAdd-on token consumption details. Null when billing method is "CURRENCY"
token_usage (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost token usage addon, cost, tokens left
token_usage (anyOf 2)nullAlternative

Referenced models: Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost fees amount, currency, Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost token usage addon, cost, tokens left

Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost fees amount, currency

FieldTypePresenceDescription and constraints
$objectRootPrice charged for the action. Null when billing method is "TOKEN"
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
Three-letter currency code for the price

Referenced models: Retrieve the IT seat subscription — 200 response body — data monthly seat price currency

Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost token usage addon, cost, tokens left

FieldTypePresenceDescription and constraints
$objectRootAdd-on token consumption details. Null when billing method is "CURRENCY"
addonModelRequired within parentExpand Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost token usage addon, cost, tokens left addon
The add-on that provides the tokens
coststringRequired within parentNumber of tokens consumed by the action. Zero when the add-on covers the
service without drawing from a token pool
Format: decimal
tokens_leftJSONRequired within parent
tokens_left (anyOf 1)stringAlternativeNumber of tokens left in the pool after the action is performed. Null when
the add-on covers the service without a token pool
Format: decimal
tokens_left (anyOf 2)nullAlternativeNumber of tokens left in the pool after the action is performed. Null when
the add-on covers the service without a token pool
Format: decimal

Referenced models: Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost token usage addon, cost, tokens left addon

Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost token usage addon, cost, tokens left addon

FieldTypePresenceDescription and constraints
$objectRootThe add-on that provides the tokens
idstringRequired within parentID of the add-on
Format: uuid
namestringRequired within parentPublic display name of the add-on

Update asset — 200 response body — data actions store rental at deel for zone1

FieldTypePresenceDescription and constraints
$objectRootStore a Deel-owned rental asset at a Deel zone-1 warehouse
detailsJSONRequired within parentAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
details (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions store rental at deel for zone1 details activation cost
details (anyOf 2)nullAlternative
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item, Update asset — 200 response body — data actions store rental at deel for zone1 details activation cost

Update asset — 200 response body — data actions store rental at deel for zone1 details activation cost

FieldTypePresenceDescription and constraints
$objectRootAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
activation_costModelRequired within parentExpand Update asset — 200 response body — data actions store rental at deel for zone1 details activation cost activation cost
Cost charged to activate zone-1 storage

Referenced models: Update asset — 200 response body — data actions store rental at deel for zone1 details activation cost activation cost

Update asset — 200 response body — data actions store rental at deel for zone1 details activation cost activation cost

FieldTypePresenceDescription and constraints
$objectRootCost charged to activate zone-1 storage
billing_methodstringRequired within parentHow the action is charged. When "TOKEN", the fees are covered by an
add-on token pool; when "CURRENCY", the fees are billed in the currency
specified in the "fees" field.
Known values: CURRENCY, TOKEN
feesJSONRequired within parentPrice charged for the action. Null when billing method is "TOKEN"
fees (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost fees amount, currency
fees (anyOf 2)nullAlternative
token_usageJSONRequired within parentAdd-on token consumption details. Null when billing method is "CURRENCY"
token_usage (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost token usage addon, cost, tokens left
token_usage (anyOf 2)nullAlternative

Referenced models: Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost fees amount, currency, Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost token usage addon, cost, tokens left

Update asset — 200 response body — data actions transfer own asset

FieldTypePresenceDescription and constraints
$objectRootTransfer an organization-owned asset to another user
detailsJSONRequired within parentAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
details (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions transfer rental details eligible countries, transfer cost
details (anyOf 2)nullAlternative
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item, Update asset — 200 response body — data actions transfer rental details eligible countries, transfer cost

Update asset — 200 response body — data actions transfer rental

FieldTypePresenceDescription and constraints
$objectRootTransfer a Deel-owned rental asset to another user
detailsJSONRequired within parentAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
details (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions transfer rental details eligible countries, transfer cost
details (anyOf 2)nullAlternative
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item, Update asset — 200 response body — data actions transfer rental details eligible countries, transfer cost

Update asset — 200 response body — data actions transfer rental details eligible countries, transfer cost

FieldTypePresenceDescription and constraints
$objectRootAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
eligible_countriesarrayRequired within parentCountries the asset can be transferred to
eligible_countries[]ModelEach itemExpand Retrieve a product's catalog details — 200 response body — data variants item available countries item
transfer_costModelRequired within parentExpand Update asset — 200 response body — data actions transfer rental details eligible countries, transfer cost transfer cost
Cost charged for the transfer service

Referenced models: Retrieve a product's catalog details — 200 response body — data variants item available countries item, Update asset — 200 response body — data actions transfer rental details eligible countries, transfer cost transfer cost

Update asset — 200 response body — data actions transfer rental details eligible countries, transfer cost transfer cost

FieldTypePresenceDescription and constraints
$objectRootCost charged for the transfer service
billing_methodstringRequired within parentHow the action is charged. When "TOKEN", the fees are covered by an
add-on token pool; when "CURRENCY", the fees are billed in the currency
specified in the "fees" field.
Known values: CURRENCY, TOKEN
feesJSONRequired within parentPrice charged for the action. Null when billing method is "TOKEN"
fees (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost fees amount, currency
fees (anyOf 2)nullAlternative
token_usageJSONRequired within parentAdd-on token consumption details. Null when billing method is "CURRENCY"
token_usage (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost token usage addon, cost, tokens left
token_usage (anyOf 2)nullAlternative

Referenced models: Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost fees amount, currency, Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost token usage addon, cost, tokens left

Update asset — 200 response body — data actions unarchive own asset

FieldTypePresenceDescription and constraints
$objectRootUnarchive a previously archived organization-owned asset
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item

Update asset — 200 response body — data actions update location location to user

FieldTypePresenceDescription and constraints
$objectRootDeprecated: same as update_own_asset_location_location_to_user, kept for published API compatibility
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item

Update asset — 200 response body — data actions update location user to location

FieldTypePresenceDescription and constraints
$objectRootDeprecated: same as update_own_asset_location_user_to_location, kept for published API compatibility
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item

Update asset — 200 response body — data actions update location user to user

FieldTypePresenceDescription and constraints
$objectRootDeprecated: same as update_own_asset_location_user_to_user, kept for published API compatibility
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item

Update asset — 200 response body — data actions update own asset details

FieldTypePresenceDescription and constraints
$objectRootUpdate editable details of an organization-owned asset
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item

Update asset — 200 response body — data actions update own asset location location to user

FieldTypePresenceDescription and constraints
$objectRootUpdate the location of an organization-owned asset from a warehouse to a user
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item

Update asset — 200 response body — data actions update own asset location user to location

FieldTypePresenceDescription and constraints
$objectRootUpdate the location of an organization-owned asset from a user to a warehouse
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item

Update asset — 200 response body — data actions update own asset location user to user

FieldTypePresenceDescription and constraints
$objectRootUpdate the assigned user of an organization-owned asset that is currently with a user
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item

Update asset — 200 response body — data actions update rental location user to user

FieldTypePresenceDescription and constraints
$objectRootUpdate the assigned user of a Deel-owned rental asset handed over in person
detailsJSONRequired within parentAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
details (anyOf 1)ModelAlternativeExpand Update asset — 200 response body — data actions update rental location user to user details reassignable in
details (anyOf 2)nullAlternative
disabled_reasonsarrayRequired within parentReasons why the action is disabled. Empty when the action is enabled or not applicable
disabled_reasons[]ModelEach itemExpand Update asset — 200 response body — data actions clear own asset disabled reasons item
statusstringRequired within parentWhether the action is currently available for this asset
Known values: DISABLED, ENABLED, NOT_APPLICABLE

Referenced models: Update asset — 200 response body — data actions clear own asset disabled reasons item, Update asset — 200 response body — data actions update rental location user to user details reassignable in

Update asset — 200 response body — data actions update rental location user to user details reassignable in

FieldTypePresenceDescription and constraints
$objectRootAction-specific context needed to perform the action. Populated for enabled and
disabled actions (so callers can see what a successful attempt would look like);
null when the action is not applicable to this asset.
reassignable_inarrayRequired within parentCountries the rental can be handed over to, bound to the rental contract's billing region
reassignable_in[]ModelEach itemExpand Retrieve a product's catalog details — 200 response body — data variants item available countries item

Referenced models: Retrieve a product's catalog details — 200 response body — data variants item available countries item

Update asset — 200 response body — data assigned user Details of the user with asset possession

FieldTypePresenceDescription and constraints
$objectRootDetails of the user with asset possession
emailsarrayRequired within parentArray of user email addresses
emails[]stringEach itemFormat: email
first_namestringRequired within parentFirst name of the user
hris_profile_idstringRequired within parentThe unique identifier of the HRIS profile of the assigned user
Format: uuid
last_namestringRequired within parentLast name of the user

Update asset — 200 response body — data keyboard layout string

FieldTypePresenceDescription and constraints
$stringRootKeyboard layout of the asset, null when none is recorded
Known values: ARABIC, BELARUSIAN_JCUKEN, BELGIAN_AZERTY, BRAZILIAN_PORTUGUESE_QWERTY, BULGARIAN, CANADIAN_MULTILINGUAL_STANDARD_QWERTY, COLEMAK, CROATIAN_QWERTZ, CZECH_QWERTY, DANISH_QWERTY, DUTCH_QWERTY, DVORAK_ENGLISH, DVORAK_FRENCH, EGYPTIAN_LOCAL, ENGLISH_RUSSIAN_QWERTY, EU_STANDARD_QWERTY, FRENCH_AZERTY, FRENCH_BEPO, GERMAN_QWERTZ, GREEK, HEBREW, HUNGARIAN_QWERTZ, INDIAN_QWERTY, INTERNATIONAL_ENGLISH_QWERTY, ITALIAN_QWERTY, JAPANESE_QWERTY, KOREAN_QWERTY, LATAM_QWERTY, NORWEGIAN_QWERTY, POLISH_QWERTY, PORTUGUESE_QWERTY, RUSSIAN_JCUKEN, SERBIAN_CYRILLIC, SERBIAN_LATIN_QWERTZ, SLOVAK_QWERTZ, SPANISH_QWERTY, SWEDISH_QWERTY, SWISS_FRENCH_QWERTZ, SWISS_GERMAN_QWERTZ, THAI, TURKISH_QWERTY, UKRAINIAN_JCUKEN, UK_ENGLISH_QWERTY, UNKNOWN, US_ENGLISH_QWERTY, VIETNAMESE, WORKMAN

Update asset — 200 response body — data ownership

FieldTypePresenceDescription and constraints
$objectRootAsset owner
namestringRequired within parentAsset owner name
typestringRequired within parentAsset owner type
Known values: DEEL, ORGANIZATION

Update asset — 200 response body — data product

FieldTypePresenceDescription and constraints
$objectRootProduct details
brandstringRequired within parentProduct brand
categoryModelRequired within parentExpand Retrieve a product's catalog details — 200 response body — data category
Product category
idstringRequired within parentUnique identifier of the product
Format: uuid
namestringRequired within parentProduct name
specificationsarrayRequired within parentSpecifications of the product
specifications[]ModelEach itemExpand Update asset — 200 response body — data product specifications item

Referenced models: Update asset — 200 response body — data product specifications item, Retrieve a product's catalog details — 200 response body — data category

Update asset — 200 response body — data product specifications item

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentSpecification name
valuestringRequired within parentSpecification value

Update asset — 200 response body — data purchase value Purchase value of the asset

FieldTypePresenceDescription and constraints
$objectRootPurchase value of the asset
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
Three-letter currency code for the price

Referenced models: Retrieve the IT seat subscription — 200 response body — data monthly seat price currency

Update asset — 200 response body — data status

FieldTypePresenceDescription and constraints
$stringRootCurrent state of the asset
Known values: ACTIVE, ADDED_BY_MISTAKE, BEING_REPAIRED, BINNED, BROKEN_AT_WAREHOUSE, BROKEN_BY_USER, BROKEN_IN_TRANSIT, CLEARED, DAMAGED_AT_WAREHOUSE, DAMAGED_BY_USER, DAMAGED_IN_TRANSIT, LEFT_WITH_USER, LOST_IN_TRANSIT, RETURNED_TO_DEEL, SHRINKAGE, STOLEN, SUPPLIER_RETURN, USED_AS_SPARE_PART, WAITING_FOR_CLEARANCE

Update asset — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
end_of_life_onstringOptionalEnd-of-life date for the asset
Format: date
gradestringOptionalCondition grade of the asset
One of: A, B, C, D, F, NEW
purchase_datestringOptionalDate the asset was purchased. Cannot be in the future.
Format: date
purchase_valueModelOptionalExpand Update asset — request body — body data purchase value
Price paid for the asset
serial_numberstringOptionalAsset serial number. Cannot be blanked on device categories.

Referenced models: Update asset — request body — body data purchase value

Update asset — request body — body data purchase value

FieldTypePresenceDescription and constraints
$objectRootPrice paid for the asset
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand Update asset — request body — body data purchase value currency
Three-letter currency code for the price

Referenced models: Update asset — request body — body data purchase value currency

Update asset — request body — body data purchase value currency

FieldTypePresenceDescription and constraints
$stringRootThree-letter currency code for the price
One of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BDT, BGN, BHD, BIF, BMD, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWD

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.