GuidesAPI ReferenceChangelogAPI PolicyAPI StatusGusto Security
API Reference
These docs are for v2023-09-01. Click to read the latest docs for v2024-04-01.

Update a contractor

Update a contractor.

scope: contractors:write

🚧

Warning

Watch out when changing a contractor's type (when the contractor is finished onboarding). Specifically, changing contractor type can be dangerous since Gusto won’t recognize and file two separate 1099s if they simply change from business to individual

Path Params
string
required

The UUID of the contractor

Body Params
string
required

The current version of the object. See the versioning guide for information on how to use this field.

string
Defaults to Individual

The contractor type.

string

The contractor’s wage type.

string

The day when the contractor will start working for the company.

string

The contractor’s hourly rate. This attribute is required if the wage_type is Hourly.

boolean
Defaults to false

Whether the contractor or the payroll admin will complete onboarding in Gusto.
Self-onboarding is recommended so that contractors receive Gusto accounts.
If self_onboarding is true, then email is required.

string

The contractor’s email address.

string

The contractor’s first name.
This attribute is required for Individual contractors and will be ignored for Business contractors.

string

The contractor’s last name.
This attribute is required for Individual contractors and will be ignored for Business contractors.

string

The contractor’s middle initial.
This attribute is optional for Individual contractors and will be ignored for Business contractors.

boolean
Defaults to false

The boolean flag indicating whether Gusto will file a new hire report for the contractor.
This attribute is optional for Individual contractors and will be ignored for Business contractors.

string | null

State where the contractor will be conducting the majority of their work for the company.
This value is used when generating the new hire report.
This attribute is required for Individual contractors if file_new_hire_report is true and will be ignored for Business contractors.

string

This attribute is optional for Individual contractors and will be ignored for Business contractors.
Social security number is needed to file the annual 1099 tax form.

string

The name of the contractor business. This attribute is required for Business contractors and will be ignored for Individual contractors.

string

The employer identification number of the contractor business.
This attribute is optional for Business contractors and will be ignored for Individual contractors.

boolean

The status of the contractor. If the contractor's start date is in the future, updating this field to true means we are setting the start date to today.

Headers
string

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Responses

Response body
object
string
required

The UUID of the contractor in Gusto.

string

The UUID of the company the contractor is employed by.

string

The contractor's wage type, either "Fixed" or "Hourly".

Fixed Hourly

boolean
Defaults to true

The status of the contractor with the company.

string

The current version of the object. See the versioning guide for information on how to use this field.

string

The contractor's type, either "Individual" or "Business".

Individual Business

string | null

The contractor’s first name. This attribute is required for β€œIndividual” contractors and will be ignored for β€œBusiness” contractors.

string | null

The contractor’s last name. This attribute is required for β€œIndividual” contractors and will be ignored for β€œBusiness” contractors.

string | null

The contractor’s middle initial. This attribute is optional for β€œIndividual” contractors and will be ignored for β€œBusiness” contractors.

string | null

The name of the contractor business. This attribute is required for β€œBusiness” contractors and will be ignored for β€œIndividual” contractors.

string | null

The Federal Employer Identification Number of the contractor business. This attribute is optional for β€œBusiness” contractors and will be ignored for β€œIndividual” contractors.

boolean | null

Whether company's Employer Identification Number (EIN) is present

string | null

The contractor’s email address. This attribute is optional for β€œIndividual” contractors and will be ignored for β€œBusiness” contractors.

string

The contractor's start date.

object

The contractor’s home address.

string
string | null
string
string
string
string
string

The contractor’s hourly rate. This attribute is required if the wage_type is β€œHourly”.

boolean
Defaults to false

The boolean flag indicating whether Gusto will file a new hire report for the contractor

string | null

State where the contractor will be conducting the majority of their work for the company.
This value is used when generating the new hire report.

boolean

The updated onboarding status for the contractor

string

One of the "onboarding_status" enum values.

admin_onboarding_incomplete admin_onboarding_review self_onboarding_not_invited self_onboarding_invited self_onboarding_started self_onboarding_review onboarding_completed

404

Not Found

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

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

Language
Credentials