Gusto
Common Model Sync Frequencies
Accessed third-party endpoints
Merge interacts with Gusto API endpoints to access certain information as detailed below.
API Endpoints

GET/v1/companies/{company_id}/company_benefits
Merge interacts with this API endpoint to...
Access EmployerBenefit information
EmployerBenefit fields
nameString

deduction_codeString

remote_idString

benefit_plan_typeEnum

descriptionString

remote_dataArray
GET/v1/companies/{company_id}/employees
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
employeeUUID
Access Employee information
Employee fields
remote_idString

date_of_birthDateTime (ISO 8601)

termination_dateDateTime (ISO 8601)

display_full_nameString

start_dateDateTime (ISO 8601)

preferred_nameString

mobile_phone_numberString

work_emailString

remote_dataArray

personal_emailString

last_nameString

managerUUID

first_nameString

employment_statusEnum
Access Employment information
Employment fields
remote_idString

pay_rateNumber

job_titleString

pay_periodEnum

effective_dateDateTime (ISO 8601)

remote_dataArray

employment_typeEnum

employeeUUID

flsa_statusEnum
GET/v1/employees/{employee_id}/employee_benefits
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
benefit_plan_typeString

provider_nameString

remote_idString

remote_dataArray
GET/v1/companies/{company_id}
Merge interacts with this API endpoint to...
Access Company information
Company fields
display_nameString

remote_idString

legal_nameString

remote_dataArray
Access Location information
Location fields
zip_codeString

cityString

street_1String

street_2String

stateString

countryEnum
GET/v1/companies/{id}/departments
Merge interacts with this API endpoint to...
Access Group information
Group fields
nameString

remote_idString

remote_dataArray
GET/v1/employees/{employee_id}/home_addresses
Merge interacts with this API endpoint to...
Access Location information
Location fields
remote_idString

zip_codeString

cityString

street_1String

street_2String

remote_dataArray

stateString

countryEnum
GET/v1/companies/{company_id}/pay_schedules
Merge interacts with this API endpoint to...
Access PayGroup information
PayGroup fields
pay_group_nameString

remote_idString

remote_dataArray
GET/v1/companies/{company_id}/pay_schedules/assignments
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
pay_frequencyEnum
GET/v1/companies/{company_id}/contractors
Merge interacts with this API endpoint to...
Access Location information
Location fields
zip_codeString

cityString

street_1String

street_2String

remote_dataArray

stateString

countryEnum
Access Employee information
Employee fields
home_locationUUID

remote_idString

work_locationUUID

preferred_nameString

work_emailString

remote_dataArray

employment_statusEnum

last_nameString

first_nameString

start_dateDateTime (ISO 8601)
Access Employment information
Employment fields
pay_rateNumber

pay_frequencyEnum

pay_periodEnum

effective_dateDateTime (ISO 8601)

remote_dataArray

employeeUUID
GET/v1/employees/{employee_id}/work_addresses
Merge interacts with this API endpoint to...
Access Location information
Location fields
remote_idString

zip_codeString

cityString

street_1String

street_2String

remote_dataArray

stateString

countryEnum
GET/v1/companies/{company_id}/payrolls
Merge interacts with this API endpoint to...
Access PayrollRun information
PayrollRun fields
check_dateDateTime (ISO 8601)

remote_idString

run_stateEnum

run_typeEnum

remote_dataArray

end_dateDateTime (ISO 8601)

start_dateDateTime (ISO 8601)
Access EmployeePayrollRun information
EmployeePayrollRun fields
check_dateDateTime (ISO 8601)

payroll_runUUID
GET/v1/companies/{company_id}/payrolls/{payroll_id}
Merge interacts with this API endpoint to...
Access EmployeePayrollRun information
EmployeePayrollRun fields
net_payNumber

gross_payNumber

remote_dataArray

employeeUUID

end_dateDateTime (ISO 8601)

start_dateDateTime (ISO 8601)
Access Tax information
Tax fields
nameString

employee_payroll_runUUID

amountNumber

employer_taxBoolean

remote_dataArray
Access Deduction information
Deduction fields
nameString

employee_payroll_runUUID

employee_deductionNumber

company_deductionNumber

remote_dataArray
Access Earning information
Earning fields
amountNumber

typeEnum

remote_dataArray

employee_payroll_runUUID
Access Employment information
Employment fields
remote_dataArray

employeeUUID