Create a Global Payroll (GP) contract | Deel

curl -X POST https://api.letsdeel.com/rest/contracts/gp \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "data": {
    "client": {
      "team": {
        "id": "00000000-0000-0000-0000-000000000000"
      },
      "legal_entity": {
        "id": "00000000-0000-0000-0000-000000000000"
      }
    },
    "employee": {
      "email": "jane.doe@example.com",
      "address": {
        "zip": "44000",
        "city": "Denver",
        "street": "Deel Street 500",
        "country": "US"
      },
      "last_name": "Doe",
      "first_name": "Jane",
      "work_email": "jane.doe@company.com"
    },
    "job_title": "Senior Software Engineer",
    "employment": {
      "type": "Full-time",
      "holidays": {
        "allowance": 20,
        "start_date": "2024-01-01"
      },
      "start_date": "2024-01-01"
    },
    "compensation_details": {
      "scale": "YEAR",
      "salary": 85000
    }
  }
}'

{
  "data": {
    "id": "c9f8a1b2-1234-5678-9abc-1234567890ab",
    "type": "global_payroll",
    "client": {
      "legal_entity": {
        "name": "Acme Corporation Ltd."
      }
    },
    "status": "completed",
    "employee": {
      "email": "jane.doe@example.com",
      "last_name": "Doe",
      "first_name": "Jane",
      "employee_number": "EMP-1001"
    },
    "job_title": "Designer",
    "created_at": "2024-06-15T10:30:00.000Z",
    "employment": {
      "type": "Full-time",
      "state": "CA",
      "country": "US",
      "end_date": "2025-06-15T00:00:00.000Z",
      "holidays": {
        "allowance": 20,
        "start_date": "2024-01-01T00:00:00.000Z"
      },
      "start_date": "2024-01-01T00:00:00.000Z",
      "work_visa_required": true
    },
    "compensation_details": {
      "scale": "YEAR",
      "salary": 85000,
      "currency": "USD"
    }
  }
}

Creates a new Global Payroll contract. Country-specific fields required in the request body vary by country and must be retrieved in advance from GET /forms/gp/worker-additional-fields/{country_code}. Returns the created contract including its unique id.

Token scopes: contracts:write

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Request

Global Payroll (GP) contract object that needs to be created.

dataobjectRequired

Response

Successful operation.

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error