Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Contract Amendments

Automatable Contract Amendment

Check if a contract amendment request is automatable. If the contract amendment request is automatable, then after submission, it will instantly amend the employee's contract and send them an updated document.

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.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)-Manage contract amendments (contract_amendment:write)
post/v1/contract-amendments/automatable

Query parameters

integer

Specific version number

OR
'latest'

Use latest version

Version of the form schema

Headers

Authorizationstring required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

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": {
    "automatable": true,
    "message": "The contract amendment request will be processed as an automatable request."
  }
}