Paychex
Merge interacts with Paychex API endpoints to access certain information as detailed below.
API Endpoints
GET/companies/{company_id}/workers
Merge interacts with this API endpoint to...
Access Employee information
Employee fields
gender
Enummanager
UUIDstart_date
DateTime (ISO 8601)date_of_birth
DateTime (ISO 8601)employee_number
Stringtermination_date
DateTime (ISO 8601)last_name
Stringfirst_name
Stringdisplay_full_name
Stringremote_data
Arraypreferred_name
Stringethnicity
Enumemployment_status
Enumwork_location
UUIDssn
Stringteam
UUIDremote_id
StringAccess BankInfo information
BankInfo fields
employee
UUIDAccess Employment information
Employment fields
job_title
Stringemployment_type
Enumemployee
UUIDremote_data
Arrayflsa_status
EnumAccess Benefit information
Benefit fields
employee
UUIDGET/companies
Merge interacts with this API endpoint to...
Access Employee information
Employee fields
company
UUIDAccess Company information
Company fields
legal_name
Stringeins
Arrayremote_data
Arrayremote_id
Stringdisplay_name
StringGET/workers/{employee_id}/directdeposits
Merge interacts with this API endpoint to...
Access BankInfo information
BankInfo fields
remote_data
Arrayaccount_number
Stringrouting_number
Stringaccount_type
EnumGET/companies/{company_id}/locations
Merge interacts with this API endpoint to...
Access Location information
Location fields
street_1
Stringcity
Stringremote_data
Arrayzip_code
Stringstate
Stringcountry
Enumstreet_2
Stringname
Stringremote_id
StringGET/companies/{company_id}/payperiods
Merge interacts with this API endpoint to...
Access PayrollRun information
PayrollRun fields
check_date
DateTime (ISO 8601)start_date
DateTime (ISO 8601)run_state
Enumremote_data
Arrayremote_id
Stringend_date
DateTime (ISO 8601)Access EmployeePayrollRun information
EmployeePayrollRun fields
end_date
DateTime (ISO 8601)check_date
DateTime (ISO 8601)payroll_run
UUIDstart_date
DateTime (ISO 8601)GET/companies/{company_id}/checks
Merge interacts with this API endpoint to...
Access EmployeePayrollRun information
EmployeePayrollRun fields
remote_id
Stringremote_data
Arrayemployee
UUIDnet_pay
NumberAccess Earning information
Earning fields
type
Enumamount
Numberemployee_payroll_run
UUIDAccess Deduction information
Deduction fields
employee_payroll_run
UUIDemployee_deduction
Numbername
StringAccess Tax information
Tax fields
amount
Numberemployee_payroll_run
UUIDname
Stringemployer_tax
BooleanGET/companies/{company_id}/organizations
Merge interacts with this API endpoint to...
Access Team information
Team fields
remote_id
Stringremote_data
Arrayparent_team
UUIDname
StringAccess Group information
Group fields
type
Enumremote_data
Arrayremote_id
Stringparent_group
UUIDname
StringGET/workers/{employee_id}/communications
Merge interacts with this API endpoint to...
Access Employee information
Employee fields
personal_email
Stringmobile_phone_number
Stringwork_email
Stringremote_data
Arrayhome_location
UUIDAccess Location information
Location fields
street_1
Stringcity
Stringremote_data
Arrayzip_code
Stringstate
Stringcountry
Enumstreet_2
Stringremote_id
StringGET/workers/{employee_id}/compensation/payrates
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
pay_rate
Numberpay_period
Enumeffective_date
DateTime (ISO 8601)GET/workers/{employee_id}/paycomponents
Merge interacts with this API endpoint to...
Access EmployerBenefit information
EmployerBenefit fields
remote_id
Stringremote_data
Arrayname
Stringdeduction_code
StringAccess Benefit information
Benefit fields
start_date
DateTime (ISO 8601)remote_data
Arraycompany_contribution
Numberbenefit_plan_type
Stringemployee_contribution
Numberremote_id
Stringend_date
DateTime (ISO 8601)employer_benefit
UUID