v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

Update a company

Updates the specified company.

patch/companies/{company}

Path parameters

companystring required

ID of the company to update

Request body

legal_namestring

Legal name of the company

trade_namestring

Trade name of the company

other_business_namestring

Other business name used by the company.

business_typestring

Business type of the company. One of sole_proprietorship, partnership, c_corporation, s_corporation, or llc.

industry_typestring

Industry type of the company. One of auto_or_machine_sales, auto_or_machine_repair, arts_or_entertainment_or_recreation, cleaning_services, consulting_services, educational_services, family_care_services, financial_services, food_and_beverage_retail_or_wholesale, general_construction_or_general_contracting, health_care, hospitality_or_accommodation, hvac_or_plumbing_or_electrical_contracting, legal_services, non_food_retail_or_wholesale, other, personal_care_services, real_estate, restaurant, scientific_or_technical_services, security_services, tobacco_or_alcohol_sales, or transportation.

websitestring

Website URL of the company.

emailstring

Email address of payroll department or payroll administrator

phonestring

Phone number for the company

principal_place_of_businessstring

Company's workplace ID whose address would be printed on paystub, instead of legal address.

pay_frequencystring

Frequency by which the employees get paid. One of "weekly", "biweekly", "semimonthly", "monthly", "quarterly", or "annually"

processing_periodstring

The default processing period of payrolls. <br><br>One of three_day, two_day, or one_day.<br><br>The processing period determines the approval deadline of the payroll. For a payroll with a Friday payday, three_day will mean the approval deadline is on Tuesday, whereas two_day will mean the approval deadline is on Wednesday.<br><br>The possible values for this field are constrained by the processing periods the company is approved for.

start_datestring date

Date the company will start using Check as their payroll processor

metadatastring json

Additional loosely structured information to associate with the company

default_bank_accountstring

ID of the default bank account of the company.<br><br>The default bank account is used for employer tax collections and refunds, as well as to fund payrolls unless the user explicitly sets the bank_account argument when creating or updating a payroll.<br><br>The default bank account can be updated to be any one of the company's active bank accounts.

Response

200

object required