curl --request POST \
--url https://sandbox.nmbr.co/services/payroll/earning_line_items/bulk/create/scope \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payroll_id": "<id>",
"pay_stubs": {
"include": "all"
}
}
'{
"object": "list",
"data": [
{
"id": "<id>",
"object": "pay_stub",
"data": {
"payroll": {
"id": "<id>",
"object": "payroll",
"links": {
"self": "/payrolls/<id>"
}
},
"work_assignment": {
"id": "<id>",
"object": "work_assignment",
"links": {
"self": "/work_assignments/<id>"
}
},
"payment_method": "direct_deposit",
"has_taxes_calculated": true,
"is_pending_tax_rates": false,
"employee_summary": {
"gross": 0,
"subtractions": 0,
"reimbursements": 0,
"net": 0,
"gross_ytd": 0,
"subtractions_ytd": 0,
"reimbursements_ytd": 0,
"net_ytd": 0
},
"contractor_summary": {
"gross": null,
"reimbursements": null,
"net": null,
"gross_ytd": 0,
"reimbursements_ytd": 0,
"net_ytd": 0
},
"company_summary": {
"taxes_and_contributions": 0,
"benefits": 0,
"total": 0,
"taxes_and_contributions_ytd": 0,
"benefits_ytd": 0,
"total_ytd": 0
},
"vacation_pay_balance": 0,
"liability": 0,
"cash_requirement": 0,
"note": null,
"line_item_summary": {
"earnings": {
"period": 0,
"period_managed": 0,
"period_unmanaged": 0,
"ytd": 0
},
"statutory_withholdings": {
"period": 0,
"ytd": 0
},
"reimbursements": {
"period": 0,
"ytd": 0
},
"allowances": {
"period": 0,
"ytd": 0
},
"benefits": {
"period": 0,
"ytd": 0
},
"employee_benefits": {
"period": 0,
"ytd": 0
},
"employer_benefits": {
"period": 0,
"ytd": 0
},
"deductions": {
"period": 0,
"ytd": 0
}
},
"is_stale": false,
"stale_since": null,
"warnings": {
"object": "list",
"data": []
},
"external_ref": null,
"created_at": "2026-01-01T00:00:00.000000Z",
"updated_at": "2026-01-01T00:00:00.000000Z"
},
"links": {
"self": "/pay_stubs/<id>"
}
}
],
"links": {
"first": "http://localhost/earning_line_items/bulk/create/scope?payroll_id=<id>&pay_stubs%5Binclude%5D=all&page=1",
"last": "http://localhost/earning_line_items/bulk/create/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 create scope for earning line items
curl --request POST \
--url https://sandbox.nmbr.co/services/payroll/earning_line_items/bulk/create/scope \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payroll_id": "<id>",
"pay_stubs": {
"include": "all"
}
}
'{
"object": "list",
"data": [
{
"id": "<id>",
"object": "pay_stub",
"data": {
"payroll": {
"id": "<id>",
"object": "payroll",
"links": {
"self": "/payrolls/<id>"
}
},
"work_assignment": {
"id": "<id>",
"object": "work_assignment",
"links": {
"self": "/work_assignments/<id>"
}
},
"payment_method": "direct_deposit",
"has_taxes_calculated": true,
"is_pending_tax_rates": false,
"employee_summary": {
"gross": 0,
"subtractions": 0,
"reimbursements": 0,
"net": 0,
"gross_ytd": 0,
"subtractions_ytd": 0,
"reimbursements_ytd": 0,
"net_ytd": 0
},
"contractor_summary": {
"gross": null,
"reimbursements": null,
"net": null,
"gross_ytd": 0,
"reimbursements_ytd": 0,
"net_ytd": 0
},
"company_summary": {
"taxes_and_contributions": 0,
"benefits": 0,
"total": 0,
"taxes_and_contributions_ytd": 0,
"benefits_ytd": 0,
"total_ytd": 0
},
"vacation_pay_balance": 0,
"liability": 0,
"cash_requirement": 0,
"note": null,
"line_item_summary": {
"earnings": {
"period": 0,
"period_managed": 0,
"period_unmanaged": 0,
"ytd": 0
},
"statutory_withholdings": {
"period": 0,
"ytd": 0
},
"reimbursements": {
"period": 0,
"ytd": 0
},
"allowances": {
"period": 0,
"ytd": 0
},
"benefits": {
"period": 0,
"ytd": 0
},
"employee_benefits": {
"period": 0,
"ytd": 0
},
"employer_benefits": {
"period": 0,
"ytd": 0
},
"deductions": {
"period": 0,
"ytd": 0
}
},
"is_stale": false,
"stale_since": null,
"warnings": {
"object": "list",
"data": []
},
"external_ref": null,
"created_at": "2026-01-01T00:00:00.000000Z",
"updated_at": "2026-01-01T00:00:00.000000Z"
},
"links": {
"self": "/pay_stubs/<id>"
}
}
],
"links": {
"first": "http://localhost/earning_line_items/bulk/create/scope?payroll_id=<id>&pay_stubs%5Binclude%5D=all&page=1",
"last": "http://localhost/earning_line_items/bulk/create/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 ("pay_stub").
Hide child attributes
Hide child attributes
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 Earning or Pay Rate. Read-only; set custom_amount to override.
Whether this line item was generated by an Earning or Pay Rate recurrence and calculated automatically. When true, only custom_amount and custom_hours can be modified and the line item cannot be deleted.
The type of earning 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 ("earning_type").
Hide child attributes
Hide child attributes
The string identifier for this earning type.
The human-readable display name for this earning type.
A map of Payroll types to whether this earning type is available on that Payroll type.
The effective hours for this line item. Returns custom_hours if set, otherwise managed_hours. null if neither is set. Read-only.
The default hours from the linked Pay Rate. Read-only; set custom_hours to override.
An override for managed_hours. When set, hours reflects this value instead of managed_hours. Can be used to prorate the dollar amount on salary line items.
The vacation pay accrued on this line item, calculated based on the Work Assignment's Vacation Pay Settings.
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.
The effective earned-on date for this line item. Returns custom_earned_on if set, otherwise managed_earned_on. Read-only.
The earned-on date set by the system. Read-only; set custom_earned_on to override.
An override for managed_earned_on. When set, earned_on reflects this value instead of managed_earned_on. Must fall within the payroll's pay period.
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.