Skip to content

Latest commit

 

History

History
executable file
·
97 lines (71 loc) · 8.09 KB

README.md

File metadata and controls

executable file
·
97 lines (71 loc) · 8.09 KB
Raw

federalTaxDetails

Available Operations

getV1CompaniesCompanyIdFederalTaxDetails

Fetches attributes relevant for a company's federal taxes.

Example Usage

import { Gusto } from "@speakeasy-sdks/gusto";
import {
  GetV1CompaniesCompanyIdFederalTaxDetailsRequest,
  GetV1CompaniesCompanyIdFederalTaxDetailsResponse,
  GetV1CompaniesCompanyIdFederalTaxDetailsSecurity,
} from "@speakeasy-sdks/gusto/dist/sdk/models/operations";

const sdk = new Gusto();
const companyId: string = "exercitationem";
const operationSecurity: GetV1CompaniesCompanyIdFederalTaxDetailsSecurity = {
  authorization: "",
};

sdk.federalTaxDetails.getV1CompaniesCompanyIdFederalTaxDetails(operationSecurity, companyId).then((res: GetV1CompaniesCompanyIdFederalTaxDetailsResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
security operations.GetV1CompaniesCompanyIdFederalTaxDetailsSecurity ✔️ The security requirements to use for the request.
companyId string ✔️ The UUID of the company
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.GetV1CompaniesCompanyIdFederalTaxDetailsResponse>

putV1CompaniesCompanyIdFederalTaxDetails

Updates attributes relevant for a company's federal taxes. This information is required is to onboard a company for use with Gusto Embedded Payroll.

Example Usage

import { Gusto } from "@speakeasy-sdks/gusto";
import {
  PutV1CompaniesCompanyIdFederalTaxDetailsRequest,
  PutV1CompaniesCompanyIdFederalTaxDetailsRequestBody,
  PutV1CompaniesCompanyIdFederalTaxDetailsResponse,
} from "@speakeasy-sdks/gusto/dist/sdk/models/operations";

const sdk = new Gusto({
  security: {
    authorization: "",
  },
});
const companyId: string = "earum";
const requestBody: PutV1CompaniesCompanyIdFederalTaxDetailsRequestBody = {
  ein: "facere",
  filingForm: "numquam",
  legalName: "doloribus",
  taxPayerType: "suscipit",
  taxableAsScorp: false,
  version: "reiciendis",
};

sdk.federalTaxDetails.putV1CompaniesCompanyIdFederalTaxDetails(companyId, requestBody).then((res: PutV1CompaniesCompanyIdFederalTaxDetailsResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
companyId string ✔️ The UUID of the company
requestBody operations.PutV1CompaniesCompanyIdFederalTaxDetailsRequestBody ➖ Attributes related to federal tax details that can be updated via this endpoint include:
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.PutV1CompaniesCompanyIdFederalTaxDetailsResponse>