Testing & Sandbox
Sandbox

Seed a contractor rate

Changed on

Sets the contractor's main rate, the same way an employer's rate edit does. A main rate without a service_start_date is updated in place and keeps its id. A main rate with one belongs to a Statement of Work and is kept: seeding adds a new main rate beside it, and the list endpoint returns both while that Statement of Work is in force. This lets the rate endpoints be exercised without going through contract signature. Contractor Management Plus contractors cannot be seeded: the endpoint returns 422.

The currency is derived from the legal entity the contractor is paid in by. A rate in a currency the contractor cannot be paid in is rejected with 422.

This endpoint is only available in Sandbox, otherwise it will respond with a 404.

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.
post/v1/sandbox/contractors/employments/{employment_id}/rates

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/sandbox/contractors/employments/{employment_id}/rates
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token)

Path parameters

employment_idstring required

Contractor employment ID

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

amountstring required

The amount paid per type, in the major unit, e.g. 103.83.

pay_frequency'weekly' | 'bi_weekly' | 'semi_monthly' | 'monthly' nullable

How often the contractor is paid. Must be null or omitted for a one_off rate.

type'hourly' | 'daily' | 'weekly' | 'monthly' | 'one_off' required

The unit the amount is paid per.

Example request

{
  "amount": "103.83",
  "pay_frequency": "monthly",
  "type": "hourly"
}

Response

Created

Example response

{
  "data": {
    "amount": {
      "amount": "109.87",
      "currency": {
        "code": "EUR",
        "name": "Euro",
        "symbol": "€"
      }
    },
    "contract_expiration_date": null,
    "contract_start_date": "2026-01-01",
    "id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
    "pay_frequency": "monthly",
    "service_end_date": null,
    "service_start_date": "2026-01-01",
    "type": "hourly"
  }
}

Changes