> ## 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. # List earnings ## OpenAPI ````yaml /spec/openapi.json get /earnings 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: /earnings: get: tags: - Earnings summary: List earnings operationId: earnings-index parameters: - name: business_entity_id in: query schema: type: string required: false - name: pay_schedule_id in: query schema: type: string required: false - name: work_assignment_id in: query schema: type: string required: false - name: employee_id in: query schema: type: string required: false - name: has_business_preset in: query schema: type: boolean required: false - name: business_preset_id in: query schema: type: string required: false - name: include_types in: query schema: anyOf: - type: string enum: - bonus_discretionary - bonus_non_discretionary - bonus_non_taxable - commission - commission_periodic - commission_self_employed - death_benefit - gift_cash - gratuity - in_lieu_wages - income_replacement_indemnity_non_taxable - income_replacement_indemnity_taxable - invoice_payment - invoice_sales_tax - leave_bereavement - leave_citizenship - leave_domestic_and_sexual_violence - leave_general - leave_jury_duty - leave_maternity - leave_organ_donor - leave_parental - leave_paternity - leave_personal - leave_sick - leave_voting - leave_wedding - overtime - parental_top_up_insurable - parental_top_up_non_insurable - pension - retiring_allowance - retiring_allowance_eligible - retroactive_pay - retroactive_pay_increase - salary - salary_continuance - severance_pay - statutory_holiday_pay - supplemental_unemployment - time_off_in_lieu - time_off_in_lieu_overtime - vacation_accrual_adjustment - vacation_pay - vacation_pay_employee_terminated - vacation_pay_no_time_taken - vacation_pay_time_taken - wage - type: array items: type: string enum: - bonus_discretionary - bonus_non_discretionary - bonus_non_taxable - commission - commission_periodic - commission_self_employed - death_benefit - gift_cash - gratuity - in_lieu_wages - income_replacement_indemnity_non_taxable - income_replacement_indemnity_taxable - invoice_payment - invoice_sales_tax - leave_bereavement - leave_citizenship - leave_domestic_and_sexual_violence - leave_general - leave_jury_duty - leave_maternity - leave_organ_donor - leave_parental - leave_paternity - leave_personal - leave_sick - leave_voting - leave_wedding - overtime - parental_top_up_insurable - parental_top_up_non_insurable - pension - retiring_allowance - retiring_allowance_eligible - retroactive_pay - retroactive_pay_increase - salary - salary_continuance - severance_pay - statutory_holiday_pay - supplemental_unemployment - time_off_in_lieu - time_off_in_lieu_overtime - vacation_accrual_adjustment - vacation_pay - vacation_pay_employee_terminated - vacation_pay_no_time_taken - vacation_pay_time_taken - wage required: false - name: exclude_types in: query schema: anyOf: - type: string enum: - bonus_discretionary - bonus_non_discretionary - bonus_non_taxable - commission - commission_periodic - commission_self_employed - death_benefit - gift_cash - gratuity - in_lieu_wages - income_replacement_indemnity_non_taxable - income_replacement_indemnity_taxable - invoice_payment - invoice_sales_tax - leave_bereavement - leave_citizenship - leave_domestic_and_sexual_violence - leave_general - leave_jury_duty - leave_maternity - leave_organ_donor - leave_parental - leave_paternity - leave_personal - leave_sick - leave_voting - leave_wedding - overtime - parental_top_up_insurable - parental_top_up_non_insurable - pension - retiring_allowance - retiring_allowance_eligible - retroactive_pay - retroactive_pay_increase - salary - salary_continuance - severance_pay - statutory_holiday_pay - supplemental_unemployment - time_off_in_lieu - time_off_in_lieu_overtime - vacation_accrual_adjustment - vacation_pay - vacation_pay_employee_terminated - vacation_pay_no_time_taken - vacation_pay_time_taken - wage - type: array items: type: string enum: - bonus_discretionary - bonus_non_discretionary - bonus_non_taxable - commission - commission_periodic - commission_self_employed - death_benefit - gift_cash - gratuity - in_lieu_wages - income_replacement_indemnity_non_taxable - income_replacement_indemnity_taxable - invoice_payment - invoice_sales_tax - leave_bereavement - leave_citizenship - leave_domestic_and_sexual_violence - leave_general - leave_jury_duty - leave_maternity - leave_organ_donor - leave_parental - leave_paternity - leave_personal - leave_sick - leave_voting - leave_wedding - overtime - parental_top_up_insurable - parental_top_up_non_insurable - pension - retiring_allowance - retiring_allowance_eligible - retroactive_pay - retroactive_pay_increase - salary - salary_continuance - severance_pay - statutory_holiday_pay - supplemental_unemployment - time_off_in_lieu - time_off_in_lieu_overtime - vacation_accrual_adjustment - vacation_pay - vacation_pay_employee_terminated - vacation_pay_no_time_taken - vacation_pay_time_taken - wage required: false - name: effective_on in: query schema: type: string format: date required: false - name: not_effective_on in: query schema: type: string format: date required: false - name: effective_from in: query schema: type: object required: false description: >- Date filters support two formats: Exact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=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: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31` - name: effective_to in: query schema: type: object required: false description: >- Date filters support two formats: Exact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=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: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31` - name: external_ref in: query schema: type: string required: false - name: search_payee_names in: query schema: type: string required: false - name: sort in: query schema: type: string enum: - effective_from - effective_to - work_assignment.payee.default - work_assignment.payee.first_name - work_assignment.payee.last_name required: false description: >- Sort order is specified using the format `sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by and `direction` is the optional sort direction (`asc` or `desc`). - name: tag_id in: query schema: type: string required: false - name: tag_group_id in: query schema: type: string required: false - name: expand in: query schema: type: array items: type: string enum: - business_preset - expense_accounting_code - liability_accounting_code - tag_assignment - work_assignment required: false 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 (`"earning"`). readOnly: true data: type: object allOf: - $ref: '#/components/schemas/Earning' anyOf: - type: object title: Default - type: object title: With work_assignment expanded properties: work_assignment: type: object properties: data: $ref: '#/components/schemas/WorkAssignment' - type: object title: With business_preset expanded properties: business_preset: type: object properties: data: $ref: '#/components/schemas/BusinessPreset' - type: object title: With expense_accounting_code expanded properties: expense_accounting_code: type: object properties: data: $ref: >- #/components/schemas/ExpenseAccountingCode - type: object title: With liability_accounting_code expanded properties: liability_accounting_code: type: object properties: data: $ref: >- #/components/schemas/LiabilityAccountingCode - type: object title: With tag_assignment expanded properties: tag_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. readOnly: true data: $ref: '#/components/schemas/TagAssignment' example: object: list data: - id: object: earning data: work_assignment: id: object: work_assignment links: self: /work_assignments/ earning_type: id: object: earning_type data: type: parental_top_up_insurable label: Parental Top-Up (Insurable) supported_payroll_types: regular: true historical: true off_cycle: true links: self: /earning_types/parental_top_up_insurable title: null title_translations: null title_translated: null amount: 5000 frequency: per_payroll date_basis: null pay_period_cadence: null effective_from: '2026-01-01' effective_to: null business_preset: null expense_accounting_code: null liability_accounting_code: null external_ref: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /earnings/ links: first: /earnings?work_assignment_id=&page=1 last: /earnings?work_assignment_id=&page=1 prev: null next: null meta: current_page: 1 last_page: 1 per_page: 15 total: 1 has_more: false components: schemas: Earning: type: object title: Earning 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 earning_type: type: object description: The type of earning, which determines how it is taxed. 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 (`"earning_type"`). readOnly: true data: $ref: '#/components/schemas/EarningType' 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 amount: type: number description: >- The monetary amount applied each time this earning is included on a Pay Stub. format: decimal frequency: type: string description: >- The frequency at which this earning 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 earning is applied to Pay Stubs. format: date effective_to: type: string description: >- The date after which this earning is no longer applied. `null` if the earning 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 WorkAssignment: type: object title: Work Assignment properties: title: type: string description: >- An optional label for this work assignment, used to distinguish between multiple work assignments for the same Employee or Contractor. 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 employee: 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 (`"employee"`). readOnly: true pay_schedule: 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 (`"pay_schedule"`). readOnly: true business_entity: 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 (`"business_entity"`). readOnly: true current_tax_jurisdiction: type: string description: >- The current Province of Employment (POE) for the work assignment, derived from the `ca::province_of_employment` Tax Property on the work assignment or, if none is set, from the Business Entity. nullable: true is_primary: type: boolean description: >- When `true`, the standard tax reductions are applied to this work assignment's Pay Stubs. Only one work assignment per Employee per Business Entity may be primary. If none is explicitly set to primary, the earliest work assignment is treated as primary. accrued_vacation_pay: type: number description: This attribute is deprecated and will be removed. deprecated: true format: decimal paid_vacation_pay: type: number description: This attribute is deprecated and will be removed. deprecated: true format: decimal first_non_draft_period_start: type: string description: >- The start of the first pay period for which this work assignment has a non-draft Payroll. `null` if the work assignment has never appeared on an approved or paid Payroll. nullable: true format: date last_non_draft_period_end: type: string description: >- The end of the most recent pay period for which this work assignment has a non-draft Payroll. `null` if the work assignment has never appeared on an approved or paid Payroll. nullable: true format: date available_tax_properties: type: array description: >- A list of Tax Property template identifiers supported for this work assignment, based on its jurisdiction. nullable: true items: type: string 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 archived_at: type: string description: >- The date the work assignment was archived. Archiving ends the work assignment's participation in future Payrolls. The archive date must not fall before any active Pay Rate's effective period. readOnly: true nullable: true format: dateTime 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 BusinessPreset: type: object title: Business Preset properties: business_entity: 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 (`"business_entity"`). readOnly: true name: type: string maxLength: 255 name_translations: type: object description: Optional translations for the `name` property. allOf: - $ref: '#/components/schemas/Translations' nullable: true name_translated: type: string description: >- The translation of the `name` property for the request locale. Computed using the values in `name` and `name_translations` and the value of the request's `Accept-Language` header. readOnly: true 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 type: type: string maxLength: 255 subtype: type: string nullable: true maxLength: 255 remittance_account: {} is_managed: type: boolean description: >- If true, this is a default Business Preset and can not be deleted, `title` and `remittance_account` may be set. expense_accounting_code: {} liability_accounting_code: {} income_basis: type: string nullable: true enum: - all_earnings - none - regular_earnings - total_income income_includes: type: object nullable: true 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 ExpenseAccountingCode: $ref: '#/components/schemas/AccountingCode' LiabilityAccountingCode: $ref: '#/components/schemas/AccountingCode' TagAssignment: type: object properties: unit: type: string enum: - amount - hours - percentage tag_allocations: type: array items: type: object properties: tags: type: array items: $ref: '#/components/schemas/Tag' value: type: number format: decimal expense_accounting_code: $ref: '#/components/schemas/AccountingCode' liability_accounting_code: $ref: '#/components/schemas/AccountingCode' EarningType: type: object title: Earning Type properties: type: type: string description: The string identifier for this earning type. nullable: true label: type: string description: The human-readable display name for this earning type. nullable: true supported_payroll_types: type: object description: >- A map of Payroll types to whether this earning type is available on that Payroll type. nullable: true properties: regular: type: boolean historical: type: boolean off_cycle: type: boolean 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 AccountingCode: type: object title: Accounting Code properties: business_entity: type: object description: The Business Entity this accounting code belongs to. 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 (`"business_entity"`). readOnly: true type: type: string description: The type of accounting code. enum: - bank - expense - liability code: type: string description: >- The accounting code identifier as it appears in the chart of accounts. nullable: true maxLength: 255 title: type: string 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 description: type: string nullable: true description_translations: type: object description: Optional translations for the `description` property. allOf: - $ref: '#/components/schemas/Translations' nullable: true description_translated: type: string description: >- The translation of the `description` property for the request locale. Computed using the values in `description` and `description_translations` and the value of the request's `Accept-Language` header. readOnly: true mapping: type: object nullable: true properties: xero: type: boolean quickbooks: type: boolean fallback_mappings: type: object description: >- Line Item type/subtype pairs that default to this accounting code when no specific mapping is configured. Each entry contains `type` and `subtype`. nullable: true 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 Tag: type: object title: Tag properties: label: type: string maxLength: 255 label_translations: type: object description: Optional translations for the `label` property. allOf: - $ref: '#/components/schemas/Translations' nullable: true label_translated: type: string description: >- The translation of the `label` property for the request locale. Computed using the values in `label` and `label_translations` and the value of the request's `Accept-Language` header. readOnly: true description: type: string nullable: true description_translations: type: object description: Optional translations for the `description` property. allOf: - $ref: '#/components/schemas/Translations' nullable: true description_translated: type: string description: >- The translation of the `description` property for the request locale. Computed using the values in `description` and `description_translations` and the value of the request's `Accept-Language` header. readOnly: true archived_at: type: string description: >- When set, the tag is archived and excluded from index listings by default. readOnly: true nullable: true format: dateTime is_deletable: type: boolean description: >- A tag may not be deleted while it is assigned to any active allocation. integrations: type: object description: >- Identifiers for this tag in external accounting integrations, used to sync tags imported from those systems. nullable: true properties: xero: type: object nullable: true properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true maxLength: 32 quickbooks: type: object nullable: true properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true maxLength: 32 tag_group: 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 (`"tag_group"`). readOnly: true business_entity: 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 (`"business_entity"`). readOnly: true 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 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 ````