Skip to content

Latest commit

 

History

History
executable file
·
247 lines (179 loc) · 15.3 KB

README.md

File metadata and controls

executable file
·
247 lines (179 loc) · 15.3 KB
Raw

contractorPayments

Available Operations

deleteV1CompaniesCompanyIdContractorPaymentContractorPayment

Cancels and deletes a contractor payment. If the contractor payment has already started processing, the payment cannot be cancelled.

scope: payrolls:run

Example Usage

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

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

sdk.contractorPayments.deleteV1CompaniesCompanyIdContractorPaymentContractorPayment(companyId, contractorPaymentId).then((res: DeleteV1CompaniesCompanyIdContractorPaymentContractorPaymentResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
companyId string ✔️ The UUID of the company
contractorPaymentId string ✔️ The UUID of the contractor payment
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.DeleteV1CompaniesCompanyIdContractorPaymentContractorPaymentResponse>

getV1CompaniesCompanyIdContractorPaymentContractorPayment

Returns a single contractor payments

scope: payrolls:read

Example Usage

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

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

sdk.contractorPayments.getV1CompaniesCompanyIdContractorPaymentContractorPayment(companyId, contractorPaymentId).then((res: GetV1CompaniesCompanyIdContractorPaymentContractorPaymentResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
companyId string ✔️ The UUID of the company
contractorPaymentId string ✔️ The UUID of the contractor payment
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.GetV1CompaniesCompanyIdContractorPaymentContractorPaymentResponse>

getV1CompaniesCompanyIdContractorPayments

Returns an object containing individual contractor payments, within a given time period, including totals.

scope: payrolls:read

Example Usage

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

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

sdk.contractorPayments.getV1CompaniesCompanyIdContractorPayments({
  companyId: "in",
  contractorUuid: "illum",
  endDate: "2020-12-31",
  groupByDate: false,
  page: 9785.71,
  per: 6994.79,
  startDate: "2020-01-01",
}).then((res: GetV1CompaniesCompanyIdContractorPaymentsResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
request operations.GetV1CompaniesCompanyIdContractorPaymentsRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.GetV1CompaniesCompanyIdContractorPaymentsResponse>

getV1ContractorPaymentsContractorPaymentUuidReceipt

Returns a contractor payment receipt.

Notes:

  • Receipts are only available for direct deposit payments and are only available once those payments have been funded.
  • Payroll Receipt requests for payrolls which do not have receipts available (e.g. payment by check) will return a 404 status.
  • Hour and dollar amounts are returned as string representations of numeric decimals.
  • Dollar amounts are represented to the cent.
  • If no data has yet be inserted for a given field, it defaults to “0.00” (for fixed amounts).

scope: payrolls:read

Example Usage

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

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

sdk.contractorPayments.getV1ContractorPaymentsContractorPaymentUuidReceipt(contractorPaymentUuid).then((res: GetV1ContractorPaymentsContractorPaymentUuidReceiptResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
contractorPaymentUuid string ✔️ The UUID of the contractor payment
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.GetV1ContractorPaymentsContractorPaymentUuidReceiptResponse>

postV1CompaniesCompanyIdContractorPayments

Pay a contractor. Information needed depends on the contractor's wage type (hourly vs fixed)

scope: payrolls:run

Example Usage

import { Gusto } from "@speakeasy-sdks/gusto";
import {
  PostV1CompaniesCompanyIdContractorPaymentsRequest,
  PostV1CompaniesCompanyIdContractorPaymentsRequestBody,
  PostV1CompaniesCompanyIdContractorPaymentsRequestBodyPaymentMethod,
  PostV1CompaniesCompanyIdContractorPaymentsResponse,
} from "@speakeasy-sdks/gusto/dist/sdk/models/operations";
import { RFCDate } from "@speakeasy-sdks/gusto/dist/sdk/types";

const sdk = new Gusto({
  security: {
    authorization: "",
  },
});
const companyId: string = "magnam";
const requestBody: PostV1CompaniesCompanyIdContractorPaymentsRequestBody = {
  bonus: 500,
  contractorUuid: "cumque",
  date: new RFCDate("2020-01-01"),
  hours: 40,
  paymentMethod: PostV1CompaniesCompanyIdContractorPaymentsRequestBodyPaymentMethod.HistoricalPayment,
  reimbursement: 20,
  wage: 5000,
};

sdk.contractorPayments.postV1CompaniesCompanyIdContractorPayments(companyId, requestBody).then((res: PostV1CompaniesCompanyIdContractorPaymentsResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
companyId string ✔️ The UUID of the company
requestBody operations.PostV1CompaniesCompanyIdContractorPaymentsRequestBody ➖ N/A
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.PostV1CompaniesCompanyIdContractorPaymentsResponse>