patch
https://api.everee.com/integration/v1/partner/companies//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
| Field | Notes |
|---|---|
payFrequency | One of DAILY, WEEKLY, BI_WEEKLY, SEMI_MONTHLY or MONTHLY. |
payPeriodStartDay | Applies only to WEEKLY and BI_WEEKLY. Sending it with any other frequency is a 400, and switching to another frequency clears it. |
annualRevenue | An amount and currency, like {"amount": 750000.00, "currency": "USD"}. |
naicsCode | Six digits. |
What's required before submitting
These appear in readiness.missing until they're provided:
| Requirement | Satisfied by |
|---|---|
WORKER_TYPES | paysW2Employees or paysContractors set to true. |
EMPLOYEE_COUNT | employeeCount, when the company pays W-2 employees. |
CONTRACTOR_COUNT | contractorCount, when the company pays contractors. |
PAY_FREQUENCY | payFrequency. |
PAY_PERIOD_START_DAY | payPeriodStartDay, when the frequency is WEEKLY or BI_WEEKLY. |
ANNUAL_REVENUE, NATURE_OF_BUSINESS, NAICS_CODE | The matching field. |
Errors
| Status | Meaning |
|---|---|
400 | payFrequency isn't a supported value, or payPeriodStartDay was sent with a frequency that doesn't use one. |
401 | The API key is missing, malformed or expired. |
404 | No company with this ID belongs to your partner account. |
409 | The onboarding is no longer a DRAFT, or the contract has been signed. |
422 | A value is malformed, for example a naicsCode that isn't six digits or a negative count. |