/

Docs
History
Schema
Generate

Filter operations

post/companies/{company}/components/previous_provider_accessCompany Previous Payroll Provider Access
post/companies/{company}/components/progress_trackerCompany Progress Tracker Component
post/companies/{company}/components/verification_documentsCompany Verification Documents
post/companies/{company}/components/early_enrollmentCompany Early Enrollment
post/companies/{company}/components/signatory_agreementsCompany Signatory Agreements
post/companies/{company}/components/connect_bank_accountCompany Connect Bank Account
post/companies/{company}/components/team_setupCompany Team Setup
post/companies/{company}/components/team_setup/employeesEmployee Roster
post/companies/{company}/components/team_setup/contractorsContractor Roster
post/companies/{company}/components/team_setup/workplacesWorkplace Roster
post/companies/{company}/components/team_setup/personal_detailsPersonal Details
post/companies/{company}/components/pay_historyCompany Pay History
post/companies/{company}/components/full_service_setup_submissionCompany Full Service Setup Submission Component
post/companies/{company}/components/business_detailsCompany Business Details Component
post/employees/{employee}/components/tax_setupEmployee Tax Setup Component
post/companies/{company}/onboardCompany Onboard
post/companies/{company}/components/terms_of_serviceCompany Terms of Service
post/companies/{company}/components/detailsCompany Details
post/companies/{company}/components/payment_setupCompany Payment Setup
post/companies/{company}/components/tax_setupCompany Tax Setup
post/companies/{company}/components/employee_setupCompany-Defined Employee Setup
post/companies/{company}/components/filing_authorizationCompany Filing Authorization
post/companies/{company}/components/accounting_integrationCompany Accounting Integration
post/companies/{company}/components/authorization_documentsCompany Authorization Documents
post/companies/{company}/components/tax_documentsCompany Tax Documents
post/companies/{company}/components/company_reportsCompany Reports
post/companies/{company}/components/run_payrollRun Payroll
post/companies/{company}/components/checklistFiling Preparation Checklist Component
post/companies/{company}/components/filing_previewFiling Preview Component
post/employees/{employee}/onboardEmployee Onboard
post/employees/{employee}/components/ssn_setupEmployee SSN Setup
post/employees/{employee}/components/payment_setupEmployee Payment Setup
post/employees/{employee}/components/withholdings_setupEmployee Withholdings Setup
post/employees/{employee}/components/profileEmployee Profile
post/employees/{employee}/components/benefitsEmployee Benefits
post/employees/{employee}/components/post_tax_deductionsEmployee Post-Tax Deductions
post/employees/{employee}/components/tax_documentsEmployee Tax Documents
post/employees/{employee}/components/paystubsEmployee Paystubs
post/contractors/{contractor}/onboardContractor Onboard
post/contractors/{contractor}/components/tax_documentsContractor Tax Documents
post/contractors/{contractor}/components/paystubsContractor Paystubs
get/companiesList companies
post/companiesCreate a company
get/companies/{company}Get a company
patch/companies/{company}Update a company
get/companies/{company}/reports/payroll_journalGet payroll journal
get/companies/{company}/reports/tax_liabilitiesGet tax liability report
get/companies/{company}/paydaysGet company paydays
get/companies/{company}/reports/contractor_paymentsGet contractor payments report
get/companies/{company}/reports/w2_previewGet W-2 Preview Report
get/companies/{company}/reports/w4_exemption_statusGet W-4 Exempt Status Report
get/companies/{company}/federal_ein_verificationsList Federal EIN Verifications
get/companies/{company}/federal_ein_verifications/{federal_ein_verification}Get a Federal EIN Verification
get/companies/{company}/tax_depositsList tax deposits
get/companies/{company}/signatoriesGet signatories
post/companies/{company}/signatoriesCreate a signatory
get/companies/{company}/enrollment_profileGet the enrollment profile
put/companies/{company}/enrollment_profileCreate the enrollment profile
patch/companies/{company}/enrollment_profileUpdate the enrollment profile
get/companies/{company}/benefit_aggregationsBenefit Aggregations
post/companies/{company}/start_implementationStart implementation
post/companies/{company}/cancel_implementationCancel implementation
post/companies/{company_id}/request_embedded_setupRequest Embedded Setup
post/addresses/validateValidate address
get/workplacesList workplaces
post/workplacesCreate a workplace
get/workplaces/{workplace}Get a workplace
patch/workplaces/{workplace}Update a workplace
get/employeesList employees
post/employeesCreate an employee
get/employees/{employee}Get an employee
patch/employees/{employee}Update an employee
get/employees/{employee}/paystubsList employee paystubs
get/employees/{employee}/paystubs/{payroll}Get a paystub
get/employees/{employee}/formsList employee forms
get/employees/{employee}/forms/{form}Get an employee form
post/employees/{employee}/forms/{form}/submitSubmit an employee form
get/employees/{employee}/company_defined_attributesGet company-defined attributes
patch/employees/{employee}/company_defined_attributesUpdate company-defined attributes
get/employees/{employee}/reciprocity_electionsGet reciprocity elections
patch/employees/{employee}/reciprocity_electionsUpdate reciprocity elections
get/employees/{employee}/revealReveal employee SSN
post/employees/{employee}/authorize_partnerAuthorize an integration partner for an employee
get/contractorsList contractors
post/contractorsCreate a contractor
get/contractors/{contractor}Get a contractor
patch/contractors/{contractor}Update a contractor
get/contractors/{contractor}/paymentsList contractor payments
get/contractors/{contractor}/payments/{payroll}Get a contractor pay statement
get/contractors/{contractor}/formsList contractor forms
post/contractors/{contractor}/forms/{form}/submitSubmit a contractor form
get/contractors/{contractor}/revealReveal contractor SSN
get/bank_accountsList bank accounts
post/bank_accountsCreate a bank account
get/bank_accounts/{bank_account}Get a bank account
delete/bank_accounts/{bank_account}Delete a bank account
patch/bank_accounts/{bank_account}Update a bank account
get/bank_accounts/{bank_account}/revealReveal account number
get/net_pay_splitsList net pay splits
post/net_pay_splitsCreate a net pay split
get/payrolls/{payroll}/previewPreview a payroll

Changes to Preview a payroll

get/payrolls/{payroll}/preview

Nov 3, 20265a54f5eb888b Revision changes
- info
  added the optional property to the response with the status