Deel · Schema

Deel Contract

Canonical schema for a Deel contract record across IC, EOR, Global Payroll, and COR types.

HRPayrollGlobal PayrollEOREmployer of RecordContractorsHRISATSWorkforceComplianceImmigrationBackground ChecksWebhooksIT

Properties

Name	Type	Description
id	string	Deel contract identifier.
external_id	string	Client-side external identifier for cross-system reconciliation.
name	string
type	string
status	string
country	string	ISO 3166-1 alpha-2 country code.
currency	string	ISO 4217 currency code.
team	object
worker	object
salary	number	Salary or rate amount in the contract currency.
salary_frequency	string
start_date	string
end_date	string
scope_of_work	string
created_at	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/deel-com/main/json-schema/deel-contract-schema.json",
  "title": "Deel Contract",
  "description": "Canonical schema for a Deel contract record across IC, EOR, Global Payroll, and COR types.",
  "type": "object",
  "required": ["id", "type", "status", "country", "currency"],
  "properties": {
    "id": { "type": "string", "description": "Deel contract identifier." },
    "external_id": { "type": "string", "description": "Client-side external identifier for cross-system reconciliation." },
    "name": { "type": "string" },
    "type": {
      "type": "string",
      "enum": ["ongoing_time_based", "pay_as_you_go_time_based", "milestones", "eor", "global_payroll", "direct_employee", "cor"]
    },
    "status": {
      "type": "string",
      "enum": ["new", "in_progress", "waiting_for_review", "waiting_for_signature", "active", "terminated", "cancelled", "completed"]
    },
    "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code." },
    "currency": { "type": "string", "description": "ISO 4217 currency code." },
    "team": {
      "type": "object",
      "properties": {
        "id": { "type": "string" },
        "name": { "type": "string" }
      }
    },
    "worker": {
      "type": "object",
      "properties": {
        "id": { "type": "string" },
        "name": { "type": "string" },
        "email": { "type": "string", "format": "email" }
      }
    },
    "salary": { "type": "number", "description": "Salary or rate amount in the contract currency." },
    "salary_frequency": { "type": "string", "enum": ["hourly", "weekly", "monthly", "yearly"] },
    "start_date": { "type": "string", "format": "date" },
    "end_date": { "type": "string", "format": "date" },
    "scope_of_work": { "type": "string" },
    "created_at": { "type": "string", "format": "date-time" }
  },
  "additionalProperties": true
}