Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentTimestamp of when the bank account was created, in ISO-8601 format.
Format: date-time
funds_distributionJSONOptional
funds_distribution (anyOf 1)JSONAlternative
funds_distribution (anyOf 1) (anyOf 1)numberAlternativePercentage (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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
funds_distribution (anyOf 2)nullAlternativePercentage (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
idstringRequired within parentUnique identifier for the newly added bank account.
Format: uuid
statusstringRequired within parentThe status of the newly added bank account.
updated_atstringRequired within parentTimestamp 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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
file_idsarrayRequired within parentThe ids of the files the request was rejected over.
file_ids[]stringEach item

Add payroll migration files to a legal entity — request body — body data

FieldTypePresenceDescription and constraints
$objectRootThe payroll migration files to attach to the import.
filesarrayRequired within parentThe files to attach to the import, between 1 and 50 per request.
files[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
file_idstringRequired within parentThe identifier the Deel file service returned for the uploaded file.
Maximum length: 64
Minimum length: 1
Pattern: ^[A-Za-z0-9_-]+$
one_time_secretstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

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

Referenced models: Create a Global Payroll worker — 201 response body — data client, Create a Global Payroll worker — 201 response body — data compensation details, Create a Global Payroll 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

FieldTypePresenceDescription and constraints
$objectRoot
legal_entityModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalLegal entity name.

Create a Global Payroll worker — 201 response body — data compensation details

FieldTypePresenceDescription and constraints
$objectRoot
currencystringOptionalCurrency of gross annual/month salary.
salaryJSONOptional
salary (anyOf 1)numberAlternativeGross annual/month salary.
Format: double
salary (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
scalestringOptionalScale at which the salary is paid.

Create a Global Payroll worker — 201 response body — data employee

FieldTypePresenceDescription and constraints
$objectRoot
emailstringOptionalEmployee's email address.
employee_numberJSONOptional
employee_number (anyOf 1)stringAlternativeEmployee's number.
employee_number (anyOf 2)nullAlternativeEmployee's number.
first_namestringOptionalEmployee's first name.
idstringOptionalWorker id. Use it with the other Global Payroll worker endpoints (`/rest/gp/workers/{worker_id}/...`).
Format: uuid
last_namestringOptionalEmployee's last name.

Create a Global Payroll worker — 201 response body — data employment

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

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

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

FieldTypePresenceDescription and constraints
$objectRoot
allowanceJSONOptional
allowance (anyOf 1)numberAlternativeNumber of holidays.
Format: double
allowance (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start_dateJSONOptional
start_date (anyOf 1)stringAlternativeLong date-time format following ISO-8601.
Format: date-time
start_date (anyOf 2)nullAlternativeLong date-time format following ISO-8601.
Format: date-time

Create a Global Payroll worker — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
compensationModelRequired within parentExpand Create a Global Payroll worker — request body — body data compensation
Base compensation of the worker.
contract_statestringOptionalState 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_numberstringOptionalEmployee 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_typestringRequired within parentEmployment type of the worker.
One of: FULL_TIME, PART_TIME
external_idstringOptionalIdentifier of the worker in your own system. It must be unique within your organization.
Maximum length: 100
Minimum length: 1
fte_percentageintegerOptionalFull-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_addressModelRequired within parentExpand Create a Global Payroll worker — request body — body data home address
Home address of the worker.
job_titlestringRequired within parentJob title of the worker.
Maximum length: 255
Minimum length: 1
legal_entity_idstringRequired within parentIdentifier 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_idstringRequired within parentIdentifier of the active Global Payroll payroll group of the legal entity the worker is paid in.
Maximum length: 100
Minimum length: 1
personal_infoModelRequired within parentExpand Create a Global Payroll worker — request body — body data personal info
Personal details of the worker.
ptoModelOptionalExpand Create a Global Payroll worker — request body — body data pto
Paid time off settings for the worker.
should_invite_employee_to_appbooleanOptionalWhether to email the worker an invitation to join Deel. Defaults to false.
Default: false
start_datestringRequired within parentEmployment start date, in YYYY-MM-DD format. The payroll start date defaults to it.
Format: date
Maximum length: 10
Minimum length: 10
team_idstringRequired within parentIdentifier 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_locationModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootBase compensation of the worker.
amountnumberRequired within parentBase compensation amount per scale period.
Format: double
Minimum: 0
currencystringRequired within parentISO 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}$
scalestringRequired within parentPeriod the amount is paid for.
One of: ANNUALLY, MONTHLY, BI_MONTHLY, TWO_WEEKLY, WEEKLY, DAILY, HOURLY
typestringOptionalWhether 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

FieldTypePresenceDescription and constraints
$objectRootHome address of the worker.
citystringRequired within parentCity.
Maximum length: 100
Minimum length: 1
countrystringRequired within parentCountry of the home address as an ISO 3166-1 alpha-2 code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
statestringOptionalState, province or region.
Maximum length: 50
Minimum length: 1
streetstringRequired within parentStreet and number.
Maximum length: 255
Minimum length: 1
zipstringRequired within parentPostal code.
Maximum length: 100
Minimum length: 1

Create a Global Payroll worker — request body — body data personal info

FieldTypePresenceDescription and constraints
$objectRootPersonal details of the worker.
date_of_birthstringOptionalDate of birth of the worker, in YYYY-MM-DD format.
Format: date
Maximum length: 10
Minimum length: 10
emailstringRequired within parentPersonal email address of the worker. It identifies the worker within your organization.
Format: email
Maximum length: 255
Minimum length: 3
first_namestringRequired within parentFirst name of the worker.
Maximum length: 100
Minimum length: 1
last_namestringRequired within parentLast name of the worker.
Maximum length: 100
Minimum length: 1
nationalitystringOptionalNationality of the worker as an ISO 3166-1 alpha-2 country code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
work_emailstringOptionalWork email address of the worker.
Format: email
Maximum length: 255
Minimum length: 3

Create a Global Payroll worker — request body — body data pto

FieldTypePresenceDescription and constraints
$objectRootPaid time off settings for the worker.
start_datestringOptionalDate paid time off starts accruing, in YYYY-MM-DD format.
Format: date
Maximum length: 10
Minimum length: 10
yearly_allowancenumberOptionalNumber of paid time off days granted per year.
Format: double
Minimum: 0

Create a Global Payroll worker — request body — body data work location

FieldTypePresenceDescription and constraints
$objectRootWhere the worker works. Required when the legal entity is in the United States.
effective_datestringOptionalDate from which the work location applies. Defaults to start_date.
Format: date
entity_address_idstringOptionalIdentifier 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_remotebooleanRequired within parentWhether the worker works remotely rather than from an entity office.
namestringOptionalName 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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
urlstringRequired within parentA pre-signed URL to download the payslip PDF.

Get a payroll migration import — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootThe payroll migration import.
created_atstringRequired within parentWhen the import was created.
Format: date-time
filesarrayRequired within parentThe files attached to the import.
files[]ModelEach itemExpand Get a payroll migration import — 200 response body — data files item
import_idstringRequired within parentThe unique identifier of the payroll migration import.
Format: uuid
legal_entity_idstringRequired within parentThe legal entity the import belongs to.
Format: uuid
statusModelRequired within parentExpand 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_atJSONRequired within parent
submitted_at (anyOf 1)stringAlternativeWhen the import was submitted for review, or null when it is not SUBMITTED.
Format: date-time
submitted_at (anyOf 2)nullAlternativeWhen the import was submitted for review, or null when it is not SUBMITTED.
Format: date-time
typestringRequired within parentWhat kind of ingestion this is. Year-to-date payroll history is the only kind today.
Known values: YTD_HISTORICAL_INGESTION
updated_atstringRequired within parentWhen 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

FieldTypePresenceDescription and constraints
$objectRoot
file_idstringRequired within parentThe identifier of the file in the Deel file service.
file_nameJSONRequired within parent
file_name (anyOf 1)stringAlternativeThe name displayed for the file in Deel, when one is known.
file_name (anyOf 2)nullAlternativeThe name displayed for the file in Deel, when one is known.
file_sizeJSONRequired within parent
file_size (anyOf 1)JSONAlternative
file_size (anyOf 1) (anyOf 1)integerAlternativeThe size of the file in bytes, when one is known.
Maximum: 10485760
Minimum: 1
file_size (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
file_size (anyOf 2)nullAlternativeThe size of the file in bytes, when one is known.
Maximum: 10485760
Minimum: 1
mime_typeJSONRequired within parent
mime_type (anyOf 1)stringAlternativeThe media type of the file, when one is known.
mime_type (anyOf 2)nullAlternativeThe media type of the file, when one is known.
sourcestringRequired within parentWhich 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_atstringRequired within parentWhen the file was uploaded to the Deel file service.
Format: date-time

Get a payroll migration import — 200 response body — data status

FieldTypePresenceDescription and constraints
$stringRootThe 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

FieldTypePresenceDescription and constraints
$objectRoot
dataobjectRequired within parentAdditional keys: see wildcard field
data.*JSONAdditional keysAny type

Get payroll activation readiness for a legal entity — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
is_readybooleanRequired within parentWhether the payroll activation has reached the READY stage. False if there is none yet.

List payroll groups for a legal entity — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand List payroll groups for a legal entity — 200 response body — data item
paginationModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
calendarsarrayRequired within parentREGULAR calendars for this group within the requested year.
calendars[]ModelEach itemExpand List payroll groups for a legal entity — 200 response body — data item calendars item
idstringRequired within parentUnique identifier of the payroll group.
is_activebooleanRequired within parentWhether the payroll group is currently active.
namestringRequired within parentHuman-readable name of the payroll group.
regular_cycle_cadencestringRequired within parentFrequency 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

FieldTypePresenceDescription and constraints
$objectRoot
calendar_typestringRequired within parentType of the calendar, e.g. REGULAR.
idstringRequired within parentUnique identifier of the calendar.
valuesobjectRequired within parentMap 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.*ModelAdditional keysExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
valuestringRequired within parentISO-8601 date-time value for this calendar key.

List payroll groups for a legal entity — 200 response body — pagination

FieldTypePresenceDescription and constraints
$objectRoot
hasMorebooleanRequired within parentWhether additional pages exist after this one.
limitJSONRequired within parent
limit (anyOf 1)integerAlternativeMaximum number of items returned in this page.
Maximum: 9007199254740991
Minimum: 1
limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
nextCursorJSONRequired within parent
nextCursor (anyOf 1)stringAlternativeOpaque cursor for the next page, or null when there are no more results.
nextCursor (anyOf 2)nullAlternativeOpaque cursor for the next page, or null when there are no more results.

List payroll groups for a legal entity — request body — query pagination

FieldTypePresenceDescription and constraints
$objectRoot
cursorstringOptionalMaximum length: 256
Minimum length: 1
Pattern: ^[A-Za-z0-9_-]+$
limitintegerOptionalDefault: 10
Maximum: 15
Minimum: 1

List payroll migration imports for a legal entity — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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.
paginationModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootThe legal entity's payroll migration imports and the payroll data Deel already holds.
importsarrayRequired within parentThe legal entity's payroll migration imports, newest first. Empty when it has none.
imports[]ModelEach itemExpand Get a payroll migration import — 200 response body — data
periodModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootThe period the legal entity's payroll data on the Deel side already covers.
endJSONRequired within parent
end (anyOf 1)stringAlternativeThe last day the payroll data Deel holds covers, as YYYY-MM-DD.
end (anyOf 2)nullAlternativeThe last day the payroll data Deel holds covers, as YYYY-MM-DD.
startJSONRequired within parent
start (anyOf 1)stringAlternativeThe first day the payroll data Deel holds covers, as YYYY-MM-DD.
start (anyOf 2)nullAlternativeThe first day the payroll data Deel holds covers, as YYYY-MM-DD.

List payroll migration imports for a legal entity — 200 response body — pagination

FieldTypePresenceDescription and constraints
$objectRootPagination metadata for the page of imports returned.
has_morebooleanRequired within parentWhether a further page of imports exists.
limitJSONRequired within parent
limit (anyOf 1)integerAlternativeThe page size that was applied - the requested limit, or its default when none was sent.
Maximum: 50
Minimum: 1
limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeThe cursor to pass to fetch the next page, or null when this is the last one.
next_cursor (anyOf 2)nullAlternativeThe cursor to pass to fetch the next page, or null when this is the last one.

Retrieve HRIS worker bank accounts — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
account_numberstringOptionalBank account number
bank_namestringOptionalBank name
full_namestringOptionalAccount holder name
ibanstringOptionalInternational Bank Account Number
idstringOptionalBank account ID
statusstringOptionalAccount status

Retrieve additional information fields for GP workers by country — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentUse 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[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
opstringRequired within parentUse this operator to evaluate the dependency condition against the referenced field's submitted value.
Known values: eq, ne, gt, gte, lt, lte, contains
valueJSONRequired within parentUse 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

FieldTypePresenceDescription and constraints
$objectRoot
opstringRequired within parentUse 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

FieldTypePresenceDescription and constraints
$objectRoot
dependenciesarrayRequired within parentUse 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[]ModelEach itemExpand Retrieve additional information fields for GP workers by country — 200 response body — data item dependencies item
is_requiredbooleanRequired within parentUse 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.
keystringRequired within parentUse 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_bystringOptionalUse 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.
typeModelRequired within parentExpand 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_guideModelRequired within parentExpand 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.
validationarrayRequired within parentUse 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[]ModelEach itemExpand Retrieve additional information fields for GP workers by country — 200 response body — data item validation item
values_allowedarrayOptionalUse 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[]stringEach 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

FieldTypePresenceDescription and constraints
$objectRoot
keystringRequired within parentUse 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.
valueModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$JSONRootUse 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)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)numberAlternativeFormat: double
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 3)booleanAlternative
$ (anyOf 4)ModelAlternativeExpand 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)ModelAlternativeExpand Retrieve additional information fields for GP workers by country — 200 response body — data / item / dependencies / item / value / op: notnull
$ (anyOf 6)arrayAlternative
$ (anyOf 6)[]stringEach 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

FieldTypePresenceDescription and constraints
$stringRootUse 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

FieldTypePresenceDescription and constraints
$objectRootUse this object to control how the field is rendered in the UI. Contains labels, input type, display order, and supplementary text.
descriptionstringRequired within parentUse 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_typestringRequired within parentUse 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_textstringRequired within parentUse 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.
labelstringRequired within parentUse this value as the primary English-language label when rendering the field in the UI.
local_labelstringRequired within parentUse this value as the localized field label when rendering the form in the worker's local language.
orderJSONRequired within parent
order (anyOf 1)integerAlternativeUse 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve additional information fields for GP workers by country — 200 response body — data item validation item

FieldTypePresenceDescription and constraints
$objectRoot
error_messagestringRequired within parentUse 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.
typestringRequired within parentUse 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.
valuestringOptionalUse 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

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
account_numberstringOptionalThe user's bank account number.
account_typestringOptionalBank account type.
ach_routing_numberstringOptionalThe ACH (Automated Clearing House) Routing Number.
address_line1stringOptionalThe primary address line.
address_line2stringOptionalThe secondary address line.
bank_branch_namestringOptionalThe name of the user's bank branch.
bank_codestringOptionalThe bank code.
bank_country_codestringOptionalThe country code where the bank is located.
bank_namestringOptionalName of the user's bank.
branch_codestringOptionalThe branch code of the user's bank.
citystringOptionalThe city of the user's address.
country_codestringOptionalThe country code of the user.
created_atstringRequired within parentLong date-time format following ISO-8601.
Format: date-time
currency_codestringOptionalThe currency code for transactions.
emailstringOptionalThe user's email address.
full_namestringOptionalFull name of the user.
funds_distributionJSONOptional
funds_distribution (anyOf 1)JSONAlternative
funds_distribution (anyOf 1) (anyOf 1)numberAlternativePercentage (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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
funds_distribution (anyOf 2)nullAlternativePercentage (0–100) of the salary paid to this account. All of a contract’s accounts sum to 100.
Format: double
ibanstringOptionalThe International Bank Account Number (IBAN).
idstringRequired within parentUnique identifier of this resource.
original_namestringOptionalThe original name of the user.
phonestringOptionalThe user's phone number.
postalstringOptionalThe user's postal or ZIP code.
province_statestringOptionalThe state or province of the user's address.
rib_numberstringOptionalThe RIB(Relevé d'Identité Bancaire).
sort_codestringOptionalUK sort code.
statusstringOptionalCurrent status of bank account.
swift_bicstringOptionalSWIFT/BIC code for the bank.
tax_idstringOptionalThe user's tax identification number.
updated_atstringRequired within parentLong date-time format following ISO-8601.
Format: date-time

Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
is_requiredbooleanRequired within parentIndicates whether the field is required.
keystringRequired within parentThe unique key representing the field.
labelstringOptionalThe label or display name for this field.
typestringOptionalThe type of the field, such as 'Text' or 'Dropdown'.
validationsarrayOptionalAn array of validation rules applied to the field.
validations[]ModelEach itemExpand Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item
values_allowedarrayOptionalAn array of allowed values for the field (e.g., for dropdown fields).
values_allowed[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalThe type of validation applied to the field.
Known values: MIN_LENGTH, MAX_LENGTH, REGEX
valueModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)numberAlternativeFormat: double
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRoot
labelstringOptionalThe display name of the allowed value.
valuestringOptionalThe value associated with the allowed option.

Retrieve contract creation schema — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentFields 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[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
defaultJSONOptionalValue applied when the field is omitted.
dependenciesarrayOptionalOther fields this field is conditional on.
dependencies[]ModelEach itemExpand Retrieve contract creation schema — 200 response body — data item dependencies item
is_nullablebooleanOptionalWhether null is an accepted value.
is_requiredbooleanRequired within parentWhether the field must be provided.
keystringRequired within parentField name to send, dotted for nested objects and suffixed with [] for array items.
typestringRequired within parentTransport type of the field.
Known values: string, number, boolean, object, array
validationarrayOptionalConstraints applied to the value.
validation[]ModelEach itemExpand Retrieve contract creation schema — 200 response body — data item validation item
values_allowedarrayOptionalPermitted values, when the field is restricted to a fixed set.
values_allowed[]JSONEach itemAny 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

FieldTypePresenceDescription and constraints
$objectRoot
equalsarrayOptionalValues of the referenced field that trigger the condition.
equals[]JSONEach itemAny type
fieldstringRequired within parentField this one depends on.

Retrieve contract creation schema — 200 response body — data item validation item

FieldTypePresenceDescription and constraints
$objectRoot
fieldstringOptionalField this constraint is relative to, when the bound references another field instead of a literal.
typestringRequired within parentConstraint name, e.g. max, pattern, email, positive, format.
valueJSONOptionalConstraint argument, when the constraint is a literal.

Retrieve the Global Payroll worker creation schema — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentFields accepted by POST /rest/gp/workers. A field absent from the list is not accepted for the given country.
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
defaultJSONOptionalValue applied when the field is omitted.
dependenciesarrayOptionalOther fields this field is conditional on.
dependencies[]ModelEach itemExpand Retrieve the Global Payroll worker creation schema — 200 response body — data item dependencies item
is_nullablebooleanOptionalWhether null is an accepted value.
is_requiredbooleanRequired within parentWhether the field must be provided for the given country, legal entity and payroll group.
keystringRequired within parentField to send, exactly as the create endpoint accepts it. Dotted for nested objects.
Maximum length: 200
Minimum length: 1
typestringRequired within parentTransport type of the field.
Known values: string, number, boolean, object, array
validationarrayOptionalConstraints applied to the value.
validation[]ModelEach itemExpand Retrieve the Global Payroll worker creation schema — 200 response body — data item validation item
values_allowedarrayOptionalPermitted values, when the field is restricted to a fixed set. For contract_state these are the provinces of the country.
values_allowed[]JSONEach itemAny 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

FieldTypePresenceDescription and constraints
$objectRoot
equalsarrayOptionalValues of the referenced field that trigger the condition.
equals[]JSONEach itemAny type
fieldstringRequired within parentField this one depends on.
Maximum length: 200
Minimum length: 1

Retrieve the Global Payroll worker creation schema — 200 response body — data item validation item

FieldTypePresenceDescription and constraints
$objectRoot
fieldstringOptionalField this constraint is relative to, when the bound references another field.
Maximum length: 200
Minimum length: 1
messagestringOptionalError message the create endpoint returns when the constraint fails.
Maximum length: 500
Minimum length: 1
typestringRequired within parentConstraint name, e.g. pattern, max, length, format, not_allowed.
Maximum length: 50
Minimum length: 1
valueJSONOptionalConstraint argument, when the constraint is a literal.

Set salary split — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentThe resulting split per account after the update.
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
funds_distributionJSONRequired within parent
funds_distribution (anyOf 1)numberAlternativePercentage (0–100) of the salary paid to this account.
Format: double
funds_distribution (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentIdentifier of the bank account.

Set salary split — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
settingsarrayRequired within parentThe salary split across the contract's bank accounts. Percentages must add up to 100.
settings[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
bank_idstringRequired within parentIdentifier of the bank account (as returned by GET /banks).
funds_distributionnumberRequired within parentPercentage (0–100) of the salary paid to this account.
Format: double
Maximum: 100
Minimum: 0

Update bank account — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
account_numberstringOptionalThe user's bank account number.
account_typestringOptionalBank account type.
ach_routing_numberstringOptionalThe ACH (Automated Clearing House) Routing Number.
address_line1stringOptionalThe primary address line.
address_line2stringOptionalThe secondary address line.
bank_branch_namestringOptionalThe name of the user's bank branch.
bank_codestringOptionalThe bank code.
bank_country_codestringOptionalThe country code where the bank is located.
bank_namestringOptionalName of the user's bank.
branch_codestringOptionalThe branch code of the user's bank.
citystringOptionalThe city of the user's address.
country_codestringOptionalThe country code of the user's address.
currency_codestringOptionalThe currency code for transactions.
emailstringOptionalThe user's email address.
full_namestringOptionalFull name of the user.
ibanstringOptionalThe International Bank Account Number (IBAN).
original_namestringOptionalThe original name of the user.
phonestringOptionalThe user's phone number.
postalstringOptionalThe user's postal or ZIP code.
province_statestringOptionalThe state or province of the user's address.
rib_numberstringOptionalThe RIB (Relevé d'Identité Bancaire).
swift_bicstringOptionalSWIFT/BIC code for the bank.
tax_idstringOptionalThe user's tax identification number.

Update employment type for a contract — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
contract_idstringRequired within parentThe unique identifier of the GP contract.
Maximum length: 100
Pattern: ^(([a-z0-9]{6,})|([a-z0-9-_]{20,})|(-2[0-9]{2}))$
effective_datestringRequired within parentThe date from which the change takes effect.
Format: date
employment_typestringRequired within parentThe updated employment type.
Known values: EMPLOYEE_FT, EMPLOYEE_PT, ON_LEAVE
fteJSONRequired within parent
fte (anyOf 1)numberAlternativeThe 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update employment type for a contract — request body — body data

FieldTypePresenceDescription and constraints
$objectRootEmployment-type change details, including the effective date.
effective_datestringRequired within parentThe date from which the new employment type takes effect (YYYY-MM-DD).
Format: date
employment_typestringRequired within parentThe new employment type: EMPLOYEE_FT (full-time), EMPLOYEE_PT (part-time), or ON_LEAVE (on leave).
One of: EMPLOYEE_FT, EMPLOYEE_PT, ON_LEAVE
ftenumberRequired within parentFull-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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
contract_idstringRequired within parentThe unique identifier of the GP contract.
Maximum length: 100
Pattern: ^(([a-z0-9]{6,})|([a-z0-9-_]{20,})|(-2[0-9]{2}))$
contract_termstringRequired within parentThe contract term derived from the end date: DEFINITE when an end date is set, INDEFINITE when it is null.
Known values: DEFINITE, INDEFINITE
effective_datestringRequired within parentThe date from which the change takes effect.
Format: date
end_dateJSONRequired within parent
end_date (anyOf 1)stringAlternativeThe recorded contract end date, or null when the contract is open-ended.
Format: date
end_date (anyOf 2)nullAlternativeThe recorded contract end date, or null when the contract is open-ended.
Format: date

Update end date for a contract — request body — body data

FieldTypePresenceDescription and constraints
$objectRootEnd date change details, including the effective date.
effective_datestringRequired within parentThe date from which the new end date applies (YYYY-MM-DD).
Format: date
end_datestring or nullRequired within parentThe new contract end date (YYYY-MM-DD), or null to make the contract open-ended.
Format: date

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.