> ## 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. # Retrieve an earning type ## OpenAPI ````yaml /spec/openapi.json get /earning_types/{earning_type} 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: Remittance Totals - name: Reports - name: ROE SAT Agreements - 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: /earning_types/{earning_type}: get: tags: - Earning Types summary: Retrieve an earning type operationId: earning-types-show parameters: - name: earning_type in: path schema: type: string required: true - name: features in: query schema: type: string enum: - CA - GB required: false description: >- Country code that adds each type's payroll calculations to the response, as the `features` and `form_mappings` fields. Currently only `ca` is supported. See [Line item type features](https://docs.nmbr.co/guides/payroll-fundamentals/line-item-type-features). responses: '200': description: OK 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 (`"earning_type"`). readOnly: true data: $ref: '#/components/schemas/EarningType' example: id: object: earning_type data: type: salary label: Salary supported_payroll_types: regular: true historical: true off_cycle: true correction: true features: - type: income_tax label: Income Tax definitions: - jurisdiction: ca_federal effects: - withholding help_text: Salary is subject to Federal Income Tax. program_label: null - jurisdiction: ca_ab effects: - withholding help_text: Salary is subject to Income Tax. program_label: null - jurisdiction: ca_bc effects: - withholding help_text: Salary is subject to Income Tax. program_label: null - jurisdiction: ca_mb effects: - withholding help_text: Salary is subject to Income Tax. program_label: null - jurisdiction: ca_nb effects: - withholding help_text: Salary is subject to Income Tax. program_label: null - jurisdiction: ca_nl effects: - withholding help_text: Salary is subject to Income Tax. program_label: null - jurisdiction: ca_ns effects: - withholding help_text: Salary is subject to Income Tax. program_label: null - jurisdiction: ca_nt effects: - withholding help_text: Salary is subject to Income Tax. program_label: null - jurisdiction: ca_nu effects: - withholding help_text: Salary is subject to Income Tax. program_label: null - jurisdiction: ca_on effects: - withholding help_text: Salary is subject to Income Tax. program_label: null - jurisdiction: ca_pe effects: - withholding help_text: Salary is subject to Income Tax. program_label: null - jurisdiction: ca_qc effects: - withholding help_text: >- Salary is subject to Income Tax. When a TP-1015.3-V has been completed, Income Tax is calculated on Salary following Revenue Quebec's cumulative-averaging method, using estimated income and expenses from the TP-1015.3-V. program_label: null - jurisdiction: ca_sk effects: - withholding help_text: Salary is subject to Income Tax. program_label: null - jurisdiction: ca_yt effects: - withholding help_text: Salary is subject to Income Tax. program_label: null - jurisdiction: ca_oc effects: - withholding help_text: >- Federal Income Tax rates apply, plus the default outside-Canada surtax. program_label: null - type: pensionable label: Pensionable (CPP/QPP) definitions: - jurisdiction: ca_federal effects: - withholding help_text: Salary is subject to CPP. program_label: CPP - jurisdiction: ca_oc effects: - withholding help_text: Salary is subject to CPP. program_label: CPP - jurisdiction: ca_qc effects: - withholding help_text: Salary is subject to QPP. program_label: QPP - type: insurable label: Insurable (EI/QPIP) definitions: - jurisdiction: ca_federal effects: - withholding help_text: Salary is subject to EI. program_label: EI - jurisdiction: ca_qc effects: - withholding help_text: Salary is subject to EI. program_label: EI - jurisdiction: ca_oc effects: - withholding help_text: Salary is subject to EI. program_label: EI - jurisdiction: ca_qc effects: - withholding help_text: Salary is subject to QPIP. program_label: QPIP - type: wcb label: WCB definitions: - jurisdiction: ca_ab effects: - withholding help_text: Salary is subject to WCB. program_label: WCB - jurisdiction: ca_bc effects: - withholding help_text: Salary is subject to WorkSafeBC. program_label: WorkSafeBC - jurisdiction: ca_mb effects: - withholding help_text: Salary is subject to WCB. program_label: WCB - jurisdiction: ca_nb effects: - withholding help_text: Salary is subject to WorkSafeNB. program_label: WorkSafeNB - jurisdiction: ca_nl effects: - withholding help_text: Salary is subject to WorkplaceNL. program_label: WorkplaceNL - jurisdiction: ca_ns effects: - withholding help_text: Salary is subject to WCB. program_label: WCB - jurisdiction: ca_nt effects: - withholding help_text: Salary is subject to WSCC. program_label: WSCC - jurisdiction: ca_nu effects: - withholding help_text: Salary is subject to WSCC. program_label: WSCC - jurisdiction: ca_on effects: - withholding help_text: Salary is subject to WSIB. program_label: WSIB - jurisdiction: ca_pe effects: - withholding help_text: Salary is subject to WCB. program_label: WCB - jurisdiction: ca_qc effects: - withholding help_text: Salary is subject to CNESST. program_label: CNESST - jurisdiction: ca_sk effects: - withholding help_text: Salary is subject to WCB. program_label: WCB - jurisdiction: ca_yt effects: - withholding help_text: Salary is subject to WCB. program_label: WCB - type: eht label: EPT definitions: - jurisdiction: ca_bc effects: - withholding help_text: Salary is subject to EHT. program_label: EHT - jurisdiction: ca_mb effects: - withholding help_text: Salary is subject to HE Levy. program_label: HE Levy - jurisdiction: ca_nl effects: - withholding help_text: Salary is subject to HAPSET. program_label: HAPSET - jurisdiction: ca_on effects: - withholding help_text: Salary is subject to EHT. program_label: EHT - jurisdiction: ca_qc effects: - withholding help_text: Salary is subject to HSF. program_label: HSF - type: vacationable label: Vacationable definitions: - jurisdiction: ca_ab effects: - accrues_vacation_pay help_text: Vacation pay accrues on Salary program_label: null - jurisdiction: ca_bc effects: - accrues_vacation_pay help_text: Vacation pay accrues on Salary program_label: null - jurisdiction: ca_mb effects: - accrues_vacation_pay help_text: Vacation pay accrues on Salary program_label: null - jurisdiction: ca_nb effects: - accrues_vacation_pay help_text: Vacation pay accrues on Salary program_label: null - jurisdiction: ca_nl effects: - accrues_vacation_pay help_text: Vacation pay accrues on Salary program_label: null - jurisdiction: ca_ns effects: - accrues_vacation_pay help_text: Vacation pay accrues on Salary program_label: null - jurisdiction: ca_nt effects: - accrues_vacation_pay help_text: Vacation pay accrues on Salary program_label: null - jurisdiction: ca_nu effects: - accrues_vacation_pay help_text: Vacation pay accrues on Salary program_label: null - jurisdiction: ca_on effects: - accrues_vacation_pay help_text: Vacation pay accrues on Salary program_label: null - jurisdiction: ca_pe effects: - accrues_vacation_pay help_text: Vacation pay accrues on Salary program_label: null - jurisdiction: ca_qc effects: - accrues_vacation_pay help_text: Vacation pay accrues on Salary program_label: null - jurisdiction: ca_sk effects: - accrues_vacation_pay help_text: Vacation pay accrues on Salary program_label: null - jurisdiction: ca_yt effects: - accrues_vacation_pay help_text: Vacation pay accrues on Salary program_label: null - type: stat_payable label: Included in Statutory Holiday Pay definitions: [] form_mappings: - form: t4 form_label: T4 mapping: - - name: '14' help_text: Employment Income jurisdictions: - ca_ab - ca_bc - ca_mb - ca_nb - ca_nl - ca_ns - ca_nt - ca_nu - ca_on - ca_pe - ca_qc - ca_sk - ca_yt - form: rl1 form_label: RL-1 mapping: - - name: A help_text: Employment Income Before Source Deductions jurisdictions: - ca_ab - ca_bc - ca_mb - ca_nb - ca_nl - ca_ns - ca_nt - ca_nu - ca_on - ca_pe - ca_qc - ca_sk - ca_yt links: self: /earning_types/salary components: schemas: 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 correction: type: boolean 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 - stat_payable - 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 - included_in_stat_holiday_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 in at least one province. 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 jurisdictions: type: array description: >- The provinces of employment where amounts of this type are reported in this box. Most types report the same boxes in every province; a few, such as Quebec tips, do not. items: type: string description: The province of employment (e.g. `ca_on`, `ca_qc`). securitySchemes: CompanyToken: type: http scheme: bearer ````