Deel · Schema

Deel Payroll Event

Canonical schema for a Deel Global Payroll event/cycle.

HRPayrollGlobal PayrollEOREmployer of RecordContractorsHRISATSWorkforceComplianceImmigrationBackground ChecksWebhooksIT

Properties

Name Type Description
id string
legal_entity_id string
country string
currency string
cycle_start string
cycle_end string
cutoff_date string
pay_date string
status string
total_gross number
total_net number
worker_count integer
View JSON Schema on GitHub

JSON Schema

deel-payroll-event-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/deel-com/main/json-schema/deel-payroll-event-schema.json",
  "title": "Deel Payroll Event",
  "description": "Canonical schema for a Deel Global Payroll event/cycle.",
  "type": "object",
  "required": ["id", "legal_entity_id", "country", "currency", "cycle_start", "cycle_end", "status"],
  "properties": {
    "id": { "type": "string" },
    "legal_entity_id": { "type": "string" },
    "country": { "type": "string" },
    "currency": { "type": "string" },
    "cycle_start": { "type": "string", "format": "date" },
    "cycle_end": { "type": "string", "format": "date" },
    "cutoff_date": { "type": "string", "format": "date" },
    "pay_date": { "type": "string", "format": "date" },
    "status": {
      "type": "string",
      "enum": ["draft", "open", "locked", "processed", "paid", "closed"]
    },
    "total_gross": { "type": "number" },
    "total_net": { "type": "number" },
    "worker_count": { "type": "integer" }
  },
  "additionalProperties": true
}