v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

Get paydays

Returns a list of paydays and their corresponding period_start, period_end, and approval_deadline dates for the specified pay schedule. Results span one year of dates. If the payday or approval_deadline was impacted by a weekend or a bank holiday, then impacted_by_weekend_or_holiday will be true, otherwise false.

get/pay_schedules/{pay_schedule}/paydays

Path parameters

pay_schedulestring required

Query parameters

startstring date

Return paydays on or after this date.

Response

200

paydaystring

period_startstring

period_endstring

approval_deadlinestring

impacted_by_weekend_or_holidayboolean

approval_deadline_datetimestring

Example response

[
  {
    "payday": "2024-05-09",
    "period_start": "2024-04-16",
    "period_end": "2024-05-01",
    "approval_deadline": "2024-05-03",
    "approval_deadline_datetime": "2024-05-07T17:00:00-07:00"
  }
]