---
title: "GET /v1/payroll/deductions"
method: GET
path: "/v1/payroll/deductions"
tags: ["Payroll"]
---

# GET /v1/payroll/deductions

`GET /v1/payroll/deductions`

## Request

- Base URL: `https://open.wenmarpro.com`
- URL: `https://open.wenmarpro.com/v1/payroll/deductions`
- Auth: none declared

## Query parameters

- `province` string
- `frequency` string
- `gross` string
- `federal_claim` string
- `provincial_claim` string
- `pay_date` string
- `ytd_cpp` string
- `ytd_cpp2` string
- `ytd_ei` string
- `ytd_pensionable` string

## Response `200`

The deductions from the pay, the net pay, the employer's share and every T4127 factor used. An estimate.

- PayrollDeductions: The deductions from one regular pay in Ontario, by CRA's T4127 formulas.
  - `attribution` string[], required: The data this answer came from; none, the engine's tables are the data.
  - `edition` PayrollEdition, required: The edition of T4127 the answer was worked out with.
    - `effective` string, required: The first pay date the tables cover, `YYYY-MM-DD`.
    - `number` integer, required: The edition number.
    - `title` string, required: "T4127 Payroll Deductions Formulas, 123rd edition".
    - `url` string, nullable: Where CRA publishes the edition.
    - `valid_until` string, required: The last pay date the tables cover, `YYYY-MM-DD`.
  - `employee` PayrollEmployee, required: The employee's deductions on one pay, in dollars.
    - `cpp` number, double, required: CPP (base and first additional).
    - `cpp2` number, double, required: CPP2.
    - `ei` number, double, required: EI.
    - `federal_tax` number, double, required: Federal income tax.
    - `provincial_tax` number, double, required: Ontario income tax.
    - `total` number, double, required: Income tax, CPP, CPP2 and EI.
    - `total_tax` number, double, required: Federal and Ontario income tax.
  - `employer` PayrollEmployer, required: The employer's share on one pay, in dollars.
    - `cpp` number, double, required: CPP (base and first additional).
    - `cpp2` number, double, required: CPP2.
    - `ei` number, double, required: EI.
    - `total` number, double, required: CPP, CPP2 and EI.
  - `factors` PayrollFactor[], required: Every T4127 factor used, with the value used and what it means.
    - `meaning` string, required: What the factor means.
    - `name` string, required: The name the engine gives the factor.
    - `value` number, double, required: The value used, after rounding.
  - `federal_claim` PayrollClaim, required: A claim amount used, in dollars, and whether it is the tables' basic amount.
    - `amount` number, double, required: The claim amount, in dollars.
    - `basic` boolean, required: `true` when the amount is the tables' basic amount (claim code 1).
  - `frequency` string, required: The frequency slug: `weekly`, `biweekly`, `semi-monthly` or `monthly`.
  - `gross` number, double, required: The gross pay for the period, in dollars.
  - `net_pay` number, double, required: Gross pay less the employee's deductions, in dollars.
  - `note` string, required: The note that the answer is an estimate.
  - `pay_date` string, required: The pay date, `YYYY-MM-DD`.
  - `pay_date_note` string, nullable: Said when the pay date was moved into the tables held.
  - `pdoc_url` string, required: CRA's Payroll Deductions Online Calculator.
  - `periods_per_year` integer, required: Pay periods in the year.
  - `province` string, required: "ON".
  - `provincial_claim` PayrollClaim, required: A claim amount used, in dollars, and whether it is the tables' basic amount.
    - `amount` number, double, required: The claim amount, in dollars.
    - `basic` boolean, required: `true` when the amount is the tables' basic amount (claim code 1).
  - `year_to_date` PayrollYearToDate, required: What was deducted and earned on earlier pays this calendar year, in dollars.
    - `cpp` number, double, required: CPP (base and first additional) deducted earlier this year.
    - `cpp2` number, double, required: CPP2 deducted earlier this year.
    - `ei` number, double, required: EI deducted earlier this year.
    - `pensionable` number, double, required: Pensionable earnings earlier this year.

## Other responses

- `400`: `validation_failed`: a field cannot be read, the pay date is outside the tables held, or the province is not Ontario; `details.field` names the field.

---

[API](https://skmtc.dev/wenmarpro/apis/wenmar-open.md) · [All operations](https://skmtc.dev/wenmarpro/apis/wenmar-open/llms.txt) · [OpenAPI document](https://skmtc.dev/wenmarpro/apis/wenmar-open/revisions/1027b548b6f0?raw)