Retrieve Pay Period Timespans

get https://{hostname}/api/v1/commons/pay_period

This resource returns a pay period timespan based on the pay period ID, pay rule ID, user, date, and period type. The system supports the following parameter combinations:

pay_period_id returns the pay period timespan for the specified pay period ID.
pay_rule_id returns the pay period timespan for the specified pay rule ID.
user returns the current pay period timespan for the specified user ID.
date returns the pay period timespan for the specified date for the current logged-in user.
user specified in conjunction with date returns the pay period timespan for the specified user and date.
period_type can be specified as Previous, Current, or Next to return the appropriate pay period timespan.
period_type can be specified in conjunction with user_id, pay_period_id, or pay_rule_id.
If no parameter is specified, this resource returns the current pay period for the current logged-in user.
If other parameter combinations are specified, the system considers the parameters in the following order:
1. pay period id
2. pay rule id
3. user
4. date

Language

Credentials

Bearer

JWT

URL