Get Company Information

Summary Description

The Get Company Information API endpoint provides access to specific company details. Users can retrieve a wide range of company information, including: company name, address, industry, (EIN) Employer Identification Number, and more.

Use Cases

Once the developer has company information, they can update their system with the latest earning codes. To update the earning codes in their system and they need to know what earning codes are available in Paylocity.
After getting company data, clients are use the company specific schema to pull the information into their UI to expose to a user.
Once the developer has company information, developers can add a New Employee to Paylocity and the system requires them to include the Benefit Class assigned in Paylocity for the New Employee.

get/apiHub/corehr/v1/companies/{companyId}

Request

Base URL
dc1demogwext.paylocity.com (relative, and the document’s source URL is not known)
URL
dc1demogwext.paylocity.com/apiHub/corehr/v1/companies/{companyId}
Auth
none declared

Path parameters

companyIdstring required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity. Allowable Values: 9 char max.

Headers

testModeboolean

If true all responses are mocked and generated randomly.

Authorizationstring

Authorization token. Ex. Bearer ...

Response

companyIdstring nullable

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.

companyNamestring nullable

Represents the official name of the company or organization. It typically includes the full legal name of the company and is used to uniquely identify the entity.

phonestring nullable

Contains the numerical digits that make up the phone number. It represents the unique identifier for contacting an individual or entity by phone.

webTimeCostring nullable

The web time company ID.

clientIdinteger nullable

ClientId is the company set ID when the client is a company set. If the client is a standalone company, then clientId will be the same as the companyId.

parentCompanySetIdstring nullable

Indicates the company set to which the company belongs. It helps organize and categorize companies into sets or groups.

serviceStartDatestring date-time nullable

Represents the date when the company's services or operations officially commenced. It is useful for tracking the start of business activities.

einstring nullable

Stands for Employee Identification Number, a unique identifier assigned to businesses for tax purposes in the United States. It helps identify the company for tax reporting.

dbastring nullable

Represents the Doing Business As (DBA) name of the company. It is the name under which the company conducts business if it differs from its legal name.

naicsinteger nullable

Refers to the North American Industry Classification System (NAICS) code. It classifies the company's primary industry or business sector.

industryTypestring nullable

Provides information about the type or category of industry in which the company operates. It helps categorize businesses further.

accessEndDatestring date-time nullable

Specifies the date when access to a particular system or service will expire for the company.

endDatestring date-time nullable

Represents the date when a specific service or agreement with the company will conclude or expire.

firstCheckDatestring date-time nullable

First Check Date refers to the day a company's initial billing begins.

statusstring nullable

Indicates whether the company is currently active or inactive. It serves as a binary indicator of the company's operational status.

entityTypestring nullable

Specifies the legal type of entity to which the company belongs. Common entity types include "Corporation," "Limited Liability Company (LLC)," and others.

Changes

No recorded changes to this operation across all 1 revision of this API.