Skip to main content
PUT
Update a pay stub

Authorizations

Authorization
string
header
required

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

Path Parameters

pay_stub
string
required

Body

application/json
payment_method
enum<string>

The payment method for this pay stub.

Available options:
direct_deposit,
manual,
pad,
wire
note
string | null

An optional note on the pay stub, visible to the partner.

external_ref
string
Maximum string length: 255
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 - 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 ("pay_stub").

data
Pay Stub · object