Apideck · Schema

Payroll

IntegrationsUnified API

Properties

Name Type Description
id object
company_id object
processed boolean Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated.
processed_date string The date the payroll was processed.
check_date string The date on which employees will be paid for the payroll.
start_date string The start date, inclusive, of the pay period.
end_date string The end date, inclusive, of the pay period.
totals object
compensations array An array of compensations for the payroll.
custom_mappings object
View JSON Schema on GitHub

JSON Schema

apideck-payroll-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Payroll",
  "title": "Payroll",
  "type": "object",
  "x-apideck-schema-id": "Payroll",
  "x-apideck-weights": {
    "id": "critical",
    "company_id": "high",
    "processed": "critical",
    "processed_date": "medium",
    "check_date": "critical",
    "start_date": "critical",
    "end_date": "critical",
    "totals": "high",
    "compensations": "medium"
  },
  "required": [
    "id",
    "processed",
    "check_date",
    "start_date",
    "end_date"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "$ref": "#/components/schemas/IdOrNull"
    },
    "company_id": {
      "$ref": "#/components/schemas/CompanyId"
    },
    "processed": {
      "type": "boolean",
      "description": "Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated.",
      "example": false,
      "nullable": true
    },
    "processed_date": {
      "type": "string",
      "description": "The date the payroll was processed.",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "example": "2022-04-08",
      "nullable": true
    },
    "check_date": {
      "type": "string",
      "description": "The date on which employees will be paid for the payroll.",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "example": "2022-04-08",
      "nullable": true
    },
    "start_date": {
      "type": "string",
      "description": "The start date, inclusive, of the pay period.",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "example": "2022-04-08",
      "nullable": true
    },
    "end_date": {
      "type": "string",
      "description": "The end date, inclusive, of the pay period.",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "example": "2022-04-21",
      "nullable": true
    },
    "totals": {
      "$ref": "#/components/schemas/PayrollTotals"
    },
    "compensations": {
      "type": "array",
      "description": "An array of compensations for the payroll.",
      "items": {
        "$ref": "#/components/schemas/Compensation"
      }
    },
    "custom_mappings": {
      "$ref": "#/components/schemas/CustomMappings"
    }
  }
}