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
An 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.
attribute | type | description |
---|---|---|
employerCheckID | string | Employer Check ID |
companyID | string | ID of 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: |
reporting_periods | array | List of reporting periods contained in this employer check. Show child attributes**reportingPeriodID** type: string description: Reporting Period ID start end |
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 total_employer_taxes company_debit total_employee_taxes |
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. |