@gusto/embedded-api NPM

gusto-embedded

Developer-friendly & type-safe Typescript SDK specifically catered to leverage gusto-embedded API.

!IMPORTANT This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Gusto API: Welcome to Gusto's Embedded Payroll API documentation!

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @gusto/embedded-api
# Install optional peer dependencies if you plan to use React hooks
npm add @tanstack/react-query react react-dom

PNPM

pnpm add @gusto/embedded-api
# Install optional peer dependencies if you plan to use React hooks
pnpm add @tanstack/react-query react react-dom

Bun

bun add @gusto/embedded-api
# Install optional peer dependencies if you plan to use React hooks
bun add @tanstack/react-query react react-dom

Yarn

yarn add @gusto/embedded-api zod
# Install optional peer dependencies if you plan to use React hooks
yarn add @tanstack/react-query react react-dom

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

!NOTE This package is published as an ES Module (ESM) only. For applications using CommonJS, use await import("@gusto/embedded-api") to import and use this package.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { GustoEmbedded } from "@gusto/embedded-api";

const gustoEmbedded = new GustoEmbedded({
  companyAccessAuth: process.env["GUSTOEMBEDDED_COMPANY_ACCESS_AUTH"] ?? "",
});

async function run() {
  const result = await gustoEmbedded.introspection.getInfo({});

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
`companyAccessAuth`	http	HTTP Bearer	`GUSTOEMBEDDED_COMPANY_ACCESS_AUTH`

To authenticate with the API the companyAccessAuth parameter must be set when initializing the SDK client instance. For example:

import { GustoEmbedded } from "@gusto/embedded-api";

const gustoEmbedded = new GustoEmbedded({
  companyAccessAuth: process.env["GUSTOEMBEDDED_COMPANY_ACCESS_AUTH"] ?? "",
});

async function run() {
  const result = await gustoEmbedded.introspection.getInfo({});

  console.log(result);
}

run();

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

import { GustoEmbedded } from "@gusto/embedded-api";

const gustoEmbedded = new GustoEmbedded();

async function run() {
  const result = await gustoEmbedded.companies.createPartnerManaged({
    systemAccessAuth: process.env["GUSTOEMBEDDED_SYSTEM_ACCESS_AUTH"] ?? "",
  }, {
    requestBody: {
      user: {
        firstName: "Frank",
        lastName: "Ocean",
        email: "frank@example.com",
        phone: "2345558899",
      },
      company: {
        name: "Frank's Ocean, LLC",
        tradeName: "Frank’s Ocean",
        ein: "123456789",
        contractorOnly: false,
      },
    },
  });

  console.log(result);
}

run();

Available Resources and Operations

achTransactions

getAll - Get all ACH transactions for a company

bankAccounts

create - Create a company bank account
get - Get all company bank accounts
verify - Verify a company bank account
createFromPlaidToken - Create a bank account from a plaid processor token

companies

createPartnerManaged - Create a partner managed company
get - Get a company
update - Update a company
migrate - Migrate company to embedded payroll
acceptTermsOfService - Accept terms of service for a company user
retrieveTermsOfService - Retrieve terms of service status for a company user
createAdmin - Create an admin for the company
listAdmins - Get all the admins at a company
getOnboardingStatus - Get the company's onboarding status
finishOnboarding - Finish company onboarding
getCustomFields - Get the custom fields of a company

companies.suspensions

get - Get suspensions for this company
suspend - Suspend a company's account

companyAttachment

getDownloadUrl - Get a temporary url to download the Company Attachment file

companyAttachments

getDetails - Get Company Attachment Details
getList - Get List of Company Attachments
create - Create Company Attachment and Upload File

companyBenefits

create - Create a company benefit
list - Get benefits for a company
get - Get a company benefit
update - Update a company benefit
delete - Delete a company benefit
getAll - Get all benefits supported by Gusto
getSupported - Get a supported benefit by ID
getSummary - Get company benefit summary by company benefit id.
getEmployeeBenefits - Get all employee benefits for a company benefit
updateEmployeeBenefits - Bulk update employee benefits for a company benefit
getRequirements - Get benefit fields requirements by ID

companyForms

getAll - Get all company forms
get - Get a company form
getPdf - Get a company form pdf
sign - Sign a company form

contractorDocuments

getAll - Get all contractor documents
get - Get a contractor document
getPdf - Get the contractor document pdf
sign - Sign a contractor document

contractorForms

list - Get all contractor forms
get - Get a contractor form
getPdf - Get the contractor form pdf
generate1099 - Generate a 1099 form DEMO

contractorPaymentGroups

create - Create a contractor payment group
getList - Get contractor payment groups for a company
preview - Preview a contractor payment group
get - Fetch a contractor payment group
delete - Cancel a contractor payment group
fund - Fund a contractor payment group DEMO

contractorPaymentMethod

getBankAccounts - Get all contractor bank accounts
get - Get a contractor's payment method
update - Update a contractor's payment method

contractorPaymentMethods

createBankAccount - Create a contractor bank account

contractorPayments

getReceipt - Get a single contractor payment receipt
fund - Fund a contractor payment DEMO
create - Create a contractor payment
list - Get contractor payments for a company
get - Get a single contractor payment
delete - Cancel a contractor payment

contractors

create - Create a contractor
list - Get contractors of a company
get - Get a contractor
update - Update a contractor
delete - Delete a contractor
getOnboardingStatus - Get the contractor's onboarding status
updateOnboardingStatus - Change the contractor's onboarding status
getAddress - Get a contractor address
updateAddress - Update a contractor's address
getV1CompaniesCompanyIdContractorsPaymentDetails - List contractor payment details

departments

create - Create a department
getAll - Get all departments of a company
get - Get a department
update - Update a department
delete - Delete a department
addPeople - Add people to a department
removePeople - Remove people from a department

earningTypes

create - Create a custom earning type
list - Get all earning types for a company
update - Update an earning type
delete - Deactivate an earning type

employeeAddresses

get - Get an employee's home addresses
create - Create an employee's home address
retrieveHomeAddress - Get an employee's home address
update - Update an employee's home address
delete - Delete an employee's home address
getWorkAddresses - Get an employee's work addresses
createWorkAddress - Create an employee work address
retrieveWorkAddress - Get an employee work address
updateWorkAddress - Update an employee work address
deleteWorkAddress - Delete an employee's work address

employeeBenefits

create - Create an employee benefit
get - Get all benefits for an employee
retrieve - Get an employee benefit
update - Update an employee benefit
delete - Delete an employee benefit
getYtdBenefitAmountsFromDifferentCompany - Get year-to-date benefit amounts from a different company
createYtdBenefitAmountsFromDifferentCompany - Create year-to-date benefit amounts from a different company

employeeEmployments

createTermination - Create an employee termination
getTerminations - Get terminations for an employee
deleteTermination - Delete an employee termination
updateTermination - Update an employee termination
createRehire - Create an employee rehire
rehire - Update an employee rehire
getRehire - Get an employee rehire
deleteRehire - Delete an employee rehire
getHistory - Get employment history for an employee

employeeForms

generateW2 - Generate a W2 form DEMO
list - Get all employee forms
get - Get an employee form
getPdf - Get the employee form pdf
sign - Sign an employee form

employeePaymentMethod

create - Create an employee bank account
deleteBankAccount - Delete an employee bank account
updateBankAccount - Update an employee bank account
get - Get an employee's payment method
update - Update an employee's payment method

employeePaymentMethods

getBankAccounts - Get all employee bank accounts

employees

list - Get employees of a company
create - Create an employee
getV1CompaniesCompanyIdEmployeesPaymentDetails - Get employee payment details for a company
createHistorical - Create a historical employee
get - Get an employee
update - Update an employee.
delete - Delete an onboarding employee
getCustomFields - Get an employee's custom fields
updateOnboardingDocumentsConfig - Update an employee's onboarding documents config
getOnboardingStatus - Get the employee's onboarding status
updateOnboardingStatus - Update the employee's onboarding status
getTimeOffActivities - Get employee time off activities

employeeTaxSetup

getFederalTaxes - Get an employee's federal taxes
updateFederalTaxes - Update an employee's federal taxes
getStateTaxes - Get an employee's state taxes
updateStateTaxes - Update an employee's state taxes

externalPayrolls

create - Create a new external payroll for a company
get - Get external payrolls for a company
retrieve - Get an external payroll
delete - Delete an external payroll
update - Update an external payroll
calculateTaxes - Get tax suggestions for an external payroll
listTaxLiabilities - Get tax liabilities
updateTaxLiabilities - Update tax liabilities
finalizeTaxLiabilities - Finalize tax liabilities options and convert into processed payrolls

federalTaxDetails

get - Get Federal Tax Details
update - Update Federal Tax Details

garnishments

create - Create a garnishment
list - Get garnishments for an employee
get - Get a garnishment
update - Update a garnishment
getChildSupportData - Get child support garnishment data

holidayPayPolicies

get - Get a company's holiday pay policy
create - Create a holiday pay policy for a company
update - Update a company's holiday pay policy
delete - Delete a company's holiday pay policy
addEmployees - Add employees to a company's holiday pay policy
removeEmployees - Remove employees from a company's holiday pay policy

i9Verification

getAuthorization - Get an employee's I-9 authorization
update - Create or update an employee's I-9 authorization
getDocumentOptions - Get an employee's I-9 verification document options
getDocuments - Get an employee's I-9 verification documents
createDocuments - Create an employee's I-9 authorization verification documents
deleteDocument - Delete an employee's I-9 verification document
employerSign - Employer sign an employee's Form I-9

industrySelection

get - Get a company industry selection
update - Update a company industry selection

informationRequests

getInformationRequests - Get all information requests for a company

introspection

getInfo - Get info about the current access token
refreshToken - Refresh access token

invoices

get - Retrieve invoicing data for companies

jobsAndCompensations

createJob - Create a job
getJobs - Get jobs for an employee
getJob - Get a job
update - Update a job
delete - Delete an individual job
getCompensations - Get compensations for a job
createCompensation - Create a compensation
getCompensation - Get a compensation
updateCompensation - Update a compensation
deleteCompensation - Delete a compensation

locations

create - Create a company location
get - Get company locations
retrieve - Get a location
update - Update a location
getMinimumWages - Get minimum wages for a location

notifications

getDetails - Get a notification's details
getCompanyNotifications - Get notifications for company

paymentConfigs

get - Get a company's payment configs
update - Update a company's payment configs

payrolls

createOffCycle - Create an off-cycle payroll
list - Get all payrolls for a company
getApprovedReversals - Get approved payroll reversals
get - Get a single payroll
update - Update a payroll by ID
delete - Delete a payroll
prepare - Prepare a payroll for update
getReceipt - Get a single payroll receipt
getBlockers - Get all payroll blockers for a company
skip - Skip a payroll
calculateGrossUp - Calculate gross up
calculate - Calculate a payroll
submit - Submit payroll
cancel - Cancel a payroll
getPayStub - Get an employee pay stub (pdf)
getPayStubs - Get an employee's pay stubs
generatePrintableChecks - Generate printable payroll checks (pdf)

paySchedules

create - Create a new pay schedule
getAll - Get the pay schedules for a company
getPreview - Preview pay schedule dates
get - Get a pay schedule
update - Update a pay schedule
getPayPeriods - Get pay periods for a company
getUnprocessedTerminationPeriods - Get termination pay periods for a company
getAssignments - Get pay schedule assignments for a company
previewAssignment - Preview pay schedule assignments for a company
assign - Assign pay schedules for a company

recoveryCases

get - Get all recovery cases for a company
redebit - Initiate a redebit for a recovery case

reports

createCustom - Create a custom report
postPayrollsPayrollUuidReportsGeneralLedger - Create a general ledger report
getReportsRequestUuid - Get a report
getTemplate - Get a report template

signatories

create - Create a signatory
list - Get all company signatories
invite - Invite a signatory
update - Update a signatory
delete - Delete a signatory

taxRequirements

get - Get State Tax Requirements
updateState - Update State Tax Requirements
getAll - Get All Tax Requirement States

timeOffPolicies

calculateAccruingTimeOffHours - Calculate accruing time off hours
get - Get a time off policy
update - Update a time off policy
getAll - Get all time off policies
create - Create a time off policy
addEmployees - Add employees to a time off policy
removeEmployees - Remove employees from a time off policy
updateBalance - Update employee time off hour balances
deactivate - Deactivate a time off policy

webhooks

createSubscription - Create a webhook subscription
listSubscriptions - List webhook subscriptions
updateSubscription - Update a webhook subscription
getSubscription - Get a webhook subscription
deleteSubscription - Delete a webhook subscription
verify - Verify the webhook subscription
requestVerificationToken - Request the webhook subscription verification_token

wireInRequests

get - Get a single Wire In Request
submit - Submit a wire in request
list - Get all Wire In Requests for a company

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

achTransactionsGetAll - Get all ACH transactions for a company
bankAccountsCreate - Create a company bank account
bankAccountsCreateFromPlaidToken - Create a bank account from a plaid processor token
bankAccountsGet - Get all company bank accounts
bankAccountsVerify - Verify a company bank account
companiesAcceptTermsOfService - Accept terms of service for a company user
companiesCreateAdmin - Create an admin for the company
companiesCreatePartnerManaged - Create a partner managed company
companiesFinishOnboarding - Finish company onboarding
companiesGet - Get a company
companiesGetCustomFields - Get the custom fields of a company
companiesGetOnboardingStatus - Get the company's onboarding status
companiesListAdmins - Get all the admins at a company
companiesMigrate - Migrate company to embedded payroll
companiesRetrieveTermsOfService - Retrieve terms of service status for a company user
companiesSuspensionsGet - Get suspensions for this company
companiesSuspensionsSuspend - Suspend a company's account
companiesUpdate - Update a company
companyAttachmentGetDownloadUrl - Get a temporary url to download the Company Attachment file
companyAttachmentsCreate - Create Company Attachment and Upload File
companyAttachmentsGetDetails - Get Company Attachment Details
companyAttachmentsGetList - Get List of Company Attachments
companyBenefitsCreate - Create a company benefit
companyBenefitsDelete - Delete a company benefit
companyBenefitsGet - Get a company benefit
companyBenefitsGetAll - Get all benefits supported by Gusto
companyBenefitsGetEmployeeBenefits - Get all employee benefits for a company benefit
companyBenefitsGetRequirements - Get benefit fields requirements by ID
companyBenefitsGetSummary - Get company benefit summary by company benefit id.
companyBenefitsGetSupported - Get a supported benefit by ID
companyBenefitsList - Get benefits for a company
companyBenefitsUpdate - Update a company benefit
companyBenefitsUpdateEmployeeBenefits - Bulk update employee benefits for a company benefit
companyFormsGet - Get a company form
companyFormsGetAll - Get all company forms
companyFormsGetPdf - Get a company form pdf
companyFormsSign - Sign a company form
contractorDocumentsGet - Get a contractor document
contractorDocumentsGetAll - Get all contractor documents
contractorDocumentsGetPdf - Get the contractor document pdf
contractorDocumentsSign - Sign a contractor document
contractorFormsGenerate1099 - Generate a 1099 form DEMO
contractorFormsGet - Get a contractor form
contractorFormsGetPdf - Get the contractor form pdf
contractorFormsList - Get all contractor forms
contractorPaymentGroupsCreate - Create a contractor payment group
contractorPaymentGroupsDelete - Cancel a contractor payment group
contractorPaymentGroupsFund - Fund a contractor payment group DEMO
contractorPaymentGroupsGet - Fetch a contractor payment group
contractorPaymentGroupsGetList - Get contractor payment groups for a company
contractorPaymentGroupsPreview - Preview a contractor payment group
contractorPaymentMethodGet - Get a contractor's payment method
contractorPaymentMethodGetBankAccounts - Get all contractor bank accounts
contractorPaymentMethodsCreateBankAccount - Create a contractor bank account
contractorPaymentMethodUpdate - Update a contractor's payment method
contractorPaymentsCreate - Create a contractor payment
contractorPaymentsDelete - Cancel a contractor payment
contractorPaymentsFund - Fund a contractor payment DEMO
contractorPaymentsGet - Get a single contractor payment
contractorPaymentsGetReceipt - Get a single contractor payment receipt
contractorPaymentsList - Get contractor payments for a company
contractorsCreate - Create a contractor
contractorsDelete - Delete a contractor
contractorsGet - Get a contractor
contractorsGetAddress - Get a contractor address
contractorsGetOnboardingStatus - Get the contractor's onboarding status
contractorsGetV1CompaniesCompanyIdContractorsPaymentDetails - List contractor payment details
contractorsList - Get contractors of a company
contractorsUpdate - Update a contractor
contractorsUpdateAddress - Update a contractor's address
contractorsUpdateOnboardingStatus - Change the contractor's onboarding status
departmentsAddPeople - Add people to a department
departmentsCreate - Create a department
departmentsDelete - Delete a department
departmentsGet - Get a department
departmentsGetAll - Get all departments of a company
departmentsRemovePeople - Remove people from a department
departmentsUpdate - Update a department
earningTypesCreate - Create a custom earning type
earningTypesDelete - Deactivate an earning type
earningTypesList - Get all earning types for a company
earningTypesUpdate - Update an earning type
employeeAddressesCreate - Create an employee's home address
employeeAddressesCreateWorkAddress - Create an employee work address
employeeAddressesDelete - Delete an employee's home address
employeeAddressesDeleteWorkAddress - Delete an employee's work address
employeeAddressesGet - Get an employee's home addresses
employeeAddressesGetWorkAddresses - Get an employee's work addresses
employeeAddressesRetrieveHomeAddress - Get an employee's home address
employeeAddressesRetrieveWorkAddress - Get an employee work address
employeeAddressesUpdate - Update an employee's home address
employeeAddressesUpdateWorkAddress - Update an employee work address
employeeBenefitsCreate - Create an employee benefit
employeeBenefitsCreateYtdBenefitAmountsFromDifferentCompany - Create year-to-date benefit amounts from a different company
employeeBenefitsDelete - Delete an employee benefit
employeeBenefitsGet - Get all benefits for an employee
employeeBenefitsGetYtdBenefitAmountsFromDifferentCompany - Get year-to-date benefit amounts from a different company
employeeBenefitsRetrieve - Get an employee benefit
employeeBenefitsUpdate - Update an employee benefit
employeeEmploymentsCreateRehire - Create an employee rehire
employeeEmploymentsCreateTermination - Create an employee termination
employeeEmploymentsDeleteRehire - Delete an employee rehire
employeeEmploymentsDeleteTermination - Delete an employee termination
employeeEmploymentsGetHistory - Get employment history for an employee
employeeEmploymentsGetRehire - Get an employee rehire
employeeEmploymentsGetTerminations - Get terminations for an employee
employeeEmploymentsRehire - Update an employee rehire
employeeEmploymentsUpdateTermination - Update an employee termination
employeeFormsGenerateW2 - Generate a W2 form DEMO
employeeFormsGet - Get an employee form
employeeFormsGetPdf - Get the employee form pdf
employeeFormsList - Get all employee forms
employeeFormsSign - Sign an employee form
employeePaymentMethodCreate - Create an employee bank account
employeePaymentMethodDeleteBankAccount - Delete an employee bank account
employeePaymentMethodGet - Get an employee's payment method
employeePaymentMethodsGetBankAccounts - Get all employee bank accounts
employeePaymentMethodUpdate - Update an employee's payment method
employeePaymentMethodUpdateBankAccount - Update an employee bank account
employeesCreate - Create an employee
employeesCreateHistorical - Create a historical employee
employeesDelete - Delete an onboarding employee
employeesGet - Get an employee
employeesGetCustomFields - Get an employee's custom fields
employeesGetOnboardingStatus - Get the employee's onboarding status
employeesGetTimeOffActivities - Get employee time off activities
employeesGetV1CompaniesCompanyIdEmployeesPaymentDetails - Get employee payment details for a company
employeesList - Get employees of a company
employeesUpdate - Update an employee.
employeesUpdateOnboardingDocumentsConfig - Update an employee's onboarding documents config
employeesUpdateOnboardingStatus - Update the employee's onboarding status
employeeTaxSetupGetFederalTaxes - Get an employee's federal taxes
employeeTaxSetupGetStateTaxes - Get an employee's state taxes
employeeTaxSetupUpdateFederalTaxes - Update an employee's federal taxes
employeeTaxSetupUpdateStateTaxes - Update an employee's state taxes
eventsGet - Get all events
externalPayrollsCalculateTaxes - Get tax suggestions for an external payroll
externalPayrollsCreate - Create a new external payroll for a company
externalPayrollsDelete - Delete an external payroll
externalPayrollsFinalizeTaxLiabilities - Finalize tax liabilities options and convert into processed payrolls
externalPayrollsGet - Get external payrolls for a company
externalPayrollsListTaxLiabilities - Get tax liabilities
externalPayrollsRetrieve - Get an external payroll
externalPayrollsUpdate - Update an external payroll
externalPayrollsUpdateTaxLiabilities - Update tax liabilities
federalTaxDetailsGet - Get Federal Tax Details
federalTaxDetailsUpdate - Update Federal Tax Details
flowsCreate - Create a flow
garnishmentsCreate - Create a garnishment
garnishmentsGet - Get a garnishment
garnishmentsGetChildSupportData - Get child support garnishment data
garnishmentsList - Get garnishments for an employee
garnishmentsUpdate - Update a garnishment
generatedDocumentsGet - Get a generated document
historicalEmployeesUpdate - Update a historical employee
holidayPayPoliciesAddEmployees - Add employees to a company's holiday pay policy
holidayPayPoliciesCreate - Create a holiday pay policy for a company
holidayPayPoliciesDelete - Delete a company's holiday pay policy
holidayPayPoliciesGet - Get a company's holiday pay policy
holidayPayPoliciesRemoveEmployees - Remove employees from a company's holiday pay policy
holidayPayPoliciesUpdate - Update a company's holiday pay policy
i9VerificationCreateDocuments - Create an employee's I-9 authorization verification documents
i9VerificationDeleteDocument - Delete an employee's I-9 verification document
i9VerificationEmployerSign - Employer sign an employee's Form I-9
i9VerificationGetAuthorization - Get an employee's I-9 authorization
i9VerificationGetDocumentOptions - Get an employee's I-9 verification document options
i9VerificationGetDocuments - Get an employee's I-9 verification documents
i9VerificationUpdate - Create or update an employee's I-9 authorization
industrySelectionGet - Get a company industry selection
industrySelectionUpdate - Update a company industry selection
informationRequestsGetInformationRequests - Get all information requests for a company
introspectionGetInfo - Get info about the current access token
introspectionRefreshToken - Refresh access token
invoicesGet - Retrieve invoicing data for companies
jobsAndCompensationsCreateCompensation - Create a compensation
jobsAndCompensationsCreateJob - Create a job
jobsAndCompensationsDelete - Delete an individual job
jobsAndCompensationsDeleteCompensation - Delete a compensation
jobsAndCompensationsGetCompensation - Get a compensation
jobsAndCompensationsGetCompensations - Get compensations for a job
jobsAndCompensationsGetJob - Get a job
jobsAndCompensationsGetJobs - Get jobs for an employee
jobsAndCompensationsUpdate - Update a job
jobsAndCompensationsUpdateCompensation - Update a compensation
locationsCreate - Create a company location
locationsGet - Get company locations
locationsGetMinimumWages - Get minimum wages for a location
locationsRetrieve - Get a location
locationsUpdate - Update a location
notificationsGetCompanyNotifications - Get notifications for company
notificationsGetDetails - Get a notification's details
paymentConfigsGet - Get a company's payment configs
paymentConfigsUpdate - Update a company's payment configs
payrollsCalculate - Calculate a payroll
payrollsCalculateGrossUp - Calculate gross up
payrollsCancel - Cancel a payroll
payrollsCreateOffCycle - Create an off-cycle payroll
payrollsDelete - Delete a payroll
payrollsGeneratePrintableChecks - Generate printable payroll checks (pdf)
payrollsGet - Get a single payroll
payrollsGetApprovedReversals - Get approved payroll reversals
payrollsGetBlockers - Get all payroll blockers for a company
payrollsGetPayStub - Get an employee pay stub (pdf)
payrollsGetPayStubs - Get an employee's pay stubs
payrollsGetReceipt - Get a single payroll receipt
payrollsList - Get all payrolls for a company
payrollsPrepare - Prepare a payroll for update
payrollsSkip - Skip a payroll
payrollsSubmit - Submit payroll
payrollsUpdate - Update a payroll by ID
paySchedulesAssign - Assign pay schedules for a company
paySchedulesCreate - Create a new pay schedule
paySchedulesGet - Get a pay schedule
paySchedulesGetAll - Get the pay schedules for a company
paySchedulesGetAssignments - Get pay schedule assignments for a company
paySchedulesGetPayPeriods - Get pay periods for a company
paySchedulesGetPreview - Preview pay schedule dates
paySchedulesGetUnprocessedTerminationPeriods - Get termination pay periods for a company
paySchedulesPreviewAssignment - Preview pay schedule assignments for a company
paySchedulesUpdate - Update a pay schedule
recoveryCasesGet - Get all recovery cases for a company
recoveryCasesRedebit - Initiate a redebit for a recovery case
reportsCreateCustom - Create a custom report
reportsGetReportsRequestUuid - Get a report
reportsGetTemplate - Get a report template
reportsPostPayrollsPayrollUuidReportsGeneralLedger - Create a general ledger report
signatoriesCreate - Create a signatory
signatoriesDelete - Delete a signatory
signatoriesInvite - Invite a signatory
signatoriesList - Get all company signatories
signatoriesUpdate - Update a signatory
taxRequirementsGet - Get State Tax Requirements
taxRequirementsGetAll - Get All Tax Requirement States
taxRequirementsUpdateState - Update State Tax Requirements
timeOffPoliciesAddEmployees - Add employees to a time off policy
timeOffPoliciesCalculateAccruingTimeOffHours - Calculate accruing time off hours
timeOffPoliciesCreate - Create a time off policy
timeOffPoliciesDeactivate - Deactivate a time off policy
timeOffPoliciesGet - Get a time off policy
timeOffPoliciesGetAll - Get all time off policies
timeOffPoliciesRemoveEmployees - Remove employees from a time off policy
timeOffPoliciesUpdate - Update a time off policy
timeOffPoliciesUpdateBalance - Update employee time off hour balances
webhooksCreateSubscription - Create a webhook subscription
webhooksDeleteSubscription - Delete a webhook subscription
webhooksGetSubscription - Get a webhook subscription
webhooksListSubscriptions - List webhook subscriptions
webhooksRequestVerificationToken - Request the webhook subscription verification_token
webhooksUpdateSubscription - Update a webhook subscription
webhooksVerify - Verify the webhook subscription
wireInRequestsGet - Get a single Wire In Request
wireInRequestsList - Get all Wire In Requests for a company
wireInRequestsSubmit - Submit a wire in request

React hooks with TanStack Query

React hooks built on TanStack Query are included in this SDK. These hooks and the utility functions provided alongside them can be used to build rich applications that pull data from the API using one of the most popular asynchronous state management library.

To learn about this feature and how to get started, check REACT_QUERY.md.

!WARNING
This feature is currently in preview and is subject to breaking changes within the current major version of the SDK as we gather user feedback on it.