The Company Object

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 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: 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 partner
live: Company is 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 Set to false by default.
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.
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. This should be in theMM/DD/YYYY format.
legal_structure enum Accepts any of the following values: ccorp,corp,estate,foreign_entity,llc,llp,lp,nonprofit, partnership,scheme,scorp,soleprop, or 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 Accepts the following values:
all for a company that supports both 1099 contractors and W2 employees.
contractor_only for a company that solely supports 1099 contractors.
payroll_schedule enum The default payroll schedule that the company follows. Accepts any of the following values: 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

EXAMPLE COMPANY OBJECT

{
  "companyID": "1234567890",
  "status": "migration_pending",
  "first_name": "Erlich",
  "last_name": "Bachman",
  "email": "founder@aviato.com",
  "business_name": "Aviato",
  "business_ein": "083746568",
  "business_address": "1 Market St.",
  "business_city": "San Francisco",
  "business_state": "CA",
  "business_zip": "94105",
  "mail_address": "1 Market St.",
  "mail_city": "San Francisco",
  "mail_state": "CA",
  "mail_zip": "94105",
  "skip_migration": false,
  "business_phone": "4046762121",
  "account_number": "123456789",
  "routing_number": "0987654321",
  "requirements": [],
  "onboarding_url": null,
  "is_sandbox": true,
  "ssn": "22-333-4444",
  "ownership_percentage": 25,
  "dob": "01/01/1990",
  "legal_structure": "ccorp",
  "job_title": "CEO",
  "address": "1 Ferry Building",
  "city": "San francisco",
  "state": "CA",
  "zip": "94105",
    "company_type": "all",
  "payroll_firstCheckDate": "2024-08-30",
    "payroll_schedule": "weekly",
    "payroll_firstPayPeriodID": "6580ce4a3808d60023b4e412"
}