Employments
Employment Management

Set contract origin for a contractor employment

Changed on

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 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)
post/v1/employments/{employment_id}/contract-origin

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/employments/{employment_id}/contract-origin
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, employment:write, employments, all:write)

Path parameters

employment_idstring required

Employment ID

Request body

contract_origin'remote_contract' | 'custom_remote_contract' | 'provided_by_customer' required
template_type'contractor_agreement' | 'contractor_services_agreement' | 'contractor_statement_of_work' | 'custom_contractor_agreement' | 'custom_contractor_agreement_v2' required

Required when contract_origin is remote_contract or custom_remote_contract, ignored when provided_by_customer

Example request

{
  "contract_origin": "provided_by_customer",
  "template_type": "contractor_agreement"
}

Response

Success

Example response

{
  "data": {
    "status": "ok"
  }
}

Changes