Expand description
The data types sent to and returned from the API client.
Structs§
- Address
- The contractor’s home address.
- Addresses
- Admin
- The representation of an admin user in Gusto.
- Approver
- This value will be null if the request has not been approved.
- Benefits
- Companies
- Company
- The representation of a company in Gusto.
- Company
Bank Account - The company bank account
- Company
Benefit - The representation of a company benefit.
- Company
Custom Field - A custom field on a company
- Compensation
- The representation of compensation in Gusto.
- Compensations
- The available company-wide compensation rates for the company.
- Contractor
- The representation of a contractor (individual or business) in Gusto.
- Contractor
Payment - The representation of a single contractor payment.
- Contractor
Payment Summary - The representation of the summary of contractor payments for a given company in a given time period.
- Contractor
Payments - Current
User - Days
- An object that represents the days in the time off request. The keys of the object are the dates, formatted as a YYYY-MM-DD string. The values of the object are the number of hours requested off for each day, formatted as a string representation of a numeric decimal to the thousands place.
- Deductions
- Earning
Type - Earning
Type List Response - Eligible
Employees - Employee
- The representation of an employee in Gusto.
- Employee
Benefit - The representation of an employee benefit.
- Employee
Compensations - Employee
Custom Field - A custom field of an employee
- Federal
TaxDetails - Fixed
- Fixed
Compensations - Garnishment
- Garnishments, or employee deductions, are fixed amounts or percentages deducted from an employee’s pay. They can be deducted a specific number of times or on a recurring basis. Garnishments can also have maximum deductions on a yearly or per-pay-period bases. Common uses for garnishments are court-ordered payments for child support or back taxes. Some companies provide loans to their employees that are repaid via garnishments.
- GetCompany
Custom Fields Response - GetCompany
Federal TaxDetails Response - GetCompany
Payroll Reversals Response - GetEmployee
Custom Fields Response - Home
Address - Hourly
- Hourly
Compensations - Initiator
- Job
- The representation of a job in Gusto.
- JobApplicant
- The representation of a job applicant in Gusto.
- JobLocation
- Location
- The representation of an address in Gusto.
- Paid
Time Off - The representation of paid time off in Gusto.
- PayPeriod
- The representation of a pay period.
- PaySchedule
- The representation of a pay schedule.
- Payroll
- Information about the payroll for the pay period.
- Payroll
Admin - Payroll
Data - Payroll
Employee Compensations Paid Time Off - Payroll
PayPeriod - Post
Company Admins Request - Post
Company Bank Accounts Request - Post
Company Benefits Request - Post
Company Contractors Request - Post
Company Earning Types Request - Post
Company JobApplicants Request - Post
Company Locations Request - Post
Company Payrolls Request - Post
Employee Benefits Request - Post
Employee Garnishments Request - Post
Employee Terminations Request - Post
Employee YtdBenefit Amounts From Different Company Request - Post
Employees Request - Post
JobCompensations Request - Post
JobRequest - Post
Partner Managed Companies Request - Post
Partner Managed Companies Request Company - Post
Partner Managed Companies Response - Post
Provision Request - Post
Provision Request Company - Post
Provision Response - Primary
Payroll Admin - The primary payroll admin of the company.
- Primary
Signatory - The primary signatory of the company.
- PutComntractor
Request - PutCompany
Bank Accounts Verify Request - PutCompany
Benefit Request - PutCompany
Earning Type Request - PutCompany
Federal TaxDetails Request - PutCompany
JobApplicant Request - PutCompany
PaySchedules Schedule Request - PutCompany
Payrolls Request - PutCompany
Payrolls Request Employee Compensations - PutCompany
Payrolls Request Employee Compensations Fixed - An array of fixed compensations for the employee. Fixed compensations include tips, bonuses, and one time reimbursements.
- PutCompany
Payrolls Request Employee Compensations Hourly - An array of hourly compensations for the employee. Hourly compensations include regular, overtime, and double overtime hours.
- PutCompensation
Request - PutEmployee
Benefit Request - PutEmployee
Home Address Request - PutEmployees
Request - PutGarnishment
Request - PutJob
Request - PutLocation
Request - Roles
- An object containing each of the user’s permissions.
- Supported
Benefit - Taxes
- Termination
- The representation of a termination in Gusto.
- Time
OffRequest - The representation of a time off request.
- Time
OffRequest Employee - Total
- The wage and reimbursement totals for all contractor payments within a given time period.
- Totals
- The subtotals for the payroll.
- User
- Information for the user who will be the primary payroll administrator for the new company.
Enums§
- Account
Type - Bank account type
- Company
Status - The status of the company in Gusto. “Approved” companies may run payroll with Gusto. “Not Approved” companies may not yet run payroll with Gusto. In order to run payroll, the company may need to complete onboarding or contact support. “Suspended” companies may not run payroll with Gusto. In order to unsuspend their account, the company must contact support.
- Custom
Field Type - Deduction
Reduces Taxable Income - Whether the employee deduction reduces taxable income or not. Only valid for Group Term Life benefits. Note: when the value is not “unset”, coverage amount and coverage salary multiplier are ignored.
- Entity
Type - The tax payer type of the company.
- Flsa
Status - The FLSA status for this compensation. Salaried (‘Exempt’) employees are paid a fixed salary every pay period. Salaried with overtime (‘Salaried Nonexempt’) employees are paid a fixed salary every pay period, and receive overtime pay when applicable. Hourly (‘Nonexempt’) employees are paid for the hours they work, and receive overtime pay when applicable. Owners (‘Owner’) are employees that own at least twenty percent of the company.
- Frequency
- GetCompany
Payrolls Include - Gusto
Person Type - Include
- OffCycle
Reason - Onboarding
Person Type - Must be “Employee” if send_offer is set to true.
- Payment
Method - The payment method.
- Payment
Unit - The unit accompanying the compensation rate. If the employee is an owner, rate should be ‘Paycheck’.
- Payroll
Employee Compensations Payment Method - The employee’s compensation payment method. This value is only available for processed payrolls.
- Request
Type - The type of time off request.
- Status
- The status of the time off request.
- Tier
- The Gusto product tier of the company.
- Type
- The contractor’s type, either “Individual” or “Business”.
- Verification
Status - The verification status of the bank account.
- Wage
Type - The contractor’s wage type, either “Fixed” or “Hourly”.