Employer Check Created Event

This endpoint specifies what will be sent to your 'Employer Check Created' Webhook. Zeal POSTs a request containing an Employer Check Object created from pending checks, at 2 PM PST. You can update the webhook URL you want Zeal to hit in the 'API' Page of the Zeal Dashboard.


Request Body

attributetypedescription
testbooleanWhether the employee check was created in Test Mode
companyIDstringZeal companyID of Employer
business_namestringBusiness Name of Employer
employerCheckIDstringEmployer Check ID
statusstringWill hold the following values:
pre-processed
reporting_periodsarrayList 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

totalsobjectTotals for this employer check stored in an object


Show child attributes
gross_pay
type: number
description: Gross pay for employee (total pay before taxes)
employee_checksarrayList 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.

Returns

Doesn't return anything but rather POSTs the created Employer Check Object to your webhook URL


Raw Content Example

{
  "test": true,
  "companyID": "083472985",
  "business_name": "Test Company",
  "employerCheckID": "123456789",
  "status": "pre-processed",
  "reporting_periods": [
    {
      "reportingPeriodID": "01739fc4cfd84c2e93dba5e802d1dda1",
      "start": "2020-01-05T00:00:00.000Z",
      "end": "2020-01-06T00:01:00.000Z"
    }
  ],
  "totals": {
    "gross_pay": 40,
    "net_pay": null,
    "total_employer_taxes": null,
    "company_debit": null,
    "total_employee_taxes": null
  },
  "employee_checks": [
    {
      "employeeCheckID": "9827465739",
      "status": "pre-processed",
      "employeeID": "0987654321",
      "check_date": "2020-01-06T00:00:00Z",
      "metadata": {},
      "first_name": "peter",
      "last_name": "gregory",
      "reportingPeriodID": "01739fc4cfd84c2e93dba5e802d1dda1",
      "gross_pay": 40,
      "net_pay": null,
      "total_employee_taxes": null,
      "total_employer_taxes": null,
      "taxes": [],
      "shifts": [
        {
          "shiftID": "4712c99283304b7b989179aae36b4590",
          "status": "processed",
          "employeeID": "1234567890",
          "time": "2019-12-13T04:00:00Z",
          "metadata": {},
          "hourly": {
            "hours": 2,
            "wage": 20
          }
        }
      ]
    }
  ]
}