Sign in

v4

latestOpenAPI 3.0.02026-07-314441026.8 MB
Contractors

Update a contractor

put/contractors/{contractor}

Path parameters

contractorstring required

Request body

business_namestring nullable

The contractor's business or corporation name. null for individual contractors.

first_namestring nullable

The contractor's first name. null for corporation contractors.

last_namestring nullable

The contractor's last name. null for corporation contractors.

middle_initialstring nullable

The contractor's middle initial. null for corporation contractors.

emailstring

The contractor's email address, used for payroll communications.

business_numberstring

The contractor's 15-character (BN15) Canada Revenue Agency (CRA) program account number, consisting of a 9-digit Business Number (BN), a 2-letter program identifier, and a 4-digit reference number. null for individual contractors.

sinstring

The contractor's Social Insurance Number (SIN). null for corporation contractors.

external_refstring
preferred_locale'en' | 'fr'

The locale used for payroll communications sent to this contractor, such as Pay Stub emails. If not set, the Business Entity's locale is used.

archived_atstring date

The date the contractor was archived. Archiving a contractor also archives all Work Assignments that are not already archived. Archived contractors do not appear in active listings.

Response

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

The type of the object in Nmbr ("contractor").