Skip to main content
POST
Create Pay Group

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required

Body

application/json
name
string
required
period_type
enum<string>
required
Available options:
WEEK,
MONTH
payroll_mode
enum<string>
default:POSITIVE_PAY
Available options:
POSITIVE_PAY,
NET_CHANGE
pension_prp_method
enum<string>
default:METHOD_A

How the pension pay reference period (PRP) of a pay group's payruns is set.

METHOD_A: the pay period. METHOD_B: the tax week or tax month containing the pay date.

Available options:
METHOD_A,
METHOD_B

Response

Successful Response

id
string
required
name
string
required
period_type
enum<string>
required
Available options:
WEEK,
MONTH
payroll_mode
enum<string>
default:POSITIVE_PAY
Available options:
POSITIVE_PAY,
NET_CHANGE
pension_prp_method
enum<string>
default:METHOD_A

How the pension pay reference period (PRP) of a pay group's payruns is set.

METHOD_A: the pay period. METHOD_B: the tax week or tax month containing the pay date.

Available options:
METHOD_A,
METHOD_B