Retrieve an employer statutory withholding line item

Authorizations

Authorization

string

header

required

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

Path Parameters

line_item

string

required

Query Parameters

expand

enum<string>[]

Available options:

business_preset,

custom_expense_accounting_code,

custom_liability_accounting_code,

expense_accounting_code,

liability_accounting_code,

managed_expense_accounting_code,

managed_liability_accounting_code,

managed_tag_assignment,

pay_stub,

remittance_account,

source_adjustment,

tag_assignment,

tag_assignment_amounts

Response

200 - application/json

string

read-only

The unique identifier of the object in Nmbr.

object

string

read-only

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

data

Default · object

Default
With pay_stub expanded
With remittance_account expanded
With source_adjustment expanded
With business_preset expanded
With expense_accounting_code expanded
With managed_expense_accounting_code expanded
With custom_expense_accounting_code expanded
With liability_accounting_code expanded
With managed_liability_accounting_code expanded
With custom_liability_accounting_code expanded
With tag_assignment expanded
With managed_tag_assignment expanded
With tag_assignment_amounts expanded

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.

data.is_managed

boolean

Always true. Employer 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.employer_statutory_withholding_type

object

The type of employer statutory withholding for this line item.

Hide child attributes

data.employer_statutory_withholding_type.id

string

read-only

The unique identifier of the object in Nmbr.

data.employer_statutory_withholding_type.object

string

read-only

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

data.employer_statutory_withholding_type.data

Employer Statutory Withholding Type · object

Hide child attributes

data.employer_statutory_withholding_type.data.type

string | null

The string identifier for this employer statutory withholding type.

data.employer_statutory_withholding_type.data.label

string | null

The human-readable display name for this employer 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.