latestSwagger 2.02026-08-0982147352.7 KB

be66ed178abe

Company

company

Returns the id of the company created.<p>Scopes: import_plan, update_company</p>

post/v{version}/companies

Path parameters

versionstring required

Query parameters

new_companies_onlyboolean

Request body

namestring required

The name of the company.

agent_emailstring

The email address of the agent for the company.

assign_agent_teamsboolean

Indicates whether or not to assign the agent's team to this company. This value is only respected if an agent is found for the provided agent_email, otherwise it is ignored.

create_team_for_agentboolean

Indicates whether or not to always create a new team for the agent, if it doesn't already exist. The default is true.

einstring

The EIN of the company.

sicstring

The SIC of the company.

default_pay_cycle_periodsinteger

The number of pay cycles for all employees per year, by default. Accepted values are 1-52.

Response

Success

idstring required