Gusto
Merge interacts with Gusto API endpoints to access certain information as detailed below.
API Endpoints
GET/v1/companies/{company_id}
Merge interacts with this API endpoint to...
Access Company information
Company fields
legal_name
Stringremote_id
Stringdisplay_name
Stringremote_data
ArrayAccess Location information
Location fields
zip_code
Stringcity
Stringstate
Stringstreet_1
Stringcountry
Enumstreet_2
StringGET/v1/companies/{id}/departments
Merge interacts with this API endpoint to...
Access Group information
Group fields
remote_id
Stringremote_data
Arrayname
StringGET/v1/companies/{company_id}/payrolls
Merge interacts with this API endpoint to...
Access PayrollRun information
PayrollRun fields
run_type
Enumend_date
DateTime (ISO 8601)remote_data
Arrayrun_state
Enumstart_date
DateTime (ISO 8601)check_date
DateTime (ISO 8601)remote_id
StringAccess EmployeePayrollRun information
EmployeePayrollRun fields
check_date
DateTime (ISO 8601)payroll_run
UUIDend_date
DateTime (ISO 8601)start_date
DateTime (ISO 8601)GET/v1/companies/{company_id}/payrolls/{payroll_id}
Merge interacts with this API endpoint to...
Access EmployeePayrollRun information
EmployeePayrollRun fields
net_pay
Numberemployee
UUIDgross_pay
Numberremote_data
ArrayAccess Tax information
Tax fields
employee_payroll_run
UUIDremote_data
Arrayamount
Numberemployer_tax
Booleanname
StringAccess Deduction information
Deduction fields
employee_deduction
Numberemployee_payroll_run
UUIDremote_data
Arrayname
StringAccess Earning information
Earning fields
employee_payroll_run
UUIDtype
Enumamount
Numberremote_data
ArrayAccess TimeOff information
TimeOff fields
employee
UUIDemployee_note
Stringamount
Numberremote_data
ArrayGET/v1/employees/{employee_id}/home_addresses
Merge interacts with this API endpoint to...
Access Location information
Location fields
zip_code
Stringremote_data
Arrayremote_id
Stringcity
Stringstate
Stringstreet_1
Stringcountry
Enumstreet_2
StringGET/v1/companies/{company_id}/employees
Merge interacts with this API endpoint to...
Access Employee information
Employee fields
last_name
Stringpersonal_email
Stringmobile_phone_number
Stringremote_data
Arraystart_date
DateTime (ISO 8601)first_name
Stringdate_of_birth
DateTime (ISO 8601)display_full_name
Stringwork_email
Stringmanager
UUIDtermination_date
DateTime (ISO 8601)preferred_name
Stringremote_id
Stringemployment_status
EnumAccess Employment information
Employment fields
flsa_status
Enumremote_data
Arraypay_rate
Numberpay_period
Enumeffective_date
DateTime (ISO 8601)job_title
Stringemployee
UUIDremote_id
StringAccess Benefit information
Benefit fields
employee
UUIDGET/v1/employees/{employee_id}/work_addresses
Merge interacts with this API endpoint to...
Access Location information
Location fields
zip_code
Stringremote_data
Arrayremote_id
Stringcity
Stringstate
Stringstreet_1
Stringcountry
Enumstreet_2
StringGET/v1/companies/{company_id}/contractors
Merge interacts with this API endpoint to...
Access Location information
Location fields
zip_code
Stringremote_data
Arraycity
Stringstate
Stringstreet_1
Stringcountry
Enumstreet_2
StringAccess Employee information
Employee fields
last_name
Stringremote_data
Arraystart_date
DateTime (ISO 8601)first_name
Stringhome_location
UUIDwork_email
Stringpreferred_name
Stringremote_id
Stringemployment_status
EnumAccess Employment information
Employment fields
remote_data
Arraypay_rate
Numberpay_period
Enumeffective_date
DateTime (ISO 8601)employee
UUIDpay_frequency
EnumGET/v1/companies/{company_id}/pay_schedules
Merge interacts with this API endpoint to...
Access PayGroup information
PayGroup fields
pay_group_name
Stringremote_id
Stringremote_data
ArrayGET/v1/companies/{company_id}/pay_schedules/assignments
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
pay_frequency
EnumGET/v1/companies/{company_id}/company_benefits
Merge interacts with this API endpoint to...
Access EmployerBenefit information
EmployerBenefit fields
deduction_code
Stringremote_data
Arraybenefit_plan_type
Enumname
Stringdescription
Stringremote_id
StringGET/v1/employees/{employee_id}/employee_benefits
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
remote_id
Stringremote_data
ArrayGET/v1/company_benefits/{company_benefit_id}
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
benefit_plan_type
Stringprovider_name
String