Create Company

post https://api.worklio.com/wep/companies

Create company and set information about it.

This endpoint can be called only by System level user.

Newly created company is automatically added to current System level user permissions and so other calls can be called.
Employee call will return Forbidden result even for Employee own company.

Body Params

CompanyCreate entity

name

string | null

required

Business Name

fein

string | null

required

Federal Employer ID Number of Company.

companyType

int32

required

The legal form of the company.

Members:

1 - Corporation ( C-Corp. )
2 - Partnership ( Partnership. )
3 - SCorp ( S-Corp. )
4 - LLCPartnership ( LLC Partnership. )
5 - SoleProprietorship ( Sole Proprietor. )
6 - LLCSoleProprietor ( LLC Sole Proprietor. )
7 - LLC ( LLC C-Corp. )
8 - LLCSCorp ( LLC S-Corp. )
9 - NonProfit ( Non Profit. )
10 - GovernmentalEntity ( Governmental Entity. )

tradeName

string | null

Doing Business As

startOn

date-time | null

Start day
Data type is validated and must be Number

businessSince

date-time | null

Business since
Data type is validated and must be Number

externalId

string | null

External system ID - Can be used for linking Embedded Payroll records with source records.

string | null

Business e-mail.

website

string | null

Company website

phone

string | null

Business phone

timeZone

int32

Time zones.

Members:

1 - PacificStandardTime ( Pacific Standard Time )
2 - MountainStandardTime ( Mountain Standard Time )
3 - CentralStandardTime ( Central Standard Time )
4 - EasternStandardTime ( Eastern Standard Time )
5 - AlaskanStandardTime ( Alaskan Standard Time )
6 - HawaiianStandardTime ( Hawaiian Standard Time )
7 - AtlanticStandardTime ( Atlantic Standard Time )
8 - NewfoundlandStandardTime ( Newfoundland Standard Time )
9 - USMountainStandardTime ( US Mountain Standard Time )

companyAddress

object

required

payrollPolicy

object

metaData

string | null

Meta data

enabledEWA

boolean | null

Enabled EWA

Headers

api-version

string

Defaults to 1.0

The requested API version

x-api-version

string

Defaults to 1.0

The requested API version

Responses

Response body

object

int32

ID of Company.

name

string | null

Business Name

fein

string | null

Federal Employer ID Number of Company.

companyType

int32

The legal form of the company.

Members:

1 - Corporation ( C-Corp. )
2 - Partnership ( Partnership. )
3 - SCorp ( S-Corp. )
4 - LLCPartnership ( LLC Partnership. )
5 - SoleProprietorship ( Sole Proprietor. )
6 - LLCSoleProprietor ( LLC Sole Proprietor. )
7 - LLC ( LLC C-Corp. )
8 - LLCSCorp ( LLC S-Corp. )
9 - NonProfit ( Non Profit. )
10 - GovernmentalEntity ( Governmental Entity. )

1 2 3 4 5 6 7 8 9 10

tradeName

string | null

Doing Business As

startOn

date-time | null

Start day

businessSince

date-time | null

Business Since

createdOn

date-time | null

Created on day

externalId

string | null

External system ID - Can be used for linking Embedded Payroll records with source records.

website

string | null

Company website

phone

string | null

Business phone

string | null

Business e-mail.

timeZone

int32

Time zones.

Members:

1 - PacificStandardTime ( Pacific Standard Time )
2 - MountainStandardTime ( Mountain Standard Time )
3 - CentralStandardTime ( Central Standard Time )
4 - EasternStandardTime ( Eastern Standard Time )
5 - AlaskanStandardTime ( Alaskan Standard Time )
6 - HawaiianStandardTime ( Hawaiian Standard Time )
7 - AtlanticStandardTime ( Atlantic Standard Time )
8 - NewfoundlandStandardTime ( Newfoundland Standard Time )
9 - USMountainStandardTime ( US Mountain Standard Time )

1 2 3 4 5 6 7 8 9

usesDivisions

boolean | null

Company has set divisions.

companyAddress

object

Address

addressLine1

string | null

Address Line 1

addressLine2

string | null

Address Line 2

addressCity

string | null

City

addressState

string | null

State

addressZIP

string | null

Zip Code

addressCountry

string | null

Country - US is default value.

geoLatitude

double | null

Geographical Latitude

geoLongitude

double | null

Geographical Longitude

int32

ID of Address

payrollPolicy

object

payFrequency

int32

Members:

0 - NA ( N/A. )
1 - Weekly ( Weekly. )
2 - BiWeekly ( Bi-weekly. )
3 - SemiMonthly ( Semi-monthly. )
4 - Monthly ( Monthly. )

1 2 3 4

firstPayPeriodEndDate

date-time

First Pay Period End Date

secondPayPeriodEndDate

date-time | null

Second Pay Period End Date

firstPayDate

date-time

First Pay Date

movePayDayOnHolidaysAndWeekends

int32

Members:

0 - DayAfter ( First Business Day After )
1 - DayBefore ( Last Business Day Before )

1

autoRun

boolean

Autorun - payroll will be started and processed automatically

metaData

string | null

Meta data

reqEEJobCostCode

boolean

Require employees to have a job costing code

enabledEWA

boolean | null

Enabled EWA

global

object

isEnable

boolean

if Global operations are enable

weeklyPeriodStart

int32

Members:

0 - Sunday ( Indicates Sunday. )
1 - Monday ( Indicates Monday. )
2 - Tuesday ( Indicates Tuesday. )
3 - Wednesday ( Indicates Wednesday. )
4 - Thursday ( Indicates Thursday. )
5 - Friday ( Indicates Friday. )
6 - Saturday ( Indicates Saturday. )

1 2 3 4 5 6

biWeeklyPeriodStart

object

blocked

boolean | null

Company has been blocked ( cannot start payroll or manipulate with it ).

refCode

string | null

Referral code used during registration

uiNumber

int32

UI Number/Id (readonly value reserved for system use)

Language

Credentials

Bearer

jwt


xxxxxxxxxx
15
1
curl --request POST \
2
     --url https://api.worklio.com/wep/companies \
3
     --header 'accept: application/json' \
4
     --header 'api-version: 1.0' \
5
     --header 'content-type: application/*+json' \
6
     --header 'x-api-version: 1.0' \
7
     --data '
8
{
9
  "companyType": 1,
10
  "payrollPolicy": {
11
    "payFrequency": 0,
12
    "movePayDayOnHolidaysAndWeekends": 0
13
  }
14
}
15
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

text/plain

200Success

400Bad Request