Module gusto_api::types

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.
• CompanyBankAccount
  The company bank account
• CompanyBenefit
  The representation of a company benefit.
• CompanyCustomField
  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.
• ContractorPayment
  The representation of a single contractor payment.
• ContractorPaymentSummary
  The representation of the summary of contractor payments for a given company in a given time period.
• ContractorPayments
• CurrentUser
• 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
• EarningType
• EarningTypeListResponse
• EligibleEmployees
• Employee
  The representation of an employee in Gusto.
• EmployeeBenefit
  The representation of an employee benefit.
• EmployeeCompensations
• EmployeeCustomField
  A custom field of an employee
• FederalTaxDetails
• Fixed
• FixedCompensations
• 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.
• GetCompanyCustomFieldsResponse
• GetCompanyFederalTaxDetailsResponse
• GetCompanyPayrollReversalsResponse
• GetEmployeeCustomFieldsResponse
• HomeAddress
• Hourly
• HourlyCompensations
• 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.
• PaidTimeOff
  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.
• PayrollAdmin
• PayrollData
• PayrollEmployeeCompensationsPaidTimeOff
• PayrollPayPeriod
• PostCompanyAdminsRequest
• PostCompanyBankAccountsRequest
• PostCompanyBenefitsRequest
• PostCompanyContractorsRequest
• PostCompanyEarningTypesRequest
• PostCompanyJobApplicantsRequest
• PostCompanyLocationsRequest
• PostCompanyPayrollsRequest
• PostEmployeeBenefitsRequest
• PostEmployeeGarnishmentsRequest
• PostEmployeeTerminationsRequest
• PostEmployeeYtdBenefitAmountsFromDifferentCompanyRequest
• PostEmployeesRequest
• PostJobCompensationsRequest
• PostJobRequest
• PostPartnerManagedCompaniesRequest
• PostPartnerManagedCompaniesRequestCompany
• PostPartnerManagedCompaniesResponse
• PostProvisionRequest
• PostProvisionRequestCompany
• PostProvisionResponse
• PrimaryPayrollAdmin
  The primary payroll admin of the company.
• PrimarySignatory
  The primary signatory of the company.
• PutComntractorRequest
• PutCompanyBankAccountsVerifyRequest
• PutCompanyBenefitRequest
• PutCompanyEarningTypeRequest
• PutCompanyFederalTaxDetailsRequest
• PutCompanyJobApplicantRequest
• PutCompanyPaySchedulesScheduleRequest
• PutCompanyPayrollsRequest
• PutCompanyPayrollsRequestEmployeeCompensations
• PutCompanyPayrollsRequestEmployeeCompensationsFixed
  An array of fixed compensations for the employee. Fixed compensations include tips, bonuses, and one time reimbursements.
• PutCompanyPayrollsRequestEmployeeCompensationsHourly
  An array of hourly compensations for the employee. Hourly compensations include regular, overtime, and double overtime hours.
• PutCompensationRequest
• PutEmployeeBenefitRequest
• PutEmployeeHomeAddressRequest
• PutEmployeesRequest
• PutGarnishmentRequest
• PutJobRequest
• PutLocationRequest
• Roles
  An object containing each of the user’s permissions.
• SupportedBenefit
• Taxes
• Termination
  The representation of a termination in Gusto.
• TimeOffRequest
  The representation of a time off request.
• TimeOffRequestEmployee
• 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

• AccountType
  Bank account type
• CompanyStatus
  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.
• CustomFieldType
• DeductionReducesTaxableIncome
  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.
• EntityType
  The tax payer type of the company.
• FlsaStatus
  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
• GetCompanyPayrollsInclude
• GustoPersonType
• Include
• OffCycleReason
• OnboardingPersonType
  Must be “Employee” if send_offer is set to true.
• PaymentMethod
  The payment method.
• PaymentUnit
  The unit accompanying the compensation rate. If the employee is an owner, rate should be ‘Paycheck’.
• PayrollEmployeeCompensationsPaymentMethod
  The employee’s compensation payment method. This value is only available for processed payrolls.
• RequestType
  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”.
• VerificationStatus
  The verification status of the bank account.
• WageType
  The contractor’s wage type, either “Fixed” or “Hourly”.