REremote-com
Contract Amendments

Create Contract Amendment

Creates a Contract Amendment request.

This endpoint requires and returns country-specific data. The exact required and returned fields will vary depending on which country the employment is in. To see the list of parameters for each country, see the Show form schema endpoint under the Contract Amendments category.

Please note that the compliance requirements for each country are subject to change according to local laws. Given its continual updates, using Remote's json-schema-form should be considered in order to avoid compliance issues and to have the latest version of a country requirements.

If you are using this endpoint to build an integration, make sure you are dynamically collecting or displaying the latest parameters for each country by querying the "Show form schema" endpoint.

For more information on JSON Schemas, see the How JSON Schemas work documentation.

To learn how you can dynamically generate forms to display in your UI, see the documentation for the json-schema-form tool.

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 contract amendments (contract_amendment:write)
Company-scoped access token (assertion)Manage employments (employments)-Manage contract amendments (contract_amendment:write)
Customer API tokenManage employments (employments)-Manage contract amendments (contract_amendment:write)
post/v1/contract-amendments

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/contract-amendments
  • Auth
    • OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: contract_amendment:write
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: contract_amendment:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:write
    • or HTTP bearer

Query parameters

integer

Specific version number

OR
'latest'

Use latest version

Version of the form schema

Headers

Authorizationstring required

An access token of one of the types listed in this endpoint's Authentication section, as Bearer <ACCESS TOKEN>.

A token from the Refresh Token flow is of the same type as the token issued with that refresh token.

Request body

amendment_contract_idstring required

The contract ID of the contract that needs to be amended.

contract_amendmentobject required

Contract amendment informations. As its properties may vary depending on the country, you must query the Show form schema endpoint passing the country code, contract_amendment and the employment ID as request body.

employment_idstring required

The employment ID that is related to the contract amendment request.

Example request

{
  "amendment_contract_id": "c15993d8-aa8a-4fbb-b395-8b7a54f57db1",
  "contract_amendment": {},
  "employment_id": "e31adae1-company-id-af5fba7dd803"
}

Response

Success

Example response

{
  "data": {
    "contract_amendment": {
      "amendment_contract_id": "8772a9f1-b43c-46be-a1ce-e50b6819f5ee",
      "changes": {
        "compensation.amount": {
          "current": 500000,
          "previous": 400000
        },
        "contract.job_title": {
          "current": "A new job title",
          "previous": "An old job title"
        },
        "contract_details.details.contract_duration_type": {
          "current": "fixed_term",
          "previous": "indefinite"
        }
      },
      "employment_id": "1e74fdc2-7420-4eef-ab0a-b794cbbef4e1",
      "id": "ba310525-9282-40c9-8977-14d844bf891a",
      "request_details": {
        "additional_comments": null,
        "effective_date": "2024-03-04",
        "reason_for_change": "annual_pay_adjustment",
        "reason_for_change_description": null,
        "salary_decrease_details": null
      },
      "requested_by": "5a31f3c1-d7a7-4311-89cb-928959d3d540",
      "status": "submitted",
      "submitted_at": "2023-04-13T13:35:06Z",
      "zendesk_ticket_url": "https://zendesk.com/ticket-23333"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.