Add Pay Rule

post

https://api.joinplanbase.com/api/v1/pay_rules

Add a new pay rule to the current user's organization. This may include attributes such as unique name, and associated roles or departments.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

The name of the pay rule

export_code

The export code used for payroll system exports

enabled

Whether this pay rule is enabled

pay_rule_amounts

array | null

The associated pay rule amounts

is_override

Whether this pay rule is an override

after_week_hours_condition

Only apply rule after these hours have been worked in a week

on_condition

array | null

Only apply rule if working on these days

time_condition

array | null

Only apply rule if working on these times

custom_object_count_conditions

array | null

Only apply rule if the number of custom objects meets these conditions

between_week_hours_condition

array | null

Only apply rule if working between these hours

include_shifts_without_tags

Whether to include shifts without tags in the rule

team_ids

array | null

List of teams that use this pay rule

role_ids

array | null

List of roles that use this pay rule

person_ids

array | null

List of people that use this pay rule

shift_type_ids

array | null

List of shift types that trigger this pay rule

custom_option_ids

array | null

List of custom options that trigger this pay rule

Responses

200Successful Response

422Validation Error