Employer Check Object

The Zeal Employer Check represents a payroll run and is only created when checks are sent out (typically the day before a check date). It notably contains employee checks paid during this payroll run and a totals object that contains aggregate and sum values across the contained employee checks.

📘
IMPORTANT
A Employer Check Object is created purely based on timing--it could potentially encapsulate 2 employee checks that have different reporting periods, but the same check date.
See Employer Check Object.

attribute	type	description
employerCheckID	string	Employer Check ID
companyID	string	ID of the Company that owns this employee check
status	string	When an employer check is processed, employee checks are sent out and tax information is attached to the Employer Check object. This field holds one of the following values: `pending` `pre-processed` `processed`
reporting_periods	array	List of reporting periods contained in this employer check. Show child attributes reportingPeriodID type: string description: Reporting Period ID start type: datetime description: Start time and date of reporting period end type: datetime required: End time and date of reporting period
totals	object	Totals for this employer check stored in an object. Show child attributes gross_pay type: float description: Gross pay for employee (total pay before taxes) net_pay type: float description: Net pay for employee (total pay after taxes = `gross_pay - total_employee_taxes`) processed check total_employer_taxes type: float required: Total amount of employer taxes processed check company_debit type: float description: Total cost for the company (`net_pay + total_employee_taxes + total_employer_taxes`) processed check total_employee_taxes type: float description: Total amount of employee taxes for this employer check run processed check
employee_checks	array	List of all employee checks. Each object contains information regarding how each employee is paid for this payroll run (i.e. everything found on a paystub and more). See Employee Check Object for all attributes.

{
  "employerCheckID": "123456789",
  "companyID": "0987654321",
  "status": "processed",
  "reporting_periods": [
    {
      "reportingPeriodID": "01739fc4cfd84c2e93dba5e802d1dda1",
      "start": "2023-01-05T10:01:00.000Z",
      "end": "2023-01-06T10:00:00.000Z"
    }
  ],
  "totals": {
    "gross_pay": 40,
    "net_pay": 26.82,
    "total_employer_taxes": 2.8,
    "company_debit": 42.8,
    "total_employee_taxes": 13.18
  },
  "employee_checks": [
    {
      "employeeCheckID": "9827465739",
      "status": "processed",
      "employeeID": "0987654321",
      "check_date": "2020-01-07",
      "approval_required": false,
      "approved": false,
      "metadata": {},
      "first_name": "peter",
      "last_name": "gregory",
      "reportingPeriodID": "01739fc4cfd84c2e93dba5e802d1dda1",
      "gross_pay": 40,
      "net_pay": 26.82,
      "total_employee_taxes": 13.18,
      "total_employer_taxes": 2.8,
      "taxes": [
        {
          "name": "Employee Medicare Tax",
          "paidBy": "EMPLOYEE_WITHHOLDING",
          "amount": 1.16
        }
      ],
      "shifts": [
        {
          "shiftID": "4712c99283304b7b989179aae36b4590",
          "status": "processed",
          "employeeID": "1234567890",
          "time": "2023-01-13T04:00:00Z",
          "metadata": {},
          "hourly": {
            "hours": 2,
            "wage": 20
          },
          "overtime": {
            "hours": 2.5,
            "wage": 30
          }
        }
      ]
    }
  ]
}

📘IMPORTANT

📘
IMPORTANT