API Reference

Update a contract for a person

patch
https://api.runn.io/people//contracts/

Update one of a person's contracts. Adding an end date to an ongoing contract here lets the person be archived (see PATCH /people/{personId}).

Path Params
integer
required
integer
required
Body Params
integer
date

Defaults to today. Format: YYYY-MM-DD

date | null

Format: YYYY-MM-DD

string
enum
Defaults to employee

The type of employment for the contract.

Allowed:
number

Defaults to the role's cost per hour

number
≥ 1

Defaults to the account's default minutes per day

rosteredDays
object

Every value must be the same as minutesPerDay or 0.

string

This feature is currently hidden, and can not be seen in the app

Headers
enum
required
Defaults to 1.0.0
Allowed:
Responses

Updated 7 days ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago

Did this page help you?