Skip to main content
POST
Explain statutory holiday pay calculation

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
pay_stub_id
string
required

The pay stub to explain statutory holiday pay for.

holiday_dates
string<date>[]

Optional array of Y-m-d dates within the pay stub's pay period to treat as statutory holidays. When omitted, the statutory holidays for the work assignment's Province of Work (POW) are used.

configuration
object

Optional override of the work assignment's statutory holiday pay configuration. When omitted, the work assignment's ca_statutory_holiday_pay tax property in effect at the start of the pay period is used.

Response

200 - application/json

OK

id
string
read-only

The unique identifier of the object in Nmbr.

object
string
read-only

The type of the object in Nmbr ("statutory_holiday_pay_explanation").

data
Statutory Holiday Pay Explanation · object