Create a contractor payment group

post https://api.gusto-demo.com/v1/companies/{company_id}/contractor_payment_groups

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

scope: payrolls:run

Responses

Response body

object

uuid

string

The unique identifier of the contractor payment group.

company_uuid

string

The UUID of the company.

check_date

string

The check date of the contractor payment group.

debit_date

string

The debit date of the contractor payment group.

status

string

The status of the contractor payment group. Will be Funded if all payments that should be funded (i.e. have Direct Deposit for payment method) are funded. A group can have status Funded while having associated payments that have status Unfunded, i.e. payment with Check payment method.

Unfunded Funded

creation_token

string | null

Token used to make contractor payment group creation idempotent. Will error if attempting to create a group with a duplicate token.

totals

object

amount

string

The total amount for the group of contractor payments.

debit_amount

string

The total debit amount for the group of contractor payments. Sum of wage & reimbursement amount.

wage_amount

string

The total wage amount for the group of contractor payments.

reimbursement_amount

string

The total reimbursement amount for the group of contractor payments.

contractor_payments

array of objects

contractor_payments

object

uuid

string

The unique identifier of the contractor payment in Gusto.

contractor_uuid

string

The UUID of the contractor.

bonus

string

The bonus amount in the payment.

hours

string

The number of hours worked for the payment.

payment_method

string

The payment method.

Direct Deposit Check Historical Payment Correction Payment

reimbursement

string

The reimbursement amount in the payment.

status

string

The status of the contractor payment. Will transition to Funded during payments processing if the payment should be funded, i.e. has Direct Deposit for payment method. Contractors payments with Check payment method will remain Unfunded.

Funded Unfunded

hourly_rate

string

The rate per hour worked for the payment.

may_cancel

boolean

Determine if the contractor payment can be cancelled.

wage

string

The fixed wage of the payment, regardless of hours worked.

wage_type

string

The wage type for the payment.

Hourly Fixed

wage_total

string

(hours * hourly_rate) + wage + bonus

404

Not Found

The requested resource does not exist. Make sure the provided UUID is valid.

`invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the Errors Categories guide for more details.

xxxxxxxxxx
curl --request POST \
     --url https://api.gusto-demo.com/v1/companies/company_id/contractor_payment_groups \
     --header 'X-Gusto-API-Version: 2024-04-01' \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

xxxxxxxxxx
}
{
  "uuid": "f693e034-d833-46e3-88d4-2c820c383c57",
  "company_uuid": "c54046f7-1be4-4c54-8194-f4842c30c86d",
  "check_date": "2024-05-07",
  "debit_date": "2024-05-01",
  "status": "Unfunded",
  "creation_token": "45ef81bb-ae24-4ad1-b2c6-6e563a4c30ed",
  "contractor_payments": [
    {
      "uuid": "630dc982-f498-4ebc-a6dc-4d76711027ce",
      "contractor_uuid": "2e6d0970-31bf-47ce-bdb4-713e4207ecf4",
      "bonus": "0.0",
      "hours": "40.0",
      "hourly_rate": "18.0",
      "may_cancel": false,
      "payment_method": "Direct Deposit",
      "reimbursement": "75.0",
      "status": "Unfunded",
      "wage": "0.0",
      "wage_type": "Hourly",
      "wage_total": "720.0"
    },
    {
      "uuid": "12f51eba-d653-4357-8c05-1f1f8d0fd5e3",
      "contractor_uuid": "a975fda0-fcf5-469a-a5fd-06e43d1cd99d",

200Full contractor payment group object

422Unprocessable Entity This may happen when the body of your request contains errors such as invalid_attribute_value, or the request fails due to an invalid_operation. See the Errors Categories guide for more details.

`invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the Errors Categories guide for more details.