Deel: Clearance requests schemas
11 Deel schemas with complete fields and constraints.
← Clearance requests operations · All schemas
Approve or reject quotes on a clearance request — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | Decisions on each request item in the clearance request. Every request item in the clearance request must be included; otherwise the endpoint returns a `clearance_request_items_undecided` error. |
items[] | Model | Each item | Expand Approve or reject quotes on a clearance request — request body — body data items item |
Referenced models: Approve or reject quotes on a clearance request — request body — body data items item
Approve or reject quotes on a clearance request — request body — body data items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_accepted | boolean | Required within parent | Whether the quote for this request item is accepted (`true`) or rejected (`false`). When every item is rejected the clearance request is cancelled. |
request_item_id | string | Required within parent | Unique identifier of the clearance request item the decision applies to Format: uuid |
Cancel a clearance request — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Cancel a clearance request — 200 response body — data |
Referenced models: Cancel a clearance request — 200 response body — data
Cancel a clearance request — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cancelled_reason | JSON | Required within parent | Reason the clearance request was cancelled, absent unless the status is CANCELLED |
cancelled_reason (anyOf 1) | string | Alternative | Reason the clearance request was cancelled, absent unless the status is CANCELLED Known values: DEADLINE_EXCEEDED, REQUESTED_BY_CUSTOMER |
cancelled_reason (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Creation timestamp of the clearance request Format: date-time |
expires_at | JSON | Required within parent | |
expires_at (anyOf 1) | string | Alternative | Timestamp indicating when the request expires and the manager can no longer take action, absent when no deadline applies Format: date-time |
expires_at (anyOf 2) | null | Alternative | Timestamp indicating when the request expires and the manager can no longer take action, absent when no deadline applies Format: date-time |
id | string | Required within parent | Unique identifier of the clearance request Format: uuid |
public_id | string | Required within parent | Public identifier of the clearance request |
request_items | array | Required within parent | Items included in this clearance request, one per asset being cleared |
request_items[] | Model | Each item | Expand Cancel a clearance request — 200 response body — data request items item |
status | string | Required within parent | Current state of the clearance request Known values: CANCELLED, COMPLETED, DECIDED, PENDING_DECISION, PENDING_QUOTE, PENDING_RETURN |
Referenced models: Cancel a clearance request — 200 response body — data request items item
Cancel a clearance request — 200 response body — data request items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
asset | Model | Required within parent | Expand Cancel a clearance request — 200 response body — data request items item asset Asset being cleared as part of this clearance request item |
id | string | Required within parent | Unique identifier of the clearance request item Format: uuid |
quote_price | JSON | Required within parent | Quote price offered by the clearance partner for the asset, absent until a quote is received |
quote_price (anyOf 1) | Model | Alternative | Expand Cancel a clearance request — 200 response body — data request items item quote price amount, currency |
quote_price (anyOf 2) | null | Alternative | |
status | string | Required within parent | Current state of the item within the clearance request lifecycle Known values: CANCELLED, CUSTOMER_ACCEPTED_QUOTE, CUSTOMER_REJECTED_QUOTE, PENDING_CUSTOMER_DECISION, PENDING_QUOTE, SKIPPED_QUOTE |
Referenced models: Cancel a clearance request — 200 response body — data request items item asset, Cancel a clearance request — 200 response body — data request items item quote price amount, currency
Cancel a clearance request — 200 response body — data request items item asset
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Asset being cleared as part of this clearance request item |
id | string | Required within parent | Unique identifier of the asset Format: uuid |
product | Model | Required within parent | Expand Cancel a clearance request — 200 response body — data request items item asset product Product details of the asset |
public_id | string | Required within parent | Public identifier of the asset |
serial_number | JSON | Required within parent | |
serial_number (anyOf 1) | string | Alternative | Asset serial number, absent when the manufacturer did not assign one |
serial_number (anyOf 2) | null | Alternative | Asset serial number, absent when the manufacturer did not assign one |
Referenced models: Cancel a clearance request — 200 response body — data request items item asset product
Cancel a clearance request — 200 response body — data request items item asset product
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Product details of the asset |
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
Cancel a clearance request — 200 response body — data request items item quote price amount, currency
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Quote price offered by the clearance partner for the asset, absent until a quote is received |
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
Create a clearance request for an asset — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
manager_hris_profile_id | string | Required within parent | HRIS profile identifier of the manager attributed as the requester of the clearance. Must be a manager in the same organization. Format: uuid |
List clearance requests — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand List clearance requests — 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 clearance requests — 200 response body — data item
List clearance requests — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cancelled_reason | JSON | Required within parent | Reason the clearance request was cancelled, absent unless the status is CANCELLED |
cancelled_reason (anyOf 1) | string | Alternative | Reason the clearance request was cancelled, absent unless the status is CANCELLED Known values: DEADLINE_EXCEEDED, REQUESTED_BY_CUSTOMER |
cancelled_reason (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Creation timestamp of the clearance request Format: date-time |
expires_at | JSON | Required within parent | |
expires_at (anyOf 1) | string | Alternative | Timestamp indicating when the request expires and the manager can no longer take action, absent when no deadline applies Format: date-time |
expires_at (anyOf 2) | null | Alternative | Timestamp indicating when the request expires and the manager can no longer take action, absent when no deadline applies Format: date-time |
id | string | Required within parent | Unique identifier of the clearance request Format: uuid |
public_id | string | Required within parent | Public identifier of the clearance request |
status | string | Required within parent | Current state of the clearance request Known values: CANCELLED, COMPLETED, DECIDED, PENDING_DECISION, PENDING_QUOTE, PENDING_RETURN |