companyID | string | CompanyID of company |
status | string | Tracks the company onboarding lifecycle. Holds one of the following values: initial_onboarding (still onboarding), payroll_access_needed (Zeal still needs access to this company’s previous payroll provider to migrate records), migration_pending (Zeal is still migrating records from the previous payroll provider), payment_permission_pending (data migration is done but not ready to run payroll, usually pending banking partner information), live (ready to process payroll), offboarded (company has been offboarded) |
first_name | string | First name of primary business owner |
last_name | string | Last name of primary business owner |
email | string | Email address of primary business owner |
business_name | string | Business name |
business_ein | string | FEIN of company |
business_address | string | Business address of company (Line 1 and Line 2 combined) |
business_city | string | Business address of company (city) |
business_state | string | Business address of the company (state abbreviation) |
business_zip | string | Business address of company (5-digit zip code) |
business_phone | string | Primary phone number of the company |
mail_address | string | Mailing address of the company |
mail_city | string | Mailing city of the company |
mail_state | string | Mailing state of the company |
mail_zip | string | Mailing ZIP code of the company |
skip_migration | boolean | Defaults to false. If true, Zeal skips migrating payroll information from the company’s old payroll provider. Confirm with the company that migration is not necessary - failure to migrate old records may impact tax reporting and filing. |
account_number | string | Account number of the company’s bank account |
routing_number | string | Routing number of the company’s bank account |
requirements | array | List of required information for this company account (e.g. information that needs to be collected before running payments, payroll registration information, etc.). See The Requirement Object. |
onboarding_url | string | URL of the company’s onboarding flow if the company is still onboarding (status is initial_onboarding). Otherwise null. |
is_sandbox | boolean | Determines the test status of the company. false when the company was created in Production mode or using the Production API key. |
ssn | string | Social Security Number of the primary business owner |
ownership_percentage | integer | The ownership percentage held by the primary business owner |
dob | string | Date of birth of the primary business owner, in MM/DD/YYYY format |
legal_structure | enum | One of: ccorp, corp, estate, foreign_entity, llc, llp, lp, nonprofit, partnership, scheme, scorp, soleprop, trust |
job_title | string | The job title of the primary business owner |
address | string | Address of the primary business owner |
address_line2 | string | Address line 2 of the primary business owner |
city | string | City of the primary business owner |
state | string | State of the primary business owner |
zip | string | Zip code of the primary business owner |
company_type | enum | all for a company that supports both 1099 contractors and W-2 employees. contractor_only for a company that solely supports 1099 contractors. |
payroll_schedule | enum | The default payroll schedule the company follows. One of: daily, weekly, biweekly, semimonthly, monthly |
payroll_firstDate | date | The ISO-8601 date of the first regular payroll |
payroll_firstPayPeriodID | string | Reporting period ID of the first regular payroll |
