Deel: Worker information schemas
24 Deel schemas with complete fields and constraints.
← Worker information operations · All schemas
Add GP Workers Additional Information — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Add GP Workers Additional Information — 201 response body — data |
Referenced models: Add GP Workers Additional Information — 201 response body — data
Add GP Workers Additional Information — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | Datetime of submission of the additional information |
Add GP Workers Additional Information — request body — body data value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (oneOf 1) | string | Alternative | Maximum length: 1000 |
$ (oneOf 2) | number | Alternative | Format: double |
$ (oneOf 3) | boolean | Alternative |
Add bank account — worker Information create Gpworker Bank — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Add bank account — worker Information create Gpworker Bank — 201 response body — data |
Referenced models: Add bank account — worker Information create Gpworker Bank — 201 response body — data
Add bank account — worker Information create Gpworker Bank — 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 |
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 |
Modify bank account — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Modify bank account — 200 response body — data |
Referenced models: Modify bank account — 200 response body — data
Modify bank account — 200 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 |
id | string | Required within parent | Unique identifier for the modified bank account. Format: uuid |
status | string | Required within parent | The status of the modified bank account. |
updated_at | string | Required within parent | Timestamp of the last update to the bank account, in ISO-8601 format. Format: date-time |
Modify bank account — request body — body
| 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. |
Retrieve bank accounts — worker Information get Gpworker Banks — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Retrieve bank accounts — worker Information get Gpworker Banks — 200 response body — data item |
Referenced models: Retrieve bank accounts — worker Information get Gpworker Banks — 200 response body — data item
Retrieve bank accounts — worker Information get Gpworker Banks — 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. |
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 — worker Information get Gpworker 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 — worker Information get Gpworker Bank Guide — 200 response body — data item |
Referenced models: Retrieve bank guide — worker Information get Gpworker Bank Guide — 200 response body — data item
Retrieve bank guide — worker Information get Gpworker Bank Guide — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
key | string | Required within parent | The unique key representing the field. |
label | string | Optional | The label or display name for this field. |
required | boolean | Required within parent | Indicates whether the field is required. |
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
Update GP worker additional information — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Update GP worker additional information — 200 response body — data |
Referenced models: Update GP worker additional information — 200 response body — data
Update GP worker additional information — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_additional_data_done | boolean | Required within parent | True when all required additional information fields for EDM onboarding have been provided. |
is_updated | boolean | Required within parent | Indicates if the contract was updated. |
missing_keys | array | Required within parent | Public API keys of required fields still missing. Empty when is_additional_data_done is true. |
missing_keys[] | string | Each item |
Update PTO policy — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Update PTO policy — 200 response body — data |
Referenced models: Update PTO policy — 200 response body — data
Update PTO policy — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
updated | boolean | Required within parent | Indicates if the PTO policy was successfully updated. |
Update PTO policy — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accrual_start_date | string | Required within parent | Short date in format ISO-8601 (YYYY-MM-DD). For example: '2022-12-31'. Format: date |
yearly_allowance | string | Required within parent | Enter the number of holidays. Example: '15' for 15 days. |
Update address — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Update address — 201 response body — data |
Referenced models: Update address — 201 response body — data
Update address — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | JSON | Optional | |
city (anyOf 1) | string | Alternative | City name. |
city (anyOf 2) | null | Alternative | City name. |
country | string | Optional | Country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | State name. |
state (anyOf 2) | null | Alternative | State name. |
street | JSON | Optional | |
street (anyOf 1) | string | Alternative | Street name. |
street (anyOf 2) | null | Alternative | Street name. |
updated_at | string | Optional | Long date-time format following ISO-8601 Format: date-time |
zip | JSON | Optional | |
zip (anyOf 1) | string | Alternative | Zip code. |
zip (anyOf 2) | null | Alternative | Zip code. |
Update address — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | string | Optional | City name. |
street | string | Optional | Street name. |
zip | string | Optional | Zip code. |
Update compensation — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Update compensation — 200 response body — data item |
Referenced models: Update compensation — 200 response body — data item
Update compensation — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
effective_date | string | Optional | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. Format: date |
salary | string | Optional | Compensation salary. |
scale | string | Optional | The scale to which a given salary applies. Known values: YEAR, MONTH, HOUR |
status | string | Optional | The status of a salary amendment. Known values: ACTIVE, UPCOMING, OUTDATED |
Update compensation — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
effective_date | string | Required within parent | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. Format: date |
salary | number | Required within parent | Compensation salary. Format: double |
scale | string | Required within parent | The scale to which a given salary applies. One of: YEAR, MONTH, HOUR |
Update employee information — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
employee_number | string | Optional | Employee's unique number. |