List employer statutory withholding line items

curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/employer_statutory_withholding_line_items \
  --header 'Authorization: Bearer <token>'

{
  "object": "list",
  "data": [
    {
      "id": "<id>",
      "object": "employer_statutory_withholding_line_item",
      "data": {
        "pay_stub": {
          "id": "<id>",
          "object": "pay_stub",
          "links": {
            "self": "/pay_stubs/<id>"
          }
        },
        "line_item_type": "employer_statutory_withholding",
        "is_system": true,
        "is_managed": true,
        "amount": 0,
        "custom_amount": null,
        "managed_amount": 0,
        "employer_statutory_withholding_type": {
          "id": "<id>",
          "object": "employer_statutory_withholding_type",
          "data": {
            "type": "ei",
            "label": "EI"
          },
          "links": {
            "self": "/employer_statutory_withholding_types/ei"
          }
        },
        "title": "EI",
        "title_translations": {
          "en": "EI",
          "fr": "AE"
        },
        "title_translated": "EI",
        "remittance_account": {
          "id": "<id>",
          "object": "remittance_account",
          "links": {
            "self": "/remittance_accounts/<id>"
          }
        },
        "source_adjustment": null,
        "business_preset": {
          "id": "<id>",
          "object": "business_preset",
          "links": {
            "self": "/business_presets/<id>"
          }
        },
        "expense_accounting_code": null,
        "managed_expense_accounting_code": null,
        "custom_expense_accounting_code": null,
        "liability_accounting_code": null,
        "managed_liability_accounting_code": null,
        "custom_liability_accounting_code": null,
        "component_settings": {
          "attributes_locked": false
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/employer_statutory_withholding_line_items/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "employer_statutory_withholding_line_item",
      "data": {
        "pay_stub": {
          "id": "<id>",
          "object": "pay_stub",
          "links": {
            "self": "/pay_stubs/<id>"
          }
        },
        "line_item_type": "employer_statutory_withholding",
        "is_system": true,
        "is_managed": true,
        "amount": 0,
        "custom_amount": null,
        "managed_amount": 0,
        "employer_statutory_withholding_type": {
          "id": "<id>",
          "object": "employer_statutory_withholding_type",
          "data": {
            "type": "cpp",
            "label": "CPP"
          },
          "links": {
            "self": "/employer_statutory_withholding_types/cpp"
          }
        },
        "title": "CPP",
        "title_translations": {
          "en": "CPP",
          "fr": "RPC"
        },
        "title_translated": "CPP",
        "remittance_account": {
          "id": "<id>",
          "object": "remittance_account",
          "links": {
            "self": "/remittance_accounts/<id>"
          }
        },
        "source_adjustment": null,
        "business_preset": {
          "id": "<id>",
          "object": "business_preset",
          "links": {
            "self": "/business_presets/<id>"
          }
        },
        "expense_accounting_code": null,
        "managed_expense_accounting_code": null,
        "custom_expense_accounting_code": null,
        "liability_accounting_code": null,
        "managed_liability_accounting_code": null,
        "custom_liability_accounting_code": null,
        "component_settings": {
          "attributes_locked": false
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/employer_statutory_withholding_line_items/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "employer_statutory_withholding_line_item",
      "data": {
        "pay_stub": {
          "id": "<id>",
          "object": "pay_stub",
          "links": {
            "self": "/pay_stubs/<id>"
          }
        },
        "line_item_type": "employer_statutory_withholding",
        "is_system": true,
        "is_managed": true,
        "amount": 0,
        "custom_amount": null,
        "managed_amount": 0,
        "employer_statutory_withholding_type": {
          "id": "<id>",
          "object": "employer_statutory_withholding_type",
          "data": {
            "type": "cpp_2",
            "label": "CPP 2"
          },
          "links": {
            "self": "/employer_statutory_withholding_types/cpp_2"
          }
        },
        "title": "CPP 2",
        "title_translations": {
          "en": "CPP 2",
          "fr": "RPC 2"
        },
        "title_translated": "CPP 2",
        "remittance_account": {
          "id": "<id>",
          "object": "remittance_account",
          "links": {
            "self": "/remittance_accounts/<id>"
          }
        },
        "source_adjustment": null,
        "business_preset": {
          "id": "<id>",
          "object": "business_preset",
          "links": {
            "self": "/business_presets/<id>"
          }
        },
        "expense_accounting_code": null,
        "managed_expense_accounting_code": null,
        "custom_expense_accounting_code": null,
        "liability_accounting_code": null,
        "managed_liability_accounting_code": null,
        "custom_liability_accounting_code": null,
        "component_settings": {
          "attributes_locked": false
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/employer_statutory_withholding_line_items/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "employer_statutory_withholding_line_item",
      "data": {
        "pay_stub": {
          "id": "<id>",
          "object": "pay_stub",
          "links": {
            "self": "/pay_stubs/<id>"
          }
        },
        "line_item_type": "employer_statutory_withholding",
        "is_system": true,
        "is_managed": true,
        "amount": 1235.11,
        "custom_amount": null,
        "managed_amount": 1235.11,
        "employer_statutory_withholding_type": {
          "id": "<id>",
          "object": "employer_statutory_withholding_type",
          "data": {
            "type": "ei",
            "label": "EI"
          },
          "links": {
            "self": "/employer_statutory_withholding_types/ei"
          }
        },
        "title": "EI",
        "title_translations": {
          "en": "EI",
          "fr": "AE"
        },
        "title_translated": "EI",
        "remittance_account": {
          "id": "<id>",
          "object": "remittance_account",
          "links": {
            "self": "/remittance_accounts/<id>"
          }
        },
        "source_adjustment": null,
        "business_preset": {
          "id": "<id>",
          "object": "business_preset",
          "links": {
            "self": "/business_presets/<id>"
          }
        },
        "expense_accounting_code": null,
        "managed_expense_accounting_code": null,
        "custom_expense_accounting_code": null,
        "liability_accounting_code": null,
        "managed_liability_accounting_code": null,
        "custom_liability_accounting_code": null,
        "component_settings": {
          "attributes_locked": false
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/employer_statutory_withholding_line_items/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "employer_statutory_withholding_line_item",
      "data": {
        "pay_stub": {
          "id": "<id>",
          "object": "pay_stub",
          "links": {
            "self": "/pay_stubs/<id>"
          }
        },
        "line_item_type": "employer_statutory_withholding",
        "is_system": true,
        "is_managed": true,
        "amount": 2101.43,
        "custom_amount": null,
        "managed_amount": 2101.43,
        "employer_statutory_withholding_type": {
          "id": "<id>",
          "object": "employer_statutory_withholding_type",
          "data": {
            "type": "cpp",
            "label": "CPP"
          },
          "links": {
            "self": "/employer_statutory_withholding_types/cpp"
          }
        },
        "title": "CPP",
        "title_translations": {
          "en": "CPP",
          "fr": "RPC"
        },
        "title_translated": "CPP",
        "remittance_account": {
          "id": "<id>",
          "object": "remittance_account",
          "links": {
            "self": "/remittance_accounts/<id>"
          }
        },
        "source_adjustment": null,
        "business_preset": {
          "id": "<id>",
          "object": "business_preset",
          "links": {
            "self": "/business_presets/<id>"
          }
        },
        "expense_accounting_code": null,
        "managed_expense_accounting_code": null,
        "custom_expense_accounting_code": null,
        "liability_accounting_code": null,
        "managed_liability_accounting_code": null,
        "custom_liability_accounting_code": null,
        "component_settings": {
          "attributes_locked": false
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/employer_statutory_withholding_line_items/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "employer_statutory_withholding_line_item",
      "data": {
        "pay_stub": {
          "id": "<id>",
          "object": "pay_stub",
          "links": {
            "self": "/pay_stubs/<id>"
          }
        },
        "line_item_type": "employer_statutory_withholding",
        "is_system": true,
        "is_managed": true,
        "amount": 355.22,
        "custom_amount": null,
        "managed_amount": 355.22,
        "employer_statutory_withholding_type": {
          "id": "<id>",
          "object": "employer_statutory_withholding_type",
          "data": {
            "type": "cpp_2",
            "label": "CPP 2"
          },
          "links": {
            "self": "/employer_statutory_withholding_types/cpp_2"
          }
        },
        "title": "CPP 2",
        "title_translations": {
          "en": "CPP 2",
          "fr": "RPC 2"
        },
        "title_translated": "CPP 2",
        "remittance_account": {
          "id": "<id>",
          "object": "remittance_account",
          "links": {
            "self": "/remittance_accounts/<id>"
          }
        },
        "source_adjustment": null,
        "business_preset": {
          "id": "<id>",
          "object": "business_preset",
          "links": {
            "self": "/business_presets/<id>"
          }
        },
        "expense_accounting_code": null,
        "managed_expense_accounting_code": null,
        "custom_expense_accounting_code": null,
        "liability_accounting_code": null,
        "managed_liability_accounting_code": null,
        "custom_liability_accounting_code": null,
        "component_settings": {
          "attributes_locked": false
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/employer_statutory_withholding_line_items/<id>"
      }
    }
  ],
  "links": {
    "first": "/employer_statutory_withholding_line_items?pay_stub_id=<id>&page=1",
    "last": "/employer_statutory_withholding_line_items?pay_stub_id=<id>&page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 6,
    "has_more": false
  }
}

GET

employer_statutory_withholding_line_items

curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/employer_statutory_withholding_line_items \
  --header 'Authorization: Bearer <token>'

{
  "object": "list",
  "data": [
    {
      "id": "<id>",
      "object": "employer_statutory_withholding_line_item",
      "data": {
        "pay_stub": {
          "id": "<id>",
          "object": "pay_stub",
          "links": {
            "self": "/pay_stubs/<id>"
          }
        },
        "line_item_type": "employer_statutory_withholding",
        "is_system": true,
        "is_managed": true,
        "amount": 0,
        "custom_amount": null,
        "managed_amount": 0,
        "employer_statutory_withholding_type": {
          "id": "<id>",
          "object": "employer_statutory_withholding_type",
          "data": {
            "type": "ei",
            "label": "EI"
          },
          "links": {
            "self": "/employer_statutory_withholding_types/ei"
          }
        },
        "title": "EI",
        "title_translations": {
          "en": "EI",
          "fr": "AE"
        },
        "title_translated": "EI",
        "remittance_account": {
          "id": "<id>",
          "object": "remittance_account",
          "links": {
            "self": "/remittance_accounts/<id>"
          }
        },
        "source_adjustment": null,
        "business_preset": {
          "id": "<id>",
          "object": "business_preset",
          "links": {
            "self": "/business_presets/<id>"
          }
        },
        "expense_accounting_code": null,
        "managed_expense_accounting_code": null,
        "custom_expense_accounting_code": null,
        "liability_accounting_code": null,
        "managed_liability_accounting_code": null,
        "custom_liability_accounting_code": null,
        "component_settings": {
          "attributes_locked": false
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/employer_statutory_withholding_line_items/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "employer_statutory_withholding_line_item",
      "data": {
        "pay_stub": {
          "id": "<id>",
          "object": "pay_stub",
          "links": {
            "self": "/pay_stubs/<id>"
          }
        },
        "line_item_type": "employer_statutory_withholding",
        "is_system": true,
        "is_managed": true,
        "amount": 0,
        "custom_amount": null,
        "managed_amount": 0,
        "employer_statutory_withholding_type": {
          "id": "<id>",
          "object": "employer_statutory_withholding_type",
          "data": {
            "type": "cpp",
            "label": "CPP"
          },
          "links": {
            "self": "/employer_statutory_withholding_types/cpp"
          }
        },
        "title": "CPP",
        "title_translations": {
          "en": "CPP",
          "fr": "RPC"
        },
        "title_translated": "CPP",
        "remittance_account": {
          "id": "<id>",
          "object": "remittance_account",
          "links": {
            "self": "/remittance_accounts/<id>"
          }
        },
        "source_adjustment": null,
        "business_preset": {
          "id": "<id>",
          "object": "business_preset",
          "links": {
            "self": "/business_presets/<id>"
          }
        },
        "expense_accounting_code": null,
        "managed_expense_accounting_code": null,
        "custom_expense_accounting_code": null,
        "liability_accounting_code": null,
        "managed_liability_accounting_code": null,
        "custom_liability_accounting_code": null,
        "component_settings": {
          "attributes_locked": false
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/employer_statutory_withholding_line_items/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "employer_statutory_withholding_line_item",
      "data": {
        "pay_stub": {
          "id": "<id>",
          "object": "pay_stub",
          "links": {
            "self": "/pay_stubs/<id>"
          }
        },
        "line_item_type": "employer_statutory_withholding",
        "is_system": true,
        "is_managed": true,
        "amount": 0,
        "custom_amount": null,
        "managed_amount": 0,
        "employer_statutory_withholding_type": {
          "id": "<id>",
          "object": "employer_statutory_withholding_type",
          "data": {
            "type": "cpp_2",
            "label": "CPP 2"
          },
          "links": {
            "self": "/employer_statutory_withholding_types/cpp_2"
          }
        },
        "title": "CPP 2",
        "title_translations": {
          "en": "CPP 2",
          "fr": "RPC 2"
        },
        "title_translated": "CPP 2",
        "remittance_account": {
          "id": "<id>",
          "object": "remittance_account",
          "links": {
            "self": "/remittance_accounts/<id>"
          }
        },
        "source_adjustment": null,
        "business_preset": {
          "id": "<id>",
          "object": "business_preset",
          "links": {
            "self": "/business_presets/<id>"
          }
        },
        "expense_accounting_code": null,
        "managed_expense_accounting_code": null,
        "custom_expense_accounting_code": null,
        "liability_accounting_code": null,
        "managed_liability_accounting_code": null,
        "custom_liability_accounting_code": null,
        "component_settings": {
          "attributes_locked": false
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/employer_statutory_withholding_line_items/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "employer_statutory_withholding_line_item",
      "data": {
        "pay_stub": {
          "id": "<id>",
          "object": "pay_stub",
          "links": {
            "self": "/pay_stubs/<id>"
          }
        },
        "line_item_type": "employer_statutory_withholding",
        "is_system": true,
        "is_managed": true,
        "amount": 1235.11,
        "custom_amount": null,
        "managed_amount": 1235.11,
        "employer_statutory_withholding_type": {
          "id": "<id>",
          "object": "employer_statutory_withholding_type",
          "data": {
            "type": "ei",
            "label": "EI"
          },
          "links": {
            "self": "/employer_statutory_withholding_types/ei"
          }
        },
        "title": "EI",
        "title_translations": {
          "en": "EI",
          "fr": "AE"
        },
        "title_translated": "EI",
        "remittance_account": {
          "id": "<id>",
          "object": "remittance_account",
          "links": {
            "self": "/remittance_accounts/<id>"
          }
        },
        "source_adjustment": null,
        "business_preset": {
          "id": "<id>",
          "object": "business_preset",
          "links": {
            "self": "/business_presets/<id>"
          }
        },
        "expense_accounting_code": null,
        "managed_expense_accounting_code": null,
        "custom_expense_accounting_code": null,
        "liability_accounting_code": null,
        "managed_liability_accounting_code": null,
        "custom_liability_accounting_code": null,
        "component_settings": {
          "attributes_locked": false
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/employer_statutory_withholding_line_items/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "employer_statutory_withholding_line_item",
      "data": {
        "pay_stub": {
          "id": "<id>",
          "object": "pay_stub",
          "links": {
            "self": "/pay_stubs/<id>"
          }
        },
        "line_item_type": "employer_statutory_withholding",
        "is_system": true,
        "is_managed": true,
        "amount": 2101.43,
        "custom_amount": null,
        "managed_amount": 2101.43,
        "employer_statutory_withholding_type": {
          "id": "<id>",
          "object": "employer_statutory_withholding_type",
          "data": {
            "type": "cpp",
            "label": "CPP"
          },
          "links": {
            "self": "/employer_statutory_withholding_types/cpp"
          }
        },
        "title": "CPP",
        "title_translations": {
          "en": "CPP",
          "fr": "RPC"
        },
        "title_translated": "CPP",
        "remittance_account": {
          "id": "<id>",
          "object": "remittance_account",
          "links": {
            "self": "/remittance_accounts/<id>"
          }
        },
        "source_adjustment": null,
        "business_preset": {
          "id": "<id>",
          "object": "business_preset",
          "links": {
            "self": "/business_presets/<id>"
          }
        },
        "expense_accounting_code": null,
        "managed_expense_accounting_code": null,
        "custom_expense_accounting_code": null,
        "liability_accounting_code": null,
        "managed_liability_accounting_code": null,
        "custom_liability_accounting_code": null,
        "component_settings": {
          "attributes_locked": false
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/employer_statutory_withholding_line_items/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "employer_statutory_withholding_line_item",
      "data": {
        "pay_stub": {
          "id": "<id>",
          "object": "pay_stub",
          "links": {
            "self": "/pay_stubs/<id>"
          }
        },
        "line_item_type": "employer_statutory_withholding",
        "is_system": true,
        "is_managed": true,
        "amount": 355.22,
        "custom_amount": null,
        "managed_amount": 355.22,
        "employer_statutory_withholding_type": {
          "id": "<id>",
          "object": "employer_statutory_withholding_type",
          "data": {
            "type": "cpp_2",
            "label": "CPP 2"
          },
          "links": {
            "self": "/employer_statutory_withholding_types/cpp_2"
          }
        },
        "title": "CPP 2",
        "title_translations": {
          "en": "CPP 2",
          "fr": "RPC 2"
        },
        "title_translated": "CPP 2",
        "remittance_account": {
          "id": "<id>",
          "object": "remittance_account",
          "links": {
            "self": "/remittance_accounts/<id>"
          }
        },
        "source_adjustment": null,
        "business_preset": {
          "id": "<id>",
          "object": "business_preset",
          "links": {
            "self": "/business_presets/<id>"
          }
        },
        "expense_accounting_code": null,
        "managed_expense_accounting_code": null,
        "custom_expense_accounting_code": null,
        "liability_accounting_code": null,
        "managed_liability_accounting_code": null,
        "custom_liability_accounting_code": null,
        "component_settings": {
          "attributes_locked": false
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/employer_statutory_withholding_line_items/<id>"
      }
    }
  ],
  "links": {
    "first": "/employer_statutory_withholding_line_items?pay_stub_id=<id>&page=1",
    "last": "/employer_statutory_withholding_line_items?pay_stub_id=<id>&page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 6,
    "has_more": false
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

pay_stub_id

string

Only return line items on the specified Pay Stub.

payroll_id

string

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

payroll_status

enum<string>

Available options:

approved,

draft,

failed,

paid,

partially_paid,

processing

payroll_type

enum<string>

Available options:

correction,

historical,

off_cycle,

regular

payroll_period_start

object

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_end

object

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_date

object

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_id

string

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

work_assignment_id

string

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

employee_id

string

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

contractor_id

string

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

business_entity_id

string

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

has_business_preset

boolean

business_preset_id

string

include_types

enum<string>

Only return line items with the specified types.

Available options:

cpp,

cpp_2,

eht,

ei,

qpip,

qpp,

qpp_2,

wcb

exclude_types

enum<string>

Only return line items without the specified types.

Available options:

cpp,

cpp_2,

eht,

ei,

qpip,

qpp,

qpp_2,

wcb

external_ref

string

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

object

string

read-only

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

data

object[]

Hide child attributes

data.id

string

read-only

The unique identifier of the object in Nmbr.

data.object

string

read-only

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

data.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.data.pay_stub

object

Hide child attributes

data.data.pay_stub.id

string

read-only

The unique identifier of the object in Nmbr.

data.data.pay_stub.object

string

read-only

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

data.data.line_item_type

string | null

data.data.is_system

boolean

Whether this line item was generated automatically by the payroll engine.

data.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.data.amount

number<decimal> | null

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

data.data.custom_amount

number<decimal> | null

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

data.data.managed_amount

number<decimal>

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

data.data.employer_statutory_withholding_type

object

The type of employer statutory withholding for this line item.

Hide child attributes

data.data.employer_statutory_withholding_type.id

string

read-only

The unique identifier of the object in Nmbr.

data.data.employer_statutory_withholding_type.object

string

read-only

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

data.data.employer_statutory_withholding_type.data

Employer Statutory Withholding Type · object

Hide child attributes

data.data.employer_statutory_withholding_type.data.type

string | null

The string identifier for this employer statutory withholding type.

data.data.employer_statutory_withholding_type.data.label

string | null

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

data.data.title

string | null

Maximum string length: 255

data.data.title_translations

object

Optional translations for the title property.

Hide child attributes

data.data.title_translations.en

string

Maximum string length: 255

data.data.title_translations.fr

string

Maximum string length: 255

data.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.data.remittance_account

object

Hide child attributes

data.data.remittance_account.id

string

read-only

The unique identifier of the object in Nmbr.

data.data.remittance_account.object

string

read-only

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

data.data.source_adjustment

any

data.data.business_preset

object

Hide child attributes

data.data.business_preset.id

string

read-only

The unique identifier of the object in Nmbr.

data.data.business_preset.object

string

read-only

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

data.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.data.managed_expense_accounting_code

any

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

data.data.custom_expense_accounting_code

any

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

data.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.data.managed_liability_accounting_code

any

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

data.data.custom_liability_accounting_code

any

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

data.data.component_settings

object

Settings specific to the Nmbr component.

Hide child attributes

data.data.component_settings.attributes_locked

boolean

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

data.data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.data.updated_at

string<dateTime>

read-only

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

Show bulk delete scope for reimbursement line items Create an employer statutory withholding line item

⌘I