Update a company's payroll profile

Set a draft company's worker types, pay frequency, revenue and NAICS code.

Use this endpoint to describe how the company pays workers. It is a partial update: fields you leave out keep their current value.

📘

Part of Company details. For how this fits into onboarding, see the guide: Collecting company information: payroll profile.

When you can call this

Only while the onboarding is a DRAFT and the contract documents haven't been signed. Otherwise it returns 409.

Field notes

FieldNotes
payFrequencyOne of DAILY, WEEKLY, BI_WEEKLY, SEMI_MONTHLY or MONTHLY.
payPeriodStartDayApplies only to WEEKLY and BI_WEEKLY. Sending it with any other frequency is a 400, and switching to another frequency clears it.
annualRevenueAn amount and currency, like {"amount": 750000.00, "currency": "USD"}.
naicsCodeSix digits. Everee uses it to choose the company's default occupation (SOC) code, unless one was chosen for the company.
targetGoLiveDateOptional. The date you want the company to go live: the first day of the first pay period Everee pays. It's checked against the profile as changed by this request. See Which dates are accepted. After the draft, change it with Set the target go-live date.
targetGoLivePayrollCalendarIdOptional. The payroll calendar to check targetGoLiveDate against, when the company has more than one and no default.

A change to payFrequency or payPeriodStartDay that would leave a saved target off the first day of a pay period is refused with 409, unless the same request sends a new targetGoLiveDate.

What's required before submitting

These appear in readiness.missing until they're provided:

RequirementSatisfied by
WORKER_TYPESpaysW2Employees or paysContractors set to true.
EMPLOYEE_COUNTemployeeCount, when the company pays W-2 employees.
CONTRACTOR_COUNTcontractorCount, when the company pays contractors.
PAY_FREQUENCYpayFrequency.
PAY_PERIOD_START_DAYpayPeriodStartDay, when the frequency is WEEKLY or BI_WEEKLY.
ANNUAL_REVENUE, NATURE_OF_BUSINESS, NAICS_CODEThe matching field.

Worker types and the plan

You can only say the company pays W-2 employees or 1099 contractors if its plan has a price for them. If Everee's plan for the company has no W-2 employee or no 1099 contractor line, setting paysW2Employees or paysContractors to true returns 400, and if the plan changes after you've set it, WORKER_TYPES appears in readiness.missing until the two agree.

Errors

StatusMeaning
400payFrequency isn't a supported value, or payPeriodStartDay was sent with a frequency that doesn't use one.
401The API key is missing, malformed or expired.
404No company with this ID belongs to your partner account.
409The onboarding is no longer a DRAFT, or the contract has been signed, or the change would leave the target go-live date off the first day of a pay period, or Everee has set the go-live date.
422targetGoLiveDate isn't tomorrow or later and the first day of a pay period (the message names the nearest valid dates), or there's no pay frequency or payroll calendar to check it against.
422A value is malformed, for example a naicsCode that isn't six digits or a negative count.
Path Params
integer
required

The company's ID, as returned when the company was created.

Body Params
boolean

Whether the company pays W-2 employees.

boolean

Whether the company pays contractors.

integer
≥ 0

Number of W-2 employees. Zero or more.

integer
≥ 0

Number of contractors. Zero or more.

string
enum

How often the company runs payroll.

Allowed:
string
enum

The day pay periods start. Only for WEEKLY and BI_WEEKLY.

Allowed:
annualRevenue
object
string

What the business does.

date

The go-live date you want: the first day of the first pay period Everee pays. It must be tomorrow or later and the first day of a pay period on the company's payroll calendar configuration, as changed by this request. Change or clear it later with Set the target go-live date.

int64

The payroll calendar to check the target against, when the company has more than one and no default.

string

The company's 6-digit NAICS code.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json