Set contract origin for a contractor employment

Sets the contract_origin for a contractor employment.

  • remote_contract — Remote provides and manages the contract (a contract document is created)
  • custom_remote_contract — A customised Remote contract is used (a contract document is created)
  • provided_by_customer — The employer provides their own contract (no contract document is created)

When provided_by_customer is selected, the contractor can be invited without completing the
contract_details onboarding step.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:write works too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage employments (employments)-Manage employments (employment:write)
Company-scoped access token (assertion)Manage employments (employments)-Manage employments (employment:write)
Customer API tokenManage 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

Body Params

Contract origin parameters

string
enum
required
Allowed:
string
enum
required

Required when contract_origin is remote_contract or custom_remote_contract, ignored when provided_by_customer

Allowed:
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