Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parentDecisions 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[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
is_acceptedbooleanRequired within parentWhether the quote for this request item is accepted (`true`) or rejected (`false`). When every item is rejected the clearance request is cancelled.
request_item_idstringRequired within parentUnique identifier of the clearance request item the decision applies to
Format: uuid

Cancel a clearance request — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
cancelled_reasonJSONRequired within parentReason the clearance request was cancelled, absent unless the status is CANCELLED
cancelled_reason (anyOf 1)stringAlternativeReason the clearance request was cancelled, absent unless the status is CANCELLED
Known values: DEADLINE_EXCEEDED, REQUESTED_BY_CUSTOMER
cancelled_reason (anyOf 2)nullAlternative
created_atstringRequired within parentCreation timestamp of the clearance request
Format: date-time
expires_atJSONRequired within parent
expires_at (anyOf 1)stringAlternativeTimestamp 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)nullAlternativeTimestamp indicating when the request expires and the manager can no longer take action, absent when no deadline applies
Format: date-time
idstringRequired within parentUnique identifier of the clearance request
Format: uuid
public_idstringRequired within parentPublic identifier of the clearance request
request_itemsarrayRequired within parentItems included in this clearance request, one per asset being cleared
request_items[]ModelEach itemExpand Cancel a clearance request — 200 response body — data request items item
statusstringRequired within parentCurrent 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

FieldTypePresenceDescription and constraints
$objectRoot
assetModelRequired within parentExpand Cancel a clearance request — 200 response body — data request items item asset
Asset being cleared as part of this clearance request item
idstringRequired within parentUnique identifier of the clearance request item
Format: uuid
quote_priceJSONRequired within parentQuote price offered by the clearance partner for the asset, absent until a quote is received
quote_price (anyOf 1)ModelAlternativeExpand Cancel a clearance request — 200 response body — data request items item quote price amount, currency
quote_price (anyOf 2)nullAlternative
statusstringRequired within parentCurrent 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

FieldTypePresenceDescription and constraints
$objectRootAsset being cleared as part of this clearance request item
idstringRequired within parentUnique identifier of the asset
Format: uuid
productModelRequired within parentExpand Cancel a clearance request — 200 response body — data request items item asset product
Product details of the asset
public_idstringRequired within parentPublic identifier of the asset
serial_numberJSONRequired within parent
serial_number (anyOf 1)stringAlternativeAsset serial number, absent when the manufacturer did not assign one
serial_number (anyOf 2)nullAlternativeAsset 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

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

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

Cancel a clearance request — 200 response body — data request items item quote price amount, currency

FieldTypePresenceDescription and constraints
$objectRootQuote price offered by the clearance partner for the asset, absent until a quote is received
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
Three-letter currency code for the price

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

Create a clearance request for an asset — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
manager_hris_profile_idstringRequired within parentHRIS 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

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

Referenced models: List clearance requests — 200 response body — data item

List clearance requests — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
cancelled_reasonJSONRequired within parentReason the clearance request was cancelled, absent unless the status is CANCELLED
cancelled_reason (anyOf 1)stringAlternativeReason the clearance request was cancelled, absent unless the status is CANCELLED
Known values: DEADLINE_EXCEEDED, REQUESTED_BY_CUSTOMER
cancelled_reason (anyOf 2)nullAlternative
created_atstringRequired within parentCreation timestamp of the clearance request
Format: date-time
expires_atJSONRequired within parent
expires_at (anyOf 1)stringAlternativeTimestamp 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)nullAlternativeTimestamp indicating when the request expires and the manager can no longer take action, absent when no deadline applies
Format: date-time
idstringRequired within parentUnique identifier of the clearance request
Format: uuid
public_idstringRequired within parentPublic identifier of the clearance request
statusstringRequired within parentCurrent state of the clearance request
Known values: CANCELLED, COMPLETED, DECIDED, PENDING_DECISION, PENDING_QUOTE, PENDING_RETURN

Report an issue with this page

Necessary

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

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

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

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