NMnmbr
Statutory Withholding Line Items

List statutory withholding line items

Changed on
get/statutory_withholding_line_items

Request

  • Base URL
    https://sandbox.nmbr.co/services/payroll
  • Auth
    HTTP bearer

Query parameters

pay_stub_idstring

Only return line items on the specified Pay Stub.

payroll_idstring

Only return line items on Pay Stubs on the specified Payroll.

'approved' | 'draft' | 'failed' | 'paid' | 'partially_paid' | 'processing'
OR
string[]
'correction' | 'historical' | 'off_cycle' | 'regular'
OR
string[]
payroll_period_startobject

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: payroll_period_start=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

  • gt (greater than)
  • gte (greater than or equal to)
  • lte (less than or equal to)
  • lt (less than) Example: payroll_period_start[gte]=2024-01-01&payroll_period_start[lt]=2024-12-31
payroll_period_endobject

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: payroll_period_end=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

  • gt (greater than)
  • gte (greater than or equal to)
  • lte (less than or equal to)
  • lt (less than) Example: payroll_period_end[gte]=2024-01-01&payroll_period_end[lt]=2024-12-31
payroll_pay_dateobject

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: payroll_pay_date=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

  • gt (greater than)
  • gte (greater than or equal to)
  • lte (less than or equal to)
  • lt (less than) Example: payroll_pay_date[gte]=2024-01-01&payroll_pay_date[lt]=2024-12-31
pay_schedule_idstring

Only return line items on Pay Stubs on the specified Pay Schedule.

work_assignment_idstring

Only return line items on Pay Stubs for the specified Work Assignment.

employee_idstring

Only return line items on pay stubs for the specified Employee.

contractor_idstring

Only return line items on pay stubs for the specified Contractor.

business_entity_idstring

Only return line items on Pay Stubs under the specified Business Entity.

has_business_presetboolean
business_preset_idstring
'cpp' | 'cpp_2' | 'ei' | 'federal_income_tax' | 'provincial_income_tax' | 'qpip' | 'qpp' | 'qpp_2' | 'territorial_income_tax' | 'uk_paye_income_tax'
OR
string[]

Only return line items with the specified types.

'cpp' | 'cpp_2' | 'ei' | 'federal_income_tax' | 'provincial_income_tax' | 'qpip' | 'qpp' | 'qpp_2' | 'territorial_income_tax' | 'uk_paye_income_tax'
OR
string[]

Only return line items without the specified types.

external_refstring
expandstring[]

Response

OK

objectstring

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

Changes

  • e2262a86fcc4Revision changes
    • warning

      added the new uk_hmrc enum value to the ////// response property for the response status

    • warning

      added the new uk_tax_agency enum value to the ////// response property for the response status

  • 5b24aa3d933fRevision changes
    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status