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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
note | string | Optional | Optional human-readable note explaining the reason for archiving. |
status | string | Required within parent | Terminal 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
collection_address | Model | Required within parent | Expand 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_address | Model | Optional | Expand 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_id | string | Required within parent | HRIS profile identifier of the new holder. Format: uuid |
not_before | string | Optional | Earliest date Deel logistics may execute the pickup. Format: date |
shipment_insurance | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Location the asset is being collected from before being shipped to the new holder. |
country | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Country 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Delivery address for the target holder. Optional when the target HRIS profile already has a valid delivery address on file. |
city | string | Optional | City name |
country | Model | Required within parent | Expand Assign asset to new holder — request body — body data delivery address country Country code (ISO 3166 alpha-2) |
date_of_birth | string | Optional | Date of birth Format: date |
delivery_instructions | string | Optional | Delivery instructions for the courier |
line1 | string | Optional | Address line 1 |
line2 | string | Optional | Address line 2 |
passport_number | string | Optional | Passport number |
phone_number | string | Optional | Phone number in E.164 format |
post_code | string | Optional | Post code |
state | string | Optional | State or region name |
tax_id_number | string | Optional | Tax 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Country 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
is_waived | boolean | Required within parent | Consent to ship without insurance. When true, `purchase_details` must be omitted and Deel will not record a purchase price against the asset. |
purchase_details | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
date | string | Required within parent | Date the asset was purchased. Format: date |
price | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Purchase price paid for the asset. |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
collection_address | Model | Required within parent | Expand Create a collection for an IT asset — request body — body data collection address Location the asset is being collected from. |
not_before | string | Optional | Earliest date Deel logistics may execute the pickup. Format: date |
shipment_insurance | Model | Optional | Expand 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_location | string | Optional | Deel-managed reuse destination for the collection. Mutually exclusive with `warehouse_id`. One of: DEEL_HUB, LOCAL_HUB |
warehouse_id | string | Optional | Destination 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Location the asset is being collected from. |
country | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
delivery_address | Model | Optional | Expand 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_id | string | Required within parent | HRIS profile identifier of the recipient. Format: uuid |
is_express_delivery | boolean | Required within parent | Whether express delivery is requested. Defaults to false. Charges an express fee where the country supports express delivery. |
shipment_insurance | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Delivery address for the recipient. Optional when the HRIS profile already has a valid delivery address on file. |
city | string | Optional | City name |
country | Model | Required within parent | Expand Assign asset to new holder — request body — body data delivery address country Country code (ISO 3166 alpha-2) |
date_of_birth | string | Optional | Date of birth Format: date |
delivery_instructions | string | Optional | Delivery instructions for the courier |
line1 | string | Optional | Address line 1 |
line2 | string | Optional | Address line 2 |
passport_number | string | Optional | Passport number |
phone_number | string | Optional | Phone number in E.164 format |
post_code | string | Optional | Post code |
state | string | Optional | State or region name |
tax_id_number | string | Optional | Tax 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
is_waived | boolean | Required within parent | Consent to ship without insurance. When true, `purchase_details` must be omitted and Deel will not record a purchase price against the asset. |
purchase_details | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
brand | string | Required within parent | Product brand. Free-form; well-known values ("Apple", "Microsoft", "Dell", "Lenovo", "HP") are normalized when passed with common aliases. |
category | Model | Required within parent | Expand Create an IT asset — request body — body data category Product category |
end_of_life_on | string | Optional | End-of-life date for the asset Format: date |
grade | string | Optional | Condition grade of the asset. Currently ignored when location is AT_WAREHOUSE. One of: A, B, C, D, F, NEW |
hris_profile_id | string | Optional | HRIS profile ID of the user the asset is assigned to. Required when location is WITH_USER. Format: uuid |
keyboard_layout | Model | Optional | Expand Create an IT asset — request body — body data keyboard layout Keyboard layout of the asset. Required for laptops. |
location | string | Required within parent | Where the asset is located when created. Must be WITH_USER or AT_WAREHOUSE. One of: AT_WAREHOUSE, WITH_USER |
name | string | Required within parent | Product name displayed for the asset |
operating_system | string | Optional | Operating 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_date | string | Optional | Date the asset was purchased Format: date |
purchase_value | Model | Optional | Expand Update asset — request body — body data purchase value Price paid for the asset |
serial_number | string | Optional | Asset serial number. Required for device categories. |
specifications | array | Required within parent | Product specifications |
specifications[] | Model | Each item | Expand Create an IT asset — request body — body data specifications item |
storage_location_id | string | Optional | ID 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Product 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Keyboard 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Required within parent | Specification key One of: COLOR, DISPLAY, MEMORY, PROCESSOR, STORAGE |
value | string | Required within parent | Specification value |
List IT assets — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand List IT assets — 200 response body — data item |
has_more | boolean | Required within parent | Whether there are more results available |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor to the next page |
next_cursor (anyOf 2) | null | Alternative | Cursor to the next page |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of records Format: int64 |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
assigned_user | JSON | Required within parent | Details of the user with asset possession |
assigned_user (anyOf 1) | Model | Alternative | Expand Retrieve an IT order — 200 response body — data user Details of the user with asset possession |
assigned_user (anyOf 2) | null | Alternative | |
assigned_warehouse | JSON | Required within parent | Details of the warehouse with asset possession |
assigned_warehouse (anyOf 1) | Model | Alternative | Expand Update asset — 200 response body — data / assigned_warehouse / ownership: DEEL, ORGANIZATION, warehouse type: CLEARANCE, DEEL, ORGANIZATION |
assigned_warehouse (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Creation timestamp of the asset Format: date-time |
grade | string | Required within parent | The condition grade of the asset Known values: A, B, C, D, F, NEW |
id | string | Required within parent | Unique identifier of the item Format: uuid |
keyboard_layout | JSON | Required within parent | Keyboard layout of the asset, null when none is recorded |
keyboard_layout (anyOf 1) | Model | Alternative | Expand Update asset — 200 response body — data keyboard layout string |
keyboard_layout (anyOf 2) | null | Alternative | |
location | string | Required within parent | Current location type of the asset Known values: AT_WAREHOUSE, CLEARANCE_WAREHOUSE, DEEL_WAREHOUSE, ORGANIZATION_WAREHOUSE, SUPPLIER, WITH_COURIER, WITH_USER, WRITE_OFF |
operating_system | JSON | Required within parent | Operating system of the asset, null when none is recorded |
operating_system (anyOf 1) | string | Alternative | Operating 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) | null | Alternative | |
ownership | Model | Required within parent | Expand Update asset — 200 response body — data ownership Asset owner |
product | Model | Required within parent | Expand List IT assets — 200 response body — data item product Product details |
public_id | string | Required within parent | Public identifier of the item |
purchase_date | JSON | Required within parent | |
purchase_date (anyOf 1) | string | Alternative | Purchase date of the asset Format: date |
purchase_date (anyOf 2) | null | Alternative | Purchase date of the asset Format: date |
purchase_value | JSON | Required within parent | Purchase value of the asset |
purchase_value (anyOf 1) | Model | Alternative | Expand Update asset — 200 response body — data purchase value Purchase value of the asset |
purchase_value (anyOf 2) | null | Alternative | |
serial_number | JSON | Required within parent | |
serial_number (anyOf 1) | string | Alternative | Asset serial number |
serial_number (anyOf 2) | null | Alternative | Asset serial number |
status | string | Required within parent | Current 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_at | string | Required within parent | Last 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Product details |
brand | string | Required within parent | Product brand |
category | Model | Required within parent | Expand Retrieve a product's catalog details — 200 response body — data category Product category |
id | string | Required within parent | Unique identifier of the product Format: uuid |
name | string | Required within parent | Product name |
Referenced models: Retrieve a product's catalog details — 200 response body — data category
List IT assets — request body — query keyboard layouts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | 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 |
Retrieve an IT asset — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
actions | Model | Required within parent | Expand Update asset — 200 response body — data actions Actions the caller can execute on this asset, with availability status per action |
assigned_user | JSON | Required within parent | Details of the user with asset possession |
assigned_user (anyOf 1) | Model | Alternative | Expand Retrieve an IT order — 200 response body — data user Details of the user with asset possession |
assigned_user (anyOf 2) | null | Alternative | |
assigned_warehouse | JSON | Required within parent | Details of the warehouse with asset possession |
assigned_warehouse (anyOf 1) | Model | Alternative | Expand Update asset — 200 response body — data / assigned_warehouse / ownership: DEEL, ORGANIZATION, warehouse type: CLEARANCE, DEEL, ORGANIZATION |
assigned_warehouse (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Creation timestamp of the asset Format: date-time |
grade | string | Required within parent | The condition grade of the asset Known values: A, B, C, D, F, NEW |
id | string | Required within parent | Unique identifier of the item Format: uuid |
keyboard_layout | JSON | Required within parent | Keyboard layout of the asset, null when none is recorded |
keyboard_layout (anyOf 1) | Model | Alternative | Expand Update asset — 200 response body — data keyboard layout string |
keyboard_layout (anyOf 2) | null | Alternative | |
location | string | Required within parent | Current location type of the asset Known values: AT_WAREHOUSE, CLEARANCE_WAREHOUSE, DEEL_WAREHOUSE, ORGANIZATION_WAREHOUSE, SUPPLIER, WITH_COURIER, WITH_USER, WRITE_OFF |
operating_system | JSON | Required within parent | Operating system of the asset, null when none is recorded |
operating_system (anyOf 1) | string | Alternative | Operating 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) | null | Alternative | |
ownership | Model | Required within parent | Expand Update asset — 200 response body — data ownership Asset owner |
product | Model | Required within parent | Expand Update asset — 200 response body — data product Product details |
public_id | string | Required within parent | Public identifier of the item |
purchase_date | JSON | Required within parent | |
purchase_date (anyOf 1) | string | Alternative | Purchase date of the asset Format: date |
purchase_date (anyOf 2) | null | Alternative | Purchase date of the asset Format: date |
purchase_value | JSON | Required within parent | Purchase value of the asset |
purchase_value (anyOf 1) | Model | Alternative | Expand Update asset — 200 response body — data purchase value Purchase value of the asset |
purchase_value (anyOf 2) | null | Alternative | |
serial_number | JSON | Required within parent | |
serial_number (anyOf 1) | string | Alternative | Asset serial number |
serial_number (anyOf 2) | null | Alternative | Asset serial number |
status | string | Required within parent | Current 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_at | string | Required within parent | Last 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
hris_profile_id | string | Optional | HRIS 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 |
location | Model | Required within parent | Expand 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_id | string | Optional | ID 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | 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. One of: AT_WAREHOUSE, CLEARANCE_WAREHOUSE, DEEL_WAREHOUSE, ORGANIZATION_WAREHOUSE, SUPPLIER, WITH_COURIER, WITH_USER, WRITE_OFF |
Update asset — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Update asset — 200 response body — data |
Referenced models: Update asset — 200 response body — data
Update asset — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
actions | Model | Required within parent | Expand Update asset — 200 response body — data actions Actions the caller can execute on this asset, with availability status per action |
assigned_user | JSON | Required within parent | Details of the user with asset possession |
assigned_user (anyOf 1) | Model | Alternative | Expand Update asset — 200 response body — data assigned user Details of the user with asset possession |
assigned_user (anyOf 2) | null | Alternative | |
assigned_warehouse | JSON | Required within parent | Details of the warehouse with asset possession |
assigned_warehouse (anyOf 1) | Model | Alternative | Expand Update asset — 200 response body — data / assigned_warehouse / ownership: DEEL, ORGANIZATION, warehouse type: CLEARANCE, DEEL, ORGANIZATION |
assigned_warehouse (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Creation timestamp of the asset Format: date-time |
grade | string | Required within parent | The condition grade of the asset Known values: A, B, C, D, F, NEW |
id | string | Required within parent | Unique identifier of the item Format: uuid |
keyboard_layout | JSON | Required within parent | Keyboard layout of the asset, null when none is recorded |
keyboard_layout (anyOf 1) | Model | Alternative | Expand Update asset — 200 response body — data keyboard layout string |
keyboard_layout (anyOf 2) | null | Alternative | |
location | string | Required within parent | Current location type of the asset Known values: AT_WAREHOUSE, CLEARANCE_WAREHOUSE, DEEL_WAREHOUSE, ORGANIZATION_WAREHOUSE, SUPPLIER, WITH_COURIER, WITH_USER, WRITE_OFF |
operating_system | JSON | Required within parent | Operating system of the asset, null when none is recorded |
operating_system (anyOf 1) | string | Alternative | Operating 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) | null | Alternative | |
ownership | Model | Required within parent | Expand Update asset — 200 response body — data ownership Asset owner |
product | Model | Required within parent | Expand Update asset — 200 response body — data product Product details |
public_id | string | Required within parent | Public identifier of the item |
purchase_date | JSON | Required within parent | |
purchase_date (anyOf 1) | string | Alternative | Purchase date of the asset Format: date |
purchase_date (anyOf 2) | null | Alternative | Purchase date of the asset Format: date |
purchase_value | JSON | Required within parent | Purchase value of the asset |
purchase_value (anyOf 1) | Model | Alternative | Expand Update asset — 200 response body — data purchase value Purchase value of the asset |
purchase_value (anyOf 2) | null | Alternative | |
serial_number | JSON | Required within parent | |
serial_number (anyOf 1) | string | Alternative | Asset serial number |
serial_number (anyOf 2) | null | Alternative | Asset serial number |
status | Model | Required within parent | Expand Update asset — 200 response body — data status Current state of the asset |
updated_at | string | Required within parent | Last 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the warehouse with asset possession |
address | Model | Required within parent | Expand Update asset — 200 response body — data / assigned_warehouse / ownership: DEEL, ORGANIZATION, warehouse type: CLEARANCE, DEEL, ORGANIZATION address Warehouse address details |
id | string | Required within parent | Unique identifier of the warehouse Format: uuid |
name | string | Required within parent | Warehouse or storage location name |
ownership | string | Required within parent | Warehouse ownership type Known values: DEEL, ORGANIZATION |
public_id | string | Required within parent | Public identifier of the warehouse |
warehouse_type | string | Required within parent | Warehouse 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Warehouse address details |
city | JSON | Required within parent | |
city (anyOf 1) | string | Alternative | City name |
city (anyOf 2) | null | Alternative | City name |
country | Model | Required within parent | Expand Cancel an IT order — 200 response body — data delivery address country Country code |
date_of_birth | JSON | Required within parent | |
date_of_birth (anyOf 1) | string | Alternative | Date of birth (applicable for some address types) Format: date |
date_of_birth (anyOf 2) | null | Alternative | Date of birth (applicable for some address types) Format: date |
delivery_instructions | JSON | Required within parent | |
delivery_instructions (anyOf 1) | string | Alternative | Special instructions for deliveries |
delivery_instructions (anyOf 2) | null | Alternative | Special instructions for deliveries |
id | string | Required within parent | Unique identifier of the address Format: uuid |
is_valid | boolean | Required within parent | Whether the address passes validation |
line1 | JSON | Required within parent | |
line1 (anyOf 1) | string | Alternative | Address line 1 |
line1 (anyOf 2) | null | Alternative | Address line 1 |
line2 | JSON | Required within parent | |
line2 (anyOf 1) | string | Alternative | Address line 2 |
line2 (anyOf 2) | null | Alternative | Address line 2 |
passport_number | JSON | Required within parent | |
passport_number (anyOf 1) | string | Alternative | Passport number (applicable for some address types) |
passport_number (anyOf 2) | null | Alternative | Passport number (applicable for some address types) |
phone_number | JSON | Required within parent | |
phone_number (anyOf 1) | string | Alternative | Phone number |
phone_number (anyOf 2) | null | Alternative | Phone number |
post_code | JSON | Required within parent | |
post_code (anyOf 1) | string | Alternative | Post code |
post_code (anyOf 2) | null | Alternative | Post code |
state | JSON | Required within parent | |
state (anyOf 1) | string | Alternative | State code or name |
state (anyOf 2) | null | Alternative | State code or name |
tax_id_number | JSON | Required within parent | |
tax_id_number (anyOf 1) | string | Alternative | Tax ID number (applicable for some address types) |
tax_id_number (anyOf 2) | null | Alternative | Tax ID number (applicable for some address types) |
type | string | Required within parent | Type 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Actions the caller can execute on this asset, with availability status per action |
archive_own_asset | Model | Required within parent | Expand Update asset — 200 response body — data actions archive own asset Archive an organization-owned asset |
asset_country | JSON | Required within parent | Resolved 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) | Model | Alternative | Expand Update asset — 200 response body — data actions asset country string |
asset_country (anyOf 2) | null | Alternative | |
assign_addon_to_own_asset | Model | Required within parent | Expand Update asset — 200 response body — data actions assign addon to own asset Assign an add-on to an organization-owned asset |
clear_own_asset | Model | Required within parent | Expand Update asset — 200 response body — data actions clear own asset Clear an organization-owned asset from the fleet |
manage_end_of_rental_contract_actions | Model | Required within parent | Expand 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_rental | Model | Required within parent | Expand Update asset — 200 response body — data actions purchase rental Purchase a Deel-owned rental asset at end of contract |
return_rental_to_deel | Model | Required within parent | Expand Update asset — 200 response body — data actions return rental to deel Return a Deel-owned rental asset back to Deel |
reuse_own_asset_from_deel | Model | Required within parent | Expand 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_location | Model | Required within parent | Expand 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_hub | Model | Required within parent | Expand 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_local | Model | Required within parent | Expand 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_location | Model | Required within parent | Expand 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_local | Model | Required within parent | Expand 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_zone1 | Model | Required within parent | Expand 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_asset | Model | Required within parent | Expand Update asset — 200 response body — data actions transfer own asset Transfer an organization-owned asset to another user |
transfer_rental | Model | Required within parent | Expand Update asset — 200 response body — data actions transfer rental Transfer a Deel-owned rental asset to another user |
unarchive_own_asset | Model | Required within parent | Expand Update asset — 200 response body — data actions unarchive own asset Unarchive a previously archived organization-owned asset |
update_location_location_to_user | Model | Required within parent | Expand 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_location | Model | Required within parent | Expand 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_user | Model | Required within parent | Expand 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_details | Model | Required within parent | Expand 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_user | Model | Required within parent | Expand 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_location | Model | Required within parent | Expand 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_user | Model | Required within parent | Expand 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_user | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Archive an organization-owned asset |
details | JSON | Required within parent | Action-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) | Model | Alternative | Expand Update asset — 200 response body — data actions archive own asset details allowed statuses |
details (anyOf 2) | null | Alternative | |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Action-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_statuses | array | Required within parent | Statuses that can be passed as the archive reason when archiving the asset |
allowed_statuses[] | string | Each item | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Resolved 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Assign an add-on to an organization-owned asset |
details | JSON | Required within parent | Action-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) | Model | Alternative | Expand Update asset — 200 response body — data actions assign addon to own asset details addons |
details (anyOf 2) | null | Alternative | |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Action-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. |
addons | array | Required within parent | Add-ons that can be assigned to the asset, with a fail reason for those that don't qualify |
addons[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
addon | Model | Required within parent | Expand 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_reason | JSON | Required within parent | Reason the add-on cannot be assigned to the asset. Null when assignment is allowed |
fail_reason (anyOf 1) | Model | Alternative | Expand Update asset — 200 response body — data actions assign addon to own asset details addons addons item fail reason string |
fail_reason (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Add-on that can be assigned to the asset |
id | string | Required within parent | ID of the add-on Format: uuid |
name | string | Required within parent | Public 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Reason 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Clear an organization-owned asset from the fleet |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Manage end-of-rental options for a Deel-owned rental asset |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Purchase a Deel-owned rental asset at end of contract |
details | JSON | Required within parent | Action-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) | Model | Alternative | Expand Update asset — 200 response body — data actions purchase rental details purchase price, remaining contract value, total purchase price |
details (anyOf 2) | null | Alternative | |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Action-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_price | JSON | Required within parent | Estimated price to purchase the asset at the end of the rental contract |
purchase_price (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
remaining_contract_value | Model | Required within parent | Expand 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_price | JSON | Required within parent | Estimated total price of the purchase, including any remaining contract value |
total_purchase_price (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Estimated price to purchase the asset at the end of the rental contract |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Estimated remaining value of the rental contract |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Estimated total price of the purchase, including any remaining contract value |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Return a Deel-owned rental asset back to Deel |
details | JSON | Required within parent | Action-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) | Model | Alternative | Expand Update asset — 200 response body — data actions return rental to deel details end contract price |
details (anyOf 2) | null | Alternative | |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Action-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_price | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Estimated end-of-contract price charged when returning the asset |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Redeploy an organization-owned asset stored at a Deel warehouse |
details | JSON | Required within parent | Action-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) | Model | Alternative | Expand Update asset — 200 response body — data actions reuse own asset from deel details eligible countries, express delivery |
details (anyOf 2) | null | Alternative | |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Action-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_countries | array | Required within parent | Countries where the asset can be redeployed from Deel |
eligible_countries[] | Model | Each item | Expand Retrieve a product's catalog details — 200 response body — data variants item available countries item |
express_delivery | JSON | Required within parent | Express delivery availability and per-country fees. Null when express delivery is not supported |
express_delivery (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Express delivery availability and per-country fees. Null when express delivery is not supported |
country_fees | object | Required within parent | Express delivery fees keyed by destination country. Additional keys: see wildcard field |
country_fees.* | Model | Additional keys | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Redeploy an organization-owned asset from an organization-owned location |
details | JSON | Required within parent | Action-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) | Model | Alternative | Expand Update asset — 200 response body — data actions reuse own asset from own location details eligible countries, express delivery, service cost |
details (anyOf 2) | null | Alternative | |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Action-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_countries | array | Required within parent | Countries where the asset can be redeployed from an organization-owned location |
eligible_countries[] | Model | Each item | Expand Retrieve a product's catalog details — 200 response body — data variants item available countries item |
express_delivery | JSON | Required within parent | Express delivery availability and per-country fees. Null when express delivery is not supported |
express_delivery (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
service_cost | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Store an organization-owned asset at a Deel hub warehouse |
details | JSON | Required within parent | Action-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) | Model | Alternative | Expand 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) | null | Alternative | |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Action-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_cost | Model | Required within parent | Expand 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_country | Model | Required within parent | Expand 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_months | JSON | Required within parent | |
grace_period_in_months (anyOf 1) | integer | Alternative | Grace period in months during which storage is free before monthly fees apply Format: int64 |
grace_period_in_months (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
monthly_fee | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Cost charged to activate storage |
billing_method | string | Required within parent | How 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 |
fees | JSON | Required within parent | Price charged for the action. Null when billing method is "TOKEN" |
fees (anyOf 1) | Model | Alternative | Expand Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost fees amount, currency |
fees (anyOf 2) | null | Alternative | |
token_usage | JSON | Required within parent | Add-on token consumption details. Null when billing method is "CURRENCY" |
token_usage (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | ISO 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Monthly storage fee charged after the grace period |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Store an organization-owned asset at a Deel local warehouse |
details | JSON | Required within parent | Action-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) | Model | Alternative | Expand 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) | null | Alternative | |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Store an organization-owned asset at an organization-owned location |
details | JSON | Required within parent | Action-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) | Model | Alternative | Expand Update asset — 200 response body — data actions store own asset at own location details eligible countries, service cost |
details (anyOf 2) | null | Alternative | |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Action-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_countries | array | Required within parent | Countries where the asset can be stored at an organization-owned location |
eligible_countries[] | Model | Each item | Expand Retrieve a product's catalog details — 200 response body — data variants item available countries item |
service_cost | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Store a Deel-owned rental asset at a Deel local warehouse |
details | JSON | Required within parent | Action-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) | Model | Alternative | Expand Update asset — 200 response body — data actions store rental at deel for local details activation cost |
details (anyOf 2) | null | Alternative | |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Action-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_cost | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Cost charged to activate local storage |
billing_method | string | Required within parent | How 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 |
fees | JSON | Required within parent | Price charged for the action. Null when billing method is "TOKEN" |
fees (anyOf 1) | Model | Alternative | Expand Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost fees amount, currency |
fees (anyOf 2) | null | Alternative | |
token_usage | JSON | Required within parent | Add-on token consumption details. Null when billing method is "CURRENCY" |
token_usage (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Price charged for the action. Null when billing method is "TOKEN" |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Add-on token consumption details. Null when billing method is "CURRENCY" |
addon | Model | Required within parent | Expand 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 |
cost | string | Required within parent | Number of tokens consumed by the action. Zero when the add-on covers the service without drawing from a token pool Format: decimal |
tokens_left | JSON | Required within parent | |
tokens_left (anyOf 1) | string | Alternative | Number 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) | null | Alternative | Number 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The add-on that provides the tokens |
id | string | Required within parent | ID of the add-on Format: uuid |
name | string | Required within parent | Public display name of the add-on |
Update asset — 200 response body — data actions store rental at deel for zone1
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Store a Deel-owned rental asset at a Deel zone-1 warehouse |
details | JSON | Required within parent | Action-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) | Model | Alternative | Expand Update asset — 200 response body — data actions store rental at deel for zone1 details activation cost |
details (anyOf 2) | null | Alternative | |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Action-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_cost | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Cost charged to activate zone-1 storage |
billing_method | string | Required within parent | How 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 |
fees | JSON | Required within parent | Price charged for the action. Null when billing method is "TOKEN" |
fees (anyOf 1) | Model | Alternative | Expand Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost fees amount, currency |
fees (anyOf 2) | null | Alternative | |
token_usage | JSON | Required within parent | Add-on token consumption details. Null when billing method is "CURRENCY" |
token_usage (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Transfer an organization-owned asset to another user |
details | JSON | Required within parent | Action-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) | Model | Alternative | Expand Update asset — 200 response body — data actions transfer rental details eligible countries, transfer cost |
details (anyOf 2) | null | Alternative | |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Transfer a Deel-owned rental asset to another user |
details | JSON | Required within parent | Action-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) | Model | Alternative | Expand Update asset — 200 response body — data actions transfer rental details eligible countries, transfer cost |
details (anyOf 2) | null | Alternative | |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Action-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_countries | array | Required within parent | Countries the asset can be transferred to |
eligible_countries[] | Model | Each item | Expand Retrieve a product's catalog details — 200 response body — data variants item available countries item |
transfer_cost | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Cost charged for the transfer service |
billing_method | string | Required within parent | How 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 |
fees | JSON | Required within parent | Price charged for the action. Null when billing method is "TOKEN" |
fees (anyOf 1) | Model | Alternative | Expand Update asset — 200 response body — data actions store rental at deel for local details activation cost activation cost fees amount, currency |
fees (anyOf 2) | null | Alternative | |
token_usage | JSON | Required within parent | Add-on token consumption details. Null when billing method is "CURRENCY" |
token_usage (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Unarchive a previously archived organization-owned asset |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Deprecated: same as update_own_asset_location_location_to_user, kept for published API compatibility |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Deprecated: same as update_own_asset_location_user_to_location, kept for published API compatibility |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Deprecated: same as update_own_asset_location_user_to_user, kept for published API compatibility |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Update editable details of an organization-owned asset |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Update the location of an organization-owned asset from a warehouse to a user |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Update the location of an organization-owned asset from a user to a warehouse |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Update the assigned user of an organization-owned asset that is currently with a user |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Update the assigned user of a Deel-owned rental asset handed over in person |
details | JSON | Required within parent | Action-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) | Model | Alternative | Expand Update asset — 200 response body — data actions update rental location user to user details reassignable in |
details (anyOf 2) | null | Alternative | |
disabled_reasons | array | Required within parent | Reasons why the action is disabled. Empty when the action is enabled or not applicable |
disabled_reasons[] | Model | Each item | Expand Update asset — 200 response body — data actions clear own asset disabled reasons item |
status | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Action-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_in | array | Required within parent | Countries the rental can be handed over to, bound to the rental contract's billing region |
reassignable_in[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the user with asset possession |
emails | array | Required within parent | Array of user email addresses |
emails[] | string | Each item | Format: email |
first_name | string | Required within parent | First name of the user |
hris_profile_id | string | Required within parent | The unique identifier of the HRIS profile of the assigned user Format: uuid |
last_name | string | Required within parent | Last name of the user |
Update asset — 200 response body — data keyboard layout string
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Keyboard 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Asset owner |
name | string | Required within parent | Asset owner name |
type | string | Required within parent | Asset owner type Known values: DEEL, ORGANIZATION |
Update asset — 200 response body — data product
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Product details |
brand | string | Required within parent | Product brand |
category | Model | Required within parent | Expand Retrieve a product's catalog details — 200 response body — data category Product category |
id | string | Required within parent | Unique identifier of the product Format: uuid |
name | string | Required within parent | Product name |
specifications | array | Required within parent | Specifications of the product |
specifications[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Required within parent | Specification name |
value | string | Required within parent | Specification value |
Update asset — 200 response body — data purchase value Purchase value of the asset
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Purchase value of the asset |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Current 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end_of_life_on | string | Optional | End-of-life date for the asset Format: date |
grade | string | Optional | Condition grade of the asset One of: A, B, C, D, F, NEW |
purchase_date | string | Optional | Date the asset was purchased. Cannot be in the future. Format: date |
purchase_value | Model | Optional | Expand Update asset — request body — body data purchase value Price paid for the asset |
serial_number | string | Optional | Asset 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Price paid for the asset |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Three-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 |