Create a statutory withholding line item

Authorizations

Authorization

string

header

required

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

Body

application/json

pay_stub_id

string

required

business_preset_id

string

statutory_withholding_type

enum<string>

The type of statutory withholding for this line item.

Must be present when business_preset_id is either empty or not set.

Available options:

cpp,

cpp_2,

ei,

federal_income_tax,

provincial_income_tax,

qpip,

qpp,

qpp_2,

territorial_income_tax

custom_amount

number<decimal>

An override for managed_amount. When set, amount reflects this value instead of managed_amount.

Required range: x <= 999999

title

string | null

Maximum string length: 255

title_translations

object

Optional translations for the title property.

Hide child attributes

title_translations.en

string

Maximum string length: 255

title_translations.fr

string

Maximum string length: 255

remittance_account_id

string

expense_accounting_code_id

string

custom_expense_accounting_code_id

string

liability_accounting_code_id

string

custom_liability_accounting_code_id

string

external_ref

string

Maximum string length: 255

Response

201 - application/json

Created

string

read-only

The unique identifier of the object in Nmbr.

object

string

read-only

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

data

Statutory Withholding Line Item · object

Hide child attributes

data.pay_stub

object

Hide child attributes

data.pay_stub.id

string

read-only

The unique identifier of the object in Nmbr.

data.pay_stub.object

string

read-only

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

data.line_item_type

string | null

data.is_system

boolean

Whether this line item was generated automatically by the payroll engine. System line items cannot be deleted.

data.is_managed

boolean

Always true. Statutory withholding line items are fully managed by the payroll engine and cannot be created, updated, or deleted.

data.amount

number<decimal> | null

The effective amount for this line item. Returns custom_amount if set, otherwise managed_amount. Read-only.

data.custom_amount

number<decimal> | null

An override for managed_amount. When set, amount reflects this value instead of managed_amount.

data.managed_amount

number<decimal>

The withholding amount calculated by the payroll engine. Read-only; set custom_amount to override.

data.statutory_withholding_type

object

The type of statutory withholding for this line item.

Hide child attributes

data.statutory_withholding_type.id

string

read-only

The unique identifier of the object in Nmbr.

data.statutory_withholding_type.object

string

read-only

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

data.statutory_withholding_type.data

Statutory Withholding Type · object

Hide child attributes

data.statutory_withholding_type.data.type

string | null

The string identifier for this employee statutory withholding type.

data.statutory_withholding_type.data.label

string | null

The human-readable display name for this employee statutory withholding type.

data.title

string | null

Maximum string length: 255

data.title_translations

object

Optional translations for the title property.

Hide child attributes

data.title_translations.en

string

Maximum string length: 255

data.title_translations.fr

string

Maximum string length: 255

data.title_translated

string

read-only

The translation of the title property for the request locale. Computed using the values in title and title_translations and the value of the request's Accept-Language header.

data.remittance_account

object

Hide child attributes

data.remittance_account.id

string

read-only

The unique identifier of the object in Nmbr.

data.remittance_account.object

string

read-only

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

data.source_adjustment

any

data.business_preset

object

Hide child attributes

data.business_preset.id

string

read-only

The unique identifier of the object in Nmbr.

data.business_preset.object

string

read-only

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

data.expense_accounting_code

any

The effective expense accounting code. Returns the user-set value if present, otherwise the system-derived value. Writes to this field set the user override.

data.managed_expense_accounting_code

any

The expense accounting code derived by the system from accounting code rules and presets. Read-only.

data.custom_expense_accounting_code

any

User-set expense accounting code that overrides the system-derived value.

data.liability_accounting_code

any

The effective liability accounting code. Returns the user-set value if present, otherwise the system-derived value. Writes to this field set the user override.

data.managed_liability_accounting_code

any

The liability accounting code derived by the system from accounting code rules and presets. Read-only.

data.custom_liability_accounting_code

any

User-set liability accounting code that overrides the system-derived value.

data.component_settings

object

Settings specific to the Nmbr component.

Hide child attributes

data.component_settings.attributes_locked

boolean

Whether the line item is locked and cannot be edited in the component.

data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.updated_at

string<dateTime>

read-only

The date and time the object was last updated in Nmbr.