Sign in

v5

latestOpenAPI 3.0.02026-08-044441026.8 MB
Calculations

Explain statutory holiday pay calculation

Explain how statutory holiday pay would be calculated for the pay stub's work assignment, optionally overriding which dates are treated as holidays and/or the statutory holiday pay configuration. With no overrides, behaves as a pure explanation of how statutory holiday pay was or will be calculated under the work assignment's current configuration.

post/calculations/statutory_holiday_pay

Request body

pay_stub_idstring required

The pay stub to explain statutory holiday pay for.

holiday_datesstring[]

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.

Response

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

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