Deel: Global payroll schemas
76 Deel schemas with complete fields and constraints.
← Global payroll operations · All schemas
Add bank account — global Payroll add Gp Contract Bank Account — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Add bank account — global Payroll add Gp Contract Bank Account — 201 response body — data |
Referenced models: Add bank account — global Payroll add Gp Contract Bank Account — 201 response body — data
Add bank account — global Payroll add Gp Contract Bank Account — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Timestamp of when the bank account was created, in ISO-8601 format. Format: date-time |
funds_distribution | JSON | Optional | |
funds_distribution (anyOf 1) | JSON | Alternative | |
funds_distribution (anyOf 1) (anyOf 1) | number | Alternative | Percentage (0–100) of the salary paid to this account. A newly added account starts at 0 unless it is the only account; use PATCH /banks/settings to change the split. Format: double |
funds_distribution (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
funds_distribution (anyOf 2) | null | Alternative | Percentage (0–100) of the salary paid to this account. A newly added account starts at 0 unless it is the only account; use PATCH /banks/settings to change the split. Format: double |
id | string | Required within parent | Unique identifier for the newly added bank account. Format: uuid |
status | string | Required within parent | The status of the newly added bank account. |
updated_at | string | Required within parent | Timestamp of the last update to the bank account, in ISO-8601 format. Format: date-time |
Add payroll migration files to a legal entity — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Add payroll migration files to a legal entity — 201 response body — data The payroll migration import. |
Referenced models: Add payroll migration files to a legal entity — 201 response body — data
Add payroll migration files to a legal entity — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
file_ids | array | Required within parent | The ids of the files the request was rejected over. |
file_ids[] | string | Each item |
Add payroll migration files to a legal entity — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The payroll migration files to attach to the import. |
files | array | Required within parent | The files to attach to the import, between 1 and 50 per request. |
files[] | Model | Each item | Expand Add payroll migration files to a legal entity — request body — body data files item |
Referenced models: Add payroll migration files to a legal entity — request body — body data files item
Add payroll migration files to a legal entity — request body — body data files item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
file_id | string | Required within parent | The identifier the Deel file service returned for the uploaded file. Maximum length: 64 Minimum length: 1 Pattern: ^[A-Za-z0-9_-]+$ |
one_time_secret | string | Required within parent | The single-use secret the Deel file service returned alongside the file id. Maximum length: 255 Minimum length: 1 Pattern: ^[\u0021-\u007e]+$ |
Create a Global Payroll worker — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create a Global Payroll worker — 201 response body — data |
Referenced models: Create a Global Payroll worker — 201 response body — data
Create a Global Payroll worker — 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 worker — 201 response body — data employee |
employment | Model | Optional | Expand Create a Global Payroll worker — 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 worker — 201 response body — data employee, Create a Global Payroll worker — 201 response body — data employment
Create a Global Payroll worker — 201 response body — data client
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
legal_entity | Model | Optional | Expand Create a Global Payroll worker — 201 response body — data client legal entity |
Referenced models: Create a Global Payroll worker — 201 response body — data client legal entity
Create a Global Payroll worker — 201 response body — data client legal entity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | Legal entity name. |
Create a Global Payroll worker — 201 response body — data compensation details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Optional | Currency of gross annual/month salary. |
salary | JSON | Optional | |
salary (anyOf 1) | number | Alternative | Gross annual/month salary. Format: double |
salary (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
scale | string | Optional | Scale at which the salary is paid. |
Create a Global Payroll worker — 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. |
id | string | Optional | Worker id. Use it with the other Global Payroll worker endpoints (`/rest/gp/workers/{worker_id}/...`). Format: uuid |
last_name | string | Optional | Employee's last name. |
Create a Global Payroll worker — 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 |
is_work_visa_required | boolean | Optional | Do you require Deel to apply for a work visa for this person? |
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? |
Referenced models: Create a Global Payroll worker — 201 response body — data employment holidays
Create a Global Payroll worker — 201 response body — data employment holidays
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowance | JSON | Optional | |
allowance (anyOf 1) | number | Alternative | Number of holidays. Format: double |
allowance (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
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 |
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
Create a Global Payroll worker — request body — body data compensation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Base compensation of the worker. |
amount | number | Required within parent | Base compensation amount per scale period. Format: double Minimum: 0 |
currency | string | Required within parent | ISO 4217 currency code. It must be one of the currencies allowed for the legal entity country. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
scale | string | Required within parent | Period the amount is paid for. One of: ANNUALLY, MONTHLY, BI_MONTHLY, TWO_WEEKLY, WEEKLY, DAILY, HOURLY |
type | string | Optional | Whether the worker is salaried or paid hourly. Defaults to SALARIED. Default: SALARIED One of: SALARIED, HOURLY |
Create a Global Payroll worker — request body — body data home address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Home address of the worker. |
city | string | Required within parent | City. Maximum length: 100 Minimum length: 1 |
country | string | Required within parent | Country of the home address as an ISO 3166-1 alpha-2 code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
state | string | Optional | State, province or region. Maximum length: 50 Minimum length: 1 |
street | string | Required within parent | Street and number. Maximum length: 255 Minimum length: 1 |
zip | string | Required within parent | Postal code. Maximum length: 100 Minimum length: 1 |
Create a Global Payroll worker — request body — body data personal info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Personal details of the worker. |
date_of_birth | string | Optional | Date of birth of the worker, in YYYY-MM-DD format. Format: date Maximum length: 10 Minimum length: 10 |
email | string | Required within parent | Personal email address of the worker. It identifies the worker within your organization. Format: email Maximum length: 255 Minimum length: 3 |
first_name | string | Required within parent | First name of the worker. Maximum length: 100 Minimum length: 1 |
last_name | string | Required within parent | Last name of the worker. Maximum length: 100 Minimum length: 1 |
nationality | string | Optional | Nationality of the worker as an ISO 3166-1 alpha-2 country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
work_email | string | Optional | Work email address of the worker. Format: email Maximum length: 255 Minimum length: 3 |
Create a Global Payroll worker — request body — body data pto
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paid time off settings for the worker. |
start_date | string | Optional | Date paid time off starts accruing, in YYYY-MM-DD format. Format: date Maximum length: 10 Minimum length: 10 |
yearly_allowance | number | Optional | Number of paid time off days granted per year. Format: double Minimum: 0 |
Create a Global Payroll worker — request body — body data work location
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Where the worker works. Required when the legal entity is in the United States. |
effective_date | string | Optional | Date from which the work location applies. Defaults to start_date. Format: date |
entity_address_id | string | Optional | Identifier of an active address of the legal entity. When is_remote is false, provide either this or name. Format: uuid Maximum length: 36 Minimum length: 36 |
is_remote | boolean | Required within parent | Whether the worker works remotely rather than from an entity office. |
name | string | Optional | Name of an active address of the legal entity, as shown in the app. Alternative to entity_address_id when is_remote is false. 'Remote' is accepted and means a remote worker. Maximum length: 255 Minimum length: 1 |
Download a GP worker payslip — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Download a GP worker payslip — 200 response body — data |
Referenced models: Download a GP worker payslip — 200 response body — data
Download a GP worker payslip — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
url | string | Required within parent | A pre-signed URL to download the payslip PDF. |
Get a payroll migration import — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get a payroll migration import — 200 response body — data The payroll migration import. |
Referenced models: Get a payroll migration import — 200 response body — data
Get a payroll migration import — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The payroll migration import. |
created_at | string | Required within parent | When the import was created. Format: date-time |
files | array | Required within parent | The files attached to the import. |
files[] | Model | Each item | Expand Get a payroll migration import — 200 response body — data files item |
import_id | string | Required within parent | The unique identifier of the payroll migration import. Format: uuid |
legal_entity_id | string | Required within parent | The legal entity the import belongs to. Format: uuid |
status | Model | Required within parent | Expand Get a payroll migration import — 200 response body — data status The state of the import. IN_PROGRESS holds files that have not been submitted, and is what attaching files leaves behind - including on an import that had already been submitted, which reopens it. SUBMITTED once handed to Deel for review. DRAFT is an import started with no files yet, which only happens in the Deel web app. |
submitted_at | JSON | Required within parent | |
submitted_at (anyOf 1) | string | Alternative | When the import was submitted for review, or null when it is not SUBMITTED. Format: date-time |
submitted_at (anyOf 2) | null | Alternative | When the import was submitted for review, or null when it is not SUBMITTED. Format: date-time |
type | string | Required within parent | What kind of ingestion this is. Year-to-date payroll history is the only kind today. Known values: YTD_HISTORICAL_INGESTION |
updated_at | string | Required within parent | When the import last changed. Format: date-time |
Referenced models: Get a payroll migration import — 200 response body — data files item, Get a payroll migration import — 200 response body — data status
Get a payroll migration import — 200 response body — data files item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
file_id | string | Required within parent | The identifier of the file in the Deel file service. |
file_name | JSON | Required within parent | |
file_name (anyOf 1) | string | Alternative | The name displayed for the file in Deel, when one is known. |
file_name (anyOf 2) | null | Alternative | The name displayed for the file in Deel, when one is known. |
file_size | JSON | Required within parent | |
file_size (anyOf 1) | JSON | Alternative | |
file_size (anyOf 1) (anyOf 1) | integer | Alternative | The size of the file in bytes, when one is known. Maximum: 10485760 Minimum: 1 |
file_size (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
file_size (anyOf 2) | null | Alternative | The size of the file in bytes, when one is known. Maximum: 10485760 Minimum: 1 |
mime_type | JSON | Required within parent | |
mime_type (anyOf 1) | string | Alternative | The media type of the file, when one is known. |
mime_type (anyOf 2) | null | Alternative | The media type of the file, when one is known. |
source | string | Required within parent | Which surface the file arrived through: EXTERNAL for this API, INTERNAL for the Deel web app. An import can hold both when a client and a partner have each added files to it. Known values: INTERNAL, EXTERNAL |
uploaded_at | string | Required within parent | When the file was uploaded to the Deel file service. Format: date-time |
Get a payroll migration import — 200 response body — data status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | The state of the import. IN_PROGRESS holds files that have not been submitted, and is what attaching files leaves behind - including on an import that had already been submitted, which reopens it. SUBMITTED once handed to Deel for review. DRAFT is an import started with no files yet, which only happens in the Deel web app. Known values: DRAFT, IN_PROGRESS, SUBMITTED |
Get additional info for a contract — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | object | Required within parent | Additional keys: see wildcard field |
data.* | JSON | Additional keys | Any type |
Get payroll activation readiness for a legal entity — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get payroll activation readiness for a legal entity — 200 response body — data |
Referenced models: Get payroll activation readiness for a legal entity — 200 response body — data
Get payroll activation readiness for a legal entity — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_ready | boolean | Required within parent | Whether the payroll activation has reached the READY stage. False if there is none yet. |
List payroll groups for a legal entity — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand List payroll groups for a legal entity — 200 response body — data item |
pagination | Model | Required within parent | Expand List payroll groups for a legal entity — 200 response body — pagination |
Referenced models: List payroll groups for a legal entity — 200 response body — data item, List payroll groups for a legal entity — 200 response body — pagination
List payroll groups for a legal entity — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
calendars | array | Required within parent | REGULAR calendars for this group within the requested year. |
calendars[] | Model | Each item | Expand List payroll groups for a legal entity — 200 response body — data item calendars item |
id | string | Required within parent | Unique identifier of the payroll group. |
is_active | boolean | Required within parent | Whether the payroll group is currently active. |
name | string | Required within parent | Human-readable name of the payroll group. |
regular_cycle_cadence | string | Required within parent | Frequency at which regular payroll cycles are run for this group. Known values: WEEKLY, BIWEEKLY, MONTHLY, BIMONTHLY, FOUR_WEEKLY, QUARTERLY |
Referenced models: List payroll groups for a legal entity — 200 response body — data item calendars item
List payroll groups for a legal entity — 200 response body — data item calendars item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
calendar_type | string | Required within parent | Type of the calendar, e.g. REGULAR. |
id | string | Required within parent | Unique identifier of the calendar. |
values | object | Required within parent | Map of calendar milestone keys to their scheduled date-time values. A calendar holds only the milestones its payroll uses. Possible keys: - `START`: Start date of the payroll cycle. - `END`: End date of the payroll cycle. - `CYCLE_SUBMISSION`: Deadline to submit payroll inputs for the cycle. - `CYCLE_PUBLISHING`: Date the processed payroll is published for review. - `CYCLE_APPROVAL`: Deadline to approve the payroll (for EOR, the payments package). - `PAYROLL_FUNDING`: Date the payroll funding invoice is issued. - `FUNDING_PAYMENT_RECEIPT`: Date the funding payment must be received. - `INVOICE_PUBLISHING`: Date the payroll invoices are published. - `PAYMENT_RELEASE`: Date the salary payments are released. - `PAYSLIPS_PUBLISHING`: Date the payslips are published. - `SALARY_PAY`: Date the employees are paid. - `TIME_SHEETS_CUT_OFF`: Cut-off date for timesheets to be included in the cycle. - `LATE_STARTERS_CUTOFF`: Cut-off date for new hires to be included in the cycle. - `SOFT_G2N_UPLOAD`: Date the gross-to-net (G2N) report is uploaded. - `FINAL_BATCH_REPORTS`: Date the final batch reports are delivered. Additional keys: see wildcard field |
values.* | Model | Additional keys | Expand List payroll groups for a legal entity — 200 response body — data item calendars item values value |
Referenced models: List payroll groups for a legal entity — 200 response body — data item calendars item values value
List payroll groups for a legal entity — 200 response body — data item calendars item values value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
value | string | Required within parent | ISO-8601 date-time value for this calendar key. |
List payroll groups for a legal entity — 200 response body — pagination
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
hasMore | boolean | Required within parent | Whether additional pages exist after this one. |
limit | JSON | Required within parent | |
limit (anyOf 1) | integer | Alternative | Maximum number of items returned in this page. Maximum: 9007199254740991 Minimum: 1 |
limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
nextCursor | JSON | Required within parent | |
nextCursor (anyOf 1) | string | Alternative | Opaque cursor for the next page, or null when there are no more results. |
nextCursor (anyOf 2) | null | Alternative | Opaque cursor for the next page, or null when there are no more results. |
List payroll groups for a legal entity — request body — query pagination
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cursor | string | Optional | Maximum length: 256 Minimum length: 1 Pattern: ^[A-Za-z0-9_-]+$ |
limit | integer | Optional | Default: 10 Maximum: 15 Minimum: 1 |
List payroll migration imports for a legal entity — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand List payroll migration imports for a legal entity — 200 response body — data The legal entity's payroll migration imports and the payroll data Deel already holds. |
pagination | Model | Required within parent | Expand List payroll migration imports for a legal entity — 200 response body — pagination Pagination metadata for the page of imports returned. |
Referenced models: List payroll migration imports for a legal entity — 200 response body — data, List payroll migration imports for a legal entity — 200 response body — pagination
List payroll migration imports for a legal entity — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The legal entity's payroll migration imports and the payroll data Deel already holds. |
imports | array | Required within parent | The legal entity's payroll migration imports, newest first. Empty when it has none. |
imports[] | Model | Each item | Expand Get a payroll migration import — 200 response body — data |
period | Model | Required within parent | Expand List payroll migration imports for a legal entity — 200 response body — data period The period the legal entity's payroll data on the Deel side already covers. |
Referenced models: Get a payroll migration import — 200 response body — data, List payroll migration imports for a legal entity — 200 response body — data period
List payroll migration imports for a legal entity — 200 response body — data period
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The period the legal entity's payroll data on the Deel side already covers. |
end | JSON | Required within parent | |
end (anyOf 1) | string | Alternative | The last day the payroll data Deel holds covers, as YYYY-MM-DD. |
end (anyOf 2) | null | Alternative | The last day the payroll data Deel holds covers, as YYYY-MM-DD. |
start | JSON | Required within parent | |
start (anyOf 1) | string | Alternative | The first day the payroll data Deel holds covers, as YYYY-MM-DD. |
start (anyOf 2) | null | Alternative | The first day the payroll data Deel holds covers, as YYYY-MM-DD. |
List payroll migration imports for a legal entity — 200 response body — pagination
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pagination metadata for the page of imports returned. |
has_more | boolean | Required within parent | Whether a further page of imports exists. |
limit | JSON | Required within parent | |
limit (anyOf 1) | integer | Alternative | The page size that was applied - the requested limit, or its default when none was sent. Maximum: 50 Minimum: 1 |
limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | The cursor to pass to fetch the next page, or null when this is the last one. |
next_cursor (anyOf 2) | null | Alternative | The cursor to pass to fetch the next page, or null when this is the last one. |
Retrieve HRIS worker bank accounts — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Retrieve HRIS worker bank accounts — 200 response body — data item |
Referenced models: Retrieve HRIS worker bank accounts — 200 response body — data item
Retrieve HRIS worker bank accounts — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_number | string | Optional | Bank account number |
bank_name | string | Optional | Bank name |
full_name | string | Optional | Account holder name |
iban | string | Optional | International Bank Account Number |
id | string | Optional | Bank account ID |
status | string | Optional | Account status |
Retrieve additional information fields for GP workers by country — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Use this array to build the form UI. Each item defines one field with its type, validation, and display configuration. Items are pre-sorted by EDM display order. An empty array means no additional fields are configured for the requested country. |
data[] | Model | Each item | Expand Retrieve additional information fields for GP workers by country — 200 response body — data item |
Referenced models: Retrieve additional information fields for GP workers by country — 200 response body — data item
Retrieve additional information fields for GP workers by country — 200 response body — data / item / dependencies / item / value / op: eq, ne, gt, gte, lt, lte, contains
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
op | string | Required within parent | Use this operator to evaluate the dependency condition against the referenced field's submitted value. Known values: eq, ne, gt, gte, lt, lte, contains |
value | JSON | Required within parent | Use this value as the operand for the dependency condition evaluation. |
Retrieve additional information fields for GP workers by country — 200 response body — data / item / dependencies / item / value / op: notnull
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
op | string | Required within parent | Use this operator on its own: the condition is satisfied when the referenced field holds any non-empty value. It takes no operand. Known values: notnull |
Retrieve additional information fields for GP workers by country — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dependencies | array | Required within parent | Use this array to implement conditional field visibility. When non-empty, this field should only be displayed and required when the referenced dependency conditions are met. An empty array means the field has no conditional dependencies. |
dependencies[] | Model | Each item | Expand Retrieve additional information fields for GP workers by country — 200 response body — data item dependencies item |
is_required | boolean | Required within parent | Use this flag to determine whether the field must be provided when submitting additional information. For GP workers, the value considers the GP-specific optionality setting when available, falling back to the general optionality flag. |
key | string | Required within parent | Use this value as the field identifier when submitting additional information. Represents the snake_case version of the internal field name, generated by the API naming convention service. |
required_by | string | Optional | Use this value to determine at which stage in the payroll lifecycle this field must be collected. Known values: 'before_payroll' (required before payroll processing), 'after_payroll' (can be collected after initial payroll), 'contract_signing' (required at contract signing). Absent from the response when no lifecycle stage is configured. |
type | Model | Required within parent | Expand Retrieve additional information fields for GP workers by country — 200 response body — data item type Use this value to determine the data type expected when submitting field values. Mapped from the raw input type: 'date', 'text', 'select', 'textarea', 'tel', 'phone', and 'string' map to "string"; 'number' maps to "number"; 'checkbox' maps to "boolean". An empty string indicates an unrecognized input type. |
ui_guide | Model | Required within parent | Expand Retrieve additional information fields for GP workers by country — 200 response body — data item ui guide Use this object to control how the field is rendered in the UI. Contains labels, input type, display order, and supplementary text. |
validation | array | Required within parent | Use this array to apply client-side validation before form submission. Contains zero or one validation rule per field. An empty array means no validation is configured. |
validation[] | Model | Each item | Expand Retrieve additional information fields for GP workers by country — 200 response body — data item validation item |
values_allowed | array | Optional | Use this array to populate dropdown or select options when field_type is 'select'. Only present when the field has predefined options. Absent from the response for free-text, date, number, and other non-select field types. |
values_allowed[] | string | Each item |
Referenced models: Retrieve additional information fields for GP workers by country — 200 response body — data item validation item, Retrieve additional information fields for GP workers by country — 200 response body — data item dependencies item, Retrieve additional information fields for GP workers by country — 200 response body — data item type, Retrieve additional information fields for GP workers by country — 200 response body — data item ui guide
Retrieve additional information fields for GP workers by country — 200 response body — data item dependencies item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
key | string | Required within parent | Use this value to identify the field that this dependency refers to. Contains the snake_case key of the dependency field, matching another field's 'key' property in the same response. |
value | Model | Required within parent | Expand Retrieve additional information fields for GP workers by country — 200 response body — data item dependencies item value Use this value to evaluate the dependency condition. When the value is a primitive (string, number, or boolean), the condition is satisfied when the referenced field equals this value. When the value is an array, the condition is satisfied when the referenced field equals any one of its entries. When the value is an object, apply the operator in 'op': 'eq' (equals), 'ne' (not equals), 'gt' (greater than), 'gte' (greater than or equal), 'lt' (less than), 'lte' (less than or equal), 'contains' (field value contains the specified substring) each compare against 'value', while 'notnull' takes no operand and is satisfied when the referenced field holds any non-empty value. |
Referenced models: Retrieve additional information fields for GP workers by country — 200 response body — data item dependencies item value
Retrieve additional information fields for GP workers by country — 200 response body — data item dependencies item value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Use this value to evaluate the dependency condition. When the value is a primitive (string, number, or boolean), the condition is satisfied when the referenced field equals this value. When the value is an array, the condition is satisfied when the referenced field equals any one of its entries. When the value is an object, apply the operator in 'op': 'eq' (equals), 'ne' (not equals), 'gt' (greater than), 'gte' (greater than or equal), 'lt' (less than), 'lte' (less than or equal), 'contains' (field value contains the specified substring) each compare against 'value', while 'notnull' takes no operand and is satisfied when the referenced field holds any non-empty value. |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | number | Alternative | Format: double |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3) | boolean | Alternative | |
$ (anyOf 4) | Model | Alternative | Expand Retrieve additional information fields for GP workers by country — 200 response body — data / item / dependencies / item / value / op: eq, ne, gt, gte, lt, lte, contains |
$ (anyOf 5) | Model | Alternative | Expand Retrieve additional information fields for GP workers by country — 200 response body — data / item / dependencies / item / value / op: notnull |
$ (anyOf 6) | array | Alternative | |
$ (anyOf 6)[] | string | Each item |
Referenced models: Retrieve additional information fields for GP workers by country — 200 response body — data / item / dependencies / item / value / op: eq, ne, gt, gte, lt, lte, contains, Retrieve additional information fields for GP workers by country — 200 response body — data / item / dependencies / item / value / op: notnull
Retrieve additional information fields for GP workers by country — 200 response body — data item type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Use this value to determine the data type expected when submitting field values. Mapped from the raw input type: 'date', 'text', 'select', 'textarea', 'tel', 'phone', and 'string' map to "string"; 'number' maps to "number"; 'checkbox' maps to "boolean". An empty string indicates an unrecognized input type. Known values: string, number, boolean, "" (empty string) |
Retrieve additional information fields for GP workers by country — 200 response body — data item ui guide
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Use this object to control how the field is rendered in the UI. Contains labels, input type, display order, and supplementary text. |
description | string | Required within parent | Use this value to display supplementary context about the field below or beside the input. HTML tags are stripped. Returns an empty string when no description is configured. |
field_type | string | Required within parent | Use this value to select the appropriate UI input component. Represents the raw input type from the field configuration. Known values include 'text', 'date', 'select', 'textarea', 'tel', 'phone', 'number', 'checkbox', and 'string'. Additional values may exist. |
helper_text | string | Required within parent | Use this value to display footnote or instructional text near the field. HTML tags are stripped. Returns an empty string when no helper text is configured. |
label | string | Required within parent | Use this value as the primary English-language label when rendering the field in the UI. |
local_label | string | Required within parent | Use this value as the localized field label when rendering the form in the worker's local language. |
order | JSON | Required within parent | |
order (anyOf 1) | integer | Alternative | Use this value to determine the display position of the field in the form. Starts at 1 and reflects the position in the response array, which is pre-sorted by the configured display order. Minimum: 1 |
order (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve additional information fields for GP workers by country — 200 response body — data item validation item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_message | string | Required within parent | Use this message to display to the user when the field value fails validation. Defaults to 'Review the value entered' when no custom message is configured. |
type | string | Required within parent | Use this value to determine which validation strategy to apply. "REGEX" indicates the 'value' field contains a regular expression pattern. Any other value indicates a custom validation type identified by its uppercase name. |
value | string | Optional | Use this value as the validation parameter. For REGEX type, contains the regular expression pattern to validate the field input against. Absent when the validation type is a custom type that does not require a parameter. |
Retrieve bank accounts — global Payroll get Gp Contract Bank Accounts — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Retrieve bank accounts — global Payroll get Gp Contract Bank Accounts — 200 response body — data item |
Referenced models: Retrieve bank accounts — global Payroll get Gp Contract Bank Accounts — 200 response body — data item
Retrieve bank accounts — global Payroll get Gp Contract Bank Accounts — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_number | string | Optional | The user's bank account number. |
account_type | string | Optional | Bank account type. |
ach_routing_number | string | Optional | The ACH (Automated Clearing House) Routing Number. |
address_line1 | string | Optional | The primary address line. |
address_line2 | string | Optional | The secondary address line. |
bank_branch_name | string | Optional | The name of the user's bank branch. |
bank_code | string | Optional | The bank code. |
bank_country_code | string | Optional | The country code where the bank is located. |
bank_name | string | Optional | Name of the user's bank. |
branch_code | string | Optional | The branch code of the user's bank. |
city | string | Optional | The city of the user's address. |
country_code | string | Optional | The country code of the user. |
created_at | string | Required within parent | Long date-time format following ISO-8601. Format: date-time |
currency_code | string | Optional | The currency code for transactions. |
email | string | Optional | The user's email address. |
full_name | string | Optional | Full name of the user. |
funds_distribution | JSON | Optional | |
funds_distribution (anyOf 1) | JSON | Alternative | |
funds_distribution (anyOf 1) (anyOf 1) | number | Alternative | Percentage (0–100) of the salary paid to this account. All of a contract’s accounts sum to 100. Format: double |
funds_distribution (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
funds_distribution (anyOf 2) | null | Alternative | Percentage (0–100) of the salary paid to this account. All of a contract’s accounts sum to 100. Format: double |
iban | string | Optional | The International Bank Account Number (IBAN). |
id | string | Required within parent | Unique identifier of this resource. |
original_name | string | Optional | The original name of the user. |
phone | string | Optional | The user's phone number. |
postal | string | Optional | The user's postal or ZIP code. |
province_state | string | Optional | The state or province of the user's address. |
rib_number | string | Optional | The RIB(Relevé d'Identité Bancaire). |
sort_code | string | Optional | UK sort code. |
status | string | Optional | Current status of bank account. |
swift_bic | string | Optional | SWIFT/BIC code for the bank. |
tax_id | string | Optional | The user's tax identification number. |
updated_at | string | Required within parent | Long date-time format following ISO-8601. Format: date-time |
Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item |
Referenced models: Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item
Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_required | boolean | Required within parent | Indicates whether the field is required. |
key | string | Required within parent | The unique key representing the field. |
label | string | Optional | The label or display name for this field. |
type | string | Optional | The type of the field, such as 'Text' or 'Dropdown'. |
validations | array | Optional | An array of validation rules applied to the field. |
validations[] | Model | Each item | Expand Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item |
values_allowed | array | Optional | An array of allowed values for the field (e.g., for dropdown fields). |
values_allowed[] | Model | Each item | Expand Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item values allowed item |
Referenced models: Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item values allowed item, Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item
Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | The type of validation applied to the field. Known values: MIN_LENGTH, MAX_LENGTH, REGEX |
value | Model | Optional | Expand Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item value |
Referenced models: Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item value
Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | number | Alternative | Format: double |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item values allowed item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
label | string | Optional | The display name of the allowed value. |
value | string | Optional | The value associated with the allowed option. |
Retrieve contract creation schema — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Fields accepted when creating a Global Payroll contract. Keys use the casing the contract-creation endpoint expects, dotted for nested objects and suffixed with [] for array items. |
data[] | Model | Each item | Expand Retrieve contract creation schema — 200 response body — data item |
Referenced models: Retrieve contract creation schema — 200 response body — data item
Retrieve contract creation schema — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
default | JSON | Optional | Value applied when the field is omitted. |
dependencies | array | Optional | Other fields this field is conditional on. |
dependencies[] | Model | Each item | Expand Retrieve contract creation schema — 200 response body — data item dependencies item |
is_nullable | boolean | Optional | Whether null is an accepted value. |
is_required | boolean | Required within parent | Whether the field must be provided. |
key | string | Required within parent | Field name to send, dotted for nested objects and suffixed with [] for array items. |
type | string | Required within parent | Transport type of the field. Known values: string, number, boolean, object, array |
validation | array | Optional | Constraints applied to the value. |
validation[] | Model | Each item | Expand Retrieve contract creation schema — 200 response body — data item validation item |
values_allowed | array | Optional | Permitted values, when the field is restricted to a fixed set. |
values_allowed[] | JSON | Each item | Any type |
Referenced models: Retrieve contract creation schema — 200 response body — data item dependencies item, Retrieve contract creation schema — 200 response body — data item validation item
Retrieve contract creation schema — 200 response body — data item dependencies item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
equals | array | Optional | Values of the referenced field that trigger the condition. |
equals[] | JSON | Each item | Any type |
field | string | Required within parent | Field this one depends on. |
Retrieve contract creation schema — 200 response body — data item validation item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field | string | Optional | Field this constraint is relative to, when the bound references another field instead of a literal. |
type | string | Required within parent | Constraint name, e.g. max, pattern, email, positive, format. |
value | JSON | Optional | Constraint argument, when the constraint is a literal. |
Retrieve the Global Payroll worker creation schema — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Fields accepted by POST /rest/gp/workers. A field absent from the list is not accepted for the given country. |
data[] | Model | Each item | Expand Retrieve the Global Payroll worker creation schema — 200 response body — data item |
Referenced models: Retrieve the Global Payroll worker creation schema — 200 response body — data item
Retrieve the Global Payroll worker creation schema — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
default | JSON | Optional | Value applied when the field is omitted. |
dependencies | array | Optional | Other fields this field is conditional on. |
dependencies[] | Model | Each item | Expand Retrieve the Global Payroll worker creation schema — 200 response body — data item dependencies item |
is_nullable | boolean | Optional | Whether null is an accepted value. |
is_required | boolean | Required within parent | Whether the field must be provided for the given country, legal entity and payroll group. |
key | string | Required within parent | Field to send, exactly as the create endpoint accepts it. Dotted for nested objects. Maximum length: 200 Minimum length: 1 |
type | string | Required within parent | Transport type of the field. Known values: string, number, boolean, object, array |
validation | array | Optional | Constraints applied to the value. |
validation[] | Model | Each item | Expand Retrieve the Global Payroll worker creation schema — 200 response body — data item validation item |
values_allowed | array | Optional | Permitted values, when the field is restricted to a fixed set. For contract_state these are the provinces of the country. |
values_allowed[] | JSON | Each item | Any type |
Referenced models: Retrieve the Global Payroll worker creation schema — 200 response body — data item dependencies item, Retrieve the Global Payroll worker creation schema — 200 response body — data item validation item
Retrieve the Global Payroll worker creation schema — 200 response body — data item dependencies item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
equals | array | Optional | Values of the referenced field that trigger the condition. |
equals[] | JSON | Each item | Any type |
field | string | Required within parent | Field this one depends on. Maximum length: 200 Minimum length: 1 |
Retrieve the Global Payroll worker creation schema — 200 response body — data item validation item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field | string | Optional | Field this constraint is relative to, when the bound references another field. Maximum length: 200 Minimum length: 1 |
message | string | Optional | Error message the create endpoint returns when the constraint fails. Maximum length: 500 Minimum length: 1 |
type | string | Required within parent | Constraint name, e.g. pattern, max, length, format, not_allowed. Maximum length: 50 Minimum length: 1 |
value | JSON | Optional | Constraint argument, when the constraint is a literal. |
Set salary split — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | The resulting split per account after the update. |
data[] | Model | Each item | Expand Set salary split — 200 response body — data item |
Referenced models: Set salary split — 200 response body — data item
Set salary split — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
funds_distribution | JSON | Required within parent | |
funds_distribution (anyOf 1) | number | Alternative | Percentage (0–100) of the salary paid to this account. Format: double |
funds_distribution (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | Identifier of the bank account. |
Set salary split — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
settings | array | Required within parent | The salary split across the contract's bank accounts. Percentages must add up to 100. |
settings[] | Model | Each item | Expand Set salary split — request body — body data settings item |
Referenced models: Set salary split — request body — body data settings item
Set salary split — request body — body data settings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank_id | string | Required within parent | Identifier of the bank account (as returned by GET /banks). |
funds_distribution | number | Required within parent | Percentage (0–100) of the salary paid to this account. Format: double Maximum: 100 Minimum: 0 |
Update bank account — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_number | string | Optional | The user's bank account number. |
account_type | string | Optional | Bank account type. |
ach_routing_number | string | Optional | The ACH (Automated Clearing House) Routing Number. |
address_line1 | string | Optional | The primary address line. |
address_line2 | string | Optional | The secondary address line. |
bank_branch_name | string | Optional | The name of the user's bank branch. |
bank_code | string | Optional | The bank code. |
bank_country_code | string | Optional | The country code where the bank is located. |
bank_name | string | Optional | Name of the user's bank. |
branch_code | string | Optional | The branch code of the user's bank. |
city | string | Optional | The city of the user's address. |
country_code | string | Optional | The country code of the user's address. |
currency_code | string | Optional | The currency code for transactions. |
email | string | Optional | The user's email address. |
full_name | string | Optional | Full name of the user. |
iban | string | Optional | The International Bank Account Number (IBAN). |
original_name | string | Optional | The original name of the user. |
phone | string | Optional | The user's phone number. |
postal | string | Optional | The user's postal or ZIP code. |
province_state | string | Optional | The state or province of the user's address. |
rib_number | string | Optional | The RIB (Relevé d'Identité Bancaire). |
swift_bic | string | Optional | SWIFT/BIC code for the bank. |
tax_id | string | Optional | The user's tax identification number. |
Update employment type for a contract — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Update employment type for a contract — 200 response body — data |
Referenced models: Update employment type for a contract — 200 response body — data
Update employment type for a contract — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_id | string | Required within parent | The unique identifier of the GP contract. Maximum length: 100 Pattern: ^(([a-z0-9]{6,})|([a-z0-9-_]{20,})|(-2[0-9]{2}))$ |
effective_date | string | Required within parent | The date from which the change takes effect. Format: date |
employment_type | string | Required within parent | The updated employment type. Known values: EMPLOYEE_FT, EMPLOYEE_PT, ON_LEAVE |
fte | JSON | Required within parent | |
fte (anyOf 1) | number | Alternative | The full-time equivalent for the updated employment type, as a fraction between 0 and 1 (inclusive). Format: double Maximum: 1 Minimum: 0 |
fte (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Update employment type for a contract — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employment-type change details, including the effective date. |
effective_date | string | Required within parent | The date from which the new employment type takes effect (YYYY-MM-DD). Format: date |
employment_type | string | Required within parent | The new employment type: EMPLOYEE_FT (full-time), EMPLOYEE_PT (part-time), or ON_LEAVE (on leave). One of: EMPLOYEE_FT, EMPLOYEE_PT, ON_LEAVE |
fte | number | Required within parent | Full-time equivalent for the new employment type, as a fraction between 0 and 1 (inclusive). Format: double Maximum: 1 Minimum: 0 |
Update end date for a contract — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Update end date for a contract — 200 response body — data |
Referenced models: Update end date for a contract — 200 response body — data
Update end date for a contract — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_id | string | Required within parent | The unique identifier of the GP contract. Maximum length: 100 Pattern: ^(([a-z0-9]{6,})|([a-z0-9-_]{20,})|(-2[0-9]{2}))$ |
contract_term | string | Required within parent | The contract term derived from the end date: DEFINITE when an end date is set, INDEFINITE when it is null. Known values: DEFINITE, INDEFINITE |
effective_date | string | Required within parent | The date from which the change takes effect. Format: date |
end_date | JSON | Required within parent | |
end_date (anyOf 1) | string | Alternative | The recorded contract end date, or null when the contract is open-ended. Format: date |
end_date (anyOf 2) | null | Alternative | The recorded contract end date, or null when the contract is open-ended. Format: date |
Update end date for a contract — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | End date change details, including the effective date. |
effective_date | string | Required within parent | The date from which the new end date applies (YYYY-MM-DD). Format: date |
end_date | string or null | Required within parent | The new contract end date (YYYY-MM-DD), or null to make the contract open-ended. Format: date |