Skip to content

Deel: IT agreements schemas

12 Deel schemas with complete fields and constraints.

← IT agreements operations · All schemas

Assign agreement to a new worker — request body — body data

FieldTypePresenceDescription and constraints
$objectRootReassignment payload.
delivery_addressModelRequired within parentExpand Assign agreement to a new worker — request body — body data delivery address
Delivery address for the new holder. Country must appear in `actions.reuse.details.reassignable_in`.
hris_profile_idstringRequired within parentHRIS profile identifier of the new holder.
Format: uuid
is_express_delivery_requestedbooleanOptionalCharges the express-delivery fee when the destination country supports it. Defaults to `false`.
variant_idstringRequired within parentProduct variant to reassign the agreement to. Must be one of the variants returned in `actions.reuse.details.reusable_variants` on `GET /agreements/{agreement_id}`.
Format: uuid

Referenced models: Assign agreement to a new worker — request body — body data delivery address

Assign agreement to a new worker — request body — body data delivery address

FieldTypePresenceDescription and constraints
$objectRootDelivery address for the new holder. Country must appear in `actions.reuse.details.reassignable_in`.
citystringOptionalCity name.
countryModelRequired within parentExpand Assign agreement to a new worker — request body — body data delivery address country
Country code (ISO 3166 alpha-2).
date_of_birthstringOptionalDate of birth.
Format: date
delivery_instructionsstringOptionalDelivery instructions for the courier.
line1stringOptionalAddress line 1.
line2stringOptionalAddress line 2.
passport_numberstringOptionalPassport number.
phone_numberstringOptionalPhone number in E.164 format.
post_codestringOptionalPost code.
statestringOptionalState or region name.
tax_id_numberstringOptionalTax ID number.

Referenced models: Assign agreement to a new worker — request body — body data delivery address country

Assign agreement to a new worker — request body — body data delivery address country

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

List agreements — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Retrieve an agreement — 200 response body — data
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: Retrieve an agreement — 200 response body — data

Retrieve an agreement — 200 response body

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

Referenced models: Retrieve an agreement — 200 response body — data

Retrieve an agreement — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
actionsModelRequired within parentExpand Retrieve an agreement — 200 response body — data actions
Snapshot of which agreement-level actions are currently callable on this agreement.
assigned_hris_profileJSONRequired within parentCurrent holder of the agreement, if any. `null` while the agreement is between users
(e.g. after POST /assets/{id}/store).
assigned_hris_profile (anyOf 1)ModelAlternativeExpand Retrieve an agreement — 200 response body — data assigned hris profile emails, first name, hris profile id, last name
assigned_hris_profile (anyOf 2)nullAlternative
billing_entity_idJSONRequired within parent
billing_entity_id (anyOf 1)stringAlternativeID of the billing entity that pays for this agreement. `null` when the billing entity is
no longer active.
Format: uuid
billing_entity_id (anyOf 2)nullAlternativeID of the billing entity that pays for this agreement. `null` when the billing entity is
no longer active.
Format: uuid
created_atstringRequired within parentWhen the agreement was created.
Format: date-time
end_dateJSONRequired within parent
end_date (anyOf 1)stringAlternativeAgreement end date. `null` while the agreement is open.
Format: date
end_date (anyOf 2)nullAlternativeAgreement end date. `null` while the agreement is open.
Format: date
idstringRequired within parentUnique identifier of the agreement.
Format: uuid
productModelRequired within parentExpand Retrieve an agreement — 200 response body — data product
The product this agreement is for.
public_idstringRequired within parentPublic identifier of the agreement.
start_dateJSONRequired within parent
start_date (anyOf 1)stringAlternativeAgreement start date.
Format: date
start_date (anyOf 2)nullAlternativeAgreement start date.
Format: date
statusstringRequired within parentNormalised agreement status.
Known values: ACTIVE, CANCELED, ENDED, PENDING
store_and_reuseJSONRequired within parentStore-and-reuse block. Present only when the agreement is a rental with store-and-reuse
enabled.
store_and_reuse (anyOf 1)ModelAlternativeExpand Retrieve an agreement — 200 response body — data / store_and_reuse / status: COMPLETED, IN PROGRESS, READY
store_and_reuse (anyOf 2)nullAlternative
typestringRequired within parentAgreement type.
Known values: MANAGEMENT, PURCHASE, RENTAL
updated_atstringRequired within parentWhen the agreement was last updated.
Format: date-time
variant_idstringRequired within parentThe currently-assigned product variant.
Format: uuid

Referenced models: Retrieve an agreement — 200 response body — data assigned hris profile emails, first name, hris profile id, last name, Retrieve an agreement — 200 response body — data actions, Retrieve an agreement — 200 response body — data product, Retrieve an agreement — 200 response body — data / store_and_reuse / status: COMPLETED, IN PROGRESS, READY

Retrieve an agreement — 200 response body — data / store_and_reuse / status: COMPLETED, IN PROGRESS, READY

FieldTypePresenceDescription and constraints
$objectRootStore-and-reuse block. Present only when the agreement is a rental with store-and-reuse
enabled.
statusstringRequired within parentCurrent state of the store-and-reuse lifecycle for this rental contract.
Known values: COMPLETED, IN_PROGRESS, READY

Retrieve an agreement — 200 response body — data actions

FieldTypePresenceDescription and constraints
$objectRootSnapshot of which agreement-level actions are currently callable on this agreement.
reuseModelRequired within parentExpand Retrieve an agreement — 200 response body — data actions reuse
Backs POST /agreements/{agreement_id}/reassign.

Referenced models: Retrieve an agreement — 200 response body — data actions reuse

Retrieve an agreement — 200 response body — data actions reuse

FieldTypePresenceDescription and constraints
$objectRootBacks POST /agreements/{agreement_id}/reassign.
detailsJSONRequired within parentPopulated when `enabled = true` and the action has caller-relevant context to surface
(see per-slot documentation). Null otherwise.
details (anyOf 1)ModelAlternativeExpand Retrieve an agreement — 200 response body — data actions reuse details reassignable in, reusable variants
details (anyOf 2)nullAlternative
disabled_reasonJSONRequired within parentPopulated when `is_enabled = false`; the single reason code the storefront gave for the
disabled state. Not a list — matches V2 action-slot semantics.
disabled_reason (anyOf 1)stringAlternativePopulated when `is_enabled = false`; the single reason code the storefront gave for the
disabled state. Not a list — matches V2 action-slot semantics.
Known values: CONTRACT_HAS_ACTIVE_ASSIGNMENT, CONTRACT_IS_NOT_ACTIVE, CONTRACT_IS_NOT_RENTAL, CONTRACT_IS_NOT_REUSE_ENABLED, CONTRACT_TYPE_NOT_ALLOWED, ORGANIZATION_NOT_ACTIVE
disabled_reason (anyOf 2)nullAlternative
is_enabledbooleanRequired within parentWhether the action is currently callable on this agreement.

Referenced models: Retrieve an agreement — 200 response body — data actions reuse details reassignable in, reusable variants

Retrieve an agreement — 200 response body — data actions reuse details reassignable in, reusable variants

FieldTypePresenceDescription and constraints
$objectRootPopulated when `enabled = true` and the action has caller-relevant context to surface
(see per-slot documentation). Null otherwise.
reassignable_inarrayRequired within parentCountries the contract can currently be reassigned to (customs / entity constraints).
reassignable_in[]ModelEach itemExpand Retrieve a product's catalog details — 200 response body — data variants item available countries item
reusable_variantsarrayRequired within parentThe subset of the parent product's variants that can be reassigned via store-and-reuse.
The original contract variant is appended as a fallback when the store-and-reuse filter
returns none.
reusable_variants[]ModelEach itemExpand Retrieve a product's catalog details — 200 response body — data variants item

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

Retrieve an agreement — 200 response body — data assigned hris profile emails, first name, hris profile id, last name

FieldTypePresenceDescription and constraints
$objectRootCurrent holder of the agreement, if any. `null` while the agreement is between users
(e.g. after POST /assets/{id}/store).
emailsarrayRequired within parentArray of user email addresses
emails[]stringEach itemFormat: email
first_namestringRequired within parentFirst name of the user
hris_profile_idstringRequired within parentThe unique identifier of the HRIS profile of the assigned user
Format: uuid
last_namestringRequired within parentLast name of the user

Retrieve an agreement — 200 response body — data product

FieldTypePresenceDescription and constraints
$objectRootThe product this agreement is for.
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

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.