Documentation

API Reference

client_id:api_key

Rollfi

Embedded Payroll

Sign in

Contact Us

getPaySchedule

Introduction

Payroll API Documentation

Authentication

Company Onboarding Flow

Employee Onboarding Flow

Webhooks

The `createBusiness` API offers a holistic solution for seamlessly integrating a new company into the system. This API is designed to streamline the onboarding process by consolidating multiple steps into a single, efficient call. This approach is ideal for businesses seeking a quick and straightforward onboarding experience.

### Features of `createBusiness` API:

1. **Company Registration**

2. **KYB Information**

3. **Location Setup**

4. **Admin User Addition**:
 
5. **KYB Process Initiation**

### About NAICS Codes:
- NAICS codes are a numerical system with a range from two to six digits.
- These codes are used for various administrative, regulatory, contracting, taxation, and business development purposes.

[You can look up a company’s NAICS and SIC codes here.](https://www.naics.com/naics-code-description/)


createBusiness

## Register Company 

 To Register a company and assign a payroll admin

### About NAICS Codes:
- NAICS codes are a numerical system with a range from two to six digits.
- These codes are used for various administrative, regulatory, contracting, taxation, and business development purposes.

[You can look up a company’s NAICS and SIC codes here.](https://www.naics.com/naics-code-description/)

companyRegistration

Run the getBusinessUserDetails endpoint before running this endpoint inorder to update only the required fields.

Business User can have one or more of these roles :

Payroll Admin

Controller

Beneficial Owner
(Ownership Percentage Must be specified for Beneficial Owner)

Employee

updateAdminUser


## Add Company Location

 To add a company location. 
 
### Location Details:
Payroll process requires the company’s mailing address, filing address and all addresses where the company has employees physically working in the United States.






addCompanyLocation

## Know Your Business (KYB) Process

Endpoint allows to add the information required for  **Know Your Business (“KYB”)** process. The aim is to verify business information with official records.

### Employer Identification Number (EIN)

- **Definition**: An EIN, also known as a Federal Tax Identification Number, is a unique nine-digit number.
- **Purpose**: It's assigned by the Internal Revenue Service (IRS) to business entities operating in the United States for the purposes of identification.

### Entity Type: Importance in Payroll

- **Role**: The entity type helps determine taxation and reporting requirements.
- **Why It Matters**: Different types of business entities have different payroll needs and obligations. Knowing the entity type ensures accurate and compliant payroll processing.


addKybInformation

This endpoint is used to initiate the KYB process.
The KYB process can only be initiated after completing registration followed by adding company location, business user and KYB information.

initiateCompanyKyb

## Business User Creation Endpoint

To create a **Business User**. 
This is a user whose specific role will define their permissions and responsibilities within the system.

-Business User can have one or more of these roles :
1. Payroll Admin
2. Controller
3. Beneficial Owner 
(*Ownership Percentage Must be specified for Beneficial Owner*)
4. Employee




    


addBusinessUser

This Endpoint is used to Update the Kyb Information

updateKybInformation

This endpoint is used to Update the Company's Website

updateCompany

This Endpoint is used to Delete the Business User

deleteBusinessUser

This Endpoint is used to delete the required Company Location

deleteCompanyLocation

Use the below endpoint to Add Kyc information if it satisfies the condition - The customer operates from the company's registered location.


addKycInformation

You can use the below endpoint to  input an employee's W-4 form details into the payroll system.

addW4Information

Use this endpoint to update the acceptance of Terms and Conditions.

acceptTermsAndCondition

This endpoint is used to initiate the KYC process.
The KYC process can only be initiated after completing registration followed by adding company location, business user and KYB information.

initiateUserKyc

This API is used to add the Company Bank Account Details

addCompanyBankAccount

This API is used to deactivate the Company Bank Account

deactivateCompanyBankAccount

This endpoint can be used to Create an Employee/Contractor by providing the required fields

addUser

This endpoint can be used to Create an BusinessContractor by providing the required fields

addBusinessContractor

This endpoint is used to update the required employee information

updateUser

This endpoint can be used to Create multiple Employee's/Contractor's by providing the required fields

addUsers

The respective  Code of the State is entered for Verification

addStateRegistration

Inorder to update the Company State Registration based on the State_Id this endpoint is used.

updateStateRegistration

This Endpoint is used to Add the wage details for an employee

addUserWage

This endpoint is used to update the  Wage details of an Employee/Contractor

updateUserWage

## Add Business User as an Employee Endpoint

Utilize this endpoint when an existing **Business User** needs to be added as an employee of the company.


updateBusinessUserAsEmployee

## Add Employee as an BusinessUser Endpoint

Utilize this endpoint when an existing **Employee** needs to be added as an BusinessUser of the company.


updateEmployeeAsBusinessUser

The Business User details can be updated using this endpoint

updateBusinessUser

## Update Company Location Endpoint

Use this endpoint to update the **company's location**.

updateCompanyLocation

This Endpoint is used inorder to Activate either Employee/Contractor Who has been previously Deactivated

activateUser

This Endpoint is used to Deactivate either Employee/Contractor

deactivateUser

This Endpoint is used to Terminate either Employee/Contractor

terminateUser

In order to save the Company Funding Source Entity this Endpoint is used
It comprises of information related to bank to process payroll


addUserBankAccount

This Endpoint is used to Update User Bank Account Details


updateUserBankAccount

To update the KYC information based on the Employee_Id

updateKycInformation

## Add Pay Schedule Endpoint

Use this endpoint to create a new **Pay Schedule** for the company's employees.
When CompensationFrequency is Monthly/Semi - Monthly please use this link to Update the PayBeginDate https://docs.google.com/spreadsheets/d/12LWp9jWqiovMQf18XaWPPWv_oOFvbZAsLHKSP3Q74pQ/edit#gid=146488834



addPaySchedule

## Deactivate Pay Schedule Endpoint

Use this endpoint to Deactivate **Pay Schedule** for the company's employees.


deactivatePaySchedule

## Add Supplemental Pay Endpoint

Utilize this endpoint when you need to add **supplemental pay** for an employee within the company.


addSupplementalPayPeriod

importPayrollDetails

In order to initiate the Payroll process based on the PayperiodId this endpoint is used

initiatePayroll

addSupplementalPayrollLineItem

This endpoint is used to add employee benefits

addEmployeeBenefits

This endpoint is used to update employee benefits

updateEmployeeBenefits

addCompanyEmployeeBenefits

This Endpoint is used to remove company benefits


removeCompanyBenefits

This endpoint is used to remove employee benefits

removeEmployeeBenefits

This endpoint is used to get benefit valid effective months

getBenefitValidEffectiveMonths

getBusinessUserInfo

getUserTask

This Report gets you all the users information by company name

getUsersByCompanyName

getCompanies

getPaidEmployeesCountBasedOnDateRange

In this report the pay period details are fetched based on PayPeriodId

getPayPeriodDetails

getPayPeriod

getCompanyInfo

This Report Gets you Company Location Information

getCompanyLocationInfo

This Report gets you all the Information regarding the Active Users

getActiveUsers

This Report gets you all the Information regarding the TerminatedUsers

getTerminatedUsers

This Report gets you all the Information regarding the Deactivated Users

getDeactivatedUsers

This Report will get the payroll history based on the payperiodId

getPayrollHistoryBasedOnPayPeriod

In this Report we will be able to get payperiod details and payperiodlineitem details of the company based on the Pay Begin Date and Pay End Date

getPayrollHistoryBasedOnDateRange

This Report helps in getting the PayRollLineItems information based on PayPeriodId

getPayRun

getPayStub

This Report is used to get the PayrollTransaction details based on the RequestReferenceId

API Reference

getPaySchedule

Body

Response