Deel ACTION
Create Global Payroll Contract
Create a Global Payroll (GP) contract in Deel to add an employee to your domestic payroll system. Use this when the employee works in a country where your company already has a legal entity.
employment_type must be one of: Full-time, Part-time (case-sensitive). compensation_scale must be one of: YEAR, MONTH (uppercase). address_country must be an ISO 3166-1 alpha-2 code (e.g., US, DE). client_team_id and client_legal_entity_id are required — retrieve from your Deel organization settings. For US-based employees: work_location_state (2-letter state code, e.g., OR), work_location_is_wfh, and (if not WFH) work_location_name (office name) are required. See the documentation- Action
- Writes data
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Deel account once, then configure and run Create Global Payroll Contract from your backend or agent.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "deel-create-gp-contract",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
deel: { authProvisionId: "apn_xxxxxxx" },
clientTeamId: "Client Team ID",
clientLegalEntityId: "Client Legal Entity ID",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "deel-create-gp-contract",
"configured_props": {
"deel": { "authProvisionId": "apn_xxxxxxx" },
"clientTeamId": "Client Team ID",
"clientLegalEntityId": "Client Legal Entity ID"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "deel",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "deel-create-gp-contract",
arguments: {
clientTeamId: "Client Team ID",
clientLegalEntityId: "Client Legal Entity ID",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
clientTeamId Client Team ID | string | The ID of the client team (department) for this contract. Retrieve from your Deel organization settings. Required |
clientLegalEntityId Client Legal Entity ID | string | The ID of the client legal entity (company) for this contract. Retrieve from your Deel organization settings. Required |
jobTitle Job Title | string | The employee's job title (e.g., Software Engineer). Required |
employeeFirstName Employee First Name | string | The employee's first (given) name. Required |
employeeLastName Employee Last Name | string | The employee's last (family) name. Required |
employeeEmail Employee Personal Email | string | The employee's personal email address (e.g., jane.doe@gmail.com). Required |
employeeWorkEmail Employee Work Email | string | The employee's work email address. Required |
addressStreet Street Address | string | The employee's street address. Required |
addressCity City | string | The employee's city. Required |
addressZip ZIP/Postal Code | string | The employee's ZIP or postal code. Required |
addressCountry Country | string | ISO 3166-1 alpha-2 country code of the employee's address (e.g., US, DE). Required |
employmentType Employment Type | string | One of: Full-time, Part-time (case-sensitive). Required |
startDate Start Date | string | The employment start date in ISO 8601 format (e.g., 2026-09-01). Required |
holidaysAllowance Holidays Allowance (Days) | integer | Number of annual holiday days. Required |
holidaysStartDate Holidays Start Date | string | The date from which holiday allowance accrues, in ISO 8601 format. Required |
compensationSalary Salary Amount | string | The salary amount per the chosen compensation scale (e.g., 95000 for annual). Required |
compensationScale Compensation Scale | string | Pay period for the salary. One of: YEAR, MONTH (uppercase). Required |
compensationCurrency Currency | string | ISO 4217 currency code for the salary (e.g., USD, EUR). Required |
workLocationState Work Location State | string | 2-letter US state code for the employee's work location (e.g., OR, CA). Required for US employees. Optional |
workLocationIsWfh Work From Home | boolean | Whether the employee works from home. Set to true for remote employees. Required for US employees. Optional |
workLocationName Work Location Name | string | Name of the office location (e.g., Springfield HQ). Required when Work From Home is false for US employees. Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- deel-create-gp-contract
- Version
- 0.0.2
- App
- Deel
- Authentication
- OAuth
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗