Contractors
Contract Documents

Create a contract document for a contractor

Changed on

Create a contract document for a contractor.

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 employment documents (employment_documents)-Manage documents (document:write)
post/v1/contractors/employments/{employment_id}/contract-documents

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/contractors/employments/{employment_id}/contract-documents
  • 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, document:write, employment_documents, all:write)

Path parameters

employment_idstring required

Employment ID

Request body

contract_documentobject required

Contract document parameters. Its properties may vary depending on the country.

skip_ai_checksboolean

When true, skips AI-based compliance checks (e.g. services and deliverables classification). Defaults to false.

Example request

{
  "contract_document": {},
  "skip_ai_checks": false
}

Response

Success

Example response

{
  "data": {
    "contract_document": {
      "id": "0073fcb5-b669-4e4a-b963-2a47744e75a1",
      "status": "draft"
    }
  }
}

Changes

  • c9d3f8b8186aRevision changes
    • warning

      added the new deadline_passed enum value to the // response property for the response status