curl --request POST \
--url https://sandbox.nmbr.co/services/payroll/deduction_line_items/bulk/update/scope \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payroll_id": "<id>",
"pay_stubs": {
"include": "all"
}
}
'{
"object": "list",
"data": [
{
"id": "<id>",
"object": "deduction_line_item",
"data": {
"pay_stub": {
"id": "<id>",
"object": "pay_stub",
"links": {
"self": "/pay_stubs/<id>"
}
},
"line_item_type": "deduction",
"is_managed": false,
"amount": 35,
"custom_amount": null,
"managed_amount": 35,
"deduction_type": {
"id": "<id>",
"object": "deduction_type",
"data": {
"type": "income_tax",
"label": "Income tax debt",
"locale": "en"
},
"links": {
"self": "/deduction_types/income_tax"
}
},
"recurrence": null,
"title": null,
"title_translations": null,
"title_translated": null,
"remittance_account": null,
"business_preset": null,
"source_adjustment": null,
"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
},
"external_ref": null,
"created_at": "2026-01-01T00:00:00.000000Z",
"updated_at": "2026-01-01T00:00:00.000000Z"
},
"links": {
"self": "/deduction_line_items/<id>"
}
}
],
"links": {
"first": "http://localhost/deduction_line_items/bulk/update/scope?payroll_id=<id>&pay_stubs%5Binclude%5D=all&page=1",
"last": "http://localhost/deduction_line_items/bulk/update/scope?payroll_id=<id>&pay_stubs%5Binclude%5D=all&page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"last_page": 1,
"per_page": 15,
"total": 1,
"has_more": false
}
}Show bulk update scope for deduction line items
curl --request POST \
--url https://sandbox.nmbr.co/services/payroll/deduction_line_items/bulk/update/scope \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payroll_id": "<id>",
"pay_stubs": {
"include": "all"
}
}
'{
"object": "list",
"data": [
{
"id": "<id>",
"object": "deduction_line_item",
"data": {
"pay_stub": {
"id": "<id>",
"object": "pay_stub",
"links": {
"self": "/pay_stubs/<id>"
}
},
"line_item_type": "deduction",
"is_managed": false,
"amount": 35,
"custom_amount": null,
"managed_amount": 35,
"deduction_type": {
"id": "<id>",
"object": "deduction_type",
"data": {
"type": "income_tax",
"label": "Income tax debt",
"locale": "en"
},
"links": {
"self": "/deduction_types/income_tax"
}
},
"recurrence": null,
"title": null,
"title_translations": null,
"title_translated": null,
"remittance_account": null,
"business_preset": null,
"source_adjustment": null,
"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
},
"external_ref": null,
"created_at": "2026-01-01T00:00:00.000000Z",
"updated_at": "2026-01-01T00:00:00.000000Z"
},
"links": {
"self": "/deduction_line_items/<id>"
}
}
],
"links": {
"first": "http://localhost/deduction_line_items/bulk/update/scope?payroll_id=<id>&pay_stubs%5Binclude%5D=all&page=1",
"last": "http://localhost/deduction_line_items/bulk/update/scope?payroll_id=<id>&pay_stubs%5Binclude%5D=all&page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"last_page": 1,
"per_page": 15,
"total": 1,
"has_more": false
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Response
OK
The type of the object in Nmbr ("list").
Hide child attributes
Hide child attributes
The unique identifier of the object in Nmbr.
The type of the object in Nmbr ("deduction_line_item").
Hide child attributes
Hide child attributes
Whether this line item was generated by a Deduction recurrence and calculated automatically. When true, only custom_amount can be modified and the line item cannot be deleted.
The effective amount for this line item. Returns custom_amount if set, otherwise managed_amount. Read-only.
An override for managed_amount. When set, amount reflects this value instead of managed_amount.
The amount calculated by the system or set by the linked Deduction recurrence. Read-only; set custom_amount to override.
The type of deduction for this line item.
Hide child attributes
Hide child attributes
The unique identifier of the object in Nmbr.
The type of the object in Nmbr ("deduction_type").
255The 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.
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.
The expense accounting code derived by the system from accounting code rules and presets. Read-only.
User-set expense accounting code that overrides the system-derived value.
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.
The liability accounting code derived by the system from accounting code rules and presets. Read-only.
User-set liability accounting code that overrides the system-derived value.
A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference.
255The date and time the object was created in Nmbr.
The date and time the object was last updated in Nmbr.