Skip to content

Deel: Create a Global Payroll (GP) contract

Deel gpHiring.createGpcontract: arguments, response, policy and SDK examples.

← GP hiring operations · Get started

Operation deel.gphiring_creategpcontract

Provider route: POST /contracts/gp. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["gpHiring"]["createGpcontract"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.gpHiring.createGpcontract(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.gp_hiring.create_gpcontract(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyobjectOptional
body.dataModelRequired within parentExpand Create a Global Payroll (GP) contract — request body — body data

Referenced models: Create a Global Payroll (GP) contract — request body — body data

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Create a Global Payroll (GP) contract — 201 response body

Referenced models: Create a Global Payroll (GP) contract — 201 response body

10 more schemas are linked from the tables above, on the schema pages.

Create a Global Payroll (GP) contract — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
clientModelRequired within parentExpand Create a Global Payroll (GP) contract — request body — body data client
compensation_detailsModelRequired within parentExpand Create a Global Payroll (GP) contract — request body — body data compensation details
employeeModelRequired within parentExpand Create a Global Payroll (GP) contract — request body — body data employee
employmentModelRequired within parentExpand Create a Global Payroll (GP) contract — request body — body data employment
invite_employee_to_appbooleanOptionalWhen true, the employee will receive an invitation to join the platform for onboarding.
job_titlestringRequired within parentEmployee's official job title as stated in the employment agreement.
work_locationModelOptionalExpand Create a Global Payroll (GP) contract — request body — body data work location
Work location details for the employee. Required for US legal entities.

Referenced models: Create a Global Payroll (GP) contract — request body — body data client, Create a Global Payroll (GP) contract — request body — body data compensation details, Create a Global Payroll (GP) contract — request body — body data employee, Create a Global Payroll (GP) contract — request body — body data employment, Create a Global Payroll (GP) contract — request body — body data work location

Create a Global Payroll (GP) contract — 201 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create a Global Payroll (GP) contract — 201 response body — data

Referenced models: Create a Global Payroll (GP) contract — 201 response body — data

Create a Global Payroll (GP) contract — request body — body data client
FieldTypePresenceDescription and constraints
$objectRoot
legal_entityModelRequired within parentExpand Create a Global Payroll (GP) contract — request body — body data client legal entity
payroll_group_idstringOptionalUnique identifier of the payroll group the employee will be assigned to. Must be an active payroll group of the provided legal entity. Required when the legal entity has more than one active payroll group; when omitted, the single active payroll group of the legal entity is used.
Minimum length: 1
teamModelRequired within parentExpand Create a Global Payroll (GP) contract — request body — body data client team

Referenced models: Create a Global Payroll (GP) contract — request body — body data client legal entity, Create a Global Payroll (GP) contract — request body — body data client team

Create a Global Payroll (GP) contract — request body — body data compensation details
FieldTypePresenceDescription and constraints
$objectRoot
currencystringOptionalThree-letter ISO 4217 currency code representing the salary currency.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
salarynumberRequired within parentGross salary amount based on the selected scale.
Format: double
scalestringRequired within parentDefines whether the salary amount represents yearly or monthly gross compensation.
Default: YEAR
One of: YEAR, MONTH
Create a Global Payroll (GP) contract — request body — body data employee
FieldTypePresenceDescription and constraints
$objectRoot
addressModelRequired within parentExpand Create a Global Payroll (GP) contract — request body — body data employee address
emailstringRequired within parentEmployee's personal email address used for communication and onboarding.
Format: email
Minimum length: 5
employee_numberstringOptionalInternal employee identifier within the client organization.
external_idstring or nullOptionalA unique identifier for the employee provided by an external system. Once set, it can be used as a filter when listing contracts to directly look up Deel records from an external system.
Maximum length: 100
Minimum length: 1
first_namestringRequired within parentEmployee's first name.
last_namestringRequired within parentEmployee's last name.
nationalityModelOptionalExpand Create a Global Payroll (GP) contract — request body — body data employee nationality
Employee's nationality in ISO 3166-1 alpha-2 format.
work_emailstringRequired within parentEmployee's company email address associated with the client organization.
Format: email
Minimum length: 5

Referenced models: Create a Global Payroll (GP) contract — request body — body data employee address, Create a Global Payroll (GP) contract — request body — body data employee nationality

Create a Global Payroll (GP) contract — request body — body data employment
FieldTypePresenceDescription and constraints
$objectRoot
countryModelOptionalExpand Create a Global Payroll (GP) contract — request body — body data employment country
Country where the employee is employed, in ISO 3166-1 alpha-2 format. Used as the contract country. Falls back to employee address country if not provided.
ftenumber or nullOptionalFull-time equivalent (FTE) percentage, expressed as a decimal between 0 and 1 with up to two decimal places (e.g. 1 = 100%, 0.5 = 50%). Required when `type` is `Part-time`; defaults to 1 (full-time) when omitted or null.
Default: 1
Format: double
Maximum: 1
Minimum: 0
holidaysModelRequired within parentExpand Create a Global Payroll (GP) contract — request body — body data employment holidays
start_datestringRequired within parentEmployment start date in ISO-8601 format (YYYY-MM-DD).
Format: date
typestringRequired within parentEmployment type indicating whether the employee works full-time or part-time.
One of: Full-time, Part-time

Referenced models: Create a Global Payroll (GP) contract — request body — body data employment country, Create a Global Payroll (GP) contract — request body — body data employment holidays

Create a Global Payroll (GP) contract — request body — body data work location
FieldTypePresenceDescription and constraints
$objectRootWork location details for the employee. Required for US legal entities.
effective_datestringOptionalDate when the work location becomes effective (ISO-8601 YYYY-MM-DD).
Format: date
is_wfhbooleanRequired within parentIndicates whether the employee works remotely.
namestringOptionalName of the registered entity address where the employee works. Use 'Remote' if applicable.
Create a Global Payroll (GP) contract — request body — body data client legal entity
FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier of the legal entity.
Format: uuid
Create a Global Payroll (GP) contract — request body — body data client team
FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentRefers to Groups in the platform. Working groups that reflect the organization's structure.
Format: uuid
Create a Global Payroll (GP) contract — request body — body data employee address
FieldTypePresenceDescription and constraints
$objectRoot
citystringRequired within parentCity of residence.
countryModelRequired within parentExpand Create a Global Payroll (GP) contract — request body — body data employee address country
ISO 3166-1 alpha-2 country code.
statestringOptionalState or province code.
streetstringRequired within parentStreet name and building number.
zipstringRequired within parentPostal or ZIP code.

Referenced models: Create a Global Payroll (GP) contract — request body — body data employee address country

Create a Global Payroll (GP) contract — request body — body data employment holidays
FieldTypePresenceDescription and constraints
$objectRoot
allowancenumberRequired within parentNumber of paid holiday days allocated per year.
Format: double
start_datestringRequired within parentDate when the holiday entitlement becomes effective (ISO-8601 YYYY-MM-DD).
Format: date

SDK function policy ID: deel.gphiring_creategpcontract. Catalog operation: gphiring_creategpcontract. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["contracts:write"]

Pinned headers: {"X-Version": "2026-01-01"}

Official provider source

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.