Skip to main content

Endpoint reference

Every SDK component ("block") and headless hook makes a specific set of API calls. This reference lists them all, grouped by domain to match the Reference navigation. For a concise overview, see the Proxy Security: Partner Guidance.

Within each domain, Components and Hooks list the endpoints they call, and Flows list the blocks they compose (a flow's endpoints are the union of its blocks' endpoints).

Paths use named parameters (:companyId, :employeeId, etc.) that correspond to real IDs at runtime, and each links to its page in the API reference. This data is also available as a machine-readable JSON file at endpoint-inventory.json, which includes the reference URL and the list of variables each block expects. For programmatic access, import it directly from the package:

import inventory from '@gusto/embedded-react-sdk/endpoint-inventory.json'

Companies

Components

ComponentMethodPath
InformationRequests.InformationRequestsFlowGET/v1/companies/:companyUuid/information_requests
PUT/v1/information_requests/:informationRequestUuid/submit
InformationRequests.InformationRequestListGET/v1/companies/:companyUuid/information_requests
InformationRequests.InformationRequestFormGET/v1/companies/:companyUuid/information_requests
PUT/v1/information_requests/:informationRequestUuid/submit
CompanyOnboarding.OnboardingOverviewGET/v1/companies/:companyUuid/onboarding_status
CompanyOnboarding.DocumentSignerGET/v1/companies/:companyId/forms
GET/v1/companies/:companyUuid/signatories
GET/v1/forms/:formId
GET/v1/forms/:formId/pdf
PUT/v1/forms/:formId/sign
CompanyOnboarding.DocumentListGET/v1/companies/:companyId/forms
GET/v1/companies/:companyUuid/signatories
CompanyOnboarding.IndustryGET/v1/companies/:companyId/industry_selection
PUT/v1/companies/:companyId/industry_selection
CompanyOnboarding.BankAccountGET/v1/companies/:companyId/bank_accounts
POST/v1/companies/:companyId/bank_accounts
PUT/v1/companies/:companyId/bank_accounts/:bankAccountUuid/verify
CompanyOnboarding.LocationsGET/v1/companies/:companyId/locations
POST/v1/companies/:companyId/locations
GET/v1/locations/:locationId
PUT/v1/locations/:locationId
CompanyOnboarding.LocationFormPOST/v1/companies/:companyId/locations
GET/v1/locations/:locationId
PUT/v1/locations/:locationId
CompanyOnboarding.LocationsListGET/v1/companies/:companyId/locations
CompanyOnboarding.PayScheduleGET/v1/companies/:companyId/pay_schedules
POST/v1/companies/:companyId/pay_schedules
GET/v1/companies/:companyId/pay_schedules/:payScheduleId
PUT/v1/companies/:companyId/pay_schedules/:payScheduleId
GET/v1/companies/:companyId/pay_schedules/preview
GET/v1/companies/:companyUuid/payment_configs
CompanyOnboarding.FederalTaxesGET/v1/companies/:companyId/federal_tax_details
PUT/v1/companies/:companyId/federal_tax_details
CompanyOnboarding.StateTaxesGET/v1/companies/:companyUuid/tax_requirements
GET/v1/companies/:companyUuid/tax_requirements/:state
PUT/v1/companies/:companyUuid/tax_requirements/:state
CompanyOnboarding.StateTaxesFormGET/v1/companies/:companyUuid/tax_requirements/:state
PUT/v1/companies/:companyUuid/tax_requirements/:state
CompanyOnboarding.StateTaxesListGET/v1/companies/:companyUuid/tax_requirements
CompanyOnboarding.TaxRateManagementGET/v1/companies/:companyUuid/tax_requirements/:state
PUT/v1/companies/:companyUuid/tax_requirements/:state
CompanyOnboarding.AssignSignatoryGET/v1/companies/:companyUuid/signatories
POST/v1/companies/:companyUuid/signatories
PUT/v1/companies/:companyUuid/signatories/:signatoryUuid
DELETE/v1/companies/:companyUuid/signatories/:signatoryUuid
POST/v1/companies/:companyUuid/signatories/invite
CompanyOnboarding.CreateSignatoryGET/v1/companies/:companyUuid/signatories
POST/v1/companies/:companyUuid/signatories
PUT/v1/companies/:companyUuid/signatories/:signatoryUuid
DELETE/v1/companies/:companyUuid/signatories/:signatoryUuid
CompanyOnboarding.InviteSignatoryGET/v1/companies/:companyUuid/signatories
DELETE/v1/companies/:companyUuid/signatories/:signatoryUuid
POST/v1/companies/:companyUuid/signatories/invite

Flows

FlowBlocks included
CompanyOnboarding.OnboardingFlowCompanyOnboarding.BankAccount, CompanyOnboarding.DocumentSigner, CompanyOnboarding.FederalTaxes, CompanyOnboarding.Industry, CompanyOnboarding.Locations, CompanyOnboarding.OnboardingOverview, CompanyOnboarding.PaySchedule, CompanyOnboarding.StateTaxes, EmployeeOnboarding.OnboardingFlow
InformationRequests.InformationRequestsFlowInformationRequests.InformationRequestForm, InformationRequests.InformationRequestList

Hooks

Employees

Components

ComponentMethodPath
EmployeeOnboarding.EmployeeListGET/v1/companies/:companyId/employees
DELETE/v1/employees/:employeeId
PUT/v1/employees/:employeeId/onboarding_status
EmployeeOnboarding.OnboardingSummaryGET/v1/employees/:employeeId
GET/v1/employees/:employeeId/onboarding_status
EmployeeOnboarding.LandingGET/v1/companies/:companyId
GET/v1/employees/:employeeId
EmployeeOnboarding.DocumentSignerGET/v1/employees/:employeeId
GET/v1/employees/:employeeId/forms
GET/v1/employees/:employeeId/forms/:formId
GET/v1/employees/:employeeId/forms/:formId/pdf
PUT/v1/employees/:employeeId/forms/:formId/sign
GET/v1/employees/:employeeId/i9_authorization
PUT/v1/employees/:employeeId/i9_authorization
EmployeeOnboarding.EmploymentEligibilityGET/v1/employees/:employeeId/i9_authorization
PUT/v1/employees/:employeeId/i9_authorization
EmployeeOnboarding.DocumentListGET/v1/employees/:employeeId/forms
EmployeeOnboarding.SignatureFormGET/v1/employees/:employeeId/forms/:formId
GET/v1/employees/:employeeId/forms/:formId/pdf
PUT/v1/employees/:employeeId/forms/:formId/sign
EmployeeOnboarding.I9SignatureFormGET/v1/employees/:employeeId/forms/:formId
GET/v1/employees/:employeeId/forms/:formId/pdf
PUT/v1/employees/:employeeId/forms/:formId/sign
GET/v1/employees/:employeeId/i9_authorization
EmployeeOnboarding.EmployeeDocumentsGET/v1/employees/:employeeId
PUT/v1/employees/:employeeId/onboarding_documents_config
EmployeeOnboarding.ProfilePOST/v1/companies/:companyId/employees
GET/v1/companies/:companyId/locations
GET/v1/employees/:employeeId
PUT/v1/employees/:employeeId
GET/v1/employees/:employeeId/home_addresses
POST/v1/employees/:employeeId/home_addresses
PUT/v1/employees/:employeeId/onboarding_status
GET/v1/employees/:employeeId/work_addresses
POST/v1/employees/:employeeId/work_addresses
GET/v1/home_addresses/:homeAddressUuid
PUT/v1/home_addresses/:homeAddressUuid
GET/v1/work_addresses/:workAddressUuid
PUT/v1/work_addresses/:workAddressUuid
EmployeeOnboarding.CompensationGET/v1/companies/:companyId/federal_tax_details
PUT/v1/compensations/:compensationId
DELETE/v1/compensations/:compensationId
GET/v1/employees/:employeeId
GET/v1/employees/:employeeId/jobs
POST/v1/employees/:employeeId/jobs
GET/v1/employees/:employeeId/work_addresses
PUT/v1/jobs/:jobId
DELETE/v1/jobs/:jobId
POST/v1/jobs/:jobId/compensations
GET/v1/locations/:locationUuid/minimum_wages
EmployeeOnboarding.JobsListGET/v1/employees/:employeeId/jobs
DELETE/v1/jobs/:jobId
EmployeeOnboarding.FederalTaxesGET/v1/employees/:employeeUuid/federal_taxes
PUT/v1/employees/:employeeUuid/federal_taxes
EmployeeOnboarding.StateTaxesGET/v1/employees/:employeeUuid/state_taxes
PUT/v1/employees/:employeeUuid/state_taxes
EmployeeOnboarding.DeductionsGET/v1/employees/:employeeId/garnishments
POST/v1/employees/:employeeId/garnishments
PUT/v1/garnishments/:garnishmentId
GET/v1/garnishments/child_support
EmployeeOnboarding.PaymentMethodGET/v1/employees/:employeeId/bank_accounts
POST/v1/employees/:employeeId/bank_accounts
DELETE/v1/employees/:employeeId/bank_accounts/:bankAccountUuid
GET/v1/employees/:employeeId/payment_method
PUT/v1/employees/:employeeId/payment_method
EmployeeManagement.EmployeeListGET/v1/companies/:companyId/employees
DELETE/v1/employees/:employeeId
PUT/v1/employees/:employeeId/onboarding_status
EmployeeManagement.DocumentsGET/v1/employees/:employeeId/forms
GET/v1/employees/:employeeId/forms/:formId
GET/v1/employees/:employeeId/forms/:formId/pdf
EmployeeManagement.DashboardFlowGET/v1/employees/:employeeId
EmployeeManagement.HomeAddressGET/v1/employees/:employeeId
GET/v1/employees/:employeeId/home_addresses
DELETE/v1/home_addresses/:homeAddressUuid
EmployeeManagement.WorkAddressGET/v1/employees/:employeeId
GET/v1/employees/:employeeId/work_addresses
DELETE/v1/work_addresses/:workAddressUuid
EmployeeManagement.FederalTaxesGET/v1/employees/:employeeUuid/federal_taxes
PUT/v1/employees/:employeeUuid/federal_taxes
EmployeeManagement.StateTaxesGET/v1/employees/:employeeUuid/state_taxes
PUT/v1/employees/:employeeUuid/state_taxes
EmployeeManagement.ProfilePOST/v1/companies/:companyId/employees
GET/v1/employees/:employeeId
PUT/v1/employees/:employeeId
PUT/v1/employees/:employeeId/onboarding_status
EmployeeManagement.PaymentMethodGET/v1/employees/:employeeId/bank_accounts
POST/v1/employees/:employeeId/bank_accounts
DELETE/v1/employees/:employeeId/bank_accounts/:bankAccountUuid
GET/v1/employees/:employeeId/payment_method
PUT/v1/employees/:employeeId/payment_method
EmployeeManagement.PaystubsCardGET/v1/employees/:employeeId/pay_stubs
GET/v1/payrolls/:payrollId/employees/:employeeId/pay_stub
EmployeeManagement.CompensationGET/v1/employees/:employeeId/jobs
DELETE/v1/jobs/:jobId
EmployeeManagement.TerminateEmployeeGET/v1/companies/:companyId/pay_periods/unprocessed_termination_pay_periods
GET/v1/companies/:companyId/payrolls
POST/v1/companies/:companyId/payrolls
GET/v1/employees/:employeeId
GET/v1/employees/:employeeId/terminations
POST/v1/employees/:employeeId/terminations
PUT/v1/terminations/:employeeId
EmployeeManagement.TerminationSummaryGET/v1/companies/:companyId/employees
GET/v1/employees/:employeeId
GET/v1/employees/:employeeId/terminations
DELETE/v1/employees/:employeeId/terminations

Flows

FlowBlocks included
EmployeeManagement.DashboardFlowEmployeeManagement.Compensation, EmployeeManagement.Deductions, EmployeeManagement.Documents, EmployeeManagement.FederalTaxes, EmployeeManagement.HomeAddress, EmployeeManagement.PaymentMethod, EmployeeManagement.PaystubsCard, EmployeeManagement.Profile, EmployeeManagement.StateTaxes, EmployeeManagement.WorkAddress
EmployeeManagement.EmployeeListFlowEmployeeManagement.DashboardFlow, EmployeeManagement.EmployeeList, EmployeeManagement.TerminationFlow, EmployeeOnboarding.OnboardingExecutionFlow
EmployeeManagement.TerminationFlowEmployeeManagement.TerminateEmployee, EmployeeManagement.TerminationSummary, Payroll.DismissalFlow, Payroll.PayrollLanding
EmployeeOnboarding.OnboardingExecutionFlowEmployeeOnboarding.Compensation, EmployeeOnboarding.Deductions, EmployeeOnboarding.EmployeeDocuments, EmployeeOnboarding.FederalTaxes, EmployeeOnboarding.OnboardingSummary, EmployeeOnboarding.Profile, EmployeeOnboarding.StateTaxes
EmployeeOnboarding.OnboardingFlowEmployeeOnboarding.EmployeeList, EmployeeOnboarding.OnboardingExecutionFlow
EmployeeOnboarding.SelfOnboardingFlowEmployeeOnboarding.DocumentSigner, EmployeeOnboarding.FederalTaxes, EmployeeOnboarding.Landing, EmployeeOnboarding.OnboardingSummary, EmployeeOnboarding.Profile, EmployeeOnboarding.StateTaxes

Hooks

HookMethodPath
useBankFormPOST/v1/employees/:employeeId/bank_accounts
useChildSupportGarnishmentFormGET/v1/employees/:employeeId/garnishments
POST/v1/employees/:employeeId/garnishments
PUT/v1/garnishments/:garnishmentId
GET/v1/garnishments/child_support
useCompensationFormPUT/v1/compensations/:compensationId
GET/v1/employees/:employeeId
GET/v1/employees/:employeeId/jobs
GET/v1/employees/:employeeId/work_addresses
POST/v1/jobs/:jobId/compensations
GET/v1/locations/:locationUuid/minimum_wages
useCurrentHomeAddressFormGET/v1/employees/:employeeId/home_addresses
POST/v1/employees/:employeeId/home_addresses
GET/v1/home_addresses/:homeAddressUuid
PUT/v1/home_addresses/:homeAddressUuid
useCurrentWorkAddressFormGET/v1/companies/:companyId/locations
GET/v1/employees/:employeeId/work_addresses
POST/v1/employees/:employeeId/work_addresses
GET/v1/work_addresses/:workAddressUuid
PUT/v1/work_addresses/:workAddressUuid
useDeductionFormGET/v1/employees/:employeeId/garnishments
POST/v1/employees/:employeeId/garnishments
PUT/v1/garnishments/:garnishmentId
useEmployeeDetailsFormPOST/v1/companies/:companyId/employees
GET/v1/employees/:employeeId
PUT/v1/employees/:employeeId
PUT/v1/employees/:employeeId/onboarding_status
useEmployeeListGET/v1/companies/:companyId/employees
DELETE/v1/employees/:employeeId
PUT/v1/employees/:employeeId/onboarding_status
useEmployeeStateTaxesFormGET/v1/employees/:employeeUuid/state_taxes
PUT/v1/employees/:employeeUuid/state_taxes
useFederalTaxesFormGET/v1/employees/:employeeUuid/federal_taxes
PUT/v1/employees/:employeeUuid/federal_taxes
useHomeAddressFormPOST/v1/employees/:employeeId/home_addresses
GET/v1/home_addresses/:homeAddressUuid
PUT/v1/home_addresses/:homeAddressUuid
useJobFormGET/v1/companies/:companyId/federal_tax_details
PUT/v1/compensations/:compensationId
GET/v1/employees/:employeeId
GET/v1/employees/:employeeId/jobs
POST/v1/employees/:employeeId/jobs
GET/v1/employees/:employeeId/work_addresses
PUT/v1/jobs/:jobId
usePaymentMethodFormGET/v1/employees/:employeeId/payment_method
PUT/v1/employees/:employeeId/payment_method
useSignEmployeeFormGET/v1/employees/:employeeId/forms/:formId
GET/v1/employees/:employeeId/forms/:formId/pdf
PUT/v1/employees/:employeeId/forms/:formId/sign
useSplitPaymentsFormGET/v1/employees/:employeeId/bank_accounts
GET/v1/employees/:employeeId/payment_method
PUT/v1/employees/:employeeId/payment_method
useWorkAddressFormGET/v1/companies/:companyId/locations
POST/v1/employees/:employeeId/work_addresses
GET/v1/work_addresses/:workAddressUuid
PUT/v1/work_addresses/:workAddressUuid

Contractors

Components

ComponentMethodPath
ContractorOnboarding.LandingGET/v1/companies/:companyId
GET/v1/contractors/:contractorUuid
ContractorOnboarding.ContractorListGET/v1/companies/:companyUuid/contractors
DELETE/v1/contractors/:contractorUuid
PUT/v1/contractors/:contractorUuid/onboarding_status
DELETE/v1/contractors/:contractorUuid/rehire
DELETE/v1/contractors/:contractorUuid/termination
ContractorOnboarding.ContractorProfilePOST/v1/companies/:companyUuid/contractors
GET/v1/contractors/:contractorUuid
PUT/v1/contractors/:contractorUuid
ContractorOnboarding.AddressGET/v1/contractors/:contractorUuid
GET/v1/contractors/:contractorUuid/address
PUT/v1/contractors/:contractorUuid/address
ContractorOnboarding.PaymentMethodGET/v1/contractors/:contractorUuid/bank_accounts
POST/v1/contractors/:contractorUuid/bank_accounts
GET/v1/contractors/:contractorUuid/payment_method
PUT/v1/contractors/:contractorUuid/payment_method
ContractorOnboarding.NewHireReportGET/v1/contractors/:contractorUuid
PUT/v1/contractors/:contractorUuid
ContractorOnboarding.ContractorSubmitGET/v1/contractors/:contractorUuid
GET/v1/contractors/:contractorUuid/documents
GET/v1/contractors/:contractorUuid/onboarding_status
PUT/v1/contractors/:contractorUuid/onboarding_status
GET/v1/documents/:documentUuid/pdf
ContractorOnboarding.DocumentsListGET/v1/contractors/:contractorUuid/documents
ContractorOnboarding.SignatureFormGET/v1/documents/:documentUuid
GET/v1/documents/:documentUuid/pdf
PUT/v1/documents/:documentUuid/sign
ContractorManagement.ContractorListGET/v1/companies/:companyUuid/contractors
DELETE/v1/contractors/:contractorUuid
PUT/v1/contractors/:contractorUuid/onboarding_status
DELETE/v1/contractors/:contractorUuid/rehire
DELETE/v1/contractors/:contractorUuid/termination
ContractorManagement.PaymentsListGET/v1/companies/:companyId/contractor_payment_groups
GET/v1/companies/:companyUuid/information_requests
ContractorManagement.CreatePaymentGET/v1/companies/:companyId/bank_accounts
POST/v1/companies/:companyId/contractor_payment_groups
POST/v1/companies/:companyId/contractor_payment_groups/preview
GET/v1/companies/:companyUuid/contractors
GET/v1/companies/:companyUuid/payment_configs
ContractorManagement.PaymentHistoryDELETE/v1/companies/:companyId/contractor_payments/:contractorPaymentId
GET/v1/companies/:companyUuid/contractors
GET/v1/contractor_payment_groups/:contractorPaymentGroupUuid
ContractorManagement.PaymentSummaryGET/v1/companies/:companyId/bank_accounts
GET/v1/companies/:companyUuid/contractors
GET/v1/contractor_payment_groups/:contractorPaymentGroupUuid
ContractorManagement.PaymentStatementGET/v1/companies/:companyUuid/contractors
GET/v1/contractor_payment_groups/:contractorPaymentGroupUuid
GET/v1/contractor_payments/:contractorPaymentUuid/receipt

Flows

FlowBlocks included
ContractorManagement.PaymentFlowContractorManagement.CreatePayment, ContractorManagement.PaymentHistory, ContractorManagement.PaymentStatement, ContractorManagement.PaymentSummary, ContractorManagement.PaymentsList, InformationRequests.InformationRequestsFlow
ContractorOnboarding.OnboardingFlowContractorOnboarding.Address, ContractorOnboarding.ContractorList, ContractorOnboarding.ContractorProfile, ContractorOnboarding.ContractorSubmit, ContractorOnboarding.NewHireReport, ContractorOnboarding.PaymentMethod
ContractorOnboarding.SelfOnboardingFlowContractorOnboarding.Address, ContractorOnboarding.ContractorProfile, ContractorOnboarding.DocumentSigner, ContractorOnboarding.Landing, ContractorOnboarding.OnboardingSummary, ContractorOnboarding.PaymentMethod

Hooks

Payrolls

Components

ComponentMethodPath
Payroll.PayrollConfigurationGET/v1/companies/:companyId/employees
GET/v1/companies/:companyId/pay_schedules/:payScheduleId
GET/v1/companies/:companyId/payrolls/:payrollId
PUT/v1/companies/:companyId/payrolls/:payrollId
PUT/v1/companies/:companyId/payrolls/:payrollId/calculate
PUT/v1/companies/:companyId/payrolls/:payrollId/prepare
GET/v1/companies/:companyUuid/payrolls/blockers
GET/v1/employees/:employeeId
POST/v1/payrolls/:payrollUuid/gross_up
Payroll.PayrollEditEmployeeGET/v1/companies/:companyId/pay_schedules/:payScheduleId
PUT/v1/companies/:companyId/payrolls/:payrollId
PUT/v1/companies/:companyId/payrolls/:payrollId/prepare
GET/v1/employees/:employeeId
GET/v1/employees/:employeeId/bank_accounts
Payroll.PayrollHistoryGET/v1/companies/:companyId/payrolls
PUT/v1/companies/:companyId/payrolls/:payrollId/cancel
GET/v1/companies/:companyUuid/wire_in_requests
Payroll.PayrollLandingGET/v1/companies/:companyId/pay_periods
GET/v1/companies/:companyId/pay_schedules
GET/v1/companies/:companyUuid/payrolls/blockers
POST/v1/companies/:companyUuid/payrolls/skip
GET/v1/companies/:companyUuid/wire_in_requests
Payroll.PayrollListGET/v1/companies/:companyId/pay_periods
GET/v1/companies/:companyId/pay_schedules
GET/v1/companies/:companyId/payrolls
DELETE/v1/companies/:companyId/payrolls/:payrollId
GET/v1/companies/:companyUuid/payrolls/blockers
POST/v1/companies/:companyUuid/payrolls/skip
GET/v1/companies/:companyUuid/wire_in_requests
Payroll.PayrollOverviewGET/v1/companies/:companyId/bank_accounts
GET/v1/companies/:companyId/payrolls/:payrollId
PUT/v1/companies/:companyId/payrolls/:payrollId/cancel
PUT/v1/companies/:companyId/payrolls/:payrollId/submit
GET/v1/companies/:companyUuid/payment_configs
GET/v1/payrolls/:payrollId/employees/:employeeId/pay_stub
GET/v1/wire_in_requests/:wireInRequestUuid
Payroll.PayrollFlowGET/v1/companies/:companyId/payrolls
GET/v1/companies/:companyId/payrolls/:payrollId
Payroll.PayrollReceiptsGET/v1/payrolls/:payrollUuid/receipt
Payroll.ConfirmWireDetailsGET/v1/companies/:companyId/payrolls
GET/v1/companies/:companyUuid/wire_in_requests
GET/v1/wire_in_requests/:wireInRequestUuid
PUT/v1/wire_in_requests/:wireInRequestUuid
Payroll.PayrollBlockerListGET/v1/companies/:companyUuid/information_requests
GET/v1/companies/:companyUuid/payrolls/blockers
GET/v1/companies/:companyUuid/recovery_cases
Payroll.RecoveryCasesGET/v1/companies/:companyUuid/recovery_cases
PUT/v1/recovery_cases/:recoveryCaseUuid/redebit
Payroll.OffCycleCreationGET/v1/companies/:companyId/employees
POST/v1/companies/:companyId/payrolls
GET/v1/companies/:companyUuid/payment_configs
Payroll.OffCycleFlowGET/v1/companies/:companyId/payrolls/:payrollId
Payroll.DismissalFlowGET/v1/companies/:companyId/pay_periods/unprocessed_termination_pay_periods
POST/v1/companies/:companyId/payrolls
GET/v1/companies/:companyId/payrolls/:payrollId
Payroll.DismissalPayPeriodSelectionGET/v1/companies/:companyId/pay_periods/unprocessed_termination_pay_periods
POST/v1/companies/:companyId/payrolls
GET/v1/companies/:companyId/payrolls/:payrollId
Payroll.TransitionFlowGET/v1/companies/:companyId/payrolls/:payrollId
Payroll.TransitionCreationGET/v1/companies/:companyId/pay_schedules
POST/v1/companies/:companyId/payrolls
GET/v1/companies/:companyUuid/payment_configs

Flows

FlowBlocks included
Payroll.DismissalFlowPayroll.DismissalPayPeriodSelection, Payroll.PayrollExecutionFlow
Payroll.OffCycleFlowPayroll.OffCycleCreation, Payroll.PayrollExecutionFlow
Payroll.PayrollExecutionFlowPayroll.PayrollFlow
Payroll.PayrollFlowPayroll.OffCycleFlow, Payroll.PayrollBlockerList, Payroll.PayrollConfiguration, Payroll.PayrollEditEmployee, Payroll.PayrollExecutionFlow, Payroll.PayrollLanding, Payroll.PayrollOverview, Payroll.PayrollReceipts, Payroll.TransitionFlow
Payroll.TransitionFlowPayroll.PayrollExecutionFlow, Payroll.TransitionCreation

Time off policies

Components

ComponentMethodPath
TimeOff.PolicyListGET/v1/companies/:companyId/employees
GET/v1/companies/:companyUuid/holiday_pay_policy
DELETE/v1/companies/:companyUuid/holiday_pay_policy
GET/v1/companies/:companyUuid/time_off_policies
PUT/v1/time_off_policies/:timeOffPolicyUuid/deactivate
TimeOff.PolicyTypeSelectorGET/v1/companies/:companyUuid/holiday_pay_policy
TimeOff.PolicyConfigurationFormPOST/v1/companies/:companyUuid/time_off_policies
GET/v1/time_off_policies/:timeOffPolicyUuid
PUT/v1/time_off_policies/:timeOffPolicyUuid
TimeOff.PolicySettingsGET/v1/time_off_policies/:timeOffPolicyUuid
PUT/v1/time_off_policies/:timeOffPolicyUuid
TimeOff.PolicySettingsPresentationGET/v1/time_off_policies/:timeOffPolicyUuid
PUT/v1/time_off_policies/:timeOffPolicyUuid
TimeOff.AddEmployeesToPolicyGET/v1/companies/:companyId/employees
GET/v1/time_off_policies/:timeOffPolicyUuid
PUT/v1/time_off_policies/:timeOffPolicyUuid
PUT/v1/time_off_policies/:timeOffPolicyUuid/add_employees
TimeOff.HolidaySelectionFormGET/v1/companies/:companyUuid/holiday_pay_policy
POST/v1/companies/:companyUuid/holiday_pay_policy
PUT/v1/companies/:companyUuid/holiday_pay_policy
TimeOff.AddEmployeesHolidayGET/v1/companies/:companyId/employees
GET/v1/companies/:companyUuid/holiday_pay_policy
PUT/v1/companies/:companyUuid/holiday_pay_policy/add
TimeOff.ViewHolidayEmployeesGET/v1/companies/:companyId/employees
GET/v1/companies/:companyUuid/holiday_pay_policy
PUT/v1/companies/:companyUuid/holiday_pay_policy/remove
TimeOff.ViewHolidayPolicyDetailsGET/v1/companies/:companyId/employees
GET/v1/companies/:companyUuid/holiday_pay_policy
PUT/v1/companies/:companyUuid/holiday_pay_policy/remove
TimeOff.ViewHolidayScheduleGET/v1/companies/:companyId/employees
GET/v1/companies/:companyUuid/holiday_pay_policy
PUT/v1/companies/:companyUuid/holiday_pay_policy/remove
TimeOff.TimeOffPolicyDetailGET/v1/companies/:companyId/employees
GET/v1/time_off_policies/:timeOffPolicyUuid
PUT/v1/time_off_policies/:timeOffPolicyUuid/balance
PUT/v1/time_off_policies/:timeOffPolicyUuid/remove_employees
TimeOff.TimeOffPolicyDetailPresentationGET/v1/companies/:companyId/employees
GET/v1/time_off_policies/:timeOffPolicyUuid
PUT/v1/time_off_policies/:timeOffPolicyUuid/balance
PUT/v1/time_off_policies/:timeOffPolicyUuid/remove_employees

Flows

FlowBlocks included
TimeOff.TimeOffFlowTimeOff.AddEmployeesHoliday, TimeOff.AddEmployeesToPolicy, TimeOff.HolidaySelectionForm, TimeOff.PolicyConfigurationForm, TimeOff.PolicyList, TimeOff.PolicySettings, TimeOff.PolicyTypeSelector, TimeOff.TimeOffPolicyDetail, TimeOff.ViewHolidayEmployees, TimeOff.ViewHolidaySchedule