Deactivate a contractor employment

Deactivates a Contractor Management (CM/CM+) contractor: the employment is
archived and the contractor's user account is deactivated.

Only contractor employments are supported; any other employment type returns
a 422. Contractor of Record (COR) employments cannot be deactivated through
this endpoint and return a 422.

Requirements:

  • The contractor's user account must be active.
  • The employment status must be created or active.
  • The requesting user must be allowed to manage this contractor. Managing
    a contractor who has completed onboarding requires the
    people-onboarded/update permission; without it the request returns a 403.

Deactivation also deletes or cancels the contractor's open resources, and
these are NOT restored by a later activation: recurring contractor invoices,
scheduled contractor invoices, open contractor invoices, recurring
incentives, automatic payments and pending time off. Pending contract
documents are archived and the contract is set to inactive.

Be aware of the following consequences, which match deactivating a
contractor in the Remote app:

  • An active Contractor Plus subscription is scheduled to end at the end of
    the following month; a pending (not yet started) Contractor Plus upgrade
    is cancelled immediately. Neither is restored by a later activation.
  • If the contractor also has a company admin profile, that profile is
    deleted.
  • Payments that are already processing remain billable.
  • The contractor's signed Statements of Work are ended.

On success the employment.user_status.deactivated webhook is triggered.

Calling this endpoint for an employment that is already deactivated returns
a 422 with a descriptive message.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)-Manage employments (employment:write)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Employment ID

Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json