Skip to main content
PATCH
Edit Payroll Group
This is a partial update endpoint — only include the fields you want to change. Omitted fields remain unchanged.

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

Payroll Group ID

Body

application/json

Fields to update

Request body for updating an existing payroll group.

name
string
required

Payroll group name

group_rows
string[][]
required

Array of skillset groups. Each group is an array of skillset IDs.

locations
string[]
required

Location IDs to associate with this payroll group

payroll_item_id
string

External payroll item identifier

default_wage
number<float> | null

Default wage rate

invoice_cost
string

Invoice cost (accepts string for flexibility)

wage_rules_id
string

Associated wage rule identifier

Response

OK

A payroll group used to categorize shifts for payroll and invoicing purposes.

id
string

Payroll group identifier

name
string

Payroll group name

payroll_item_id
string | null

External payroll item identifier

default_wage
number<float> | null

Default wage rate

insert_date
string | null

Creation date

invoice_cost
number<float> | null

Invoice cost rate

wage_rules_id
string | null

Associated wage rule identifier

group_rows
string[]

Skillset combination row IDs

locations
string[]

Associated location IDs