Skip to content

Deel: GP hiring schemas

23 Deel schemas with complete fields and constraints.

← GP hiring operations · All schemas

Create a Global Payroll (GP) contract — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create a Global Payroll (GP) contract — 201 response body — data

Referenced models: Create a Global Payroll (GP) contract — 201 response body — data

Create a Global Payroll (GP) contract — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
clientModelOptionalExpand Create a Global Payroll worker — 201 response body — data client
compensation_detailsModelOptionalExpand Create a Global Payroll worker — 201 response body — data compensation details
created_atJSONOptional
created_at (anyOf 1)stringAlternativeLong date-time format following ISO-8601.
Format: date-time
created_at (anyOf 2)nullAlternativeLong date-time format following ISO-8601.
Format: date-time
employeeModelOptionalExpand Create a Global Payroll (GP) contract — 201 response body — data employee
employmentModelOptionalExpand Create a Global Payroll (GP) contract — 201 response body — data employment
idstringOptionalId of the contract created.
job_titlestringOptionalEmployee's job title.
statusstringOptionalStatus of a contract in Deel workflow.
Known values: new, under_review, waiting_for_employee_contract, waiting_for_client_sign, processing_payment, waiting_for_contractor_sign, waiting_for_eor_sign, waiting_for_employee_sign, awaiting_deposit_payment, in_progress, completed, cancelled, user_cancelled, rejected, waiting_for_client_payment, onboarding
typestringOptionalType of a contract.
Known values: ongoing_time_based, milestones, time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks, eor, unknown, employee, global_payroll, shield_msa, hris_direct_employee, peo

Referenced models: Create a Global Payroll worker — 201 response body — data client, Create a Global Payroll worker — 201 response body — data compensation details, Create a Global Payroll (GP) contract — 201 response body — data employee, Create a Global Payroll (GP) contract — 201 response body — data employment

Create a Global Payroll (GP) contract — 201 response body — data employee

FieldTypePresenceDescription and constraints
$objectRoot
emailstringOptionalEmployee's email address.
employee_numberJSONOptional
employee_number (anyOf 1)stringAlternativeEmployee's number.
employee_number (anyOf 2)nullAlternativeEmployee's number.
first_namestringOptionalEmployee's first name.
last_namestringOptionalEmployee's last name.

Create a Global Payroll (GP) contract — 201 response body — data employment

FieldTypePresenceDescription and constraints
$objectRoot
countrystringOptionalCountry of employment.
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeLong date-time format following ISO-8601.
Format: date-time
end_date (anyOf 2)nullAlternativeLong date-time format following ISO-8601.
Format: date-time
holidaysModelOptionalExpand Create a Global Payroll worker — 201 response body — data employment holidays
start_dateJSONOptional
start_date (anyOf 1)stringAlternativeLong date-time format following ISO-8601.
Format: date-time
start_date (anyOf 2)nullAlternativeLong date-time format following ISO-8601.
Format: date-time
stateJSONOptional
state (anyOf 1)stringAlternativeState code of the state/province where this person will be employed.
state (anyOf 2)nullAlternativeState code of the state/province where this person will be employed.
typestringOptionalIs it a full-time contract or a part-time contract?
work_visa_requiredbooleanOptionalDo you require Deel to apply for a work visa for this person?

Referenced models: Create a Global Payroll worker — 201 response body — data employment holidays

Create a Global Payroll (GP) contract — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
clientModelRequired within parentExpand Create a Global Payroll (GP) contract — request body — body data client
compensation_detailsModelRequired within parentExpand Create a Global Payroll (GP) contract — request body — body data compensation details
employeeModelRequired within parentExpand Create a Global Payroll (GP) contract — request body — body data employee
employmentModelRequired within parentExpand Create a Global Payroll (GP) contract — request body — body data employment
invite_employee_to_appbooleanOptionalWhen true, the employee will receive an invitation to join the platform for onboarding.
job_titlestringRequired within parentEmployee's official job title as stated in the employment agreement.
work_locationModelOptionalExpand Create a Global Payroll (GP) contract — request body — body data work location
Work location details for the employee. Required for US legal entities.

Referenced models: Create a Global Payroll (GP) contract — request body — body data client, Create a Global Payroll (GP) contract — request body — body data compensation details, Create a Global Payroll (GP) contract — request body — body data employee, Create a Global Payroll (GP) contract — request body — body data employment, Create a Global Payroll (GP) contract — request body — body data work location

Create a Global Payroll (GP) contract — request body — body data client

FieldTypePresenceDescription and constraints
$objectRoot
legal_entityModelRequired within parentExpand Create a Global Payroll (GP) contract — request body — body data client legal entity
payroll_group_idstringOptionalUnique identifier of the payroll group the employee will be assigned to. Must be an active payroll group of the provided legal entity. Required when the legal entity has more than one active payroll group; when omitted, the single active payroll group of the legal entity is used.
Minimum length: 1
teamModelRequired within parentExpand Create a Global Payroll (GP) contract — request body — body data client team

Referenced models: Create a Global Payroll (GP) contract — request body — body data client legal entity, Create a Global Payroll (GP) contract — request body — body data client team

Create a Global Payroll (GP) contract — request body — body data client legal entity

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier of the legal entity.
Format: uuid

Create a Global Payroll (GP) contract — request body — body data client team

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentRefers to Groups in the platform. Working groups that reflect the organization's structure.
Format: uuid

Create a Global Payroll (GP) contract — request body — body data compensation details

FieldTypePresenceDescription and constraints
$objectRoot
currencystringOptionalThree-letter ISO 4217 currency code representing the salary currency.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
salarynumberRequired within parentGross salary amount based on the selected scale.
Format: double
scalestringRequired within parentDefines whether the salary amount represents yearly or monthly gross compensation.
Default: YEAR
One of: YEAR, MONTH

Create a Global Payroll (GP) contract — request body — body data employee

FieldTypePresenceDescription and constraints
$objectRoot
addressModelRequired within parentExpand Create a Global Payroll (GP) contract — request body — body data employee address
emailstringRequired within parentEmployee's personal email address used for communication and onboarding.
Format: email
Minimum length: 5
employee_numberstringOptionalInternal employee identifier within the client organization.
external_idstring or nullOptionalA unique identifier for the employee provided by an external system. Once set, it can be used as a filter when listing contracts to directly look up Deel records from an external system.
Maximum length: 100
Minimum length: 1
first_namestringRequired within parentEmployee's first name.
last_namestringRequired within parentEmployee's last name.
nationalityModelOptionalExpand Create a Global Payroll (GP) contract — request body — body data employee nationality
Employee's nationality in ISO 3166-1 alpha-2 format.
work_emailstringRequired within parentEmployee's company email address associated with the client organization.
Format: email
Minimum length: 5

Referenced models: Create a Global Payroll (GP) contract — request body — body data employee address, Create a Global Payroll (GP) contract — request body — body data employee nationality

Create a Global Payroll (GP) contract — request body — body data employee address

FieldTypePresenceDescription and constraints
$objectRoot
citystringRequired within parentCity of residence.
countryModelRequired within parentExpand Create a Global Payroll (GP) contract — request body — body data employee address country
ISO 3166-1 alpha-2 country code.
statestringOptionalState or province code.
streetstringRequired within parentStreet name and building number.
zipstringRequired within parentPostal or ZIP code.

Referenced models: Create a Global Payroll (GP) contract — request body — body data employee address country

Create a Global Payroll (GP) contract — request body — body data employee address country

FieldTypePresenceDescription and constraints
$stringRootISO 3166-1 alpha-2 country code.
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, 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, XA, XB, XC, XK, XX, YE, YT, ZA, ZM, ZW

Create a Global Payroll (GP) contract — request body — body data employee nationality

FieldTypePresenceDescription and constraints
$stringRootEmployee's nationality in ISO 3166-1 alpha-2 format.
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, 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, XA, XB, XC, XK, XX, YE, YT, ZA, ZM, ZW

Create a Global Payroll (GP) contract — request body — body data employment

FieldTypePresenceDescription and constraints
$objectRoot
countryModelOptionalExpand Create a Global Payroll (GP) contract — request body — body data employment country
Country where the employee is employed, in ISO 3166-1 alpha-2 format. Used as the contract country. Falls back to employee address country if not provided.
ftenumber or nullOptionalFull-time equivalent (FTE) percentage, expressed as a decimal between 0 and 1 with up to two decimal places (e.g. 1 = 100%, 0.5 = 50%). Required when `type` is `Part-time`; defaults to 1 (full-time) when omitted or null.
Default: 1
Format: double
Maximum: 1
Minimum: 0
holidaysModelRequired within parentExpand Create a Global Payroll (GP) contract — request body — body data employment holidays
start_datestringRequired within parentEmployment start date in ISO-8601 format (YYYY-MM-DD).
Format: date
typestringRequired within parentEmployment type indicating whether the employee works full-time or part-time.
One of: Full-time, Part-time

Referenced models: Create a Global Payroll (GP) contract — request body — body data employment country, Create a Global Payroll (GP) contract — request body — body data employment holidays

Create a Global Payroll (GP) contract — request body — body data employment country

FieldTypePresenceDescription and constraints
$stringRootCountry where the employee is employed, in ISO 3166-1 alpha-2 format. Used as the contract country. Falls back to employee address country if not provided.
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, 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, XA, XB, XC, XK, XX, YE, YT, ZA, ZM, ZW

Create a Global Payroll (GP) contract — request body — body data employment holidays

FieldTypePresenceDescription and constraints
$objectRoot
allowancenumberRequired within parentNumber of paid holiday days allocated per year.
Format: double
start_datestringRequired within parentDate when the holiday entitlement becomes effective (ISO-8601 YYYY-MM-DD).
Format: date

Create a Global Payroll (GP) contract — request body — body data work location

FieldTypePresenceDescription and constraints
$objectRootWork location details for the employee. Required for US legal entities.
effective_datestringOptionalDate when the work location becomes effective (ISO-8601 YYYY-MM-DD).
Format: date
is_wfhbooleanRequired within parentIndicates whether the employee works remotely.
namestringOptionalName of the registered entity address where the employee works. Use 'Remote' if applicable.

Request termination — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Request termination — 201 response body — data

Referenced models: Request termination — 201 response body — data

Request termination — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for the termination request.
Format: uuid
last_date_of_workstringRequired within parentLong date-time format following ISO-8601.
Format: date-time

Request termination — request body — body / data / severance / time_unit: DAYS, WEEKS, MONTHS, type: TIME

FieldTypePresenceDescription and constraints
$objectRoot
amountnumberRequired within parentThe amount of severance, specified in the designated currency or time unit.
Format: double
currencystringRequired within parentCurrency code for severance.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
time_unitstringRequired within parentThe unit of time for severance (e.g., DAYS, WEEKS, MONTHS).
One of: DAYS, WEEKS, MONTHS
typestringRequired within parentThe type of severance, either in time off.
One of: TIME

Request termination — request body — body / data / severance / type: CASH

FieldTypePresenceDescription and constraints
$objectRoot
amountnumberRequired within parentThe amount of severance, specified in the designated currency.
Format: double
currencystringRequired within parentCurrency code for severance.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
typestringRequired within parentThe type of severance, in cash.
One of: CASH

Request termination — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
desired_end_datestringRequired within parentThe preferred end date for terminating the worker's engagement, in ISO-8601 format (YYYY-MM-DD).
Format: date
is_voluntarybooleanRequired within parentIndicates whether the worker termination is voluntary (true) or involuntary (false).
last_date_of_workstringRequired within parentThe effective termination date of the worker's employment, in ISO-8601 format (YYYY-MM-DD).
Format: date
messagestringRequired within parentThe reason for terminating the worker's engagement.
severanceModelRequired within parentExpand Request termination — request body — body data severance

Referenced models: Request termination — request body — body data severance

Request termination — request body — body data severance

FieldTypePresenceDescription and constraints
$JSONRoot
$ (oneOf 1)ModelAlternativeExpand Request termination — request body — body / data / severance / time_unit: DAYS, WEEKS, MONTHS, type: TIME
$ (oneOf 2)ModelAlternativeExpand Request termination — request body — body / data / severance / type: CASH

Referenced models: Request termination — request body — body / data / severance / time_unit: DAYS, WEEKS, MONTHS, type: TIME, Request termination — request body — body / data / severance / type: CASH

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.