JUMP TOUser APICurrent UserRetrieves current User informationgetUpdate current User phonespostChange user passwordpostChange user loginpostRetrieves User information in company contextgetRetrieves link to back-officegetReturns capabilities for role typegetCapabilitiesGet list of capabilitiesgetGet list of user capabilitiesgetAdmin LoginsRetrieves link to back-office for SSO on-behalf-of usergetCompany APICompany BasicGet list of CompaniesgetCreate CompanypostGet list of Companies for System level usersgetGet Company informationgetUpdate CompanypatchBlock CompanypostBlock StatusgetUnblock CompanypostEmployee RequestsRequest PolicygetSave Request PolicypostCompany Help and Support ContactsGet list of company Help and Support contacts for employeesgetGet list of company Help and Support TypesgetCompany Tax SetupGet Current Tax SetupgetUpdate Tax Setup ValuespostCompany SignatoriesReturn list of valid signatories of the companygetCreate company signatorypostSet company signatorypostReturn detail of company signatorygetEdit signatorypatchRemove signatorypostReturn signatory documentsgetReturn signatory documentgetUpload file for signatory documentpostCompany Bank AccountsGet list of Bank AccountsgetCreate Bank AccountpostGet Bank AccountgetUpdate Bank AccountpatchCompany Documents - SignaturesReturn list of signed and unsigned documentsgetReturn selected documentgetUpload file with signed documentpostSign file of the document using signature string and stores itpostCompany DivisionsGet list of Company DivisiongetCompany PositionsGet list of Company PositiongetAdd a new Company PositionpostUpdate existing Company PositionpatchDelete Company PositiondeleteCompany DocumentsGet info about client folderget/wep/companies/{companyId}/folders/{folderId}/itemsgetEmployee DocumentsGet list of Employee DocumentsgetAdd new Employee documentpostGet Employee DocumentgetDelete Employee DocumentdeleteGet signatures of Employee documentgetAdd new signature to Employee documentpostEWA IntegrationGet list of Companies for EWAgetAffixReturns connection URL for Affix bridgegetReturns connection URL for Affix bridge for specified companygetIssues access token with user identity from SCU (state param from authentication) for Affix bridgegetBankingGet name of the bank by routing numbergetBank OnboardingGet Bank Onboarding StatusgetGet Bank Onboarding Company infogetBank AccountgetCreate/Update Bank AccountpostCustody Bank AccountgetCreate Custody Bank AccountpostGet list of Client KYC DocumentsgetGet Client KYC DocumentgetSubmit Client KYC documentpostUpload Client KYC documentpostGet Bank Onboarding DetailgetCreate/Update Bank Onboarding DetailpostVerify Bank AccountpostComplete Bank OnboardingpostBulletinList of Bulletin MessagesgetSet Status for Bulletin MessagesputEstimated Annual WageGet Estimated Annual WagepostGet Estimated Annual WagepostCalendarCalendar EventsgetEvent TypesgetE-Verify CasesList Of CasesgetE-Verify SetupGet Setup DetailgetSave SetuppostActivation-Deactivate SetupputHelpful LinksList of Helpful LinksgetCreate Helpful LinkpostDetail Helpful LinksgetUpdate Helpful LinkpatchOrder Helpful LinkspostHR Fields SetupList of HR Custom FieldsgetCreate HR Custom FieldpostGet HR Custom FieldgetUpdate existing custom field. If exist user data under existing Custom Field then existing Custom Field will be deleted and system creates new Custom Field.putDelete HR Custom FielddeleteOrder HR Custom FieldspostList of Field Values for current HR Custom Field across all employeesgetSet status of HR Custom Field - Activate or Deactivate itputID CollectionGet List of ID collection typesgetKotapayGet Kotapay configurationgetCreate or Update Kotapay configurationpostSign Kotapay preview documentpostComplete Sign Kotapay document and generate document filepostKYCGet KYC configuration for specified companyId parameter.getCreate or Update KYC configuration.postVerify company for KYC.postProcess company for KYC.postGet list of documents for KYCgetCreate document.postGet list of documents for KYCgetCreate Signatory document .postGet document for KYCgetDelete document.deleteGet signatory document for KYCgetDelete Signatory document.deleteGet list of document types.getGet set of document configurations.getVerify company document for KYC.postGet list of signatories for KYCgetCreate signatorypostGet signatory for KYCgetUpdate signatorypatchDelete signatorydeleteVerify signatory for KYC.postVerify signatory document for KYC.postCompany Organization StructureGet the organization structure including unassigned employeesgetCreate new empty organizational structurepostAdd (an unassigned) employee to the organizational structureputMove an existing node in the organizational structurepatchRemove an employee from the organizational structuredeleteAdd subordinate employees under the employee node assigned in the organizational structurepostSwap employees in the organizational structurepostPulse SurveysList of Pulse Survey Definitions created by logged user (as author) or assigned as EditorgetList of older Pulse Survey Definitions created by logged user (as author) or assigned as EditorgetList of Pulse Survey Definitions created by logged user (as author)getList of older Pulse Survey Definitions created by logged user (as author)getList of Pulse SurveysgetList of older Pulse SurveysgetList of Pulse Surveys as EditorgetList of older Pulse Surveys as EditorgetList of Pulse Surveys as ReviewergetList of older Pulse Surveys as ReviewergetGet Pulse Survey DefinitiongetUpdate Pulse Survey DefinitionputDelete Pulse Survey DefinitiondeleteCreate Pulse Survey DefinitionpostPublish Pulse Survey DefinitionpostFinish Pulse Survey DefinitionpostChange Pulse Survey Definition DeadlinepostGet List of Selection (assignment definition) for Receivers of current Pulse Survey DefinitiongetUpdate List of Receivers for Pulse Survey DefinitionputGet List of Receivers for current Pulse Survey DefinitiongetGet List of selection (assignment definition) for Editors of current Pulse Survey DefinitiongetUpdate List of Editors for Pulse Survey DefinitionputGet List of Editors for current Pulse Survey DefinitiongetGet List of Questions for current Pulse Survey DefinitiongetCreate Question for current Pulse Survey DefinitionpostGet Question for current Pulse Survey DefinitiongetUpdate Question for current Pulse Survey DefinitionputDelete Question in current Pulse SurveydeleteOrder List of Questions for current Pulse Survey DefinitionpostGet Summary Answers for all Questions in current Pulse SurveygetGet Summary and Data of Employee Answers for current QuestiongetGet results of Pulse Survey for employeesgetGet part of results of Pulse Survey - number of receivers that completed survey over time.getGet surveygetSave survey answerspostCreate comment to survey answerpostCreate reaction to survey answerpostCreate reaction to comment to survey answerpostList of Pulse Survey Definitions created by logged user (as author) or assigned as EditorgetCreate Pulse Survey Definition from TemplatepostCopy Pulse Survey DefinitionpostCopy Pulse Survey Definition as Templatepost/wep/companies/{companyId}/surveys/templates/copyto/{templateCompanyId}post/wep/companies/{companyId}/surveys/templates/copyfrom/{templateCompanyId}post/wep/companies/{companyId}/surveys/pulse/validusersgetCompany Structure APICompany Work LocationGet list of Work LocationsgetCreate Work LocationpostGet Work LocationgetUpdate Work LocationpatchDelete Work LocationdeleteCompany DepartmentsGet list of Company DepartmentsgetCreate Company DepartmentpostGet Company DepartmentgetUpdate Company DepartmentpatchDelete DepartmentdeleteCompany DivisionsGet list of Employees of selected DivisiongetGet Company Division informationgetUpdate Company DivisionpatchDelete DivisiondeleteActivate Company DivisionspostCreate Company DivisionpostEmployee APIEmployeesGet list of Employees for the CompanygetAdd a new Employee recordpostGet list of Employees in selected DepartmentgetGet an Employee recordgetUpdate of existing Employee recordpatchTerminate EmployeepostAdd a new Contract of the EmployeepostSends an invitation email to an existing employeepostGet sensitive personal data for Employee (SSN, DOB)getGet an Employee photogetUpdate employee photopostGet an Employee profile imagegetUpdate Employee profile imagepostGet an Employee timezonegetUpdate employee timezonepostGet an Employee Emergency Contact infogetUpdate an Employee Emergency Contact infoputEmployee Tax SetupGet Current Tax SetupgetUpdate Tax Setup ValuespostEWA IntegrationGet list of Employees for the EWAgetEmployee Form1099Get Employee's Form1099 listgetGet Employee's latest Form1099 FormgetGets specific Form1099getEmployee W-2Get the list of Employee's all W-2 FormsgetGet Employee's latest W-2 FormgetGet W-2 Form detailgetHR Fields DataList of HR Field Values for current Employee FormgetSave Field Values for Employee FormpostSave Field Value for Employee FormpostID CollectionList of ID collectionsgetCreate ID collectionpostGet Detail of ID collectiongetDelete current ID collectiondeleteSet Visibility of current ID collection according to access rightsputUpdate Page of current ID collectionputRequestsGet Change Address RequestgetSave Change Address RequestputDelete Change Address RequestdeleteGet Change Contact Info RequestgetSave Change Contact Info RequestputDelete Change Contact Info RequestdeleteGet list of RequestsgetGet Change Emergency Info RequestgetSave Change Emergency Info RequestputDelete Change Emergency Info RequestdeleteGet Change General RequestgetSave Change General RequestputDelete Change General RequestdeleteGet Change Name RequestgetSave Change Name RequestputDelete Change Name RequestdeleteGet Change Net Pay Allocation RequestgetExisting Net Pay Allocation Change Request UpdateputAdd New Net Pay Allocation Change Request / Update New Net Pay Allocation Change RequestpostDelete Change Net Pay Allocation RequestdeleteGet Questions RequestgetSave Questions RequestputDelete Questions RequestdeleteGet Change SSN RequestgetSave Change SSN RequestputDelete Change SSN RequestdeleteEmployees Working HoursEmployee's Working TimegetEmployee Self-Onboarding APISetupReturns list of templatesgetStart new employee onboardingpostPhase: 1) SettingsSave employee infoputGet employee infogetUpdate employment infoputGet employment infogetSave employment detailputGet employment detailgetGet HR FieldsgetSave HR Fields - data and statusputSave HR Fields - only data, status is not changedputReturns meta information about step personal info in Phase 2getPrefill step personal info in Phase 2putReturns meta information about step contact info in Phase 2getPrefill step contact info in Phase 2putPhase: 2) Onboarding New HireGet HR FieldsgetSave HR FieldsputPhase: 2) Onboarding New Hire - OverviewGet HR FieldsgetPhase: 3) VerificationFinalize Onboarding - Create new employeeputGet Employee's Net Pay AllocationgetFinish Step Net Pay AllocationputLoad data for Step Document SigninggetFinish Step Document SigningputLoad data for Step Document SigninggetUpload hand written documentpostGet preview Form 8850getSave data for Step Form 8850putLoad data for Step Form 8850getGet preview Form I-9getReturns stored data from I-9 FormgetFinish Step I-9putSave data for I-9 where CitizenShip is NonResidentAlienputSave data for I-9 where CitizenShip is ResidentAlienputSave data for I-9 where CitizenShip is USCitizen OR PernamentResidentputGet I-9 ID Collection for review.getI-9 ID Collection - FinishputGet Tax SetupgetFinish Step Tax SetupputUpdate Employee's Net Pay AllocationputDownload document for hand writinggetFinish Step Form 8850putOverviewList of OnboardingsgetGenerate URL for Employee OnboardinggetDiscard OnboardinggetGet Employee's Onboarding StatusgetTake controlgetGet Steps InfogetFinalize_v10/wep/companies/{companyId}/onboarding/finalize/{id}/setup-manager/{managerId}putPayroll APIPayroll PoliciesPayroll Policy InfogetList of Company PoliciesgetCreate Payroll PolicypostPayroll Policy InfogetAllows changing Payroll PolicypatchRemoves Payroll PolicydeleteNamed Payroll Policy InfogetList of Policy EmployeesgetAssign Employee to a PolicypostRemove employee from PolicydeleteGet Policy Schedule CalendargetChecks the Policy for eligibility to be run automaticallygetPayroll BasicStart Default PayrollpostSkip Default PayrollpostRetrieve Payroll StatusgetNext Payroll SteppostPrevious Payroll SteppostDiscard PayrollpostVoid PayrollGet Years For Void PayrollgetStart Void PayrollpostGet Employees For Void PayrollgetGet Payrolls For Void PayrollgetGet Employee Pay Stubs For Void PayrollgetGet Years For Void Named PayrollgetGet Employees For Void Named PayrollgetGet Payrolls For Void Named PayrollgetGet Employee Pay Stubs For Void Named PayrollgetEmployee PayrollList of current year payrollsgetList of scheduled payrollsgetList of years with any payroll for employeegetList of payrolls for yeargetGet payrollgetEarning CodesGet list of Earning Code presetsgetGet list of Earning CodesgetCreate Earning CodepostGet Earning Code informationgetUpdate Earning CodepatchDelete Earning CodedeletePay AllocationsGet list of Pay AllocationsgetCreate Pay AllocationpostGet Pay AllocationgetUpdate Pay AllocationpatchDelete Pay AllocationdeleteEmployee StatusEmployee status for payrollpostEmployee validity for payrollpostPayroll AdvancedGet PaystubgetGet Paystub (extended data)getStart Named PayrollpostStart Bonus PayrollpostStart Off-Cycle PayrollpostSkip Named PayrollpostStart PayrollpostGet data for payment authorization pagegetPayroll OverviewgetPayroll Information & HistoryPayroll History OverviewgetList of Payrolls.getList of Scheduled PayrollsgetPayroll HistorygetGet payroll Uncollected TaxesgetPayroll OverviewgetDefault Payroll HistorygetNamed Payroll HistorygetGet Running Payrolls for a CompanygetGet Running Payrolls for admingetPayroll History.getTimesheetRemove payline (Extended)deleteAdd payline (Extended)postGet list of Earnings (Extended)getGet Earnings setup (Extended)getUpdate Earnings (Extended)patchGet list of EarningsgetGet Earnings setupgetUpdate EarningspatchRemove deductiondeleteAdd new miscellaneous deductionpostAdd existing deductionpostTermination PayrollStart Termination PayrollpostTerminated employees in Default PolicygetTerminated employees in Named PolicygetPayroll Gross-UpGet payroll Gross upgetAdd new payroll Gross uppostUpdate payroll Gross uppatchRemove payroll Gross updeletePayroll ChecksPayroll Checks Generating progressgetPayroll Checks Generating progressgetGet FileToken to download Payroll ChecksgetPayroll MessagesGet a list of payroll paylines messagesgetGet a list of payline messagesgetYTD Import APIOnboardingGet payrollgetYTD Payroll SetupStart Setup PayrollpostGet Setup Payroll StatusgetDiscard Setup PayrollpostGet Eligible EmployeesgetGet EmployeesgetAdd EmployeespostRemove EmployeedeleteGet Quarter DatagetSave DatapostGet Paystub DatagetGet Paystub DatagetSave WagesReceivedpostAdd PaystubpostUpdate PaystubputRemove PaystubdeleteGet Quarters OverviewgetProcess DatapostFinish Setup PayrollpostBenefits & Deductions APICompany BenefitsList of Benefit TemplatesgetCreate Benefit TemplatepostUpdate Benefit TemplatepatchDelete Benefit TemplatedeleteList of Company BenefitsgetCreate Company BenefitpostGet Company BenefitgetUpdate Company BenefitpatchDelete Company BenefitdeleteList of Assigned EmployeesgetList of Company Benefit VersionsgetGet Benefit PlangetUpdate Benefit PlanpatchDelete Benefit PlandeleteCreate Benefit PlanpostGet Benefit ContributiongetUpdate Benefit ContributionpatchDelete Benefit ContributiondeleteCreate Benefit ContributionpostGet Benefit RulegetUpdate Benefit RulepatchDelete Benefit RuledeleteCreate Benefit RulepostEmployee BenefitsList of Employee Benefit DeductionsgetCreate Employee BenefitpostGet Employee BenefitgetUpdate Employee BenefitpatchDelete Employee Benefit DeductiondeleteEmployee DeductionsList of Current DeductionsgetGet Child Support DeductiongetUpdate Child Support DeductionpatchGet Miscellaneous DeductiongetUpdate Miscellaneous DeductionpatchList of Child Support DeductionsgetCreate Child Support DeductionpostList of Miscellaneous DeductionsgetCreate Miscellaneous DeductionpostList of Employee Deduction HistorygetCompany Benefits GroupsList of Benefit GroupsgetDashboard APIDashboardGet dashboardgetOrder dashboard itemspostGet dashboard itemgetGet company dashboardgetOrder company dashboard itemspostGet company dashboard itemgetGet employee dashboardgetOrder company dashboard itemspostGet employee dashboard itemgetGet Dashboard structure Data (Example)getReports APIJob and Project CostingGet list of SegmentsgetCreates new SegmentpostRetrieves Segment informationgetRemoves SegmentdeleteUpdate Segment informationpatchGet list of Cost CodesgetCreate Cost CodepostRetrieves Cost Code informationgetUpdate Cost CodepatchDelete Cost CodedeleteGet a list of Job Consting SegmentsgetReportsCreate Deduction Benefit Register ReportpostCreate Companies ReportpostCreate SUTA Rates ReportpostCreate Terminated Companies ReportpostCreate Deduction Benefit Roster ReportpostCreate Employees Arrears ReportpostCreate Deduction Benefit Register ReportpostCreate Deduction Benefit Roster ReportpostCreate Employees Arrears ReportpostCreate Employee Direct Deposit Register ReportpostCreate Employee Direct Deposit Roster ReportpostCreate Employee Overview ReportpostCreate Scheduled Pay ReportpostCreate Unpaid Active Employee List ReportpostCreate Employee Overview ReportpostCreate Birthday List ReportpostCreate Employee Tax Setup ReportpostCreate Employee Termination ReportpostCreate Employment Details ReportpostCreate Net Pay Allocation Roster ReportpostCreate Scheduled Pay ReportpostCreate Unpaid Active Employee List ReportpostCreate Cash Requirements ReportpostCreate FICA Tip Credit ReportpostCreate Hours Earnings Recap ReportpostCreate Job Costing ReportpostCreate Payroll Recap ReportpostCreate Payroll Recap Employee ReportpostCreate Payroll Recap ExportpostCreate Payroll Register ReportpostCreate Time Entry ReportpostCreate Time Entry Sheet ReportpostCreate Hours Earnings Recap ReportpostCreate Payroll Recap ReportpostCreate Payroll Recap Employee ReportpostCreate Payroll Register ReportpostCreate Time Entry ReportpostCreate Time Entry Sheet ReportpostCreate Daily Federal Tax Liability ReportpostCreate Daily State Tax Liability ReportpostGet Existing ReportgetGet Existing Report FilegetCreate Worker's Compensation History ReportpostCreate Worker's Compensation History ReportpostWorkers' Compensation APIWorkers' CompensationGet list of Workers' Compensation CodesgetGet list of Workers' Compensation Codes for specified companygetGet list of Workers' Compensation Codes for specified company and divisiongetGet list of Workers' Compensation Codes for specified company and stategetGet list of Workers' Compensation Codes for specified company, division and stategetGet list of Workers' Compensation Codes for specified employeegetGet list of Workers' Compensation Company RatesgetCreate Workers' Compensation Company RatepostGet Workers' Compensation Company RategetUpdate Workers' Compensation Company RatepatchTimeOff APITimeOff Policy - CompanyGet list of TimeOff PoliciesgetCreate TimeOff PolicypostGet TimeOff Policy informationgetDeactivate TimeOff PolicyputList of PresetsgetTimeOff Groups - CompanyGet list of TimeOff PoliciesgetTimeOff Policy - Employee TransactionsGet a list of Time Off transactions, sorted from newest to oldest.getCreate a new "Manual Adjustment" Time Off transactionpostDelete a "Manual Adjustment" Time Off transaction.deleteUpdate a "Manual Adjustment" Time Off transaction.patchTimeOff Policy - EmployeeReturns balance for employee and policy.getGet a list of active time off policies assigned to the employee, including hours used, balance, and other relevant statistics. All statistics are in minutes.getInitial setup to Employee's TimeOff PolicypostGets participation limits (%) for Employee's TimeOff PolicygetSets participation limits (%) for Employee's TimeOff PolicyputDeactivate Employee's TimeOff PolicyputTimeOff Requests APIEmployee TimeOff RequestsGet list of timeoff requestsgetEmployee TimeOff RequestCreate timeoff requestpostRetrieves timeoff request informationgetUpdate timeoff requestpatchRemove timeoff requestdeleteCompany TimeOff RequestsGet list of timeoff requestsgetCompany TimeOff RequestCreate timeoff requestpostRetrieves timeoff request informationgetUpdate timeoff requestpatchRemove timeoff requestdeleteApprove timeoff requestpostDeny timeoff requestpostCompany TimeOff Request TypesGet list of timeoff request typesgetCompany TimeOff Request TypeCreate timeoff request typepostRetrieves timeoff request type informationgetUpdate timeoff request typepatchRemove timeoff request typedeleteCompany TimeOff Request SetupGet timeoff request setupgetCreate timeoff request setuppostUpdate timeoff request setuppatchSystem APIAdmin LoginsCreate Admin LoginpostGet list of Admin Logins for the CompanygetUpdate Admin LoginpatchRetrieves Admin Login informationgetMulti Admin LoginsGet list of Full System Admin and Multi Admin LoginsgetCreate Multi Admin LoginpostRetrieves Full System Admin or Multi Admin Login informationgetUpdate Admin LoginpatchBlock System Admin Login or Multi Admin accesspatchActivate System Admin Login or Multi Admin accesspatchWhite-Labeling & BrandsGet Brand SetupgetSave LogopostSave Dark LogopostSave FaviconpostSave IconpostSave Dark IconpostSave App NamepostSave Custom ColorspostGet Brand Setup based on RCUgetGet Brand SetupgetSave LogopostSave Dark LogopostSave FaviconpostSave IconpostSave Dark IconpostSave App NamepostSave Custom ColorspostSave Support EmailpostSave Support PhonepostGeneralList of Custom Termination ReasonsgetAdd a new Custom Termination ReasonpostGet Custom Termination Reason By IdgetUpdate existing Custom Termination ReasonpatchDelete Custom Termination ReasondeleteList of Gender IdentitiesgetList of NAICS CodesgetList of Time ZonesgetFilesDownload File InfogetDownload FilegetPreview FilegetDownload AvatargetDownload AvatarspostNotificationsGet past commentsgetGet past commentsgetGet past commentsgetUpdates a commentpatchUpdates a commentpatchUpdates a commentpatchGet initial notificationsgetGet initial notificationsgetGet initial notificationsgetGet new notificationsgetGet new notificationsgetGet new notificationsgetGet past notificationsgetGet past notificationsgetGet past notificationsgetSet Read statusgetSet Read statusgetSet Read statusgetSet Dismissed statusgetSet Dismissed statusgetSet Dismissed statusgetRefresh notificationspostRefresh notificationspostRefresh notificationspostGet initial notificationsget/wep/companies/{companyId}/messaging/surveys/{parentId}get/wep/companies/{companyId}/employees/{employeeId}/messaging/surveys/{parentId}getGet list of items for Survey answers with comments or reactionsget/wep/messaging/posts/{postId}/reactions/{reactionKey}delete/wep/messaging/pins/{postId}/reactions/{reactionKey}delete/wep/messaging/surveys/{postId}/reactions/{reactionKey}delete/wep/messaging/posts/{postId}/thread/{commentId}/reactions/{reactionKey}delete/wep/messaging/pins/{postId}/thread/{commentId}/reactions/{reactionKey}delete/wep/messaging/surveys/{postId}/thread/{commentId}/reactions/{reactionKey}delete/wep/messaging/refreshpost/wep/companies/{companyId}/messaging/refreshpost/wep/companies/{companyId}/employees/{employeeId}/messaging/refreshpostWeb HooksList Registered Company WebHooksgetCreate Company WebHook RegistrationpostList Registered WebHooksgetCreate WebHook RegistrationpostGet Company WebHook RegistrationgetDelete Company WebHook RegistrationdeleteGet WebHook RegistrationgetDelete WebHook RegistrationdeleteTest Company WebHook RegistrationgetTest WebHook RegistrationgetPowered by Bank Accountget https://api.worklio.com/wep/companies/{companyId}/bankonboarding/bankaccountBank account.