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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client | Model | Optional | Expand Create a Global Payroll worker — 201 response body — data client |
compensation_details | Model | Optional | Expand Create a Global Payroll worker — 201 response body — data compensation details |
created_at | JSON | Optional | |
created_at (anyOf 1) | string | Alternative | Long date-time format following ISO-8601. Format: date-time |
created_at (anyOf 2) | null | Alternative | Long date-time format following ISO-8601. Format: date-time |
employee | Model | Optional | Expand Create a Global Payroll (GP) contract — 201 response body — data employee |
employment | Model | Optional | Expand Create a Global Payroll (GP) contract — 201 response body — data employment |
id | string | Optional | Id of the contract created. |
job_title | string | Optional | Employee's job title. |
status | string | Optional | Status 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 |
type | string | Optional | Type 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Optional | Employee's email address. |
employee_number | JSON | Optional | |
employee_number (anyOf 1) | string | Alternative | Employee's number. |
employee_number (anyOf 2) | null | Alternative | Employee's number. |
first_name | string | Optional | Employee's first name. |
last_name | string | Optional | Employee's last name. |
Create a Global Payroll (GP) contract — 201 response body — data employment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | string | Optional | Country of employment. |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | Long date-time format following ISO-8601. Format: date-time |
end_date (anyOf 2) | null | Alternative | Long date-time format following ISO-8601. Format: date-time |
holidays | Model | Optional | Expand Create a Global Payroll worker — 201 response body — data employment holidays |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | Long date-time format following ISO-8601. Format: date-time |
start_date (anyOf 2) | null | Alternative | Long date-time format following ISO-8601. Format: date-time |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | State code of the state/province where this person will be employed. |
state (anyOf 2) | null | Alternative | State code of the state/province where this person will be employed. |
type | string | Optional | Is it a full-time contract or a part-time contract? |
work_visa_required | boolean | Optional | Do 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client | Model | Required within parent | Expand Create a Global Payroll (GP) contract — request body — body data client |
compensation_details | Model | Required within parent | Expand Create a Global Payroll (GP) contract — request body — body data compensation details |
employee | Model | Required within parent | Expand Create a Global Payroll (GP) contract — request body — body data employee |
employment | Model | Required within parent | Expand Create a Global Payroll (GP) contract — request body — body data employment |
invite_employee_to_app | boolean | Optional | When true, the employee will receive an invitation to join the platform for onboarding. |
job_title | string | Required within parent | Employee's official job title as stated in the employment agreement. |
work_location | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
legal_entity | Model | Required within parent | Expand Create a Global Payroll (GP) contract — request body — body data client legal entity |
payroll_group_id | string | Optional | Unique 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 |
team | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier of the legal entity. Format: uuid |
Create a Global Payroll (GP) contract — request body — body data client team
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Refers 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Optional | Three-letter ISO 4217 currency code representing the salary currency. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
salary | number | Required within parent | Gross salary amount based on the selected scale. Format: double |
scale | string | Required within parent | Defines 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | Model | Required within parent | Expand Create a Global Payroll (GP) contract — request body — body data employee address |
email | string | Required within parent | Employee's personal email address used for communication and onboarding. Format: email Minimum length: 5 |
employee_number | string | Optional | Internal employee identifier within the client organization. |
external_id | string or null | Optional | A 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_name | string | Required within parent | Employee's first name. |
last_name | string | Required within parent | Employee's last name. |
nationality | Model | Optional | Expand Create a Global Payroll (GP) contract — request body — body data employee nationality Employee's nationality in ISO 3166-1 alpha-2 format. |
work_email | string | Required within parent | Employee'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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | string | Required within parent | City of residence. |
country | Model | Required within parent | Expand Create a Global Payroll (GP) contract — request body — body data employee address country ISO 3166-1 alpha-2 country code. |
state | string | Optional | State or province code. |
street | string | Required within parent | Street name and building number. |
zip | string | Required within parent | Postal 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | ISO 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Employee'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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | Model | Optional | Expand 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. |
fte | number or null | Optional | Full-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 |
holidays | Model | Required within parent | Expand Create a Global Payroll (GP) contract — request body — body data employment holidays |
start_date | string | Required within parent | Employment start date in ISO-8601 format (YYYY-MM-DD). Format: date |
type | string | Required within parent | Employment 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | 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. 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowance | number | Required within parent | Number of paid holiday days allocated per year. Format: double |
start_date | string | Required within parent | Date 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Work location details for the employee. Required for US legal entities. |
effective_date | string | Optional | Date when the work location becomes effective (ISO-8601 YYYY-MM-DD). Format: date |
is_wfh | boolean | Required within parent | Indicates whether the employee works remotely. |
name | string | Optional | Name of the registered entity address where the employee works. Use 'Remote' if applicable. |
Request termination — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Request termination — 201 response body — data |
Referenced models: Request termination — 201 response body — data
Request termination — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier for the termination request. Format: uuid |
last_date_of_work | string | Required within parent | Long date-time format following ISO-8601. Format: date-time |
Request termination — request body — body / data / severance / time_unit: DAYS, WEEKS, MONTHS, type: TIME
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | number | Required within parent | The amount of severance, specified in the designated currency or time unit. Format: double |
currency | string | Required within parent | Currency code for severance. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
time_unit | string | Required within parent | The unit of time for severance (e.g., DAYS, WEEKS, MONTHS). One of: DAYS, WEEKS, MONTHS |
type | string | Required within parent | The type of severance, either in time off. One of: TIME |
Request termination — request body — body / data / severance / type: CASH
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | number | Required within parent | The amount of severance, specified in the designated currency. Format: double |
currency | string | Required within parent | Currency code for severance. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
type | string | Required within parent | The type of severance, in cash. One of: CASH |
Request termination — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
desired_end_date | string | Required within parent | The preferred end date for terminating the worker's engagement, in ISO-8601 format (YYYY-MM-DD). Format: date |
is_voluntary | boolean | Required within parent | Indicates whether the worker termination is voluntary (true) or involuntary (false). |
last_date_of_work | string | Required within parent | The effective termination date of the worker's employment, in ISO-8601 format (YYYY-MM-DD). Format: date |
message | string | Required within parent | The reason for terminating the worker's engagement. |
severance | Model | Required within parent | Expand Request termination — request body — body data severance |
Referenced models: Request termination — request body — body data severance
Request termination — request body — body data severance
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (oneOf 1) | Model | Alternative | Expand Request termination — request body — body / data / severance / time_unit: DAYS, WEEKS, MONTHS, type: TIME |
$ (oneOf 2) | Model | Alternative | Expand 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