Module gusto_api::types [−][src]
Expand description
The data types sent to and returned from the API client.
Structs
The contractor’s home address.
The representation of an admin user in Gusto.
This value will be null if the request has not been approved.
The representation of a company in Gusto.
The company bank account
The representation of a company benefit.
A custom field on a company
The representation of compensation in Gusto.
The available company-wide compensation rates for the company.
The representation of a contractor (individual or business) in Gusto.
The representation of a single contractor payment.
The representation of the summary of contractor payments for a given company in a given time period.
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.
The representation of an employee in Gusto.
The representation of an employee benefit.
A custom field of an employee
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.
The representation of a job in Gusto.
The representation of a job applicant in Gusto.
The representation of an address in Gusto.
The representation of paid time off in Gusto.
The representation of a pay period.
The representation of a pay schedule.
Information about the payroll for the pay period.
The primary payroll admin of the company.
The primary signatory of the company.
An array of fixed compensations for the employee. Fixed compensations include tips, bonuses, and one time reimbursements.
An array of hourly compensations for the employee. Hourly compensations include regular, overtime, and double overtime hours.
An object containing each of the user’s permissions.
The representation of a termination in Gusto.
The representation of a time off request.
The wage and reimbursement totals for all contractor payments within a given time period.
The subtotals for the payroll.
Information for the user who will be the primary payroll administrator for the new company.
Enums
Bank account type
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.
The wage type for the payment.
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.
The tax payer type of the company.
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.
Include the requested attribute in the employee_compensations attribute in the response
Must be “Employee” if send_offer is set to true.
The payment method.
The unit accompanying the compensation rate. If the employee is an owner, rate should be ‘Paycheck’.
The employee’s compensation payment method. This value is only available for processed payrolls.
The bank account type
The contractor type, either an “Individual” or a “Business”.
The contractor’s wage type, either “Fixed” or “Hourly”.
The contractor’s wage type, either “Fixed” or “Hourly”.
The type of time off request.
The Gusto product tier of the company.
The status of the time off request.
The contractor’s type, either “Individual” or “Business”.
The verification status of the bank account.
The contractor’s wage type, either “Fixed” or “Hourly”.