> ## 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. # Create an allowance ## OpenAPI ````yaml /spec/openapi.json post /allowances 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: /allowances: post: tags: - Allowances summary: Create an allowance operationId: allowances-store requestBody: content: application/json: schema: allOf: - type: object properties: work_assignment_id: type: string description: >- Must belong to a work assignment associated with an entity of type Employee. business_preset_id: type: string allowance_type: type: string description: >- The type of allowance, which determines how it is taxed and reported on Pay Stubs. Must be present when `business_preset_id` is either empty or not set. enum: - automobile_and_motor_vehicle - cell_phone_allowance - child_care_expenses - child_eduction_non_taxable - child_eduction_taxable - clothing_non_taxable - clothing_taxable - education_and_professional_development - housing_allowance_cash - internet_allowance - meals_taxable - moving_allowance_non_taxable - moving_allowance_taxable - municipal_officers_expense - non_taxable_allowance - overtime_meals_non_taxable - parking_allowance - professional_membership - professional_membership_dues_taxable - social_event_allowance - taxable_cash_allowance - tools_allowance - transit_pass - travelling_allowance_non_taxable - travelling_allowance_taxable - utilities_allowance - vehicle_allowance_non_taxable amount: type: number description: >- The monetary amount applied each time this allowance is included on a Pay Stub. format: decimal minimum: 0 maximum: 99999 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 frequency: type: string description: >- The frequency at which this allowance is applied to Pay Stubs. When `per_month`, the amount is distributed evenly across all Payrolls in the calendar month. enum: - once - per_month - per_payroll effective_from: type: string description: >- The date from which this allowance is applied to Pay Stubs. format: date effective_to: type: string description: >- The date after which this allowance is no longer applied. `null` if the allowance applies indefinitely. format: date expense_accounting_code_id: type: string liability_accounting_code_id: type: string external_ref: type: string maxLength: 255 tag_assignment: type: object properties: unit: type: string enum: - percentage is_component_locked: type: boolean tag_allocations: type: array items: type: object properties: tags: type: array items: type: string value: type: number format: decimal minimum: 0 date_basis: type: string description: >- Which payroll date determines the calendar month for the allocation. Applies only to `per_month` recurrences. enum: - by_pay_date - by_period_end_date - by_period_start_date pay_period_cadence: type: array 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` recurrences. items: type: integer minItems: 1 - type: object required: - work_assignment_id - amount - frequency - effective_from example: work_assignment_id: allowance_type: cell_phone_allowance amount: '75.25' title: Cell phone allowance title_translations: en: Cell phone allowance fr: Allocation de téléphone cellulaire frequency: per_month effective_from: '2026-01-01' effective_to: '2026-12-31' external_ref: 01KFNHG3MNRS84XF1ERW0M7HP0 tag_assignment: unit: percentage tag_allocations: - tags: - value: 100 date_basis: by_period_start_date pay_period_cadence: - 1 responses: '201': description: Created content: application/json: schema: 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 (`"allowance"`). readOnly: true data: $ref: '#/components/schemas/Allowance' example: id: object: allowance data: work_assignment: id: object: work_assignment links: self: /work_assignments/ allowance_type: id: object: allowance_type data: type: cell_phone_allowance label: Cell phone allowance links: self: /allowance_types/cell_phone_allowance title: Cell phone allowance title_translations: en: Cell phone allowance fr: Allocation de téléphone cellulaire title_translated: Cell phone allowance amount: 75.25 frequency: per_month date_basis: by_period_start_date pay_period_cadence: - 1 effective_from: '2026-01-01' effective_to: '2026-12-31' business_preset: null expense_accounting_code: null liability_accounting_code: null external_ref: 01KFNHG3MNRS84XF1ERW0M7HP0 created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /allowances/ components: schemas: Translations: type: object nullable: true properties: en: type: string maxLength: 255 fr: type: string maxLength: 255 Allowance: type: object title: Allowance 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 allowance_type: type: object description: >- The type of allowance, which determines how it is taxed and reported on Pay Stubs. 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 (`"allowance_type"`). readOnly: true data: $ref: '#/components/schemas/AllowanceType' title: type: string nullable: true 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 amount: type: number description: >- The monetary amount applied each time this allowance is included on a Pay Stub. format: decimal frequency: type: string description: >- The frequency at which this allowance is applied to Pay Stubs. When `per_month`, the amount is distributed evenly across all Payrolls in the calendar month. 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` recurrences. 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` recurrences. nullable: true effective_from: type: string description: The date from which this allowance is applied to Pay Stubs. format: date effective_to: type: string description: >- The date after which this allowance is no longer applied. `null` if the allowance applies indefinitely. nullable: true format: date business_preset: {} 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 AllowanceType: type: object title: Allowance Type properties: type: type: string description: The string identifier for this allowance type. nullable: true label: type: string description: The human-readable display name for this allowance type. nullable: true features: type: array items: $ref: '#/components/schemas/LineItemTypeFeature' form_mappings: type: array items: $ref: '#/components/schemas/LineItemFormMapping' 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 ````