@speakeasy-sdks/gusto
TypeScript icon, indicating that this package has built-in type declarations

0.49.0 • Public • Published

Gusto's people platform helps growing businesses onboard, pay, insure, and support their hardworking teams with payroll, benefits, and more.

SDK Installation

NPM

npm add @speakeasy-sdks/gusto

Yarn

yarn add @speakeasy-sdks/gusto

Authentication

To get started, fill out a Production Pre-Approval form, sign up for a Developer Portal account and onboard to our sandbox environment.

Once you’ve created an account and completed your Organization setup, you will have access to your unique API token from the Organizations tab. This is used for provisioning new Gusto accounts.

Next, create an application to obtain API credentials - or “keys” - to access our demo environment. To create an application, you will need to provide at least one(1) redirect URI. You can enter multiple redirects for a single application - please do this instead of creating multiple applications for each one. OAuth2 does not support wildcard URIs or URIs with fragments (e.g #).

The application will generate a unique client_id and secret to be used for authentication.

Then create a demo company so that you can explore our product and successfully connect your application to Gusto via OAuth2 to begin making calls to the API. Demo companies are automatically generated with company info, employees, and previous payrolls so you can begin testing right away. The Authentication Example has everything you need to get started.

Once you have your API Token, client_id, secret, and a demo company, you’re ready to begin building your integration. Check out this short video tutorial for an introduction on testing the Gusto API (in demo).

SDK Example Usage

import { Gusto } from "@speakeasy-sdks/gusto";
import {
  GetV1CompaniesCompanyIdBankAccountsRequest,
  GetV1CompaniesCompanyIdBankAccountsResponse,
} from "@speakeasy-sdks/gusto/dist/sdk/models/operations";

const sdk = new Gusto({
  security: {
    authorization: "",
  },
});
const companyId: string = "corrupti";

sdk.bankAccounts.getV1CompaniesCompanyIdBankAccounts(companyId).then((res: GetV1CompaniesCompanyIdBankAccountsResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Available Resources and Operations

bankAccounts

companies

companyBenefits

companyForms

contractorForms

contractorPaymentMethod

contractorPayments

contractors

departments

earningTypes

employeeBenefits

employeeForms

employeePaymentMethod

employeeTaxSetup

employeeTermination

employees

externalPayrolls

federalTaxDetails

flows

garnishments

generatedDocuments

industrySelection

jobsAndCompensations

locations

paySchedules

paymentConfigs

payrolls

signatories

taxLiabilities

taxRequirements

timeOffPolicies

user

webhookSubscriptions

SDK Generated by Speakeasy

Readme

Keywords

none

Package Sidebar

Install

npm i @speakeasy-sdks/gusto

Weekly Downloads

10

Version

0.49.0

License

none

Unpacked Size

6.02 MB

Total Files

1348

Last publish

Collaborators

  • ccrumbaugh
  • ghaidar-speakeasy
  • ndimares
  • thomasrooneyspeakeasy
  • speakeasysimon
  • tristanspeakeasy
  • simplesagar