# Rollfi ## Docs - [activateUser](https://developer.rollfi.xyz/api-reference/adminportal/activateUser.md): ## Reactivate Employee/Contractor - [addBusinessContractor](https://developer.rollfi.xyz/api-reference/adminportal/addBusinessContractor.md): The `addBusinessContractor` API creates a new business contractor who interacts with the company payroll. - [addEmployeeMiscellaneousStateTax](https://developer.rollfi.xyz/api-reference/adminportal/addEmployeeMiscellaneousStateTax.md): The `addEmployeeMiscellaneousStateTax ` API is used to collect state-specific tax withholding information for employees in states that require profession/job specific taxes - [addFormerUser](https://developer.rollfi.xyz/api-reference/adminportal/addFormerUser.md): The `addFormerUser` API adds a terminated user to the system. - [addTimeOffPolicy](https://developer.rollfi.xyz/api-reference/adminportal/addTimeOffPolicy.md): The `addTimeOffPolicy` API adds a company-wide time off policy that can be assigned to employees - [addTimeOffPolicyAssignment](https://developer.rollfi.xyz/api-reference/adminportal/addTimeOffPolicyAssignment.md): The `addTimeOffPolicyAssignment` API adds an employee to an existing company Time Off Policy - [addUser](https://developer.rollfi.xyz/api-reference/adminportal/addUser.md): Creates a new employee or contractor in the system. - [addUserWage](https://developer.rollfi.xyz/api-reference/adminportal/addUserWage.md): Sets up wage information for an employee or contractor. - [addUsers](https://developer.rollfi.xyz/api-reference/adminportal/addUsers.md): ## Bulk Create Employees/Contractors - [addCompanyBankAccount](https://developer.rollfi.xyz/api-reference/adminportal/addcompanybankaccount.md): The `addCompanyBankAccount` API adds bank account details for a company to process payroll. - [Addstateregistration](https://developer.rollfi.xyz/api-reference/adminportal/addstateregistration.md) - [deactivateCompanyBankAccount](https://developer.rollfi.xyz/api-reference/adminportal/deactivateCompanyBankAccount.md): The `deactivateCompanyBankAccount` API deactivates a company's bank account in the system. - [deactivateUser](https://developer.rollfi.xyz/api-reference/adminportal/deactivateUser.md): The `deactivateUser` API temporarily deactivates an employee or contractor. - [DeleteStateRegistration](https://developer.rollfi.xyz/api-reference/adminportal/deleteStateRegistration.md) - [downloadDocument](https://developer.rollfi.xyz/api-reference/adminportal/downloadDocument.md): The `downloadDocument` API is used to download a document that has been uploaded to the Rollfi system - [addStateRegistrationForAlabama](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForAlabama.md): The respective Code of the State is entered for Verification - [addStateRegistrationForAlaska](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForAlaska.md): The respective Code of the State is entered for Verification - [addStateRegistrationForArizona](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForArizona.md): The respective Code of the State is entered for Verification - [addStateRegistrationForArkansas](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForArkansas.md): The respective Code of the State is entered for Verification - [addStateRegistrationForCalifornia](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForCalifornia.md): The respective Code of the State is entered for Verification - [addStateRegistrationForColorado](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForColorado.md): The respective Code of the State is entered for Verification - [addStateRegistrationForConnecticut](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForConnecticut.md): The respective Code of the State is entered for Verification - [addStateRegistrationForDelaware](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForDelaware.md): The respective Code of the State is entered for Verification - [addStateRegistrationForDistrictOfColumbia](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForDistrictOfColumbia.md): The respective Code of the State is entered for Verification - [AddStateRegistrationForFlorida](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForFlorida.md) - [AddStateRegistrationForGeorgia](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForGeorgia.md) - [AddStateRegistrationForHawaii](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForHawaii.md) - [AddStateRegistrationForIdaho](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForIdaho.md) - [AddStateRegistrationForIllinois](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForIllinois.md) - [AddStateRegistrationForIndiana](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForIndiana.md) - [addStateRegistrationForIowa](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForIowa.md): The respective Code of the State is entered for Verification - [addStateRegistrationForKansas](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForKansas.md): The respective Code of the State is entered for Verification - [addStateRegistrationForKentucky](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForKentucky.md): The respective Code of the State is entered for Verification - [addStateRegistrationForLouisiana](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForLouisiana.md): The respective Code of the State is entered for Verification - [addStateRegistrationForMaine](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForMaine.md): The respective Code of the State is entered for Verification - [addStateRegistrationForMaryland](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForMaryland.md): The respective Code of the State is entered for Verification - [addStateRegistrationForMassachusetts](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForMassachusetts.md): The respective Code of the State is entered for Verification - [addStateRegistrationForMichigan](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForMichigan.md): The respective Code of the State is entered for Verification - [addStateRegistrationForMinnesota](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForMinnesota.md): The respective Code of the State is entered for Verification - [addStateRegistrationForMississippi](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForMississippi.md): The respective Code of the State is entered for Verification - [addStateRegistrationForMissouri](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForMissouri.md): The respective Code of the State is entered for Verification - [addStateRegistrationForMontana](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForMontana.md): The respective Code of the State is entered for Verification - [addStateRegistrationForNebraska](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForNebraska.md): The respective Code of the State is entered for Verification - [addStateRegistrationForNevada](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForNevada.md): The respective Code of the State is entered for Verification - [addStateRegistrationForNewHampshire](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForNewHampshire.md): The respective Code of the State is entered for Verification - [addStateRegistrationForNewJersey](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForNewJersey.md): The respective Code of the State is entered for Verification - [addStateRegistrationForNewMexico](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForNewMexico.md): The respective Code of the State is entered for Verification - [addStateRegistrationForNewYork](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForNewYork.md): The respective Code of the State is entered for Verification - [addStateRegistrationForNorthCarolina](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForNorthCarolina.md): The respective Code of the State is entered for Verification - [addStateRegistrationForNorthDakota](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForNorthDakota.md): The respective Code of the State is entered for Verification - [addStateRegistrationForOhio](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForOhio.md): The respective Code of the State is entered for Verification - [addStateRegistrationForOregon](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForOregon.md): The respective Code of the State is entered for Verification - [addStateRegistrationForPennsylvania](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForPennsylvania.md): The respective Code of the State is entered for Verification - [addStateRegistrationForRhodeIsland](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForRhodeIsland.md): The respective Code of the State is entered for Verification - [addStateRegistrationForSouthCarolina](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForSouthCarolina.md): The respective Code of the State is entered for Verification - [addStateRegistrationForSouthDakota](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForSouthDakota.md): The respective Code of the State is entered for Verification - [addStateRegistrationForTennessee](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForTennessee.md): The respective Code of the State is entered for Verification - [addStateRegistrationForTexas](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForTexas.md): The respective Code of the State is entered for Verification - [addStateRegistrationForUtah](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForUtah.md): The respective Code of the State is entered for Verification - [addStateRegistrationForVermont](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForVermont.md): The respective Code of the State is entered for Verification - [addStateRegistrationForVirginia](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForVirginia.md): The respective Code of the State is entered for Verification - [addStateRegistrationForWashington](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForWashington.md): The respective Code of the State is entered for Verification - [addStateRegistrationForWestVirginia](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForWestVirginia.md): The respective Code of the State is entered for Verification - [addStateRegistrationForWisconsin](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForWisconsin.md): The respective Code of the State is entered for Verification - [addStateRegistrationForWyoming](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationForWyoming.md): The respective Code of the State is entered for Verification - [addStateRegistrationOklahoma](https://developer.rollfi.xyz/api-reference/adminportal/stateRegistration/addStateRegistrationOklahoma.md): The respective Code of the State is entered for Verification - [terminateUser](https://developer.rollfi.xyz/api-reference/adminportal/terminateUser.md): The `terminateUser` API permanently terminates an employee or contractor. The termination is permanent and users cannot be reactivated, but employee data is retained for compliance reasons. - [updateBusinessUser](https://developer.rollfi.xyz/api-reference/adminportal/updateBusinessUser.md): The `updateBusinessUser` API updates Business User details in the system. - [updateBusinessUserAsEmployee](https://developer.rollfi.xyz/api-reference/adminportal/updateBusinessUserAsEmployee.md): ## Convert Business User to Employee - [updateCompanyBankAccount](https://developer.rollfi.xyz/api-reference/adminportal/updateCompanyBankAccount.md): The `updateCompanyBankAccount` API updates the company's bank account details without the need to delete and manually re-add a funding source. - [updateEmployeeAsBusinessUser](https://developer.rollfi.xyz/api-reference/adminportal/updateEmployeeAsBusinessUser.md): The `updateEmployeeAsBusinessUser` API adds an existing employee as a Business User of the company. - [updateTimeOffPolicy](https://developer.rollfi.xyz/api-reference/adminportal/updateTimeOffPolicy.md): The `updateTimeOffPolicy` API is used to make changes to all elements of a company-wide time off policy - [updateTimeOffPolicyAssignment](https://developer.rollfi.xyz/api-reference/adminportal/updateTimeOffPolicyAssignment.md): The `updateTimeOffPolicyAssignment` API updates an employee's time off policy assignment - [updateTimeOffRequestStatus](https://developer.rollfi.xyz/api-reference/adminportal/updateTimeOffRequestStatus.md): The `updateTimeOffRequestStatus ` API is used to approve or deny a timeOff request - [updateUser](https://developer.rollfi.xyz/api-reference/adminportal/updateUser.md): The `updateUser` API updates required employee information in the system. - [updateUserWage](https://developer.rollfi.xyz/api-reference/adminportal/updateUserWage.md): The `updateUserWage` API updates wage details for an employee or contractor. - [updateCompanyLocation](https://developer.rollfi.xyz/api-reference/adminportal/updatecompanylocation.md): The `updateCompanyLocation` API updates the company's location information. - [Updatestateregistration](https://developer.rollfi.xyz/api-reference/adminportal/updatestateregistration.md) - [uploadDocument](https://developer.rollfi.xyz/api-reference/adminportal/uploadDocument.md): This API is used to upload a document to the rollfi system to maintain compliance - [verifyMicroDeposits](https://developer.rollfi.xyz/api-reference/adminportal/verifyMicroDeposits.md): The `verifyMicroDeposits` API verifies micro deposit amounts to confirm company bank account ownership. - [addCompanyBenefits](https://developer.rollfi.xyz/api-reference/benefits/addCompanyBenefits.md): The `addCompanyBenefits` API adds benefit plans at the company level for employee enrollment. - [addCompanyEmployeeBenefits](https://developer.rollfi.xyz/api-reference/benefits/addCompanyEmployeeBenefits.md): The `addCompanyEmployeeBenefits` API adds company benefits with employees enrolled in a single operation. Combines `addCompanyBenefits` and `addEmployeeBenefits` into a single, efficient API call. - [addEmployeeBenefits](https://developer.rollfi.xyz/api-reference/benefits/addEmployeeBenefits.md): The `addEmployeeBenefits` API enrolls an employee in company benefit plans. - [getBenefitValidEffectiveMonths](https://developer.rollfi.xyz/api-reference/benefits/getBenefitValidEffectiveMonths.md): The `getBenefitValidEffectiveMonths` API retrieves valid effective months for benefit enrollment. - [removeCompanyBenefits](https://developer.rollfi.xyz/api-reference/benefits/removeCompanyBenefits.md): The `removeCompanyBenefits` API removes company-wide benefit plans. - [removeEmployeeBenefits](https://developer.rollfi.xyz/api-reference/benefits/removeEmployeeBenefits.md): The `removeEmployeeBenefits` API removes an employee's enrollment from specific benefit plans. - [updateEmployeeBenefits](https://developer.rollfi.xyz/api-reference/benefits/updateEmployeeBenefits.md): The `updateEmployeeBenefits` API modifies an employee's enrollment in specific benefit plans. - [addBookKeeper](https://developer.rollfi.xyz/api-reference/companyonboarding/addBookKeeper.md): The `addBookKeeper` API is a streamlined method for adding a book keeper to a company - [addBusinessUser](https://developer.rollfi.xyz/api-reference/companyonboarding/addbusinessuser.md): The `addBusinessUser` API is used to create a Business User and define their permissions and responsibilities within the system. - [addCompanyLocation](https://developer.rollfi.xyz/api-reference/companyonboarding/addcompanylocation.md): The `addCompanyLocation` API is used to add a company location. This step sets up the company's primary physical location and is essential for regional compliance, tax jurisdiction, and audit readiness. - [addKybInformation](https://developer.rollfi.xyz/api-reference/companyonboarding/addkybinformation.md): The `addKybInformation` API is used to submit KYB (Know Your Business) data for regulatory compliance. Here you add the information required for the KYB process, which verifies business information with official records. - [companyRegistration](https://developer.rollfi.xyz/api-reference/companyonboarding/companyRegistration.md): The `companyRegistration` API is used to register a company, collect key company details like business name and website, and create an admin user. This is the first step in the multi-step company onboarding process. - [createBusiness](https://developer.rollfi.xyz/api-reference/companyonboarding/createBusiness.md): 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 straightfor… - [deleteBusinessUser](https://developer.rollfi.xyz/api-reference/companyonboarding/deleteBusinessUser.md): The `deleteBusiness` API is used to remove a Business User from the system and can be accessed throughout and after the onboarding process. - [initiateCompanyKyb](https://developer.rollfi.xyz/api-reference/companyonboarding/initiateCompanyKyb.md): The `initiateCompanyKyb` API is used to begin the required business verification for regulatory compliance. This triggers the KYB (Know Your Business) process to verify business information with official records. - [updateAdminUser](https://developer.rollfi.xyz/api-reference/companyonboarding/updateAdminUser.md): The `updateAdminUser` API is used to update the details of the admin user added during onboarding. - [updateCompany](https://developer.rollfi.xyz/api-reference/companyonboarding/updateCompany.md): The `updateCompany` API is used to update the company's website information after onboarding. - [updateKybInformation](https://developer.rollfi.xyz/api-reference/companyonboarding/updateKybInformation.md): The `updateKybInformation` API is used to update the KYB (Know Your Business) information that was previously submitted during company onboarding. Kyb Information should only be updated using this API before KYB is submitted. If you need to make a change after this please contact support. - [addPaySchedule](https://developer.rollfi.xyz/api-reference/payroll/addPaySchedule.md): Sets up payment frequency and schedule for company employees. - [addPayrollLineItemTaxAdjustments](https://developer.rollfi.xyz/api-reference/payroll/addPayrollLineItemTaxAdjustments.md): The `addPayrollLineItemTaxAdjustments ` API is used to add tax adjustments when the calculated taxes are incorrect. - [addPayrollTaxExemption](https://developer.rollfi.xyz/api-reference/payroll/addPayrollTaxExemption.md): Used to add a tax exemption to prevent tax withholding for particular employer and employee taxes - [addSupplementalPayPeriod](https://developer.rollfi.xyz/api-reference/payroll/addSupplementalPayPeriod.md): The `addSupplementalPayPeriod` API creates a supplemental pay period for processing additional payroll outside of the regular pay schedules. - [addSupplementalPayPeriodWithLineItems](https://developer.rollfi.xyz/api-reference/payroll/addSupplementalPayPeriodWithLineItems.md): The `addSupplementalPayPeriodWithLineItems ` API is used to fully import a supplemental payPeriod to the rollfi system - [addUsersToRegularPayPeriod](https://developer.rollfi.xyz/api-reference/payroll/addUsersToRegularPayPeriod.md): The `addUsersToRegularPayPeriod` API is used to add employees to an existing regular pay period in the rollfi system - [addUsersToSupplementalPayPeriod](https://developer.rollfi.xyz/api-reference/payroll/addUsersToSupplementalPayPeriod.md): The `addUsersToSupplementalPayPeriod` API is used to add employees to a supplemental pay period for bonuses, commissions, or adjustments. - [cancelPayrollSubmission](https://developer.rollfi.xyz/api-reference/payroll/cancelPayrollSubmission.md): The `cancelPayrollSubmission` API is used to cancel a previously submitted payroll and return it to an editable state. - [deactivatePaySchedule](https://developer.rollfi.xyz/api-reference/payroll/deactivatePaySchedule.md): The `deactivatePaySchedule` API Deactivates an existing pay schedule (cannot be undone). - [editUsersOfSupplementalPayPeriod](https://developer.rollfi.xyz/api-reference/payroll/editUsersOfSupplementalPayPeriod.md): The `editUsersOfSupplementalPayPeriod` API is used to modify high level payroll details for employees - [importPayrollHistory](https://developer.rollfi.xyz/api-reference/payroll/importPayrollHistory.md): The `importPayrollHistory` API loads a completed pay period into Rollfi so legacy payroll appears in reports and year-to-date calculations. - [importRegularDifferentialPayrollData](https://developer.rollfi.xyz/api-reference/payroll/importRegularDifferentialPayrollData.md): The `importRegularDifferentialPayrollData` API adds regular differential payroll data for processing. - [importRegularPayrollData](https://developer.rollfi.xyz/api-reference/payroll/importRegularPayrollData.md): The `importRegularPayrollData` API imports regular payroll data for processing. - [initiatePayroll](https://developer.rollfi.xyz/api-reference/payroll/initiatePayroll.md): Starts payroll calculation and processing for a specific pay period. - [removeAdditionalCompensations](https://developer.rollfi.xyz/api-reference/payroll/removeAdditionalCompensations.md): The `removeAdditionalCompensations` API is used to remove additional compensation entries for an employee in a pay period. - [removeDeductions](https://developer.rollfi.xyz/api-reference/payroll/removeDeductions.md): The `removeDeductions` API is used to remove deduction entries for an employee in a pay period. - [removeOvertime](https://developer.rollfi.xyz/api-reference/payroll/removeOvertime.md): The `removeOvertime` API is used to remove overtime entries for an employee in a pay period. - [removePayrollLineItemTaxAdjustment](https://developer.rollfi.xyz/api-reference/payroll/removePayrollLineItemTaxAdjustment.md): The `removePayrollLineItemTaxAdjustment` API is used to remove tax adjustments that have been applied to an employee for a pay period. - [removeReimbursements](https://developer.rollfi.xyz/api-reference/payroll/removeReimbursements.md): The `removeReimbursements` API is used to remove reimbursement entries from an employee in a payPeriod. - [removeUsersFromRegularPayPeriod](https://developer.rollfi.xyz/api-reference/payroll/removeUsersFromRegularPayPeriod.md): The `removeUsersFromRegularPayPeriod` API is used to remove employees from a regular pay period due to many different circumstances - [removeUsersFromSupplementalPayPeriod](https://developer.rollfi.xyz/api-reference/payroll/removeUsersFromSupplementalPayPeriod.md): The `removeUsersFromSupplementalPayPeriod` API is used to remove employees from a supplemental pay period after they have been added. - [skipPayPeriod](https://developer.rollfi.xyz/api-reference/payroll/skipPayPeriod.md): The `skipPayPeriod` API is used to skip a pay period - [updatePayrollLineItemTaxAdjustment](https://developer.rollfi.xyz/api-reference/payroll/updatePayrollLineItemTaxAdjustment.md): The `updatePayrollLineItemTaxAdjustment ` API is used to correct a tax adjustment that has been added to an employee for a pay period - [updatePayrollTaxExemption](https://developer.rollfi.xyz/api-reference/payroll/updatePayrollTaxExemption.md): Used to update the effectiveEndDate of a payroll tax exemption - [getTimeOffBalance](https://developer.rollfi.xyz/api-reference/reports/PaidTimeOff/getTimeOffBalance.md): The `getTimeOffBalane` APi is used to retrieve time off balances for each timeOffPolicy an employee is active in - [getTimeOffPolicies](https://developer.rollfi.xyz/api-reference/reports/PaidTimeOff/getTimeOffPolicies.md): The `getTimeOffPolicies` API retrieves all active time off policies for a company - [getTimeOffPolicy](https://developer.rollfi.xyz/api-reference/reports/PaidTimeOff/getTimeOffPolicy.md): The `getTimeOffPolicy ` API returns a single timeOffPolicy using timeOffPolicyId - [getTimeOffPolicyAssignment](https://developer.rollfi.xyz/api-reference/reports/PaidTimeOff/getTimeOffPolicyAssignment.md): The `getTimeOffPolicyAssignment ` API retrieves a time off assignment using the associated timeOffPolicyAssignmentId - [getTimeOffPolicyAssignments](https://developer.rollfi.xyz/api-reference/reports/PaidTimeOff/getTimeOffPolicyAssignments.md): The `getTimeOffPolicyAssignments ` API retrieves time off assignments filtered by company and employee - [getTimeOffPolicyTypes](https://developer.rollfi.xyz/api-reference/reports/PaidTimeOff/getTimeOffPolicyTypes.md): The `getTimeOffPolicyTypes` API retrieves valid paid time off policy types that a company may offer. These types are used in the `addTimeOffPolicy` API - [getTimeOffRequest](https://developer.rollfi.xyz/api-reference/reports/PaidTimeOff/getTimeOffRequest.md): The `getTimeOffRequest` API retrieves a time off request from a timeOffRequestId - [getTimeOffRequests](https://developer.rollfi.xyz/api-reference/reports/PaidTimeOff/getTimeOffRequests.md): The `getTimeOffRequests` API retrieves time off requests for a company or single employee - [getActiveUsers](https://developer.rollfi.xyz/api-reference/reports/getActiveUsers.md): The `getActiveUsers` API is used to retrieve comprehensive information about all currently active users in the system. This report provides essential user data for payroll processing, compliance tracking, and workforce management. - [getAdditionalCompensationDescription](https://developer.rollfi.xyz/api-reference/reports/getAdditionalCompensationDescription.md): The `getAdditionalCompensationDescription` API is used to retrieve available additional compensation descriptions that can be used in payroll processing. - [getAllowedTaxAdjustmentsList](https://developer.rollfi.xyz/api-reference/reports/getAllowedTaxAdjustmentsList.md): The `getAllowedTaxAdjustmentsList` retrieves a list of taxes that apply to an employee for manual adjustment. - [getBusinessUserDetails](https://developer.rollfi.xyz/api-reference/reports/getBusinessUserDetails.md): The `getBusinessUserDetails` API is used to retrieve comprehensive information about a specific business user within the system. - [getBusinessUsers](https://developer.rollfi.xyz/api-reference/reports/getBusinessUsers.md): The `getBusinessUsers` API is used to retrieve comprehensive information about **all** business users within a company. - [getCashRequirementsReport](https://developer.rollfi.xyz/api-reference/reports/getCashRequirementsReport.md): The `getCashRequirementsReport` API generates cash requirements including payroll account debits and other payroll liabilities settled outside of the Rollfi system - [getCompanies](https://developer.rollfi.xyz/api-reference/reports/getCompanies.md): The `getCompanies` API is used to retrieve a list of all companies accessible within a payroll management company's administrative environment. Company IDs are required for the majority of API calls. - [getCompanyBenefits](https://developer.rollfi.xyz/api-reference/reports/getCompanyBenefits.md): The `getCompanyBenefits` API retrieves the details for a company's benefit elections - [getCompanyInfo](https://developer.rollfi.xyz/api-reference/reports/getCompanyInfo.md): The `getCompanyInfo` API retrieves detailed information about a specific company. - [getCompanyLocationInfo](https://developer.rollfi.xyz/api-reference/reports/getCompanyLocationInfo.md): The `getCompanyLocationInfo` API retrieves all location information for a specific company including address and location type designation. - [getCompanyTask](https://developer.rollfi.xyz/api-reference/reports/getCompanyTask.md): The `getCompanyTask` API retrieves a list of pending tasks that should be completed during onboarding and day-to-day operations. - [getCompanyTaxExemptions](https://developer.rollfi.xyz/api-reference/reports/getCompanyTaxExemptions.md): Retrieves the current tax exemptions applied to an company - [getDeactivatedUsers](https://developer.rollfi.xyz/api-reference/reports/getDeactivatedUsers.md): The `getDeactivatedUsers` API retrieves comprehensive information about all users who have been deactivated within a company. - [getDeductionDescription](https://developer.rollfi.xyz/api-reference/reports/getDeductionDescription.md): The `getDeductionDescription` API retrieves available deduction identifiers that can be used in payroll processing to indicate employee contributions and voluntary withholdings. - [getEmployeeMiscellaneousStateTaxFormFields](https://developer.rollfi.xyz/api-reference/reports/getEmployeeMiscellaneousStateTaxFormFields.md): The `getEmployeeMiscellaneousStateTaxFormFields ` API retrieves available miscellaneous state tax fields for users based on their state of residence. - [getEmployeeMiscellaneousStateTaxforPayroll](https://developer.rollfi.xyz/api-reference/reports/getEmployeeMiscellaneousStateTaxforPayroll.md): The `getEmployeeMiscellaneousStateTaxforPayroll ` API retrieves the miscellaneous state tax fields that have previously been added to a user's record to be used in payroll processing. - [getEmployeeTaxExemptions](https://developer.rollfi.xyz/api-reference/reports/getEmployeeTaxExemptions.md): Retrieves the current tax exemptions applied to an employee - [getIndividualPayrollHistory](https://developer.rollfi.xyz/api-reference/reports/getIndividualPayrollHistory.md): The `getIndividualPayrollHistory` API retrieves comprehensive payroll history details for a specific employee. - [getMonthlyAndSemiMonthlyPayScheduleDates](https://developer.rollfi.xyz/api-reference/reports/getMonthlyAndSemiMonthlyPayScheduleDates.md): The `getMonthlyAndSemiMonthlyPayScheduleDates` API retrieves the pay schedule dates for monthly and semi-monthly payroll options. - [getOverTimeTypes](https://developer.rollfi.xyz/api-reference/reports/getOverTimeTypes.md): The `getOverTimeTypes` API retrieves available overtime type identifiers that can be used in payroll processing and time tracking. - [getPaidEmployeesCountBasedOnDateRange](https://developer.rollfi.xyz/api-reference/reports/getPaidEmployeesCountBasedOnDateRange.md): The `getPaidEmployeesCountBasedOnDateRange` API returns the total count of employees who received payment within a specified date range. - [getPayBeginDates](https://developer.rollfi.xyz/api-reference/reports/getPayBeginDates.md): The `getPayBeginDates` API returns available pay begin dates for Monthly and Semi-Monthly compensation frequencies. - [getPayPeriod](https://developer.rollfi.xyz/api-reference/reports/getPayPeriod.md): The `getPayPeriod` API retrieves pay period information for a company based on worker type. - [getPayPeriodDetails](https://developer.rollfi.xyz/api-reference/reports/getPayPeriodDetails.md): The `getPayPeriodDetails` API retrieves detailed information about a specific pay period using a payPeriodId. - [getPayRun](https://developer.rollfi.xyz/api-reference/reports/getPayRun.md): The `getPayRun` API retrieves payroll line item information for a specific pay period. - [getPaySchedule](https://developer.rollfi.xyz/api-reference/reports/getPaySchedule.md): The `getPaySchedule` API retrieves the pay schedules for W2 and/or 1099 workers for a company. - [getPayStub](https://developer.rollfi.xyz/api-reference/reports/getPayStub.md): The `getPayStub` API retrieves detailed pay stub information for a specific employee and pay period. - [getPayrollHistoryBasedOnDateRange](https://developer.rollfi.xyz/api-reference/reports/getPayrollHistoryBasedOnDateRange.md): The `getPayrollHistoryBasedOnDateRange` API retrieves payroll history for all pay periods within a specified date range. - [getPayrollHistoryBasedOnPayPeriod](https://developer.rollfi.xyz/api-reference/reports/getPayrollHistoryBasedOnPayPeriod.md): The `getPayrollHistoryBasedOnPayPeriod` API retrieves complete payroll history for a specific pay period. - [getPayrollJournalReport](https://developer.rollfi.xyz/api-reference/reports/getPayrollJournalReport.md): The `getPayrollJournalReport` API generates accounting journal entries for payroll transactions. - [getPayrollJournalReports](https://developer.rollfi.xyz/api-reference/reports/getPayrollJournalReports.md): The `getPayrollJournalReports` API generates accounting journal entries for payroll transactions. - [getProcessedPayperiodsDetails](https://developer.rollfi.xyz/api-reference/reports/getProcessedPayperiodsDetails.md): The `getProcessedPayPeriods` API retrieves all pay periods that have been processed for a company. - [GetStateRegistration](https://developer.rollfi.xyz/api-reference/reports/getStateRegistration.md) - [getStateW4FormFields](https://developer.rollfi.xyz/api-reference/reports/getStateW4FormFields.md): The `getStateW4FormFields` API retrieves state-specific W4 form fields for an employee based on their location. - [getTaxNameForExemption](https://developer.rollfi.xyz/api-reference/reports/getTaxNameForExemption.md): Retrieves the taxNames that can be added as exemptions for employees and companies - [getTerminatedUsers](https://developer.rollfi.xyz/api-reference/reports/getTerminatedUsers.md): The `getTerminatedUsers` API retrieves comprehensive information about all users who have been terminated within a company. - [getTransactionBasedOnReference](https://developer.rollfi.xyz/api-reference/reports/getTransactionBasedOnReference.md): The `getTransactionBasedOnReference` API retrieves payroll transaction details based on a specific request reference ID. - [getTransactions](https://developer.rollfi.xyz/api-reference/reports/getTransactions.md): The `getTransactions` API retrieves all payroll transaction records for a specific pay period. - [getTransactionsBasedOnName](https://developer.rollfi.xyz/api-reference/reports/getTransactionsBasedOnName.md): The `getTransactionsBasedOnName` API retrieves payroll transaction details based on a specific transaction name within a pay period. - [getUnProcessedPayPeriod](https://developer.rollfi.xyz/api-reference/reports/getUnProcessedPayPeriod.md): The `getUnProcessedPayPeriod` API retrieves pay periods that have not yet been processed for payroll. - [getUploadedDocuments](https://developer.rollfi.xyz/api-reference/reports/getUploadedDocuments.md): The `getUploadedDocuments` API retrieves a list of uploaded documents alongside their document specific IDs - [getUser](https://developer.rollfi.xyz/api-reference/reports/getUser.md): The `getUser` API retrieves detailed information for a specific user. - [getUserTask](https://developer.rollfi.xyz/api-reference/reports/getUserTask.md): The `getUserTask` API retrieves pending tasks and setup requirements for a specific user. - [getUsers](https://developer.rollfi.xyz/api-reference/reports/getUsers.md): The `getUsers` API retrieves detailed information for all users within a company. - [getUsersByCompanyName](https://developer.rollfi.xyz/api-reference/reports/getUsersByCompanyName.md): The `getUsersByCompanyName` API retrieves detailed information for all users within a company using company name as an identifier. - [acceptTermsAndCondition](https://developer.rollfi.xyz/api-reference/useronboarding/acceptTermsAndCondition.md): The `acceptTermsAndCondition` API is used to record a user's acceptance of the Terms and Conditions, which is mandatory for regulatory compliance before proceeding with any onboarding steps. - [addKycInformation](https://developer.rollfi.xyz/api-reference/useronboarding/addKycInformation.md): The `addKycInformation` API is used to collect essential identity information from employees as part of the KYC (Know Your Customer) process for regulatory compliance and identity validation. - [addStateW4Information](https://developer.rollfi.xyz/api-reference/useronboarding/addStateW4Information.md): The `addStateW4Information` API is used to collect state-specific tax withholding information for employees in states that require additional withholding forms. - [addW4Information](https://developer.rollfi.xyz/api-reference/useronboarding/addW4Information.md): The `addW4Information` API is used to collect federal tax withholding information from employees for accurate payroll tax calculation. - [initiateUserKyc](https://developer.rollfi.xyz/api-reference/useronboarding/initiateUserKyc.md): The `initiateUserKyc` API is used to start the KYC verification process to validate the employee's identity information. - [updateKycInformation](https://developer.rollfi.xyz/api-reference/useronboarding/updateKycInformation.md): The `updateKycInformation` API is used to modify previously submitted identity information for employees when changes are needed. - [updateStateW4Information](https://developer.rollfi.xyz/api-reference/useronboarding/updateStateW4Information.md): The `updateStateW4Information` API is used to modify previously submitted state-specific tax withholding information for employees. - [updateW4Information](https://developer.rollfi.xyz/api-reference/useronboarding/updateW4Information.md): The `updateW4Information` API is used to modify previously submitted federal tax withholding information for employees. - [addTimeOffRequest](https://developer.rollfi.xyz/api-reference/userportal/addTimeOffRequest.md): The `addTimeOffRequest` API is used to create a new time off request for manager approval - [addUserBankAccount](https://developer.rollfi.xyz/api-reference/userportal/addUserBankAccount.md): The `addUserBankAccount` API allows a bank account to be added for an employee. - [cancelTimeOffRequest](https://developer.rollfi.xyz/api-reference/userportal/cancelTimeOffRequest.md): The `cancelTimeOffRequest` API is used to cancel Approved PTO requests - [deleteTimeOffRequest](https://developer.rollfi.xyz/api-reference/userportal/deleteTimeOffRequest.md): The `deleteTimeOffRequest` API is used to delete PTO requests before they are approved - [updateKycInformation](https://developer.rollfi.xyz/api-reference/userportal/updateKycInformation.md): The `updateKycInformation` API is used to modify previously submitted identity information for employees when changes are needed. - [updateTimeOffRequest](https://developer.rollfi.xyz/api-reference/userportal/updateTimeOffRequest.md): The `updateTimeOffRequest` API is used to make changes to all fields in an existing time off request - [updateUserBankAccount](https://developer.rollfi.xyz/api-reference/userportal/updateUserBankAccount.md): The `updateUserBankAccount` API is used to change bank account details for employees. - [updateUserPayPercentage](https://developer.rollfi.xyz/api-reference/userportal/updateUserPayPercentage.md): The `updateUserPayPercentage` API is used to modify the payPercentage for an employee's bank account - [Bank Account Webhooks](https://developer.rollfi.xyz/api-reference/webhooks/bankAccounts.md) - [Company Webhooks](https://developer.rollfi.xyz/api-reference/webhooks/company.md) - [Employee Webhooks](https://developer.rollfi.xyz/api-reference/webhooks/employee.md) - [Pay Period Webhooks](https://developer.rollfi.xyz/api-reference/webhooks/payPeriod.md) - [Authentication](https://developer.rollfi.xyz/docs/Authentication.md) - [CustomerOnboarding](https://developer.rollfi.xyz/docs/CustomerOnboarding.md) - [Employee Bank Account Linking](https://developer.rollfi.xyz/docs/EmployeeBankAccountLinking.md) - [EmployeeOnboarding](https://developer.rollfi.xyz/docs/EmployeeOnboarding.md) - [Employee Tax Guide](https://developer.rollfi.xyz/docs/EmployeeTaxGuide.md) - [Payroll API Documentation](https://developer.rollfi.xyz/docs/PayrollAPIDocumentation.md) - [Payroll Guide](https://developer.rollfi.xyz/docs/PayrollGuide.md) - [Payroll Processing](https://developer.rollfi.xyz/docs/PayrollProcessing.md) - [Webhooks](https://developer.rollfi.xyz/docs/Webhooks.md) - [Terminology](https://developer.rollfi.xyz/terminology.md) ## OpenAPI Specs - [Rollfi_v2.openapi](https://developer.rollfi.xyz/Rollfi_v2.openapi.json) ## Optional - [Embedded Payroll](https://www.rollfi.xyz)