Deel: Create a Global Payroll worker — request body — body data

API reference · Contract 2026-10-27

SDK schema: Create a Global Payroll worker — request body — body data

Field	Type	Presence	Description and constraints
$	object	Root
compensation	Model	Required within parent	Expand Create a Global Payroll worker — request body — body data compensation Base compensation of the worker.
contract_state	string	Optional	State or province code the contract is governed by. Required when the legal entity country has provinces enabled for Global Payroll (for example CA, US, AU, BR, IN) and must be one of its provinces. Maximum length: 50 Minimum length: 1
employee_number	string	Optional	Employee number in your payroll system. Required when the payroll group is a Payroll Connect (Soft GP) group. It must be unique within the legal entity. Maximum length: 100 Minimum length: 1
employment_type	string	Required within parent	Employment type of the worker. One of: FULL_TIME, PART_TIME
external_id	string	Optional	Identifier of the worker in your own system. It must be unique within your organization. Maximum length: 100 Minimum length: 1
fte_percentage	integer	Optional	Full-time equivalent percentage, from 1 to 99. Required when employment_type is PART_TIME and not allowed when it is FULL_TIME. Maximum: 99 Minimum: 1
home_address	Model	Required within parent	Expand Create a Global Payroll worker — request body — body data home address Home address of the worker.
job_title	string	Required within parent	Job title of the worker. Maximum length: 255 Minimum length: 1
legal_entity_id	string	Required within parent	Identifier of the Global Payroll legal entity the worker is employed by. It must belong to your organization. Format: uuid Maximum length: 36 Minimum length: 36
payroll_group_id	string	Required within parent	Identifier of the active Global Payroll payroll group of the legal entity the worker is paid in. Maximum length: 100 Minimum length: 1
personal_info	Model	Required within parent	Expand Create a Global Payroll worker — request body — body data personal info Personal details of the worker.
pto	Model	Optional	Expand Create a Global Payroll worker — request body — body data pto Paid time off settings for the worker.
should_invite_employee_to_app	boolean	Optional	Whether to email the worker an invitation to join Deel. Defaults to false. Default: false
start_date	string	Required within parent	Employment start date, in YYYY-MM-DD format. The payroll start date defaults to it. Format: date Maximum length: 10 Minimum length: 10
team_id	string	Required within parent	Identifier of the team the contract is created in. It must belong to your organization and the caller needs permission to create contracts in it. Format: uuid Maximum length: 36 Minimum length: 36
work_location	Model	Optional	Expand Create a Global Payroll worker — request body — body data work location Where the worker works. Required when the legal entity is in the United States.

Referenced models: Create a Global Payroll worker — request body — body data compensation, Create a Global Payroll worker — request body — body data home address, Create a Global Payroll worker — request body — body data personal info, Create a Global Payroll worker — request body — body data pto, Create a Global Payroll worker — request body — body data work location