Deel: Approve or reject quotes on a clearance request
Deel clearanceRequests.decideAclearanceRequest: arguments, response, policy and SDK examples.
← Clearance requests operations · Get started
Operation deel.itclearancerequests_decideaclearancerequest_v2026_09_17
Earlier SDK releases reported this operation as deel.clearancerequests_decideaclearancerequest_v2026_09_17 (call.operation, and the managed operation on audit rows). The TypeScript resumed-call type still accepts that id, and a policy rule naming it still matches.
Provider route: POST /it/clearance-requests/{clearance_request_id}/decide. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["clearanceRequests"]["decideAclearanceRequest"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.clearanceRequests.decideAclearanceRequest(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.clearance_requests.decide_aclearance_request(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.clearance_request_id | string | Required within parent | Format: uuid |
headers | object | Required within parent | Additional keys: not allowed |
headers.X-Beta | string | Required within parent | Default: true One of: true |
body | object | Optional | |
body.data | Model | Required within parent | Expand Approve or reject quotes on a clearance request — request body — body data |
Referenced models: Approve or reject quotes on a clearance request — request body — body data
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Cancel a clearance request — 200 response body |
Referenced models: Cancel a clearance request — 200 response body
Schemas
Section titled “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
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
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 — 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 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
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
Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Three-letter currency code for the price Known values: 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 |
Retrieve a product's catalog details — 200 response body — data category
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Product category Known values: 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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.itclearancerequests_decideaclearancerequest_v2026_09_17. Catalog operation: clearancerequests_decideaclearancerequest_v2026_09_17. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["it-service-requests:write"]
Pinned headers: {"X-Version": "2026-09-17"}