Employer Check Processed

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 3:30 PM PST). You can update the webhook URL you want Zeal to hit in the 'API' Page of the Zeal Dashboard.

Request Body

attribute

type

description

test

boolean

Whether the employer check was created in Test Mode

companyID

string

Zeal companyID of Employer

business_name

string

Business Name of Employer

employerCheckID

string

Employer Check ID

status

string

Status of shift. Will hold the following values:
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: 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_checks

number

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

Returns

Doesn't return anything

curl --location --request POST 'https://www.example.com/api/receiveEmployerCheckProcessedWebhook'