> ## Documentation Index > Fetch the complete documentation index at: https://docs.nmbr.co/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /spec/openapi.json post /calculations/statutory_holiday_pay openapi: 3.0.0 info: title: Nmbr API description: API to interact with Nmbr Payroll version: 1.0.0 servers: - url: https://sandbox.nmbr.co/services/payroll security: - CompanyToken: [] tags: - name: Accounting Codes - name: Accounting Code Rules - name: Adjustments - name: Allowances - name: Allowance Line Items - name: Allowance Types - name: Async Tasks - name: Bank Accounts - name: Business Entities - name: Business Entity Verifications - name: Business Entity ROE Authorizations - name: Business Presets - name: Calculations - name: Companies - name: Contractors - name: Deductions - name: Deduction Line Items - name: Deduction Types - name: Earnings - name: Earning Line Items - name: Earning Types - name: Effective Tax Properties - name: Employees - name: Employee Benefits - name: Employee Benefit Line Items - name: Employee Benefit Types - name: Employer Benefits - name: Employer Benefit Line Items - name: Employer Benefit Types - name: Employer Statutory Withholding Line Items - name: Employer Statutory Withholding Types - name: Forms - name: Form Batches - name: Form Types - name: Holidays - name: Integrations - name: Journal Entries - name: Overtime Rates - name: Partners - name: Pay Rates - name: Pay Schedules - name: Pay Splits - name: Pay Stubs - name: Payments - name: Payrolls - name: Reimbursements - name: Reimbursement Line Items - name: Reimbursement Types - name: Remittance Accounts - name: Remittance Account Enrollments - name: Reports - name: Statutory Withholding Line Items - name: Statutory Withholding Types - name: Tags - name: Tag Groups - name: Tax Properties - name: Tax Property Templates - name: Tokens - name: Usage Records - name: Usage Summaries - name: Vacation Pay - name: Vacation Pay Settings - name: Webhooks - name: Work Assignments paths: /calculations/statutory_holiday_pay: post: tags: - Calculations summary: Explain statutory holiday pay calculation description: >- 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. operationId: calculations-statutory-holiday-pay requestBody: content: application/json: schema: allOf: - type: object properties: pay_stub_id: type: string description: The pay stub to explain statutory holiday pay for. holiday_dates: type: array description: >- 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. items: type: string format: date configuration: type: object description: >- 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. properties: calculate_entitlement: type: boolean calculation_strategy: type: string enum: - hours_only - provincial_rules_only - provincial_rules_or_hours override_rule_set: type: string enum: - AB - BC - FEDERAL - MB - NB - NL - NS - NT - NU - OC - 'ON' - PE - QC - SK - YT override_date_basis: type: string enum: - before_holiday_day - before_holiday_pay_period - before_holiday_week hours: type: number format: decimal minimum: 0 pay_rate: type: string enum: - earliest_effective_from - highest_expected_hours_per_week - highest_expected_weekly_amount - highest_rate - latest_effective_from - type: object required: - pay_stub_id example: pay_stub_id: configuration: calculate_entitlement: true calculation_strategy: provincial_rules_only responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: >- The type of the object in Nmbr (`"statutory_holiday_pay_explanation"`). readOnly: true data: $ref: '#/components/schemas/StatutoryHolidayPayExplanation' example: object: statutory_holiday_pay_explanation data: not_applicable_reason: null jurisdiction: ca_on configuration: calculate_entitlement: true calculation_strategy: provincial_rules_only override_rule_set: null override_date_basis: null hours: null pay_rate: null default_rules: - id: name: Regular earnings explanation: >- The last 4 weeks of eligible earnings, ending the day before the holiday week begins, divided by 20. earning_date_basis: before_holiday_week eligible_days_in_range: 28 eligible_work_days_in_range: 20 eligible_earning_types: - id: object: earning_type data: type: wage label: Wage supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/wage - id: object: earning_type data: type: retroactive_pay label: Retroactive Pay supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/retroactive_pay - id: object: earning_type data: type: retroactive_pay_increase label: Retroactive Pay Increase supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/retroactive_pay_increase - id: object: earning_type data: type: commission label: Commission (Non-Periodic) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/commission - id: object: earning_type data: type: commission_periodic label: Commission (Periodic) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/commission_periodic - id: object: earning_type data: type: bonus_non_discretionary label: Bonus (Non-Discretionary) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/bonus_non_discretionary - id: object: earning_type data: type: bonus_non_taxable label: Bonus (Non-Taxable) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/bonus_non_taxable - id: object: earning_type data: type: statutory_holiday_pay label: Statutory Holiday Pay supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/statutory_holiday_pay - id: object: earning_type data: type: leave_sick label: Leave (Sick) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/leave_sick - id: object: earning_type data: type: leave_general label: Leave (General) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/leave_general - id: object: earning_type data: type: leave_personal label: Leave (Personal) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/leave_personal - id: object: earning_type data: type: leave_bereavement label: Leave (Bereavement) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/leave_bereavement - id: object: earning_type data: type: leave_domestic_and_sexual_violence label: Leave (Domestic and Sexual Violence) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/leave_domestic_and_sexual_violence - id: object: earning_type data: type: leave_paternity label: Leave (Paternity) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/leave_paternity - id: object: earning_type data: type: leave_voting label: Leave (Voting) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/leave_voting - id: object: earning_type data: type: leave_wedding label: Leave (Wedding) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/leave_wedding - id: object: earning_type data: type: leave_citizenship label: Leave (citizenship) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/leave_citizenship - id: object: earning_type data: type: leave_jury_duty label: Leave (jury duty) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/leave_jury_duty - id: object: earning_type data: type: leave_organ_donor label: Leave (organ donor) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/leave_organ_donor - id: object: earning_type data: type: leave_parental label: Leave (parental) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/leave_parental - id: object: earning_type data: type: leave_maternity label: Leave (maternity) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/leave_maternity - id: object: earning_type data: type: vacation_pay label: Vacation Pay (Per Period) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/vacation_pay - id: object: earning_type data: type: vacation_pay_employee_terminated label: Vacation Pay (Employee Terminated) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/vacation_pay_employee_terminated - id: object: earning_type data: type: vacation_pay_time_taken label: Vacation Pay (Time Taken) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/vacation_pay_time_taken - id: object: earning_type data: type: vacation_pay_no_time_taken label: Vacation Pay (No Time Taken) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/vacation_pay_no_time_taken - id: object: earning_type data: type: time_off_in_lieu label: Time off in lieu supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/time_off_in_lieu eligible_allowance_types: [] eligible_reimbursement_types: [] overridden_rules: null holidays: - holiday: id: object: holiday data: jurisdiction: ca_on type: statutory name: Victoria Day name_translations: en: Victoria Day fr: Fête de la Reine name_translated: Victoria Day original_date: '2026-05-18' observed_date: '2026-05-18' created_at: '2026-01-26T20:16:33.000000Z' updated_at: '2026-01-26T20:16:33.000000Z' links: self: /holidays/ line_item_id: null amount: 229.57 hours: 7.35 entitlement: fixed_hours_calculation: null provincial_rules_calculation: - id: amount: 229.57 hours: 7.35 eligible_date_range: start: '2026-04-17' end: '2026-05-14' totals: dated_amount: 0 dated_hours: 0 undated_amount: 10000 undated_hours: 320 undated_amount_prorated: 4591.39785 undated_hours_prorated: 146.9247312 effective_amount: 4591.39785 effective_hours: 146.9247312 payroll_summaries: - payroll: id: object: payroll links: self: /payrolls/ pay_period: start: '2026-05-01' end: '2026-05-31' dated_amount_total: 0 dated_hours_total: 0 undated_amount_total: 5000 undated_hours_total: 160 eligible_days_in_pay_period: 14 days_in_pay_period: 31 undated_coverage_ratio: 0.4516129 undated_amount_prorated: 2258.0645 undated_hours_prorated: 72.258064 effective_amount: 2258.0645 effective_hours: 72.258064 earlier_holidays_amount: 0 earlier_holidays_hours: 0 dated_line_items: [] undated_line_items: - id: object: earning_line_item title: Hourly wage amount: 5000 hours: 160 - payroll: id: object: payroll links: self: /payrolls/ pay_period: start: '2026-04-01' end: '2026-04-30' dated_amount_total: 0 dated_hours_total: 0 undated_amount_total: 5000 undated_hours_total: 160 eligible_days_in_pay_period: 14 days_in_pay_period: 30 undated_coverage_ratio: 0.46666667 undated_amount_prorated: 2333.33335 undated_hours_prorated: 74.6666672 effective_amount: 2333.33335 effective_hours: 74.6666672 earlier_holidays_amount: 0 earlier_holidays_hours: 0 dated_line_items: [] undated_line_items: - id: object: earning_line_item title: Hourly wage amount: 5000 hours: 160 chosen_method: provincial_rules components: schemas: StatutoryHolidayPayExplanation: type: object title: Statutory Holiday Pay Explanation properties: not_applicable_reason: description: >- A machine-readable code describing why no entitlement was computed (one of `contractor_pay_stub`, `not_enabled`, `no_province_of_work`, `payroll_not_supported`). `null` when entitlement was calculated. jurisdiction: type: string description: >- The effective Province of Work (work assignment's POW with any `override_rule_set` applied) used to look up holidays and provincial rules, in `ca_xx` format (one of `ca_ab`, `ca_bc`, `ca_mb`, `ca_nb`, `ca_nl`, `ca_ns`, `ca_nt`, `ca_nu`, `ca_on`, `ca_pe`, `ca_qc`, `ca_sk`, `ca_yt`, or `ca_federal`). `null` when no Province of Work could be resolved. nullable: true configuration: type: object description: >- The Statutory Holiday Pay tax property configuration on the work assignment as of the start of the pay period, or the configuration override supplied in the request body. `null` when neither is present. nullable: true properties: calculate_entitlement: type: boolean calculation_strategy: type: string nullable: true override_rule_set: {} override_date_basis: {} hours: {} pay_rate: {} default_rules: type: array description: >- The rules defined by the work assignment's own Province of Work (ignoring any `override_rule_set`). Describes what would apply by default. nullable: true items: type: object properties: id: type: string description: >- The rule's stable identifier (e.g. `regular_earnings`, `commission`). Used to cross-reference per-holiday calculations under `holidays[].entitlement.provincial_rules_calculation[].id`. nullable: true name: type: string description: >- The translated human-readable name of the rule for the request locale. nullable: true explanation: type: string description: >- A prose sentence describing how this rule computes the entitlement (e.g. "The last 4 weeks of eligible earnings, ending the day before the holiday week begins, divided by 20."). nullable: true earning_date_basis: type: string description: >- Which calendar boundary the rule's look-back window ends on. One of `before_holiday_day`, `before_holiday_week`, or `before_holiday_pay_period`. nullable: true eligible_days_in_range: type: number description: >- The width of the look-back window in calendar days (e.g. 28 for Ontario's 4-week window). nullable: true format: decimal eligible_work_days_in_range: type: number description: >- The divisor used to convert the window's effective earnings into a per-holiday entitlement (e.g. 20 for Ontario). nullable: true format: decimal eligible_earning_types: type: array description: >- Earning types that count toward this rule's look-back sum. Earnings of types not listed here are excluded. nullable: true items: type: object properties: id: type: string nullable: true object: type: string nullable: true data: type: object nullable: true properties: type: type: string nullable: true label: type: string nullable: true supported_payroll_types: type: object nullable: true properties: regular: type: boolean historical: type: boolean off_cycle: type: boolean links: type: object nullable: true properties: self: type: string nullable: true eligible_allowance_types: type: object description: >- Allowance types that count toward this rule's look-back sum. Usually empty. nullable: true eligible_reimbursement_types: type: object description: >- Reimbursement types that count toward this rule's look-back sum. Usually empty. nullable: true overridden_rules: description: >- Only present when the configuration actually overrides something (either `override_rule_set` or `override_date_basis`). Describes the rules that are used in place of the defaults: sourced from the effective POW and with the overridden earning date basis applied to each rule's prose and `earning_date_basis` field. Each entry has the same shape as `default_rules`. holidays: type: array description: >- One entry per statutory holiday observed in the pay period (or per `holiday_dates` entry when an override was supplied in the request). nullable: true items: type: object properties: holiday: type: object description: >- The Holiday record being calculated against. `id` and timestamps are `null` for hypothetical holidays supplied via `holiday_dates`. nullable: true properties: id: type: string nullable: true object: type: string nullable: true data: type: object nullable: true properties: jurisdiction: type: string nullable: true type: type: string nullable: true name: type: string nullable: true name_translations: type: object nullable: true properties: en: type: string nullable: true fr: type: string nullable: true name_translated: type: string description: >- The translation of the `name` property for the request locale. Computed using the values in `name` and `name_translations` and the value of the request's `Accept-Language` header. readOnly: true original_date: type: string nullable: true observed_date: type: string nullable: true created_at: type: string nullable: true updated_at: type: string nullable: true links: type: object nullable: true properties: self: type: string nullable: true line_item_id: description: >- The id of the managed Statutory Holiday Pay earning line item on this pay stub that corresponds to this holiday. `null` when no managed line item exists yet (e.g. statutory holiday pay isn't enabled on the work assignment, the holiday was supplied as a hypothetical via `holiday_dates`, or the pay stub belongs to a Contractor). amount: type: number description: >- The dollar entitlement the employee is owed for this holiday, after applying the configuration's strategy. `0` when entitlement isn't being calculated (see `not_applicable_reason`). nullable: true format: decimal hours: type: number description: >- The hours that form the basis of `amount`, on the same basis as the amount. `0` when entitlement isn't being calculated. nullable: true format: decimal entitlement: type: object description: >- The breakdown of how `amount` and `hours` were computed. `null` when entitlement isn't being calculated for this pay stub. nullable: true properties: fixed_hours_calculation: description: >- The fixed-hours calculation result. Always populated under `hours_only` and `provincial_rules_or_hours` strategies; `null` under `provincial_rules_only`. provincial_rules_calculation: type: array description: >- Per-rule results from the provincial calculator. Always populated under `provincial_rules_only` and `provincial_rules_or_hours`; `null` under `hours_only`. Most provinces have a single `regular_earnings` rule; Quebec splits earnings and commissions into separate rules. nullable: true items: type: object properties: id: type: string description: >- The rule's identifier (e.g. `regular_earnings`). Matches an entry in `default_rules` / `overridden_rules`. nullable: true amount: type: number description: >- The entitlement this rule contributes to the holiday, computed as `totals.effective_amount ÷ eligible_work_days_in_range`. nullable: true format: decimal hours: type: number description: >- The hours basis for this rule's contribution, on the same basis as `amount`. nullable: true format: decimal eligible_date_range: type: object description: >- The look-back window for this rule, derived from the rule's `earning_date_basis` and `eligible_days_in_range`. Inclusive on both ends. nullable: true properties: start: type: string nullable: true end: type: string nullable: true totals: type: object description: >- Aggregated totals across every pay period that overlapped the look-back window, before dividing by the rule's `eligible_work_days_in_range`. `dated_*` fields sum line items whose `earned_on` date falls inside the window (included at 100%); `undated_*` fields sum line items without an `earned_on` (prorated by each pay period's coverage ratio); `effective_*` is `dated_*` plus `undated_*_prorated`. nullable: true properties: dated_amount: type: number nullable: true format: decimal dated_hours: type: number nullable: true format: decimal undated_amount: type: number nullable: true format: decimal undated_hours: type: number nullable: true format: decimal undated_amount_prorated: type: number description: >- `undated_amount` after applying each pay period's `undated_coverage_ratio`. This is the value that contributes to `effective_amount`. nullable: true format: decimal undated_hours_prorated: type: number description: >- `undated_hours` after applying each pay period's `undated_coverage_ratio`. nullable: true format: decimal effective_amount: type: number description: >- The numerator divided by `eligible_work_days_in_range` to produce the per-holiday `amount`. Equal to `dated_amount + undated_amount_prorated`. nullable: true format: decimal effective_hours: type: number description: >- The numerator divided by `eligible_work_days_in_range` to produce the per-holiday `hours`. Equal to `dated_hours + undated_hours_prorated`. nullable: true format: decimal payroll_summaries: type: array description: >- The per-payroll breakdown that produced `totals`. Each entry covers one paid prior payroll (or the current draft payroll) whose pay period overlapped the look-back window. nullable: true items: type: object properties: payroll: type: object description: The Payroll being summarized. nullable: true properties: id: type: string nullable: true object: type: string nullable: true links: type: object nullable: true properties: self: type: string nullable: true pay_period: type: object description: >- The pay period start/end dates for this payroll. Both inclusive. nullable: true properties: start: type: string nullable: true end: type: string nullable: true dated_amount_total: type: number nullable: true format: decimal dated_hours_total: type: number nullable: true format: decimal undated_amount_total: type: number nullable: true format: decimal undated_hours_total: type: number nullable: true format: decimal eligible_days_in_pay_period: type: number description: >- The number of calendar days from this pay period that fall inside the rule's `eligible_date_range`. The numerator of `undated_coverage_ratio`. nullable: true format: decimal days_in_pay_period: type: number description: >- The total number of calendar days in this pay period. The denominator of `undated_coverage_ratio`. nullable: true format: decimal undated_coverage_ratio: type: number description: >- The fraction of this pay period that overlaps the rule's `eligible_date_range`. Used to prorate the period's undated line items into the look-back sum. nullable: true format: decimal undated_amount_prorated: type: number nullable: true format: decimal undated_hours_prorated: type: number nullable: true format: decimal effective_amount: type: number nullable: true format: decimal effective_hours: type: number nullable: true format: decimal earlier_holidays_amount: type: number description: >- For cascading provincial rules (e.g. Ontario, where Statutory Holiday Pay itself counts as eligible earnings), the sum of entitlements computed for earlier holidays in the current pay period that fall inside this rule's eligible date range. Always `0` for prior payrolls' summaries. Treated as additional dated earnings. nullable: true format: decimal earlier_holidays_hours: type: number description: >- The hours equivalent of `earlier_holidays_amount`. nullable: true format: decimal dated_line_items: type: object description: >- The line items from this pay period's pay stub that have an `earned_on` date. Each entry's `in_range` flag indicates whether the `earned_on` falls inside the rule's `eligible_date_range` and therefore counted toward `dated_amount` / `dated_hours`. nullable: true undated_line_items: type: array description: >- The line items from this pay period's pay stub that have no `earned_on` date — they're assumed to be spread evenly across the period and contribute to `undated_amount` / `undated_hours` after proration by `undated_coverage_ratio`. nullable: true items: type: object properties: id: type: string nullable: true object: type: string nullable: true title: type: string nullable: true amount: type: number nullable: true format: decimal hours: type: number nullable: true format: decimal chosen_method: type: string description: >- Which calculator produced the chosen amount. Either `provincial_rules` or `fixed_hours`. Under `provincial_rules_or_hours` this can differ per holiday — the engine picks whichever yields the larger entitlement. nullable: true securitySchemes: CompanyToken: type: http scheme: bearer ````