The Company Object represents an employer in Zeal.
| attributes | type | description |
|---|---|---|
| companyID | string | CompanyID of company |
| status | string | Tracks the company onboarding lifecycle. Holds one of the following values:initial_onboarding: This company is still onboardingpayroll_access_needed: Zeal still needs access to this company's previous payroll provider to migrate recordsmigration_pending: Zeal is still migrating records from the previous payroll providerpayment_permission_pending: The company has given us their data and Zeal has done the data migration, but they are not ready to run payroll. Usually, this is because Zeal is still waiting on information from our banking partnerlive: Company is ready to process payrolloffboarded: Company has been offboarded |
| first_name | string | First Name of Primary Business Owner |
| last_name | string | Last Name of Primary Business Owner |
| 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 | If true, Zeal will skip migrating payroll information from the company's old payroll provider. Note: please 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 for more information. |
| onboarding_url | string | URL of the company's onboarding flow if the company is still onboarding i.e. status is initial_onboarding. Otherwise, this field has a value of null |
| is_sandbox | boolean | Determines the test status of the company. Set to false when a company has been created in Production mode or using the Production API Key. |
{
"companyID": "1234567890",
"status": "migration_pending",
"first_name": "Erlich",
"last_name": "Bachman",
"email": "[email protected]",
"business_name": "Aviato",
"business_ein": "083746568",
"business_address": "1 Market St.",
"business_city": "San Francisco",
"business_state": "CA",
"business_zip": "10000",
"skip_migration": false,
"business_phone": "4046762121",
"account_number": "123456789",
"routing_number": "0987654321",
"requirements": [],
"onboarding_url": null,
"is_sandbox" : true
}