Seed a contractor rate

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 of Record contractors, including ones not
active yet, and Contractor Management Plus contractors whose contract is signed cannot be seeded,
since their Statement of Work sets the rate: 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.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Contractor employment ID

Body Params

Contractor rate params

Parameters for seeding a contractor rate in Sandbox.

string
required

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

string | null
enum

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

Allowed:
string
enum
required

The unit the amount is paid per.

Allowed:
Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json