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
descriptionString

remote_idString

deduction_codeString

benefit_plan_typeEnum

nameString

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
mobile_phone_numberString

managerUUID

display_full_nameString

last_nameString

remote_idString

termination_dateDateTime (ISO 8601)

employment_statusEnum

first_nameString

work_emailString

start_dateDateTime (ISO 8601)

preferred_nameString

teamUUID

date_of_birthDateTime (ISO 8601)

remote_dataArray

personal_emailString
Access Employment information
Employment fields
remote_idString

flsa_statusEnum

job_titleString

pay_rateNumber

effective_dateDateTime (ISO 8601)

remote_dataArray

employment_typeEnum

employeeUUID

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

remote_dataArray

remote_idString

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

remote_dataArray

legal_nameString

remote_idString
Access Location information
Location fields
street_2String

countryEnum

street_1String

stateString

cityString

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

remote_idString

countryEnum

street_1String

stateString

cityString

zip_codeString

remote_dataArray
GET/v1/companies/{company_id}/contractors
Merge interacts with this API endpoint to...
Access Location information
Location fields
street_2String

countryEnum

street_1String

stateString

cityString

zip_codeString

remote_dataArray
Access Employee information
Employee fields
home_locationUUID

employment_statusEnum

remote_idString

last_nameString

first_nameString

work_emailString

work_locationUUID

start_dateDateTime (ISO 8601)

preferred_nameString

remote_dataArray
Access Employment information
Employment fields
pay_frequencyEnum

pay_rateNumber

effective_dateDateTime (ISO 8601)

remote_dataArray

employeeUUID

pay_periodEnum
GET/v1/companies/{company_id}/payrolls/{payroll_id}
Merge interacts with this API endpoint to...
Access Tax information
Tax fields
employer_taxBoolean

nameString

amountNumber

remote_dataArray

employee_payroll_runUUID
Access Deduction information
Deduction fields
nameString

employee_deductionNumber

remote_dataArray

employee_payroll_runUUID

company_deductionNumber
Access Earning information
Earning fields
amountNumber

typeEnum

remote_dataArray

employee_payroll_runUUID
Access Employment information
Employment fields
remote_dataArray

employeeUUID
Access EmployeePayrollRun information
EmployeePayrollRun fields
end_dateDateTime (ISO 8601)

start_dateDateTime (ISO 8601)

net_payNumber

gross_payNumber

remote_dataArray

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

remote_idString

start_dateDateTime (ISO 8601)

remote_dataArray

run_typeEnum

check_dateDateTime (ISO 8601)

run_stateEnum
Access EmployeePayrollRun information
EmployeePayrollRun fields
payroll_runUUID

check_dateDateTime (ISO 8601)
GET/v1/companies/{company_id}/pay_schedules
Merge interacts with this API endpoint to...
Access PayGroup information
PayGroup fields
remote_dataArray

pay_group_nameString

remote_idString
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/{id}/departments
Merge interacts with this API endpoint to...
Access Group information
Group fields
nameString

remote_dataArray

remote_idString
Access Team information
Team fields
nameString

remote_dataArray

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

remote_idString

countryEnum

street_1String

stateString

cityString

zip_codeString

remote_dataArray