Employer Check Processed Event

This endpoint specifies what will be sent to your 'Employer Check Processed' Webhook. Zeal POSTs a request containing the processed Employer Check Object (checks are typically processed at 2:00 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 Employer Check was created in Test Mode
companyIDstringZeal companyID of Employer
business_namestringBusiness Name of Employer
employerCheckIDstringEmployer Check ID
statusstringStatus of shift. Will hold the following values:
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) net_pay
type: number
description: Net pay for employee (total pay after taxes = gross_pay - total_employee_taxes) total_employer_taxes
type: number
required: Total amount of employer taxes

company_debit
type: number
description: Total cost for the company (net_pay + total_employee_taxes + total_employer_taxes)

total_employee_taxes
type: number
description: Total amount of employee taxes for this employer check run

employee_checksnumberList 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 processed Employer Check Object to your webhook URL


Raw Content Example

{
  "test": true,
  "companyID": "083472985",
  "business_name": "Test Company",
  "employerCheckID": "123456789",
  "status": "processed",
  "reporting_periods": [
    {
      "reportingPeriodID": "01739fc4cfd84c2e93dba5e802d1dda1",
      "start": "2020-01-05T22:01:00.000Z",
      "end": "2020-01-06T22:00:00.000Z"
    }
  ],
  "totals": {
    "gross_pay": 40,
    "net_pay": 36.94,
    "total_employer_taxes": 3.06,
    "company_debit": 43.06,
    "total_employee_taxes": 3.06
  },
  "employee_checks": [
    {
      "employeeCheckID": "9827465739",
      "status": "processed",
      "employeeID": "0987654321",
      "check_date": "2020-01-07T00:00:00Z",
      "metadata": {},
      "first_name": "peter",
      "last_name": "gregory",
      "reportingPeriodID": "01739fc4cfd84c2e93dba5e802d1dda1",
      "gross_pay": 40,
      "net_pay": 36.94,
      "total_employee_taxes": 3.06,
      "total_employer_taxes": 3.06,
      "taxes": [
        {
          "name": "Employee Medicare Tax",
          "paidBy": "EMPLOYEE_WITHHOLDING",
          "amount": 0.58
        },
        {
          "name": "Employee Social Security Tax",
          "paidBy": "EMPLOYEE_WITHHOLDING",
          "amount": 2.48
        },
        {
          "name": "Employer Medicare Tax",
          "paidBy": "EMPLOYER_LIABILITY",
          "amount": 0.58
        },
        {
          "name": "Employer Social Security Tax",
          "paidBy": "EMPLOYER_LIABILITY",
          "amount": 2.48
        }
      ],
      "shifts": [
        {
          "shiftID": "4712c99283304b7b989179aae36b4590",
          "status": "processed",
          "employeeID": "1234567890",
          "time": "2019-12-13T04:00:00Z",
          "metadata": {},
          "hourly": {
            "hours": 2,
            "wage": 20
          }
        }
      ]
    }
  ]
}