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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | object | Optional | |
body.data | Model | Required within parent | Expand Create a Global Payroll (GP) contract — request body — body data |
Referenced models: Create a Global Payroll (GP) contract — request body — body data
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Create a Global Payroll (GP) contract — 201 response body |
Referenced models: Create a Global Payroll (GP) contract — 201 response body
Schemas
Section titled “Schemas”10 more schemas are linked from the tables above, on the schema pages.
Create a Global Payroll (GP) contract — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client | Model | Required within parent | Expand Create a Global Payroll (GP) contract — request body — body data client |
compensation_details | Model | Required within parent | Expand Create a Global Payroll (GP) contract — request body — body data compensation details |
employee | Model | Required within parent | Expand Create a Global Payroll (GP) contract — request body — body data employee |
employment | Model | Required within parent | Expand Create a Global Payroll (GP) contract — request body — body data employment |
invite_employee_to_app | boolean | Optional | When true, the employee will receive an invitation to join the platform for onboarding. |
job_title | string | Required within parent | Employee's official job title as stated in the employment agreement. |
work_location | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
legal_entity | Model | Required within parent | Expand Create a Global Payroll (GP) contract — request body — body data client legal entity |
payroll_group_id | string | Optional | Unique 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 |
team | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Optional | Three-letter ISO 4217 currency code representing the salary currency. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
salary | number | Required within parent | Gross salary amount based on the selected scale. Format: double |
scale | string | Required within parent | Defines 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | Model | Required within parent | Expand Create a Global Payroll (GP) contract — request body — body data employee address |
email | string | Required within parent | Employee's personal email address used for communication and onboarding. Format: email Minimum length: 5 |
employee_number | string | Optional | Internal employee identifier within the client organization. |
external_id | string or null | Optional | A 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_name | string | Required within parent | Employee's first name. |
last_name | string | Required within parent | Employee's last name. |
nationality | Model | Optional | Expand Create a Global Payroll (GP) contract — request body — body data employee nationality Employee's nationality in ISO 3166-1 alpha-2 format. |
work_email | string | Required within parent | Employee'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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | Model | Optional | Expand 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. |
fte | number or null | Optional | Full-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 |
holidays | Model | Required within parent | Expand Create a Global Payroll (GP) contract — request body — body data employment holidays |
start_date | string | Required within parent | Employment start date in ISO-8601 format (YYYY-MM-DD). Format: date |
type | string | Required within parent | Employment 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Work location details for the employee. Required for US legal entities. |
effective_date | string | Optional | Date when the work location becomes effective (ISO-8601 YYYY-MM-DD). Format: date |
is_wfh | boolean | Required within parent | Indicates whether the employee works remotely. |
name | string | Optional | Name 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier of the legal entity. Format: uuid |
Create a Global Payroll (GP) contract — request body — body data client team
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Refers 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | string | Required within parent | City of residence. |
country | Model | Required within parent | Expand Create a Global Payroll (GP) contract — request body — body data employee address country ISO 3166-1 alpha-2 country code. |
state | string | Optional | State or province code. |
street | string | Required within parent | Street name and building number. |
zip | string | Required within parent | Postal 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowance | number | Required within parent | Number of paid holiday days allocated per year. Format: double |
start_date | string | Required within parent | Date when the holiday entitlement becomes effective (ISO-8601 YYYY-MM-DD). Format: date |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}