Pay Configs
API endpoints for pay configs
The pay config object
A pay config sets what someone is paid for being on call: a base rate, plus rules that override it at particular times. An on-call pay report prices each person's shifts against one.
Rules are evaluated in the order they are returned, and the first one that covers a shift wins. Any time no rule covers is paid at the base rate.
Rate paid for any time no rule covers, in the lowest denomination of the currency
1200
"2021-08-17T13:28:57.801578Z"
Currency this config pays in, in ISO 4217 format
"GBP"
Unique identifier for this pay config
"01G0J1EXE7AXZ2C93K61WBPYEH"
Human readable name for this pay config
"Engineering on-call"
Rules that apply over a single window of time, such as a public holiday
Show child attributes
Show child attributes
[ { "end_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Christmas day", "rate_cents": 4800, "start_at": "2021-08-17T13:28:57.801578Z" } ]
The unit of time every rate on this config is quoted per. Pay is pro-rated by the second either way.
hour, day "hour"
IANA timezone this config's rules are interpreted in
"Europe/London"
"2021-08-17T13:28:57.801578Z"
Rules that apply every week, by day of week and time of day, in evaluation order
Show child attributes
Show child attributes
[ { "end_time": "17:00", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "rate_cents": 2400, "start_time": "09:00", "weekdays": ["monday"] } ]
When a published report first priced against this config. Once set, editing the config needs the schedule_pay_configs.update_published scope.
"2021-08-17T13:28:57.801578Z"
Was this page helpful?
{
"base_rate_cents": 1200,
"created_at": "2021-08-17T13:28:57.801578Z",
"currency": "GBP",
"id": "01G0J1EXE7AXZ2C93K61WBPYEH",
"name": "Engineering on-call",
"one_off_rules": [
{
"end_at": "2021-08-17T13:28:57.801578Z",
"id": "01G0J1EXE7AXZ2C93K61WBPYEH",
"name": "Christmas day",
"rate_cents": 4800,
"start_at": "2021-08-17T13:28:57.801578Z"
}
],
"rate_time_unit": "hour",
"timezone": "Europe/London",
"updated_at": "2021-08-17T13:28:57.801578Z",
"weekly_rules": [
{
"end_time": "17:00",
"id": "01G0J1EXE7AXZ2C93K61WBPYEH",
"rate_cents": 2400,
"start_time": "09:00",
"weekdays": [
"monday"
]
}
],
"published_at": "2021-08-17T13:28:57.801578Z"
}