Jump to Content
Check APIGuidesReferenceChangelogAPI Upgrades
GuidesReference
GuidesReferenceChangelogAPI UpgradesCheck API
Reference

Check API

  • Introduction

Topics

  • Authentication
  • Errors
    • Error codes
    • Rate limiting
    • Errors during payroll preview
  • Idempotent Requests
  • Versioning

Check Components

  • Overview of Components
  • Setup Components
    • Company Previous Payroll Provider Accesspost
    • Company Progress Tracker Componentpost
    • Company Verification Documentspost
    • Company Signatory Agreementspost
    • Company Connect Bank Accountpost
    • Company Team Setuppost
    • Company Pay Historypost
    • Company Full Service Setup Submission Componentpost
    • Company Business Details Componentpost
    • Employee Tax Setup Componentpost
  • Company Components
    • Company Onboardpost
    • Company Terms of Servicepost
    • Company Detailspost
    • Company Payment Setuppost
    • Company Tax Setuppost
    • Company-Defined Employee Setuppost
    • Company Filing Authorizationpost
    • Company Accounting Integrationpost
    • Company Authorization Documentspost
    • Company Tax Documentspost
    • Company Reportspost
    • Run Payrollpost
    • Company Checklist Componentpost
    • Filing Preview Componentpost
  • Employee Components
    • Employee Onboardpost
    • Employee SSN Setuppost
    • Employee Payment Setuppost
    • Employee Withholdings Setuppost
    • Employee Profilepost
    • Employee Benefitspost
    • Employee Post-Tax Deductionspost
    • Employee Tax Documentspost
    • Employee Paystubspost
  • Contractor Components
    • Contractor Onboardpost
    • Contractor Tax Documentspost

API Reference

  • Companies
    • The company object
    • Create a companypost
    • Get a companyget
    • Update a companypatch
    • List companiesget
    • Get payroll journalget
    • Get payroll summaryget
    • Get tax liability reportget
    • Get company paydaysget
    • Get contractor payments reportget
    • Get W-2 Preview Reportget
    • Get W-4 Exempt Status Reportget
    • The Federal EIN Verification object
    • List Federal EIN Verificationsget
    • Get a Federal EIN Verificationget
    • List tax depositsget
    • The Signatory object
    • Get signatoriesget
    • Create a signatorypost
    • The Enrollment Profile object
    • Get the enrollment profileget
    • Create the enrollment profileput
    • Update the enrollment profilepatch
    • Get a company's applied-for tax parameters reportget
    • Implementation
      • Start implementationpost
      • Cancel implementationpost
      • Request Embedded Setuppost
  • Addresses
    • Validate addresspost
  • Workplaces
    • The workplace object
    • Create a workplacepost
    • Get a workplaceget
    • Update a workplacepatch
    • List workplacesget
  • Employees
    • The employee object
    • Create an employeepost
    • Get an employeeget
    • Update an employeepatch
    • List employeesget
    • List employee paystubsget
    • Get a paystubget
    • List employee formsget
    • Get an employee formget
    • Submit an employee formpost
    • Get company-defined attributesget
    • Update company-defined attributespatch
    • Get reciprocity electionsget
    • Update reciprocity electionspatch
    • Reveal employee SSNget
  • Contractors
    • The contractor object
    • Create a contractorpost
    • Get a contractorget
    • Update a contractorpatch
    • List contractorsget
    • List contractor paymentsget
    • Get a contractor pay statementget
    • List contractor formsget
    • Submit a contractor formpost
    • Reveal contractor SSNget
  • Bank Accounts
    • The bank account object
    • Create a bank accountpost
    • Update a bank accountpatch
    • Get a bank accountget
    • List bank accountsget
    • Delete a bank accountdelete
    • Reveal account numberget
  • Net Pay Splits
    • The net pay split object
    • Create a net pay splitpost
    • Get a net pay splitget
    • List net pay splitsget
  • Payrolls
    • The payroll object
      • The preview object
      • The totals object
      • The off-cycle options object
      • The warnings object
    • Create a payrollpost
    • Preview a payrollget
    • Reopen a pending payrollpost
    • Approve a payrollpost
    • Get a payrollget
    • Update a payrollpatch
    • List payrollsget
    • Delete a payrolldelete
    • Get paper checksget
    • Get Cash Requirement Reportget
    • Get Paper Checks Reportget
  • Payroll Items
    • The payroll item object
      • The earning object
    • Types of earnings
    • Create a payroll itempost
    • Get a payroll itemget
    • Update a payroll itempatch
    • List payroll itemsget
    • Delete a payroll itemdelete
    • Get a paper checkget
    • Warnings
  • Contractor Payments
    • The contractor payment object
    • Create a contractor paymentpost
    • Get a contractor paymentget
    • Update a contractor paymentpatch
    • List contractor paymentsget
    • Delete a contractor paymentdelete
    • Get a paper checkget
  • External Payrolls
    • The external payroll object
      • The external payroll item object
      • The external payroll contractor payment
    • List external payrollsget
    • Get an external payrollget
    • Create an external payrollpost
    • Update an external payrollpatch
    • Delete an external payrolldelete
    • Approve an external payrollpost
    • Reopen an external payrollpost
    • Preview an external payrollget
  • Pay Schedules
    • The pay schedule object
    • Create a pay schedulepost
    • Get a pay scheduleget
    • List pay schedulesget
    • Update a pay schedulepatch
    • Get paydaysget
  • Benefits
    • The benefit object
    • Types of benefits
    • Create a benefitpost
    • Get a benefitget
    • List benefitsget
    • Update a benefitpatch
    • Delete a benefitdelete
  • Post-Tax Deductions
    • The post-tax deduction object
    • Create a post-tax deductionpost
    • Get a post-tax deductionget
    • Update a post-tax deductionpatch
    • List post-tax deductionsget
    • Delete a post-tax deductiondelete
  • Company Benefits
    • The company benefit object
    • Create a company benefitpost
    • Get a company benefitget
    • List company benefitsget
    • Update a company benefitpatch
    • Delete a company benefitdelete
  • Earning Rates
    • The earning rate object
    • Create an earning ratepost
    • Get an earning rateget
    • List earning ratesget
    • Update an earning ratepatch
  • Earning Codes
    • The earning code object
    • Create an earning codepost
    • Get an earning codeget
    • List earning codesget
    • Update an earning codepatch
  • Documents
    • The document object
    • List company tax documentsget
    • Get a company tax documentget
    • Download a company tax documentget
    • List company authorization documentsget
    • Get a company authorization documentget
    • Download a company authorization documentget
    • List employee tax documentsget
    • Get an employee tax documentget
    • Download an employee tax documentget
    • List contractor tax documentsget
    • Get a contractor tax documentget
    • Download a contractor tax documentget
    • List setup documentsget
    • Get a Setup Documentget
    • Download a setup documentget
  • Company Provided Documents
    • The company provided document object
    • Create a company provided documentpost
    • Get a company provided documentget
    • List company provided documentsget
    • Upload a file for a company provided document.put
  • Forms
    • The form object
    • Get a formget
    • List formsget
    • Render a formpost
  • Payments
    • The payments and payment attempts objects
    • List paymentsget
    • Get a paymentget
    • Get a payment attemptget
    • Retry a paymentpost
    • Refund a paymentpost
    • Cancel a paymentpost
  • Tax Parameters
    • The tax parameter object
    • Types of tax parameters
    • Tax parameter option
    • Tax parameter dependency
    • Tax parameter setting
    • Tax parameter jurisdiction
    • Tax parameter definition
    • Company Tax Parameters
      • List a company's tax parametersget
      • Update a company's tax parameterspatch
      • List a company's tax parameter settingsget
      • Get a specific company's tax parameter settingget
      • List a company's jurisdictionsget
    • Employee Tax Parameters
      • List an employee's tax parametersget
      • Update an employee's tax parameterpatch
      • List an employee's tax parameter settingsget
      • Get a specific employee's tax parameter settingget
      • List an employee's jurisdictionsget
      • Bulk get employee tax parametersget
      • Bulk get employee tax parameter settingsget
      • Bulk update employee tax parameterspatch
  • Tax Elections
    • The tax election object
    • Company Tax Elections
      • List company tax electionsget
      • Create company tax electionspost
      • Update company tax electionspatch
    • Employee Tax Elections
      • List employee tax electionsget
      • Update employee tax electionspatch
  • Tax Filings
    • The tax filing object
    • The tax filing event object
    • Tax filing status
    • List tax filingsget
    • Get a tax filingget
    • Get a tax filing eventget
  • Setup
    • The setup object
    • Get a setupget
    • List setupsget
  • Requirements
    • The requirement object
    • Requirement categories
    • Requirement statuses
    • Requirement errors
    • Requirement guidance
    • List requirementsget
    • Get a requirementget
  • Webhooks
    • The webhook config object
    • Create a webhook configpost
    • Get a webhook configget
    • Update a webhook configpatch
    • Delete a webhook configdelete
    • List webhook configsget
    • Ping a webhook configpost
    • Retry webhook event in sandboxpost
  • Notifications
    • The notification object
      • Types of notification topics
    • List notificationsget
    • Get a notificationget
  • Communications
    • The communication object
      • The email object
    • List communicationsget
    • Get a communicationget
  • Usage
    • List usage summariesget
    • List usage recordsget

Employee Tax Parameters

Tax parameter actions available on the employee object

Available actions

  • List an employee's tax parameters
  • Update an employees tax parameter
  • List an employee's tax parameter settings
  • Get a specific employee tax parameter setting
  • List an employee's jurisdictions