For AI agents: visit https://apidocs.worklio.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Worklio Embedded Payroll
GuidesAPI ReferenceChangelog
Log InWorklio Embedded Payroll
API Reference
Log In
GuidesAPI ReferenceChangelog
  • Current User
    • Retrieves the current-user profile for API v1.0.get
    • Updates the current user's phone number without a verification flow.post
    • Starts phone verification for the current user.post
    • Confirms a phone verification request by using the received verification code.post
    • Starts email verification or an email change for the current user.post
    • Confirms email verification or a pending email change by using a verification code.post
    • Changes the password for the authenticated login.post
    • Changes the login email address for the authenticated login.post
    • Retrieves the current user's person profile in a specific company context.get
    • Generates a back-office SSO link for the current role.get
    • Lists capability definitions for a requested role type.get
    • Retrieves week-of-year information for the current role.get
  • Capabilities
    • Lists capability codes that are enabled for the current Worklio instance.get
    • Lists the effective capabilities available to the current user in the specified company.get
  • Admin Logins
    • Generates a back-office SSO link for another user's highest eligible admin or system role.get
  • Middesk_v10
    • MiddeskWebhook.post
  • Company Basic
    • Lists companies visible to the current caller.get
    • Create Companypost
    • Lists companies using the administration-focused projection.get
    • Gets the company profile for the specified company.get
    • Update Companypatch
    • Block Companypost
    • Block Statusget
    • Unblock Companypost
  • Employee Requests
    • Request Policyget
    • Save Request Policypost
  • Company Help and Support Contacts
    • Lists help and support contacts available for the specified company.get
    • Lists the help and support contact categories configured for the company.get
  • Company Tax Setup
    • Get Current Tax Setupget
    • Update Tax Setup Valuespost
  • Company Signatories
    • Return list of valid signatories of the companyget
    • Create company signatorypost
    • Set company signatorypost
    • Return detail of company signatoryget
    • Edit signatorypatch
    • Remove signatorypost
    • Return signatory documentsget
    • Return signatory documentget
    • Upload file for signatory documentpost
  • Company Bank Accounts
    • Get list of Bank Accountsget
    • Create Bank Accountpost
    • Get Bank Accountget
    • Update Bank Accountpatch
  • Company Documents - Signatures
    • Return list of signed and unsigned documentsget
    • Return selected documentget
    • Upload file with signed documentpost
    • Sign file of the document using signature string and stores itpost
  • Company Divisions
    • Lists divisions for the specified company.get
  • Company Positions
    • Lists positions configured for the specified company.get
    • Creates a new company position.post
    • Updates an existing company position.patch
    • Deletes a company position.del
  • Company Documents
    • Gets metadata for the company root folder or a specific company document subfolder.get
    • Gets the immediate child folders and documents stored in a company document folder.get
  • Employee Documents
    • Gets the employee documents that are visible to the current caller for the specified employee.get
    • Uploads a new document for an employee and returns the stored document metadata.post
    • Gets a single employee document together with download and signature status metadata.get
    • Deletes an employee document.del
    • Gets the recorded signature audit entries for an employee document.get
    • Records a signature entry for an employee document.post
  • EWA Integration
    • Get list of Companies for EWAget
    • EWA Status for the Company/get
    • EWA Widget for Company Adminsget
  • Affix
    • Returns connection URL for Affix bridgeget
    • Returns connection URL for Affix bridge for specified companyget
    • Issues access token with user identity from SCU (state param from authentication) for Affix bridgeget
  • Banking
    • Get name of the bank by routing numberget
    • Get bank provider configuration for specified bank accountget
    • Create or Update bank operation provider configuration for specified bank accountpost
    • Get bank provider configuration for specified bank account with prefilled missing dataget
    • Sign bank provider approval preview document for specified bank accountpost
  • Bank Setup
    • Get Bank Setup Statusget
    • Get Bank Onboarding Obsoleteget
  • Bulletin
    • Lists bulletin messages visible for the current caller in the specified company.get
    • Adds or removes bulletin message status flags for the current caller.put
  • Client Emp. Management Tools
    • Lists HR integrations available for the specified company.get
  • Estimated Annual Wage
    • Get Estimated Annual Wagepost
    • Get Estimated Annual Wagepost
  • Calendar
    • Lists calendar events for the specified company.get
    • Lists event types that can appear in the company calendar.get
    • Returns holiday calendar events visible for the specified company.get
    • Creates a company-specific holiday calendar event.post
    • Partially updates an existing company holiday event.patch
    • Soft-deletes a company holiday event.del
    • Creates a company copy of a master holiday event.post
    • Downloads Holiday Calendar import template for the specified company.get
    • Imports Holiday Calendar events from XLSX file.post
    • Returns all Holiday Groups for the specified company.get
    • Creates a new Holiday Group in `InSetup` status for the specified company.post
    • Returns the detail of a single Holiday Group including Step 1, Step 2, and Step 3 data.get
    • Partially updates a Holiday Group (Step 1, Step 2, and/or Step 3 data).patch
    • Deletes a Holiday Groupdel
    • Publishes a Holiday Group by transitioning its status from `InSetup` to `Valid`.post
  • E-Verify Cases
    • Lists E-Verify cases for the specified company.get
  • E-Verify Setup
    • Gets the effective E-Verify setup for the specified company.get
    • Creates or updates the company E-Verify setup.post
    • Activates or deactivates the company E-Verify setup.put
  • Helpful Links
    • Lists helpful links visible to the current caller.get
    • Creates a helpful link for the specified company.post
    • Gets a single helpful link visible to the current caller.get
    • Updates a helpful link for the specified company.patch
    • Reorders helpful links for the specified company.post
  • HR Fields Setup
    • List of HR Custom Fieldsget
    • Create HR Custom Fieldpost
    • Get HR Custom Fieldget
    • Update existing custom field. If exist user data under existing Custom Field then existing Custom Field will be deleted and system creates new Custom Field.put
    • Delete HR Custom Fielddel
    • Order HR Custom Fieldspost
    • List of Field Values for current HR Custom Field across all employeesget
    • Set status of HR Custom Field - Activate or Deactivate itput
  • ID Collection
    • Lists supported identity document collection types.get
  • Kotapay
    • Get Kotapay configuration for specified bank accountget
    • Create or Update Kotapay configuration for specified bank accountpost
    • Get Kotapay configuration for specified bank account with prefilled missing dataget
    • Sign Kotapay preview document for specified bank accountpost
  • KYC
    • Get KYC configuration for specified companyId parameter.get
    • Create or Update KYC configuration.post
    • Verify company for KYC.post
    • Process company for KYC.post
    • Get list of documents for KYCget
    • Create document.post
    • Get list of documents for KYCget
    • Create Signatory document .post
    • Get document for KYCget
    • Delete document.del
    • Get signatory document for KYCget
    • Delete Signatory document.del
    • Get list of document types.get
    • Get set of document configurations.get
    • Verify company document for KYC.post
    • Get list of signatories for KYCget
    • Create signatorypost
    • Get signatory for KYCget
    • Update signatorypatch
    • Delete signatorydel
    • Verify signatory for KYC.post
    • Verify signatory document for KYC.post
  • Net Promoter Score
    • Gets the active NPS survey for the current full-administration context.get
    • Gets the active NPS survey for the specified company context.get
    • Casts a vote for the active NPS survey in the full-administration context.post
    • Casts a vote for the active NPS survey in the specified company context.post
    • Skips the active NPS survey for the specified company context.post
  • Company Organization Structure
    • Get the organization structure including unassigned employeesget
    • Create new empty organizational structurepost
    • Add (an unassigned) employee to the organizational structureput
    • Move an existing node in the organizational structurepatch
    • Remove an employee from the organizational structuredel
    • Add subordinate employees under the employee node assigned in the organizational structurepost
    • Swap employees in the organizational structurepost
  • Pulse Surveys
    • List of Pulse Survey Definitions created by logged user (as author) or assigned as Editorget
    • List of Pulse Survey Definitions created by logged user (as author) or assigned as Editorget
    • List of Pulse Survey Definitions created by logged user (as author) or assigned as Editorget
    • List of Pulse Survey Definitions created by logged user (as author)get
    • List of Pulse Survey Definitions created by logged user (as author)get
    • List of Pulse Survey Definitions created by logged user (as author) or assigned as Editorget
    • List of Pulse Surveysget
    • List of Pulse Surveysget
    • List of Pulse Surveys as Editorget
    • List of Pulse Surveys as Editorget
    • List of Pulse Surveys as Reviewerget
    • List of Pulse Surveys as Reviewerget
    • Get Pulse Survey Definitionget
    • Update Pulse Survey Definitionput
    • Delete Pulse Survey Definitiondel
    • Get Pulse Survey Definitionget
    • Create Pulse Survey Definitionpost
    • Publish Pulse Survey Definitionpost
    • Finish Pulse Survey Definitionpost
    • Change Pulse Survey Definition Deadlinepost
    • Get List of Selection (assignment definition) for Receivers of current Pulse Survey Definitionget
    • Update List of Receivers for Pulse Survey Definitionput
    • Get List of Receivers for current Pulse Survey Definitionget
    • Get List of selection (assignment definition) for Editors of current Pulse Survey Definitionget
    • Update List of Editors for Pulse Survey Definitionput
    • Get List of Editors for current Pulse Survey Definitionget
    • Get List of Selection (assignment definition) for Receivers of current Pulse Survey Definitionget
    • Get List of Questions for current Pulse Survey Definitionget
    • Update List of Receivers for Pulse Survey Definitionput
    • Create Question for current Pulse Survey Definitionpost
    • Get Question for current Pulse Survey Definitionget
    • Get List of Receivers for current Pulse Survey Definitionget
    • Update Question for current Pulse Survey Definitionput
    • Delete Question in current Pulse Surveydel
    • Order List of Questions for current Pulse Survey Definitionpost
    • Get List of selection (assignment definition) for Editors of current Pulse Survey Definitionget
    • Get Summary Answers for all Questions in current Pulse Surveyget
    • Update List of Editors for Pulse Survey Definitionput
    • Get Summary and Data of Employee Answers for current Questionget
    • Get results of Pulse Survey for employeesget
    • Get List of Editors for current Pulse Survey Definitionget
    • Get part of results of Pulse Survey - number of receivers that completed survey over time.get
    • Get surveyget
    • Save survey answerspost
    • Get List of Questions for current Pulse Survey Definitionget
    • Create comment to survey answerpost
    • Create Question for current Pulse Survey Definitionpost
    • Create reaction to survey answerpost
    • Create reaction to comment to survey answerpost
    • List of Survey Templates created by logged user (as author) or assigned as Editorget
    • Get Question for current Pulse Survey Definitionget
    • Update Question for current Pulse Survey Definitionput
    • Delete Question in current Pulse Surveydel
    • Copies survey templates from a company into the master template set.post
    • Order List of Questions for current Pulse Survey Definitionpost
    • Get List of valid Users which can be assigned as Editors of Pulse Survey Definitionget
    • Get Summary Answers for all Questions in current Pulse Surveyget
    • Get Summary and Data of Employee Answers for current Questionget
    • Get results of Pulse Survey for employeesget
    • Get part of results of Pulse Survey - number of receivers that completed survey over time.get
    • Get surveyget
    • Save survey answerspost
    • Create comment to survey answerpost
    • Create reaction to survey answerpost
    • Create reaction to comment to survey answerpost
    • List of Survey Templates created by logged user (as author) or assigned as Editorget
    • List of Pulse Survey Templates created by logged user (as author) or assigned as Editorget
    • Create Pulse Survey Definition from Templatepost
    • List of Planned Survey Templates created by logged user (as author) or assigned as Editorget
    • Create Planned Survey Definition from Templatepost
    • Get Pulse Survey Definitionget
    • Update Pulse Survey Definitionput
    • Create Pulse Survey Definitionpost
    • Preview first planned survey instance start+end dates.put
    • Pause Planned Pulse Surveyput
    • Unpause Planned Pulse Surveyput
    • List of Planned Surveys Definitions (and their runs) created by logged user (as author) or assigned as Editorget
    • List of Planned Survey instances created from selected survey Definitionget
    • Get List of valid Users which can be assigned as Editors of Pulse Survey Definitionget
  • Team
    • Returns company-level Team EE onboarding counts over a date-range timeline.get
    • Returns company-level team workforce-activity counts over a date-range timeline.get
    • Returns company-level team workforce counts over a date-range timeline.get
    • Returns company-level current-day Team workforce counts.get
    • Returns window-aware filter values for Team workforce counts.get
  • Company Work Location
    • Returns work locations for the specified company.get
    • Creates a company work location.post
    • Returns a single work location for the specified company.get
    • Partially updates an existing company work location.patch
    • Deletes a company work location.del
    • Streams per-item results for creating work locations in bulk.post
    • Streams per-item results for updating work locations in bulk.patch
  • Company Departments
    • Get list of Company Departmentsget
    • Create Company Departmentpost
    • Get Company Departmentget
    • Update Company Departmentpatch
    • Delete Departmentdel
  • Company Divisions
    • Get list of Employees of selected Divisionget
    • Get Company Division informationget
    • Update Company Divisionpatch
    • Delete Divisiondel
    • Activate Company Divisionspost
    • Create Company Divisionpost
    • Create Company Division by Bulkpost
    • Update Company Division Bulkpatch
  • Employees
    • Lists employees for the specified company.get
    • Creates a new employee for the specified company.post
    • Creates a new contract for the employee.post
    • Lists employees assigned to the specified department.get
    • Gets the full employee record for the specified employee.get
    • Partially updates an existing employee record.patch
    • Terminates the specified employee.post
    • Sends an application invitation email to an existing employee.post
    • Checks whether the employee is in the current or future organizational structure for a given date.get
    • Gets the employee's sensitive personal data.get
    • Gets the employee avatar photo metadata.get
    • Uploads a new employee avatar photo.post
    • Gets the employee profile image metadata.get
    • Uploads a new employee profile image.post
    • Gets the employee's timezone information.get
    • Updates the employee's timezone selection.post
    • Gets the employee's emergency contact information.get
    • Creates or updates the employee's emergency contact information.put
    • Updates the employee's consent for electronic W-2 delivery.put
    • Permanently removes an employee record.del
    • Creates multiple employees for the specified company as a streamed response.post
    • Updates the employee's W-2 contact name and mailing address.put
  • Employee Tax Setup
    • Get Current Tax Setupget
    • Update Tax Setup Valuespost
  • EWA Integration
    • Get list of Employees for the EWAget
    • Get EWA Widget for Employeeget
  • Terms
    • Lists current and future contracts for the employee.get
    • Lists historical contracts for the employee.get
    • Gets the contract effective for the requested date.get
    • Gets one contract by identifier.get
    • Partially updates an existing contract.patch
    • Deletes an existing contract.del
  • Employee Form1099
    • Lists all 1099 forms available for the specified employee.get
    • Gets the most recent 1099 form available for the specified employee.get
    • Gets a specific 1099 form for the specified employee.get
  • Employee W-2
    • Lists all W-2 forms available for the specified employee.get
    • Gets the most recent W-2 form available for the specified employee.get
    • Gets a specific W-2 form for the specified employee.get
  • HR Fields Data
    • Lists HR custom-field values for the employee form.get
    • Saves multiple HR custom-field values for the employee form.post
    • Saves a single HR custom-field value for the employee form.post
  • ID Collection
    • Lists identity-document collections for an employee.get
    • Creates a new identity-document collection for an employee.post
    • Gets one identity-document collection for an employee.get
    • Deletes an identity-document collection for an employee.del
    • Updates employee visibility for an identity-document collection.put
    • Replaces one uploaded page in an identity-document collection.put
  • Employees Working Hours
    • Gets the employee's scheduled working time for the current day.get
  • Requests
    • Gets the employee's pending address-change request.get
    • Creates or replaces the employee's pending address-change request.put
    • Deletes the employee's pending address-change request.del
    • Gets the employee's pending contact-information change request.get
    • Creates or replaces the employee's pending contact-information change request.put
    • Deletes the employee's pending contact-information change request.del
    • Lists employee self-service requests.get
    • Gets the employee's pending emergency-contact change request.get
    • Creates or replaces the employee's pending emergency-contact change request.put
    • Deletes the employee's pending emergency-contact change request.del
    • Gets the employee's pending general-information change request.get
    • Creates or replaces the employee's pending general-information change request.put
    • Deletes the employee's pending general-information change request.del
    • Gets the employee's pending name-change request.get
    • Creates or replaces the employee's pending name-change request.put
    • Deletes the employee's pending name-change request.del
    • Gets the employee's pending net-pay-allocation change request.get
    • Creates or replaces a pending change request for an existing net-pay allocation.put
    • Creates or replaces a pending request for a new net-pay allocation.post
    • Deletes the employee's pending net-pay-allocation change request.del
    • Gets the employee's pending question request.get
    • Creates or replaces a pending request to remove a net-pay allocation.post
    • Creates or replaces the employee's pending question request.put
    • Deletes the employee's pending question request.del
    • Gets the employee's pending identification-number change request.get
    • Creates or replaces the employee's pending identification-number change request.put
    • Deletes the employee's pending identification-number change request.del
    • Creates or replaces a pending net-pay-allocation request that references an employee bank account.post
  • Employee Bank Accounts
    • Lists bank accounts available for the employee.get
    • Creates a new bank account for the employee.post
    • Gets one bank account for the employee.get
    • Deletes a bank account for the employee.del
  • Setup
    • Returns the onboarding templates that can be used for the company.get
    • Creates a new onboarding and returns the initial setup workflow metadata.post
  • Phase: 1) Settings
    • Saves the employer-entered basic employee information for phase 1.put
    • Returns the saved basic employee information for phase 1.get
    • Saves phase-1 employment basics such as hire dates and distribution settings.put
    • Returns the saved phase-1 employment basics for the onboarding.get
    • Saves detailed U.S. employment settings for the onboarding.put
    • Returns saved detailed U.S. employment settings for the onboarding.get
    • Saves detailed global-employment settings for the onboarding.put
    • Returns saved detailed global-employment settings for the onboarding.get
    • Returns employer-side HR custom fields for the phase-1 setup step.get
    • Saves phase-1 HR custom-field values and advances the onboarding step state.put
    • Saves phase-1 HR custom-field values without completing the step.put
    • Returns which employee personal-information fields are currently required.get
    • Prefills the employee personal-information step from the employer side.put
    • Returns which employee contact-information fields are currently required.get
    • Prefills the employee contact-information step from the employer side.put
    • Returns custom client-admin access settings for the onboarding.get
    • Updates custom client-admin access settings for the onboarding.post
    • Downloads the default Word template for onboarding documents.get
    • Lists active onboarding document templates configured for the onboarding.get
    • Uploads a new onboarding document template.post
    • Returns a single onboarding document template with its download token and required custom fields.get
    • Updates metadata and required custom fields for an onboarding document template.put
    • Soft-deletes an onboarding document template.del
    • Completes the setup document step and returns the next required onboarding step.post
  • Phase: 2) Onboarding New Hire
    • Returns employee-facing HR custom fields for phase 2 onboarding.get
    • Saves employee-provided HR custom field values for phase 2 onboarding.put
  • Phase: 2) Onboarding New Hire - Overview
    • Returns the employee HR-field answers for employer-side review.get
  • Phase: 3) Verification
    • Finalizes the onboarding and creates the employee record.put
    • Returns the employee's net-pay allocation records for verification.get
    • Marks the net-pay verification step as completed.put
    • Returns document-signing previews and signature requirements for verification.get
    • Completes the document-signing verification step.put
    • Returns the list of handwritten documents that can or must be uploaded.get
    • Uploads a manually signed or handwritten document for the verification workflow.post
    • Returns preview images for Form 8850.get
    • Returns preview images for the W-9 form under review.get
    • Saves the employer verification data for Form 8850.put
    • Returns the current Form 8850 verification data.get
    • Returns preview images for Form I-9.get
    • Returns the stored Form I-9 verification data for the onboarding.get
    • Marks the Form I-9 verification step as completed.put
    • Saves Form I-9 verification data for non-resident-alien employees.put
    • Saves Form I-9 verification data for resident-alien employees.put
    • Saves Form I-9 verification data for U.S. citizen or permanent-resident employees.put
    • Returns uploaded I-9 identity-document images for employer review.get
    • Marks the I-9 identity-document review step as completed.put
    • Returns the tax-setup data that must be verified before finalization.get
    • Marks the tax-setup verification step as completed.put
    • Updates a single net-pay allocation row during verification.put
    • Downloads a generated form that should be signed or completed outside the portal.get
    • Marks the Form 8850 verification step as completed.put
    • Marks the W-9 review step as completed.put
  • Overview
    • Lists onboardings for the specified company.get
    • Generates the employee-facing onboarding URL.get
    • Discards the onboarding record.get
    • Returns the verification-step status list for the onboarding.get
    • Transfers the onboarding lock to the current authorized user.get
    • Returns phase-1 continuation information for the onboarding.get
  • Finalize_v10
    • Assigns a manager to the onboarding before finalization completes.put
  • Payroll Policies
    • Payroll Policy Infoget
    • List of Company Policiesget
    • Create Payroll Policypost
    • Payroll Policy Infoget
    • Allows changing Payroll Policypatch
    • Removes Payroll Policydel
    • Get Policy Schedule Calendarget
    • Named Payroll Policy Infoget
    • List of Policy Employeesget
    • Assign Employee to a Policypost
    • Checks the Policy for eligibility to be run automaticallyget
    • Assign Employees to a Policy (bulk)post
  • Payroll Basic
    • Start Default Payrollpost
    • Skip Default Payrollpost
    • Retrieve Payroll Statusget
    • Next Payroll Steppost
    • Previous Payroll Steppost
    • Discard Payrollpost
    • Finalize payroll.post
  • Void Payroll
    • Get Years For Void Payrollget
    • Start Void Payrollpost
    • Get Employees For Void Payrollget
    • Get Payrolls For Void Payrollget
    • Get Employee Pay Stubs For Void Payrollget
    • Get Years For Void Named Payrollget
    • Get Employees For Void Named Payrollget
    • Get Payrolls For Void Named Payrollget
    • Get Employee Pay Stubs For Void Named Payrollget
    • Get Years For Void Payroll by Policy IDget
    • Get Employees For Void Payroll by Policy IDget
    • Get Payrolls For Void Payroll by Policy IDget
    • Get Employee Pay Stubs For Void Payroll by Policy IDget
  • Employee Payroll
    • List of current year payrollsget
    • List of scheduled payrollsget
    • List of years with any payroll for employeeget
    • List of payrolls for yearget
    • Get payrollget
    • Get payrollget
  • Earning Codes
    • Get list of Earning Code presetsget
    • Get list of Earning Codesget
    • Create Earning Codepost
    • Get Earning Code informationget
    • Update Earning Codepatch
    • Delete Earning Codedel
    • Create Earning Code Bulkpost
  • Pay Allocations
    • Get list of Pay Allocationsget
    • Create Pay Allocationpost
    • Get Pay Allocationget
    • Update Pay Allocationpatch
    • Delete Pay Allocationdel
    • Create Pay Allocationpost
    • Update Pay Allocationpatch
  • Employee Status
    • Employee status for payrollpost
    • Employee validity for payrollpost
  • Payroll Advanced
    • Get Paystubget
    • Get Paystub (extended data)get
    • Start Named Payrollpost
    • Start Bonus Payrollpost
    • Start Off-Cycle Payrollpost
    • Skip Named Payrollpost
    • Start Payrollpost
    • Get data for payment authorization pageget
    • Payroll Overviewget
    • Skip Payroll by Policy IDpost
    • Payroll Overview Transaction Detailget
    • Payroll Overview Check Detailget
  • Payroll Information & History
    • Payroll History Overviewget
    • List of Payrolls.get
    • List of Scheduled Payrollsget
    • Payroll Historyget
    • Get payroll Uncollected Taxesget
    • Payroll Overviewget
    • Default Payroll Historyget
    • Named Payroll Historyget
    • Get Running Payrolls for a Companyget
    • Get Running Payrolls for adminget
    • Payroll History.get
    • Payroll History Countget
    • Default Payroll Countget
    • Named Payroll Countget
    • Payroll Overview Check Detailget
    • Payroll Overview Transaction Detailget
    • Payroll History Overview Transaction Detailget
    • Payroll History Overview Check Detailget
  • Timesheet
    • Get list of Earningsget
    • Get Earnings setupget
    • Update Earningspatch
    • Remove deductiondel
    • Add new miscellaneous deductionpost
    • Add existing deductionpost
    • Change Payroll Pay Datepatch
    • Add new paystubpost
    • Employees in running payrollget
    • Adds the specified employees to a payroll run and streams progress updates to the client using Server-Sent Events (SSE).post
    • Remove paylinedel
    • Add paylinepost
  • Termination Payroll
    • Start Termination Payrollpost
    • Terminated employees in all policiesget
    • Terminated employees by Policy IDget
  • Payroll Gross-Up
    • Get payroll Gross upget
    • Add new payroll Gross uppost
    • Update payroll Gross uppatch
    • Remove payroll Gross updel
  • Payroll Checks
    • Payroll Checks Generating progressget
    • Payroll Checks Generating progressget
    • Get FileToken to download Payroll Checksget
  • Payroll Messages
    • Get a list of payroll paylines messagesget
    • Get a list of payline messagesget
  • Company Pay Codes
    • Returns client pay codes for a specific company.get
  • Unblock Payroll
    • Unblock Payrollpost
  • Onboarding
  • YTD Payroll Setup
  • Company Benefits
  • Employee Benefits
  • Employee Deductions
  • Company Benefits Groups
  • Dashboard
    • Gets the current admin dashboard definition.get
    • Saves the widget order and visibility for the current admin dashboard.post
    • Gets a single widget from the current admin dashboard.get
    • Gets the dashboard definition for a specific company.get
    • Saves the widget order and visibility for a specific company dashboard.post
    • Gets a single widget from a specific company dashboard.get
    • Gets the dashboard definition for a specific employee.get
    • Saves the widget order and visibility for a specific employee dashboard.post
    • Gets a single widget from a specific employee dashboard.get
    • Gets the example schema container for dashboard widget data payloads.get
  • Job and Project Costing
    • Get list of Segmentsget
    • Creates new Segmentpost
    • Retrieves Segment informationget
    • Removes Segmentdel
    • Update Segment informationpatch
    • Get list of Cost Codesget
    • Create Cost Codepost
    • Retrieves Cost Code informationget
    • Update Cost Codepatch
    • Delete Cost Codedel
    • Get a list of Job Costing Segmentsget
    • Create Cost Code in Bulkpost
    • Update Cost Code By Bulkpatch
  • Reports
    • Create Deduction Benefit Register Reportpost
    • Create Companies Reportpost
    • Create SUTA Rates Reportpost
    • Create Terminated Companies Reportpost
    • Create Deduction Benefit Roster Reportpost
    • Create Employees Arrears Reportpost
    • Create Deduction Benefit Register Reportpost
    • Create Deduction Benefit Roster Reportpost
    • Create Employees Arrears Reportpost
    • Create Employee Direct Deposit Register Reportpost
    • Create Employee Direct Deposit Roster Reportpost
    • Create Employee Overview Reportpost
    • Create Scheduled Pay Reportpost
    • Create Unpaid Active Employee List Reportpost
    • Create Employee Overview Reportpost
    • Create Birthday List Reportpost
    • Create Employee Tax Setup Reportpost
    • Create Employee Termination Reportpost
    • Create Employment Details Reportpost
    • Create Net Pay Allocation Roster Reportpost
    • Create Scheduled Pay Reportpost
    • Create Unpaid Active Employee List Reportpost
    • Create Cash Requirements Reportpost
    • Create FICA Tip Credit Reportpost
    • Create Hours Earnings Recap Reportpost
    • Create Job Costing Reportpost
    • Create Payroll Recap Reportpost
    • Create Payroll Recap Employee Reportpost
    • Create Payroll Recap Exportpost
    • Create Payroll Register Reportpost
    • Create Time Entry Reportpost
    • Create Time Entry Sheet Reportpost
    • Create Hours Earnings Recap Reportpost
    • Create Payroll Recap Reportpost
    • Create Payroll Recap Employee Reportpost
    • Create Payroll Register Reportpost
    • Create Time Entry Reportpost
    • Create Time Entry Sheet Reportpost
    • Create Daily Federal Tax Liability Reportpost
    • Create Daily State Tax Liability Reportpost
    • Get Existing Reportget
    • Get Existing Report Fileget
    • Create Worker's Compensation History Reportpost
    • Create Worker's Compensation History Reportpost
  • Workers' Compensation
  • TimeOff Policy - Company
    • Get list of TimeOff Policiesget
    • Create TimeOff Policypost
    • Get TimeOff Policy informationget
    • Deactivate TimeOff Policyput
    • List of Presetsget
  • TimeOff Groups - Company
    • Get list of TimeOff Policiesget
  • TimeOff Policy - Employee Transactions
    • Get a list of Time Off transactions, sorted from newest to oldest.get
    • Create a new "Manual Adjustment" Time Off transactionpost
    • Delete a "Manual Adjustment" Time Off transaction.del
    • Update a "Manual Adjustment" Time Off transaction.patch
  • TimeOff Policy - Employee
    • Returns balance for employee and policy.get
    • Get a list of active time off policies assigned to the employee, including hours used, balance, and other relevant statistics. All statistics are in minutes.get
    • Initial setup to Employee's TimeOff Policypost
    • Gets participation limits (%) for Employee's TimeOff Policyget
    • Sets participation limits (%) for Employee's TimeOff Policyput
    • Deactivate Employee's TimeOff Policyput
  • Employee TimeOff Requests
  • Employee TimeOff Request
  • Company TimeOff Requests
  • Company TimeOff Request
  • Company TimeOff Request Types
  • Company TimeOff Request Type
  • Company TimeOff Request Setup
  • Admin Logins
    • Create Admin Loginpost
    • Lists company admin logins for the specified company.get
    • Update Admin Loginpatch
    • Gets a company admin login by login identifier.get
    • Blocks a company admin login.patch
    • Create Admin Loginpost
    • Lists company admin logins for the specified company.get
    • Update Admin Loginpatch
    • Gets a company admin by company admin identifier.get
    • Blocks a company admin login.patch
    • Returns all client-admin and PEO/system-admin overview records for a company.get
  • Multi Admin Logins
    • Lists system admin and multi-admin accounts visible to the current caller.get
    • Creates a new system admin or multi-admin account.post
    • Gets one system admin or multi-admin account.get
    • Update Admin Loginpatch
    • Deactivates a system admin or multi-admin account.patch
    • Activates a system admin or multi-admin account.patch
  • Address Validation
    • Address Validationpost
  • Registrations
    • Get list of new user and company registrations and their current status.get
    • Get detailed info about new user and companies registration and current status.get
  • White-Labeling & Brands
    • Gets the resolved brand setup for a specific company.get
    • Uploads the light logo for a specific company.post
    • Uploads the dark-theme logo for a specific company.post
    • Uploads the favicon for a specific company.post
    • Uploads the standard application icon for a specific company.post
    • Uploads the dark-theme application icon for a specific company.post
    • Updates the branded application name for a specific company.post
    • Updates the custom color payload for a specific company.post
    • Gets brand setup by resolving the supplied RCU token.get
    • Gets the brand setup resolved for the current caller context.get
    • Uploads the light logo for the caller's resolved brand scope.post
    • Uploads the dark-theme logo for the caller's resolved brand scope.post
    • Uploads the favicon for the caller's resolved brand scope.post
    • Uploads the standard application icon for the caller's resolved brand scope.post
    • Uploads the dark-theme application icon for the caller's resolved brand scope.post
    • Updates the branded application name for the caller's resolved brand scope.post
    • Updates the custom color payload for the caller's resolved brand scope.post
    • Updates the support email address for the caller's resolved brand scope.post
    • Updates the support phone number for the caller's resolved brand scope.post
  • Company Access Policy
    • Gets the effective employee application access policy for the company.get
    • Updates the employee application access policy for the company.post
  • General
    • Lists active custom termination reasons.get
    • Creates a custom termination reason.post
    • Gets a custom termination reason by identifier.get
    • Updates an existing custom termination reason.patch
    • Soft-deletes a custom termination reason.del
    • Lists active gender identities.get
    • Lists the current effective NAICS codes.get
    • Lists supported time zones.get
  • Employees Access
    • Lists employees together with their employee-portal access state.get
    • Configures employee-portal access for a single employee.post
    • Configures employee-portal access for multiple employees.post
  • Files
    • Exchanges a file token for short-lived download metadata.get
    • Downloads a file by short-lived download token.get
    • Streams a file for inline preview by short-lived download token.get
    • Downloads a single employee avatar by file token.get
    • Downloads up to 10 employee avatars and returns them in a top-level JSON array.post
  • Notifications
    • Returns older comments for a post, pin, or survey thread.get
    • Returns older comments for a post, pin, or survey thread.get
    • Returns older comments for a post, pin, or survey thread.get
    • Updates an existing comment.patch
    • Updates an existing comment.patch
    • Updates an existing comment.patch
    • Returns the first page of notifications for the current system context.get
    • Returns the first page of notifications for a selected company.get
    • Returns the first page of notifications for an employee-scoped request.get
    • Returns notifications created after a previously received notification.get
    • Returns company-scoped notifications created after a previously received notification.get
    • Returns employee-scoped notifications created after a previously received notification.get
    • Returns older notifications before a previously received notification.get
    • Returns older notifications before a previously received notification for a selected company.get
    • Returns older notifications before a previously received notification for an employee-scoped request.get
    • Marks a notification as read.get
    • Marks a company-scoped notification as read.get
    • Marks an employee-scoped notification as read.get
    • Marks a notification as dismissed.get
    • Marks a company-scoped notification as dismissed.get
    • Marks an employee-scoped notification as dismissed.get
    • Refreshes the current state of specific notifications.post
    • Refreshes the current state of specific notifications for a selected company.post
    • Refreshes the current state of specific notifications for an employee-scoped request.post
    • Returns survey-answer messaging items for a company-scoped route with both parent and reference identifiers.get
    • Returns survey-answer messaging items for a company-scoped route filtered by parent identifier.get
    • Returns survey-answer messaging items for an employee-scoped route filtered by parent identifier.get
    • Returns survey-answer messaging items that currently have comments or reactions.get
    • Removes a reaction from a post, pin, or survey item.del
    • Removes a reaction from a post, pin, or survey item.del
    • Removes a reaction from a post, pin, or survey item.del
    • Removes a reaction from a comment.del
    • Removes a reaction from a comment.del
    • Removes a reaction from a comment.del
    • Refreshes the current state of mixed messaging feed items.post
    • Refreshes the current state of mixed messaging feed items for a selected company.post
    • Refreshes the current state of mixed messaging feed items for an employee-scoped request.post
  • Support Chat Info
    • Get Support Chat Infoget
    • Get Support Chat Infoget
  • Web Hooks
    • List Registered Company WebHooksget
    • Create Company WebHook Registrationpost
    • List Registered WebHooksget
    • Create WebHook Registrationpost
    • Get Company WebHook Registrationget
    • Delete Company WebHook Registrationdel
    • Get WebHook Registrationget
    • Delete WebHook Registrationdel
    • Test Company WebHook Registrationget
    • Test WebHook Registrationget
  • List of Fees
    • List of fees configurations for a all clients.get
  • List of Fee Configurations
    • List of fees configurations for a specific client.get
  • List of All Billing History
    • List of billing history for all clients.get
  • List of Billing History
    • List of billing history for a specific client.get
  • Employee Benefits And Deductions
    • Gets the employee benefits overview.get
    • Gets the detail of a single employee benefit or deduction.get
    • Gets the employee benefits-and-deductions summary grouped by category.get
  • Benefits Enrollment
    • Create New Hire Enrollmentpost
    • Create Open Enrollmentpost
    • Create QLE Enrollmentpost
    • Get enrollments for clientget
  • Employees Event Life Requests
    • List of employees Event Life Requests.get
    • List of employees Event Life Requests.get
    • Get Employees Event Life Request.get
    • Update Life Event Request.patch
    • Delete Live Event Request.del
    • Get Employees Event Life Request.get
    • Update Life Event Request.patch
    • Delete Live Event Request.del
    • List Of Available Life Event Types.get
    • List Of Available Life Event Types.get
    • Create Life Event Request.post
    • Create Life Event Request.post
  • Company Benefits
    • List of Benefit Templatesget
    • Create Benefit Templatepost
    • Update Benefit Templatepatch
    • Delete Benefit Templatedel
    • List of Company Benefitsget
    • List of Assigned Employeesget
  • Employee Benefits
    • List of Employee Benefit Deductionsget
    • Create Employee Benefitpost
    • Get Employee Benefitget
    • Update Employee Benefitpatch
    • Delete Employee Benefit Deductiondel
  • Employee Deductions
    • List of Current Deductionsget
    • Get Child Support Deductionget
    • Update Child Support Deductionpatch
    • List of Child Support Deductionsget
    • Create Child Support Deductionpost
    • List of Employee Deduction Historyget
    • Get Miscellaneous Deductionget
    • Update Miscellaneous Deductionpatch
    • List of Miscellaneous Deductionsget
    • Create Miscellaneous Deductionpost
  • Company Benefits Groups
    • List of Benefit Groupsget
  • Employee's Policy
    • Get timeoff request employee's policyget
    • Update timeoff request employee's policyput
  • TimeOff Requests Policies
    • Get list of timeoff request policiesget
    • Update timeoff request policypatch
  • TimeOff Requests
    • Get list of timeoff requestsget
    • Create timeoff requestpost
    • Gets information about current role.get
    • Retrieves timeoff request informationget
    • Update timeoff requestput
    • Remove time off requestdel
    • Calculate durationpost
    • Calculate balancepost
    • Cancel time off requestpost
    • Approve timeoff requestput
    • Deny timeoff requestput
  • TimeOff Requests Types
    • Get list of timeoff request typesget
    • Create timeoff request typepost
    • Update timeoff request typeput
    • Remove timeoff request typedel
  • Workers' Compensation
    • Get list of Workers' Compensation Codesget
    • Get list of Workers' Compensation Codes for specified companyget
    • Get list of Workers' Compensation Codes for specified company and divisionget
    • Get list of Workers' Compensation Codes for specified company and stateget
    • Get list of Workers' Compensation Codes for specified company, division and stateget
    • Get list of Workers' Compensation Codes for specified employeeget
    • Get list of Workers' Compensation Company Ratesget
    • Create Workers' Compensation Company Ratepost
    • Get Workers' Compensation Company Rateget
    • Update Workers' Compensation Company Ratepatch
  • Onboarding
    • Gets whether prior payroll history import is completed for the company onboarding flow.get
  • YTD Payroll Setup
    • Start Setup Payrollpost
    • Get Setup Payroll Statusget
    • Discard Setup Payrollpost
    • Get Eligible Employeesget
    • Get Employeesget
    • Add Employeespost
    • Remove Employeedel
    • Get Quarter Dataget
    • Save Datapost
    • Get Paystub Dataget
    • Get Paystub Dataget
    • Save WagesReceivedpost
    • Add Paystubpost
    • Update Paystubput
    • Remove Paystubdel
    • Get Quarters Overviewget
    • Process Datapost
    • Finish Setup Payrollpost
  • Create
    • Lists employees for whom a new W-4 request can be created.get
    • Creates a new W-4 request for an employee.post
  • Overview
    • Lists W-4 requests that are visible to the caller for the specified company.get
    • Generates the workflow URL for a W-4 request.get
    • Gets detailed metadata for a single W-4 request.get
    • Cancels an existing W-4 request.del
  • Verification
    • Downloads a generated W-4 document for the request.get
    • Uploads a manually signed W-4 document for employer verification.post
    • Loads the tax setup data used during W-4 verification.get
    • Finalizes the tax setup step for W-4 verification.put
    • Returns the current employer verification status for a W-4 request.get
    • Finalizes a verified W-4 request.put
  • ClientGL Export Connectors
    • Returns a list of supported third-party connectorsget
    • Returns the currently activated third-party connector.get
    • Returns current settings for QuickBooks Online connector.get
    • Sets settings for QuickBooks Online connector.put
    • Returns OAuth Authorization URL for selected Connector API.get
    • Disconnects from the Thidr-party app (such as QuickBooks Online).post
    • Deactivates (discards) the Connector.post
  • ClientGL Simplified Mapping
    • Returns list of Bank Accounts for active Connectorget
    • Returns simplified mapping records for active Connector.get
    • Updates simplified mapping records for active Connector.put
  • ClientGL Exports
    • Gets a list of ClientGL Journal Entry exports.get
    • Starts exporting the given list of payrolls using the current export connector.post
    • Returns details of a ClientGL Journal Entry export record.get
    • Deletes ClientGL Journal Entry export record.del
    • Retries a failed ClientGL Journal Entry export.post
    • Returns a detailed list of exported items.get
    • Returns a list of warning/error messages that occurred during the export process.get
  • OAuth endpoints
    • This endpoint is used to receive authorization tokens from QuickBooks Online and other third-party apps.get
  • ClientGL Payrolls
    • Gets list of payrolls for given criteria.get
  • Overview
    • Events Typesget
    • List of Policiesget
    • Get summarized Time Attendance for a single dayget
    • Get summarized Time Attendance for a date rangeget
    • Get team summarized Time Attendance for a date rangeget
  • Time Clock
    • Get current employee Time Clock statusget
    • Start a new Time Clock eventpost
    • Start a new work eventpost
    • End the current Time Clock eventpost
    • Delete a Time Clock eventdel
    • Update a Time Clock eventput
    • Create a new Time Clock eventpost
    • Returns current company time attendance statuses together with referenced event type definitions.get
    • Transfer Work Setuppost
    • Get detailed daily eventsget
  • Missing Breaks
    • Breaks from Policiesget
    • Resolve Rest Breaksput
    • Resolve Meal Breaksput
  • Approving
    • Gets attestation messages for the employee approval period.get
    • Approves or disapproves reported time for a date range.post
  • Change Log
    • Time Clock - Event Change Logget
    • Load changesget
    • Timesheet - Event Change Logget
    • Resolve Change Logpost
  • Notes
    • Lists day-level Timecard Notes write permissions for every calendar day in an employee date range.get
    • Lists current notes for an employee day or date range.get
    • Creates a new standalone note or reply for the requested employee day.post
    • Creates a new current version for an existing note.put
    • Soft-deletes the current note version.del
    • Returns the full version chain for a single logical note.get
  • Timesheet
    • Get Timesheet eventsget
    • Create a Timesheet Work Setuppost
    • Create a Timesheet eventpost
    • Update a Timesheet eventput
    • Delete events for a specific daydel
    • Update a Timesheet Work Setuppost
Powered by 
  1. Benefits & Deductions API

Employee Deductions

Updated 10 months ago


Unblock Payroll
Company Benefits Groups
Did this page help you?

Updated 10 months ago


Unblock Payroll
Company Benefits Groups
Did this page help you?