> ## Documentation Index > Fetch the complete documentation index at: https://docs.nmbr.co/llms.txt > Use this file to discover all available pages before exploring further. # Show bulk create scope for employee benefits ## OpenAPI ````yaml /spec/openapi.json post /employee_benefits/bulk/create/scope openapi: 3.0.0 info: title: Nmbr API description: API to interact with Nmbr Payroll version: 1.0.0 servers: - url: https://sandbox.nmbr.co/services/payroll security: - CompanyToken: [] tags: - name: Accounting Codes - name: Accounting Code Rules - name: Adjustments - name: Allowances - name: Allowance Line Items - name: Allowance Types - name: Async Tasks - name: Bank Accounts - name: Business Entities - name: Business Entity Verifications - name: Business Entity ROE Authorizations - name: Business Presets - name: Calculations - name: Companies - name: Contractors - name: Deductions - name: Deduction Line Items - name: Deduction Types - name: Earnings - name: Earning Line Items - name: Earning Types - name: Effective Tax Properties - name: Employees - name: Employee Benefits - name: Employee Benefit Line Items - name: Employee Benefit Types - name: Employer Benefits - name: Employer Benefit Line Items - name: Employer Benefit Types - name: Employer Statutory Withholding Line Items - name: Employer Statutory Withholding Types - name: Forms - name: Form Batches - name: Form Types - name: Holidays - name: Integrations - name: Journal Entries - name: Overtime Rates - name: Partners - name: Pay Rates - name: Pay Schedules - name: Pay Splits - name: Pay Stubs - name: Payments - name: Payrolls - name: Reimbursements - name: Reimbursement Line Items - name: Reimbursement Types - name: Remittance Accounts - name: Remittance Account Enrollments - name: Reports - name: Statutory Withholding Line Items - name: Statutory Withholding Types - name: Tags - name: Tag Groups - name: Tax Properties - name: Tax Property Templates - name: Tokens - name: Usage Records - name: Usage Summaries - name: Vacation Pay - name: Vacation Pay Settings - name: Webhooks - name: Work Assignments paths: /employee_benefits/bulk/create/scope: post: tags: - Employee Benefits summary: Show bulk create scope for employee benefits operationId: employee-benefits-bulk-create-scope requestBody: content: application/json: schema: allOf: - type: object properties: business_entity_id: type: string work_assignments: type: object properties: exclude: type: object properties: ids: type: array items: type: string payee_type: type: string enum: - contractor - employee pay_schedule_id: type: string archived: type: boolean payee_names: type: string - type: object required: - business_entity_id - work_assignments example: business_entity_id: work_assignments: include: all responses: '200': description: OK content: application/json: schema: type: object properties: object: type: string description: The type of the object in Nmbr (`"list"`). readOnly: true data: type: array items: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: >- The type of the object in Nmbr (`"work_assignment"`). readOnly: true data: $ref: '#/components/schemas/EmployeeBenefit' example: object: list data: - id: object: work_assignment data: title: null title_translations: null title_translated: null employee: id: object: employee links: self: /employees/ pay_schedule: id: object: pay_schedule links: self: /pay_schedules/ business_entity: id: object: business_entity links: self: /business_entities/ current_tax_jurisdiction: ca_on is_primary: true accrued_vacation_pay: 0 paid_vacation_pay: 0 first_non_draft_period_start: null last_non_draft_period_end: null available_tax_properties: - ca::province_of_employment - ca::province_of_work - ca::federal_oc_surtax_exempt - ca::cpp_exempt - ca::ei_exempt - ca::qc::qpp_exempt - ca::qc::qpip_exempt - ca::nt::territorial_payroll_tax - ca::nu::territorial_payroll_tax - ca::federal::additional_tax - ca::federal::claim_amount - ca::federal::total_income_less_than_total_claim_amount - ca::federal::annual_deduction_at_source - ca::statutory_holiday_pay - ca::first_nation_exemptions - ca::ab::workers_compensation_class - ca::bc::workers_compensation_class - ca::mb::workers_compensation_class - ca::nb::workers_compensation_class - ca::nl::workers_compensation_class - ca::ns::workers_compensation_class - ca::nt::workers_compensation_class - ca::nu::workers_compensation_class - ca::on::workers_compensation_class - ca::pe::workers_compensation_class - ca::qc::workers_compensation_class - ca::sk::workers_compensation_class - ca::yt::workers_compensation_class - ca::on::claim_amount - ca::on::dependent_children_credit - ca::on::impaired_dependants_credit external_ref: null archived_at: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /work_assignments/ links: first: http://localhost/employee_benefits/bulk/create/scope?page=1 last: http://localhost/employee_benefits/bulk/create/scope?page=1 prev: null next: null meta: current_page: 1 last_page: 1 per_page: 15 total: 1 has_more: false components: schemas: EmployeeBenefit: type: object title: Employee Benefit properties: work_assignment: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"work_assignment"`). readOnly: true business_preset: {} employee_benefit_type: type: object description: >- The type of employee benefit, which determines how it is taxed and reported. properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"employee_benefit_type"`). readOnly: true data: $ref: '#/components/schemas/EmployeeBenefitType' employer_benefit: {} title: type: string nullable: true maxLength: 255 title_translations: type: object description: Optional translations for the `title` property. allOf: - $ref: '#/components/schemas/Translations' nullable: true title_translated: type: string description: >- 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. readOnly: true income_basis: type: string description: >- Determines the income used as the base for percentage-based benefit calculations. `regular_earnings` includes only salary and wage earnings. `all_earnings` includes all earnings. `total_income` includes all earnings, taxable allowances, and taxable reimbursements. `none` doesn't include any line items, and can be used with `income_includes` for completely custom definitions of income. enum: - all_earnings - none - regular_earnings - total_income income_includes: type: object description: >- An optional list of specific earnings, allowances, and other line item types to include in the income calculation in addition to those included via `income_basis`. nullable: true max_annual_contribution_basis: type: string description: >- Whether `max_annual_contribution` accumulates across pay periods or applies as a fixed per-period cap. enum: - all_line_items_of_type - this_benefit apply_sales_tax: type: boolean description: Whether provincial sales tax is applied to the benefit amount. remittance_account_id: type: string description: >- The remittance account to which collected benefit amounts are remitted. nullable: true maxLength: 32 remittance_account: {} amount: type: number description: >- The contribution amount per pay period. When `amount_type` is `percent`, this is interpreted as a percentage of the income basis (0-100); otherwise as a fixed dollar amount. format: decimal amount_type: type: string description: >- Whether `amount` is a fixed dollar value (`fixed`) or a percentage of the income basis (`percent`). enum: - fixed - percent coverage_multiplier: type: number description: >- A multiplier applied to the Employee's earnings to determine the benefit coverage amount, used for coverage-based benefits such as life insurance. format: decimal max_annual_contribution: type: number description: >- The maximum dollar amount that will be contributed in a calendar year. Contributions stop once this limit is reached. nullable: true format: decimal frequency: type: string description: >- The frequency at which this benefit is applied to Pay Stubs. When `per_month`, the amount is distributed across the selected Payrolls in the calendar month. `per_month` requires `amount_type` to be `fixed`. enum: - once - per_month - per_payroll date_basis: type: string description: >- Which payroll date determines the calendar month for the allocation. Applies only to `per_month` benefits. nullable: true enum: - by_pay_date - by_period_end_date - by_period_start_date pay_period_cadence: type: object description: >- Which pay periods within the month receive the allocation. An array of 1-based positions; `-1` is the final period. Applies only to `per_month` benefits. nullable: true effective_from: type: string description: The date from which this benefit is applied to Pay Stubs. format: date effective_to: type: string description: >- The date after which this benefit is no longer applied. `null` if the benefit applies indefinitely. nullable: true format: date expense_accounting_code: {} liability_accounting_code: {} external_ref: type: string description: >- 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. nullable: true maxLength: 255 created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime EmployeeBenefitType: type: object title: Employee Benefit Type properties: type: type: string description: The string identifier for this employee benefit type. nullable: true label: type: string description: The human-readable display name for this employee benefit type. nullable: true features: type: array items: $ref: '#/components/schemas/LineItemTypeFeature' form_mappings: type: array items: $ref: '#/components/schemas/LineItemFormMapping' Translations: type: object nullable: true properties: en: type: string maxLength: 255 fr: type: string maxLength: 255 LineItemTypeFeature: type: object description: >- How this line item type affects a single payroll calculation, such as income tax or CPP. See [Line item type features](https://docs.nmbr.co/guides/payroll-fundamentals/line-item-type-features) for further details. properties: type: type: string description: The payroll calculation this entry describes. enum: - eht - income_tax - insurable - pensionable - vacationable - wcb label: type: string description: Human-readable name for the payroll calculation. definitions: type: array description: >- How this type affects the calculation, broken down by jurisdiction. Jurisdictions where it does not apply are omitted. items: type: object properties: jurisdiction: type: string description: >- The jurisdiction this applies to (e.g. `ca_federal`, `ca_on`, `ca_qc`). effects: type: array description: >- How this type affects the payroll calculation in this jurisdiction. items: type: string enum: - accrues_vacation_pay - reduces_base - tax_credit - withholding help_text: type: string description: >- Plain-language explanation of how this type affects the calculation in this jurisdiction. nullable: true program_label: type: string description: >- The program that applies in this jurisdiction, for calculations that use different programs by jurisdiction (e.g. CPP federally, QPP in Quebec; EI federally, QPIP in Quebec). nullable: true LineItemFormMapping: type: object description: The year-end tax form boxes this line item type maps to. properties: form: type: string description: The form code (e.g. `t4`). form_label: type: string description: Human-readable form name. mapping: type: array description: The boxes on the form this type contributes to. items: type: array items: type: object properties: name: type: string description: The box or line identifier on the form. help_text: type: string description: Plain-language explanation of the box, when available. nullable: true securitySchemes: CompanyToken: type: http scheme: bearer ````