---
title: "Update a pay stub"
method: PUT
path: "/pay_stubs/{pay_stub}"
tags: ["Pay Stubs"]
---

# Update a pay stub

`PUT /pay_stubs/{pay_stub}`

## Path parameters

- `pay_stub` string, required

## Request body

- object
  - `payment_method` 'direct_deposit' | 'manual' | 'pad' | 'wire' — The payment method for this pay stub.
  - `note` string, nullable — An optional note on the pay stub, visible to the partner.
  - `external_ref` string
  - `apply_standard_tax_reductions` boolean — When `true`, the standard tax reductions are applied to this pay stub's withholdings even in cases where they would otherwise be skipped to avoid applying them twice across related runs in the same period. In Canada these reductions are the employee's federal and provincial personal tax credits (their TD1 claim amounts) and the CPP/QPP basic exemption. Defaults to `false`, and has no effect where those reductions already apply.

## Response `200`

OK

- object
  - `id` string — The unique identifier of the object in Nmbr.
  - `object` string — The type of the object in Nmbr (`"pay_stub"`).
  - `data` PayStub
    - `payroll` object
      - `id` string — The unique identifier of the object in Nmbr.
      - `object` string — The type of the object in Nmbr (`"payroll"`).
    - `work_assignment` object
      - `id` string — The unique identifier of the object in Nmbr.
      - `object` string — The type of the object in Nmbr (`"work_assignment"`).
    - `payment_method` 'direct_deposit' | 'manual' | 'pad' | 'wire' — The payment method for this pay stub.
    - `has_taxes_calculated` boolean — Whether tax amounts have been calculated for this pay stub. When `false`, amounts in the `employee_summary` and `company_summary` may be incomplete.
    - `is_pending_tax_rates` boolean — This attribute is deprecated and will be removed.
    - `employee_summary` object, nullable — A summary of pay for the Employee associated with this pay stub. Both `employee_summary` and `contractor_summary` are always present. The summary that does not apply is empty rather than omitted, and its amounts may be `null` before summaries are calculated. For calculated summaries, the side with a non-null `net` is the populated summary. `*_ytd` fields contain year-to-date totals inclusive of this pay period.
      - `gross` number, nullable — The sum of all earnings and allowances.
      - `subtractions` number, nullable — The total of all deductions, taxes, and benefit contributions.
      - `reimbursements` number, nullable — The total of non-taxable reimbursements.
      - `net` number, nullable — The Employee net pay; when negative, a warning is included.
      - `gross_ytd` number, nullable
      - `subtractions_ytd` number, nullable
      - `reimbursements_ytd` number, nullable
      - `net_ytd` number, nullable
    - `contractor_summary` object, nullable — A summary of pay for the Contractor associated with this pay stub. Always present. For calculated summaries, a non-null `contractor_summary.net` means the contractor summary is populated. `*_ytd` fields contain year-to-date totals inclusive of this pay period.
      - `gross` unknown
      - `reimbursements` unknown
      - `net` unknown
      - `gross_ytd` number, nullable
      - `reimbursements_ytd` number, nullable
      - `net_ytd` number, nullable
    - `company_summary` object, nullable — A summary of the company's obligations for this pay stub. `*_ytd` fields contain year-to-date totals inclusive of this pay period.
      - `taxes_and_contributions` number, nullable — The employer share of statutory remittances (CPP and EI).
      - `benefits` number, nullable — The total of employer benefit contributions.
      - `total` number, nullable — The company's total obligations.
      - `taxes_and_contributions_ytd` number, nullable
      - `benefits_ytd` number, nullable
      - `total_ytd` number, nullable
    - `vacation_pay_balance` number, nullable — The Employee's Vacation Pay balance as of the end of this pay period. `null` for Contractor pay stubs.
    - `liability` number, nullable — The total amount owed by the company for this pay stub, including Employee or Contractor net pay, employer tax contributions, and employer benefit contributions.
    - `cash_requirement` number, nullable — The total amount that will be debited from the company's account for this pay stub when the Payroll is approved.
    - `note` string, nullable — An optional note on the pay stub, visible to the partner.
    - `line_item_summary` object, nullable — Totals grouped by line item category for this pay stub. Each category includes a `period` total for the current pay period and a `ytd` total for the calendar year to date. Categories: `earnings`, `statutory_withholdings`, `reimbursements`, `allowances`, `employee_benefits`, `employer_benefits`, `deductions`.
      - `earnings` object, nullable
        - `period` number, nullable
        - `period_managed` number, nullable
        - `period_unmanaged` number, nullable
        - `ytd` number, nullable
      - `statutory_withholdings` object, nullable
        - `period` number, nullable
        - `ytd` number, nullable
      - `reimbursements` object, nullable
        - `period` number, nullable
        - `ytd` number, nullable
      - `allowances` object, nullable
        - `period` number, nullable
        - `ytd` number, nullable
      - `benefits` object, nullable
        - `period` number, nullable
        - `ytd` number, nullable
      - `employee_benefits` object, nullable
        - `period` number, nullable
        - `ytd` number, nullable
      - `employer_benefits` object, nullable
        - `period` number, nullable
        - `ytd` number, nullable
      - `deductions` object, nullable
        - `period` number, nullable
        - `ytd` number, nullable
    - `is_stale` boolean — Whether the pay stub's tax calculations are out of date. When `true`, `stale_since` indicates when the pay stub became stale.
    - `stale_since` string, dateTime, nullable — The timestamp at which the pay stub's tax calculations became stale and need to be recalculated. `null` if the pay stub is up to date.
    - `warnings` object, nullable — A collection of data validation warnings for this pay stub. Warnings indicate incomplete or potentially incorrect data and could prevent payroll processing.
      - `object` string, nullable
      - `data` object, nullable
    - `external_ref` string, nullable — A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference.
    - `apply_standard_tax_reductions` boolean — When `true`, the standard tax reductions are applied to this pay stub's withholdings even in cases where they would otherwise be skipped to avoid applying them twice across related runs in the same period. In Canada these reductions are the employee's federal and provincial personal tax credits (their TD1 claim amounts) and the CPP/QPP basic exemption. Defaults to `false`, and has no effect where those reductions already apply.
    - `created_at` string, dateTime — The date and time the object was created in Nmbr.
    - `updated_at` string, dateTime — The date and time the object was last updated in Nmbr.

---

[API](https://skmtc.net/nmbr/apis/nmbr-api.md) · [All operations](https://skmtc.net/nmbr/apis/nmbr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmbr/nmbr-api/versions/a0c7a815860f/schema)