{ "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": { "/accounting_codes": { "get": { "summary": "List accounting codes", "operationId": "accounting-codes-index", "tags": [ "Accounting Codes" ], "parameters": [ { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "fallback_mappings.type", "in": "query", "schema": { "type": "string", "enum": [ "allowance", "deduction", "earning", "employee_benefit", "employer_benefit", "employer_statutory_withholding", "reimbursement", "statutory_withholding" ] }, "required": false }, { "name": "fallback_mappings.subtype", "in": "query", "schema": { "type": "string", "enum": [ "accident_insurance_plan", "automobile_and_motor_vehicle", "bonus_discretionary", "bonus_non_discretionary", "bonus_non_taxable", "cell_phone_allowance", "charitable_donation", "child_care_expenses", "child_eduction_non_taxable", "child_eduction_taxable", "clothing_non_taxable", "clothing_taxable", "commission", "commission_periodic", "commission_self_employed", "cpp", "cpp_2", "critical_illness", "death_benefit", "debt_relief", "dental", "education_and_professional_development", "eht", "ei", "employee_assistance_program", "federal_income_tax", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "garnishment_order", "gift_cash", "gift_near_cash", "gift_non_cash_non_taxable", "gift_non_cash_taxable", "gratuity", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "housing_allowance_cash", "in_lieu_wages", "income_replacement_indemnity_non_taxable", "income_replacement_indemnity_taxable", "income_tax", "internet_allowance", "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_unpaid", "leave_voting", "leave_wedding", "long_term_disability", "meals_subsidized_non_cash", "meals_taxable", "moving_allowance_non_taxable", "moving_allowance_taxable", "municipal_officers_expense", "non_group_long_term_disability", "non_group_short_term_disability", "non_taxable_allowance", "non_taxable_reimbursement", "other_deduction", "overtime", "overtime_meals_non_taxable", "parental_top_up_insurable", "parental_top_up_non_insurable", "parking", "parking_allowance", "pension", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_rrsp_non_periodic", "pension_unregistered_prpp", "pension_vrsp", "professional_membership", "professional_membership_dues_taxable", "profit_sharing_dpsp", "provincial_income_tax", "qpip", "qpp", "qpp_2", "retiring_allowance", "retiring_allowance_eligible", "retroactive_pay", "retroactive_pay_increase", "salary", "salary_continuance", "savings_tfsa", "second_opinion_medical_consultation", "severance_pay", "short_term_disability", "social_event_allowance", "statutory_holiday_pay", "supplemental_unemployment", "taxable_cash_allowance", "taxable_reimbursement", "territorial_income_tax", "time_off_in_lieu", "time_off_in_lieu_overtime", "tips_controlled", "tools_allowance", "transit_pass", "transportation_to_from_work", "travelling_allowance_non_taxable", "travelling_allowance_taxable", "uk_paye_income_tax", "union_dues", "union_dues_post_tax", "utilities_allowance", "vacation_accrual_adjustment", "vacation_pay", "vacation_pay_employee_terminated", "vacation_pay_no_time_taken", "vacation_pay_time_taken", "vehicle_allowance_non_taxable", "vehicle_employer_provided", "virtual_health_service", "wage", "wcb", "wellness_spending_account" ] }, "required": false }, { "name": "is_from_source", "in": "query", "schema": { "type": "string", "enum": [ "external", "manual", "quickbooks", "xero" ] }, "required": false, "description": "Filter accounting codes based on whether they are linked to an external source (e.g., Xero, QuickBooks), or generated manually within the system." }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_entity", "business_presets" ] } }, "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 (`\"accounting_code\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountingCode" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With business_entity expanded", "properties": { "business_entity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessEntity" } } } } }, { "type": "object", "title": "With business_presets expanded", "properties": { "business_presets": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/BusinessPreset" } } } } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "accounting_code", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "type": "expense", "code": "9916", "title": "Vitae error architecto sint.", "title_translations": null, "title_translated": "Vitae error architecto sint.", "description": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "description_translations": null, "description_translated": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "mapping": { "xero": false, "quickbooks": false }, "fallback_mappings": [], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/accounting_codes/" } }, { "id": "", "object": "accounting_code", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "type": "expense", "code": "9916", "title": "Vitae error architecto sint.", "title_translations": null, "title_translated": "Vitae error architecto sint.", "description": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "description_translations": null, "description_translated": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "mapping": { "xero": false, "quickbooks": false }, "fallback_mappings": [], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/accounting_codes/" } }, { "id": "", "object": "accounting_code", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "type": "expense", "code": "9916", "title": "Vitae error architecto sint.", "title_translations": null, "title_translated": "Vitae error architecto sint.", "description": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "description_translations": null, "description_translated": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "mapping": { "xero": false, "quickbooks": false }, "fallback_mappings": [], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/accounting_codes/" } }, { "id": "", "object": "accounting_code", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "type": "expense", "code": "9916", "title": "Vitae error architecto sint.", "title_translations": null, "title_translated": "Vitae error architecto sint.", "description": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "description_translations": null, "description_translated": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "mapping": { "xero": false, "quickbooks": false }, "fallback_mappings": [], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/accounting_codes/" } }, { "id": "", "object": "accounting_code", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "type": "expense", "code": "9916", "title": "Vitae error architecto sint.", "title_translations": null, "title_translated": "Vitae error architecto sint.", "description": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "description_translations": null, "description_translated": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "mapping": { "xero": false, "quickbooks": false }, "fallback_mappings": [], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/accounting_codes/" } }, { "id": "", "object": "accounting_code", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "type": "expense", "code": "9916", "title": "Vitae error architecto sint.", "title_translations": null, "title_translated": "Vitae error architecto sint.", "description": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "description_translations": null, "description_translated": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "mapping": { "xero": false, "quickbooks": false }, "fallback_mappings": [], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/accounting_codes/" } }, { "id": "", "object": "accounting_code", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "type": "expense", "code": "9916", "title": "Vitae error architecto sint.", "title_translations": null, "title_translated": "Vitae error architecto sint.", "description": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "description_translations": null, "description_translated": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "mapping": { "xero": false, "quickbooks": false }, "fallback_mappings": [], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/accounting_codes/" } }, { "id": "", "object": "accounting_code", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "type": "expense", "code": "9916", "title": "Vitae error architecto sint.", "title_translations": null, "title_translated": "Vitae error architecto sint.", "description": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "description_translations": null, "description_translated": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "mapping": { "xero": false, "quickbooks": false }, "fallback_mappings": [], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/accounting_codes/" } }, { "id": "", "object": "accounting_code", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "type": "expense", "code": "9916", "title": "Vitae error architecto sint.", "title_translations": null, "title_translated": "Vitae error architecto sint.", "description": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "description_translations": null, "description_translated": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "mapping": { "xero": false, "quickbooks": false }, "fallback_mappings": [], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/accounting_codes/" } }, { "id": "", "object": "accounting_code", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "type": "expense", "code": "9916", "title": "Vitae error architecto sint.", "title_translations": null, "title_translated": "Vitae error architecto sint.", "description": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "description_translations": null, "description_translated": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "mapping": { "xero": false, "quickbooks": false }, "fallback_mappings": [], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/accounting_codes/" } } ], "links": { "first": "/accounting_codes?business_entity_id=&page=1", "last": "/accounting_codes?business_entity_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 10, "has_more": false } } } } } } }, "post": { "summary": "Create an accounting code", "operationId": "accounting-codes-store", "tags": [ "Accounting Codes" ], "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 (`\"accounting_code\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/AccountingCode" } } }, "example": { "id": "", "object": "accounting_code", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "type": "expense", "code": "5100", "title": "Expense Code", "title_translations": null, "title_translated": "Expense Code", "description": null, "description_translations": null, "description_translated": null, "mapping": { "xero": false, "quickbooks": false }, "fallback_mappings": [], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/accounting_codes/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "business_entity_id": { "type": "string" }, "title": { "type": "string", "maxLength": 255 }, "title_translations": { "type": "object", "description": "Optional translations for the `title` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": 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.", "maxLength": 255 }, "description": { "type": "string", "nullable": true }, "description_translations": { "type": "object", "description": "Optional translations for the `description` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "fallback_mappings": { "type": "array", "description": "Line Item type/subtype pairs that default to this accounting code when no specific mapping is configured. Each entry contains `type` and `subtype`.\n\nMust be an array of valid `type` and `subtype` pairs\n\nThe combination of `type` and `subtype` must be unique within the business entities accounting codes, for the same accounting code type.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of accounting code.", "enum": [ "allowance", "deduction", "earning", "employee_benefit", "employer_benefit", "employer_statutory_withholding", "reimbursement", "statutory_withholding" ] }, "subtype": { "type": "string", "enum": [ "accident_insurance_plan", "automobile_and_motor_vehicle", "bonus_discretionary", "bonus_non_discretionary", "bonus_non_taxable", "cell_phone_allowance", "charitable_donation", "child_care_expenses", "child_eduction_non_taxable", "child_eduction_taxable", "clothing_non_taxable", "clothing_taxable", "commission", "commission_periodic", "commission_self_employed", "cpp", "cpp_2", "critical_illness", "death_benefit", "debt_relief", "dental", "education_and_professional_development", "eht", "ei", "employee_assistance_program", "federal_income_tax", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "garnishment_order", "gift_cash", "gift_near_cash", "gift_non_cash_non_taxable", "gift_non_cash_taxable", "gratuity", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "housing_allowance_cash", "in_lieu_wages", "income_replacement_indemnity_non_taxable", "income_replacement_indemnity_taxable", "income_tax", "internet_allowance", "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_unpaid", "leave_voting", "leave_wedding", "long_term_disability", "meals_subsidized_non_cash", "meals_taxable", "moving_allowance_non_taxable", "moving_allowance_taxable", "municipal_officers_expense", "non_group_long_term_disability", "non_group_short_term_disability", "non_taxable_allowance", "non_taxable_reimbursement", "other_deduction", "overtime", "overtime_meals_non_taxable", "parental_top_up_insurable", "parental_top_up_non_insurable", "parking", "parking_allowance", "pension", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_rrsp_non_periodic", "pension_unregistered_prpp", "pension_vrsp", "professional_membership", "professional_membership_dues_taxable", "profit_sharing_dpsp", "provincial_income_tax", "qpip", "qpp", "qpp_2", "retiring_allowance", "retiring_allowance_eligible", "retroactive_pay", "retroactive_pay_increase", "salary", "salary_continuance", "savings_tfsa", "second_opinion_medical_consultation", "severance_pay", "short_term_disability", "social_event_allowance", "statutory_holiday_pay", "supplemental_unemployment", "taxable_cash_allowance", "taxable_reimbursement", "territorial_income_tax", "time_off_in_lieu", "time_off_in_lieu_overtime", "tips_controlled", "tools_allowance", "transit_pass", "transportation_to_from_work", "travelling_allowance_non_taxable", "travelling_allowance_taxable", "uk_paye_income_tax", "union_dues", "union_dues_post_tax", "utilities_allowance", "vacation_accrual_adjustment", "vacation_pay", "vacation_pay_employee_terminated", "vacation_pay_no_time_taken", "vacation_pay_time_taken", "vehicle_allowance_non_taxable", "vehicle_employer_provided", "virtual_health_service", "wage", "wcb", "wellness_spending_account" ] } } } } } }, { "type": "object", "required": [ "business_entity_id", "title", "type" ] } ] }, "example": { "business_entity_id": "", "title": "Expense Code", "type": "expense", "code": "5100" } } } } } }, "/accounting_code_rules": { "get": { "summary": "List accounting code rules", "operationId": "accounting-code-rules-index", "tags": [ "Accounting Code Rules" ], "parameters": [ { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "tag_group_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "has_tag_group", "in": "query", "schema": { "type": "boolean" }, "required": false, "description": "Filter by whether the rule is scoped to a tag group. `false` returns only rules not scoped to any tag group; `true` returns only rules scoped to some tag group. Combining `false` with one or more `tag_group_id` values returns the union: rules with no tag group as well as rules in any of the listed groups." }, { "name": "tag_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "has_tag", "in": "query", "schema": { "type": "boolean" }, "required": false, "description": "Filter by whether the rule is scoped to a tag. `false` returns only rules not scoped to any tag; `true` returns only rules scoped to some tag. Combining `false` with one or more `tag_id` values returns the union: rules with no tag as well as rules with any of the listed tags." }, { "name": "type", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "allowance", "deduction", "earning", "employee_benefit", "employer_benefit", "employer_statutory_withholding", "reimbursement", "statutory_withholding" ] }, { "type": "array", "items": { "type": "string", "enum": [ "allowance", "deduction", "earning", "employee_benefit", "employer_benefit", "employer_statutory_withholding", "reimbursement", "statutory_withholding" ] } } ] }, "required": false }, { "name": "subtype", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Filter by subtype. A rule matches when its `subtypes` set holds any of the listed values." }, { "name": "business_preset_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "expense_accounting_code_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "liability_accounting_code_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "search", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Case-insensitive substring match across the rule's tag label, business preset title, line item type and subtype label, and the expense and liability accounting code's code and title. Translated fields are matched in the request's active locale (set via the `Accept-Language` header)." }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_entity", "business_preset", "expense_accounting_code", "liability_accounting_code", "tag", "tag_group" ] } }, "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 (`\"accounting_code_rule\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountingCodeRule" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With business_entity expanded", "properties": { "business_entity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessEntity" } } } } }, { "type": "object", "title": "With tag_group expanded", "properties": { "tag_group": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TagGroup" } } } } }, { "type": "object", "title": "With tag expanded", "properties": { "tag": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Tag" } } } } }, { "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/AccountingCode" } } } } }, { "type": "object", "title": "With liability_accounting_code expanded", "properties": { "liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LiabilityAccountingCode" } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "accounting_code_rule", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "tag_group": { "id": "", "object": "tag_group", "links": { "self": "/tag_groups/" } }, "tag": { "id": "", "object": "tag", "links": { "self": "/tags/" } }, "type": null, "subtype": null, "subtypes": [], "business_preset": null, "expense_accounting_code": { "id": "", "object": "accounting_code", "links": { "self": "/accounting_codes/" } }, "liability_accounting_code": null, "expense_segment_template": null, "liability_segment_template": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/accounting_code_rules/" } } ], "links": { "first": "/accounting_code_rules?business_entity_id=&page=1", "last": "/accounting_code_rules?business_entity_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create an accounting code rule", "operationId": "accounting-code-rules-store", "tags": [ "Accounting Code Rules" ], "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 (`\"accounting_code_rule\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/AccountingCodeRule" } } }, "example": { "id": "", "object": "accounting_code_rule", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "tag_group": null, "tag": null, "type": "earning", "subtype": "wage", "subtypes": [ "wage", "salary" ], "business_preset": null, "expense_accounting_code": { "id": "", "object": "accounting_code", "links": { "self": "/accounting_codes/" } }, "liability_accounting_code": { "id": "", "object": "accounting_code", "links": { "self": "/accounting_codes/" } }, "expense_segment_template": { "segments": [ { "type": "accounting_code", "id": "", "prefix": "GL-" }, { "type": "tag_group", "tag_group_id": "", "prefix": "-", "transform": [ "uppercase" ], "fallback": "0000" } ] }, "liability_segment_template": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/accounting_code_rules/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "business_entity_id": { "type": "string" }, "tag_group_id": { "type": "string", "description": "A tag group to scope this rule to. When set without `tag_id`, creates a tag-group-level rule that applies to all tags in the group." }, "tag_id": { "type": "string", "description": "A tag from the business entity's accounting code tag group. Optional \u2014 when omitted, the rule matches line items by `type`/`subtype` or `business_preset_id` alone." }, "type": { "type": "string", "description": "The line item type to scope this rule to (e.g. `earning`, `deduction`). Mutually exclusive with `business_preset_id`.", "enum": [ "allowance", "deduction", "earning", "employee_benefit", "employer_benefit", "employer_statutory_withholding", "reimbursement", "statutory_withholding" ] }, "subtype": { "type": "string", "description": "This attribute is deprecated and will be removed.\n\nUse `subtypes`. Still accepted, meaning a single-member set, and rejected against a rule that already holds several subtypes rather than truncating it. Sending both fields with values that disagree is rejected.", "nullable": true, "deprecated": true }, "subtypes": { "type": "array", "description": "The line item subtypes to further scope this rule to (e.g. `wage`, `salary`). A rule matches a line item whose subtype is any member of the set. Every subtype must belong to `type`, which a non-empty set requires. Supplying the set replaces it outright \u2014 there is no add-one or remove-one. No two rules in the same scope (same tag, same tag group, or both global) and on the same type may share a subtype.", "items": { "type": "string" } }, "business_preset_id": { "type": "string", "description": "A business preset to scope this rule to. Provides the highest specificity match. Mutually exclusive with `type` and `subtypes`.\n\nA rule with none of `tag_id`, `tag_group_id`, `type`, or `business_preset_id` is the catch-all: it matches any line item as the last resort when no other rule applies. At most one catch-all may exist per business entity." }, "expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string" }, "expense_segment_template": { "$ref": "#/components/schemas/SegmentTemplate" }, "liability_segment_template": { "$ref": "#/components/schemas/SegmentTemplate" } } }, { "type": "object", "required": [ "business_entity_id" ] } ] }, "example": { "business_entity_id": "", "type": "earning", "expense_accounting_code_id": "", "liability_accounting_code_id": "", "expense_segment_template": { "segments": [ { "type": "accounting_code", "id": "", "prefix": "GL-" }, { "type": "tag_group", "tag_group_id": "", "prefix": "-", "transform": [ "uppercase" ], "fallback": "0000" } ] }, "subtypes": [ "wage", "salary" ] } } } } } }, "/accounting_code_rules/search": { "post": { "summary": "Search accounting code rules", "description": "Search a business entity's accounting code rules. The body is a filter set at the root, plus an optional `any_of` list of filter sets. The root set narrows every result; the `any_of` sets are combined with OR and then applied together with the root, so a rule matches when it satisfies the root set and at least one `any_of` entry. An empty body returns every rule for the business entity.\n\nA filter set has the same shape at the root and in each `any_of` entry:\n\n- A field group \u2014 `tag_groups`, `tags`, `types`, `subtypes`, `business_presets`, `expense_accounting_codes`, `liability_accounting_codes` \u2014 carries an `include` and/or `exclude` list of values. `include` matches rules whose field is one of the listed values; `exclude` matches rules whose field is none of them, keeping rules where the field is unset. A rule's subtypes are a set, so `subtypes` matches on membership: `include` on any shared value, `exclude` on no shared value. - A `has_` boolean \u2014 `has_tag_group`, `has_tag`, `has_type`, `has_subtype`, `has_business_preset`, `has_expense_accounting_code`, `has_liability_accounting_code` \u2014 matches rules where the field is set (`true`) or unset (`false`).\n\nField groups and presence booleans within a set combine with AND.", "operationId": "accounting-code-rules-search", "tags": [ "Accounting Code Rules" ], "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 (`\"accounting_code_rule\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/AccountingCodeRule" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "accounting_code_rule", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "tag_group": { "id": "", "object": "tag_group", "links": { "self": "/tag_groups/" } }, "tag": { "id": "", "object": "tag", "links": { "self": "/tags/" } }, "type": null, "subtype": null, "subtypes": [], "business_preset": null, "expense_accounting_code": { "id": "", "object": "accounting_code", "links": { "self": "/accounting_codes/" } }, "liability_accounting_code": null, "expense_segment_template": null, "liability_segment_template": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/accounting_code_rules/" } } ], "links": { "first": "http://localhost/accounting_code_rules/search?page=1", "last": "http://localhost/accounting_code_rules/search?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "business_entity_id": { "type": "string", "description": "The business entity whose accounting code rules to search." }, "any_of": { "type": "array", "description": "A list of filter sets combined with OR; a rule matches when it satisfies at least one entry. Each entry has the same shape as the root filter set. An omitted or empty list applies no OR condition.", "items": { "type": "object", "properties": { "tag_groups": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "has_tag_group": { "type": "boolean" }, "tags": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "has_tag": { "type": "boolean" }, "types": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string", "enum": [ "allowance", "deduction", "earning", "employee_benefit", "employer_benefit", "employer_statutory_withholding", "reimbursement", "statutory_withholding" ] } }, "exclude": { "type": "array", "items": { "type": "string", "enum": [ "allowance", "deduction", "earning", "employee_benefit", "employer_benefit", "employer_statutory_withholding", "reimbursement", "statutory_withholding" ] } } } }, "has_type": { "type": "boolean" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "has_subtype": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "has_business_preset": { "type": "boolean" }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "has_expense_accounting_code": { "type": "boolean" }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "has_liability_accounting_code": { "type": "boolean" } } } }, "tag_groups": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "has_tag_group": { "type": "boolean" }, "tags": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "has_tag": { "type": "boolean" }, "types": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string", "enum": [ "allowance", "deduction", "earning", "employee_benefit", "employer_benefit", "employer_statutory_withholding", "reimbursement", "statutory_withholding" ] } }, "exclude": { "type": "array", "items": { "type": "string", "enum": [ "allowance", "deduction", "earning", "employee_benefit", "employer_benefit", "employer_statutory_withholding", "reimbursement", "statutory_withholding" ] } } } }, "has_type": { "type": "boolean" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "has_subtype": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "has_business_preset": { "type": "boolean" }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "has_expense_accounting_code": { "type": "boolean" }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "has_liability_accounting_code": { "type": "boolean" } } }, { "type": "object", "required": [ "business_entity_id" ] } ] }, "example": { "business_entity_id": "", "expense_accounting_codes": { "include": [ "" ] }, "any_of": [ { "tag_groups": { "include": [ "" ] }, "has_tag": true }, { "types": { "include": [ "earning" ] } } ] } } } } } }, "/adjustments": { "get": { "summary": "List adjustments", "operationId": "adjustments-index", "tags": [ "Adjustments" ], "parameters": [ { "name": "source_pay_stub_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "The `source_pay_stub_id` field is required when `correction_pay_stub_id` is not present." }, { "name": "correction_pay_stub_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "The `correction_pay_stub_id` field is required when `source_pay_stub_id` is not present." }, { "name": "external_ref", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "correction_line_item", "correction_pay_stub", "source_line_item" ] } }, "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 (`\"adjustment\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Adjustment" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With correction_pay_stub expanded", "properties": { "correction_pay_stub": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayStub" } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "adjustment", "data": { "source_line_item": { "id": "", "object": "earning_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "amount": 10000, "custom_amount": null, "managed_amount": 10000, "is_managed": true, "line_item_type": "earning", "earning_type": { "id": "", "object": "earning_type", "data": { "type": "salary", "label": "Salary", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/salary" } }, "hours": 173.33, "managed_hours": 173.33, "custom_hours": null, "accrued_vacation_pay": 0, "recurrence": { "id": "", "object": "pay_rate", "links": { "self": "/pay_rates/" } }, "pay_rate": { "id": "", "object": "pay_rate", "links": { "self": "/pay_rates/" } }, "overtime_rate": null, "title": "Salary Rate", "title_translations": null, "title_translated": "Salary Rate", "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "business_preset": null, "source_adjustment": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/earning_line_items/" } }, "correction_line_item": { "id": "", "object": "earning_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "amount": -8900, "custom_amount": null, "managed_amount": -8900, "is_managed": false, "line_item_type": "earning", "earning_type": { "id": "", "object": "earning_type", "data": { "type": "salary", "label": "Salary", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/salary" } }, "hours": null, "managed_hours": null, "custom_hours": null, "accrued_vacation_pay": 0, "recurrence": null, "pay_rate": null, "overtime_rate": null, "title": "Salary Rate Adjustment", "title_translations": { "en": "Salary Rate Adjustment", "fr": "Rajustement Salary Rate" }, "title_translated": "Salary Rate Adjustment", "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "business_preset": null, "source_adjustment": { "id": "", "object": "adjustment", "links": { "self": "/adjustments/" } }, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/earning_line_items/" } }, "correction_pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "type": "earning", "subtype": "salary", "expected_amount": 1100, "admin_note": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/adjustments/" } } ], "links": { "first": "/adjustments?correction_pay_stub_id=&page=1", "last": "/adjustments?correction_pay_stub_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create an adjustment", "operationId": "adjustments-store", "tags": [ "Adjustments" ], "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 (`\"adjustment\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Adjustment" } } }, "example": { "id": "", "object": "adjustment", "data": { "source_line_item": { "id": "", "object": "earning_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "amount": 10000, "custom_amount": null, "managed_amount": 10000, "is_managed": true, "line_item_type": "earning", "earning_type": { "id": "", "object": "earning_type", "data": { "type": "salary", "label": "Salary", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/salary" } }, "hours": 173.33, "managed_hours": 173.33, "custom_hours": null, "accrued_vacation_pay": 0, "recurrence": { "id": "", "object": "pay_rate", "links": { "self": "/pay_rates/" } }, "pay_rate": { "id": "", "object": "pay_rate", "links": { "self": "/pay_rates/" } }, "overtime_rate": null, "title": "Salary Rate", "title_translations": null, "title_translated": "Salary Rate", "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "business_preset": null, "source_adjustment": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/earning_line_items/" } }, "correction_line_item": { "id": "", "object": "earning_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "amount": -9950, "custom_amount": null, "managed_amount": -9950, "is_managed": false, "line_item_type": "earning", "earning_type": { "id": "", "object": "earning_type", "data": { "type": "salary", "label": "Salary", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/salary" } }, "hours": null, "managed_hours": null, "custom_hours": null, "accrued_vacation_pay": 0, "recurrence": null, "pay_rate": null, "overtime_rate": null, "title": "Salary Rate Adjustment", "title_translations": { "en": "Salary Rate Adjustment", "fr": "Rajustement Salary Rate" }, "title_translated": "Salary Rate Adjustment", "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "business_preset": null, "source_adjustment": { "id": "", "object": "adjustment", "links": { "self": "/adjustments/" } }, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/earning_line_items/" } }, "correction_pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "type": "earning", "subtype": "salary", "expected_amount": 50, "admin_note": "Admin note", "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/adjustments/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "correction_pay_stub_id": { "type": "string" }, "source_line_item_id": { "type": "string", "description": "Must be present when `type` and `subtype` is either empty or not set." }, "expected_amount": { "type": "number", "format": "decimal", "minimum": -99999, "maximum": 99999 }, "is_company_amount": { "type": "boolean" }, "type": { "type": "string", "description": "Must be present when `source_line_item_id` is either empty or not set.", "enum": [ "allowance", "deduction", "earning", "employee_benefit", "employer_benefit", "employer_statutory_withholding", "reimbursement", "statutory_withholding" ] }, "subtype": { "type": "string", "description": "Must be present when `source_line_item_id` is either empty or not set." }, "admin_note": { "type": "string", "nullable": true }, "external_ref": { "type": "string", "maxLength": 255 } } }, { "type": "object", "required": [ "correction_pay_stub_id", "expected_amount" ] } ] }, "example": { "correction_pay_stub_id": "", "source_line_item_id": "", "expected_amount": 50, "admin_note": "Admin note" } } } } } }, "/allowances/batch/delete": { "post": { "summary": "Batch delete allowances", "operationId": "allowances-batch-delete", "tags": [ "Allowances" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "", "" ] } } } } }, "/allowances/batch/upsert": { "post": { "summary": "Batch upsert allowances", "operationId": "allowances-batch-upsert", "tags": [ "Allowances" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "minItems": 1, "maxItems": 100 }, "example": [ { "id": "", "amount": 100, "effective_from": "2026-01-01" }, { "work_assignment_id": "", "allowance_type": "automobile_and_motor_vehicle", "amount": 75, "frequency": "per_payroll", "effective_from": "2026-01-01" } ] } } } } }, "/allowances/bulk/create": { "post": { "summary": "Bulk create allowances", "operationId": "allowances-bulk-create", "tags": [ "Allowances" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } } } }, "/allowances/bulk/create/scope": { "post": { "summary": "Show bulk create scope for allowances", "operationId": "allowances-bulk-create-scope", "tags": [ "Allowances" ], "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/Allowance" } } } } } }, "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/allowances/bulk/create/scope?page=1", "last": "http://localhost/allowances/bulk/create/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } } } }, "/allowances/bulk/delete": { "post": { "summary": "Bulk delete allowances", "operationId": "allowances-bulk-delete", "tags": [ "Allowances" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this allowance is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this allowance is no longer applied. `null` if the allowance applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/allowances/bulk/delete/scope": { "post": { "summary": "Show bulk delete scope for allowances", "operationId": "allowances-bulk-delete-scope", "tags": [ "Allowances" ], "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 (`\"allowance\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Allowance" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "allowance", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "allowance_type": { "id": "", "object": "allowance_type", "data": { "type": "automobile_and_motor_vehicle", "label": "Vehicle allowance (taxable)" }, "links": { "self": "/allowance_types/automobile_and_motor_vehicle" } }, "title": null, "title_translations": null, "title_translated": null, "amount": 35, "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": "/allowances/" } } ], "links": { "first": "http://localhost/allowances/bulk/delete/scope?page=1", "last": "http://localhost/allowances/bulk/delete/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this allowance is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this allowance is no longer applied. `null` if the allowance applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/allowances/bulk/update": { "post": { "summary": "Bulk update allowances", "operationId": "allowances-bulk-update", "tags": [ "Allowances" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this allowance is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this allowance is no longer applied. `null` if the allowance applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/allowances/bulk/update/scope": { "post": { "summary": "Show bulk update scope for allowances", "operationId": "allowances-bulk-update-scope", "tags": [ "Allowances" ], "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 (`\"allowance\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Allowance" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "allowance", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "allowance_type": { "id": "", "object": "allowance_type", "data": { "type": "automobile_and_motor_vehicle", "label": "Vehicle allowance (taxable)" }, "links": { "self": "/allowance_types/automobile_and_motor_vehicle" } }, "title": null, "title_translations": null, "title_translated": null, "amount": 35, "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": "/allowances/" } } ], "links": { "first": "http://localhost/allowances/bulk/update/scope?page=1", "last": "http://localhost/allowances/bulk/update/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this allowance is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this allowance is no longer applied. `null` if the allowance applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/allowances": { "get": { "summary": "List allowances", "operationId": "allowances-index", "tags": [ "Allowances" ], "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": [ "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" ] }, { "type": "array", "items": { "type": "string", "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" ] } } ] }, "required": false }, { "name": "exclude_types", "in": "query", "schema": { "anyOf": [ { "type": "string", "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" ] }, { "type": "array", "items": { "type": "string", "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" ] } } ] }, "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:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `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:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `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 \n`sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by\nand `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": "requires_tag_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "requires_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 (`\"allowance\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Allowance" } ], "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": "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\u00e9l\u00e9phone 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/" } }, { "id": "", "object": "allowance", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "allowance_type": { "id": "", "object": "allowance_type", "data": { "type": "parking_allowance", "label": "Parking allowance" }, "links": { "self": "/allowance_types/parking_allowance" } }, "title": "Parking allowance", "title_translations": { "en": "Parking allowance", "fr": "Allocation de stationnement" }, "title_translated": "Parking allowance", "amount": 25.75, "frequency": "per_payroll", "date_basis": null, "pay_period_cadence": null, "effective_from": "2026-01-01", "effective_to": "2026-12-31", "business_preset": null, "expense_accounting_code": null, "liability_accounting_code": null, "external_ref": "01KFNHXVA4N8WPKEGJJ5KAQJAE", "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/allowances/" } } ], "links": { "first": "/allowances?work_assignment_id=&page=1", "last": "/allowances?work_assignment_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 2, "has_more": false } } } } } } }, "post": { "summary": "Create an allowance", "operationId": "allowances-store", "tags": [ "Allowances" ], "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\u00e9l\u00e9phone 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/" } } } } } }, "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.\n\nMust 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\u00e9l\u00e9phone 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 ] } } } } } }, "/allowances/search": { "post": { "summary": "Search allowances", "description": "Search allowances under the given business entity, returning the same set the equivalent bulk update/delete operation would target with this body.", "operationId": "allowances-search", "tags": [ "Allowances" ], "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 (`\"allowance\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Allowance" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "allowance", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "allowance_type": { "id": "", "object": "allowance_type", "data": { "type": "automobile_and_motor_vehicle", "label": "Vehicle allowance (taxable)" }, "links": { "self": "/allowance_types/automobile_and_motor_vehicle" } }, "title": null, "title_translations": null, "title_translated": null, "amount": 35, "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": "/allowances/" } } ], "links": { "first": "http://localhost/allowances/search?page=1", "last": "http://localhost/allowances/search?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this allowance is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this allowance is no longer applied. `null` if the allowance applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/allowance_line_items/batch/delete": { "post": { "summary": "Batch delete allowance line items", "operationId": "allowance-line-items-batch-delete", "tags": [ "Allowance Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "", "" ] } } } } }, "/allowance_line_items/batch/upsert": { "post": { "summary": "Batch upsert allowance line items", "operationId": "allowance-line-items-batch-upsert", "tags": [ "Allowance Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "minItems": 1, "maxItems": 100 }, "example": [ { "id": "", "custom_amount": 100 }, { "pay_stub_id": "", "allowance_type": "automobile_and_motor_vehicle", "custom_amount": 75 } ] } } } } }, "/allowance_line_items/bulk/create": { "post": { "summary": "Bulk create allowance line items", "operationId": "allowance-line-items-bulk-create", "tags": [ "Allowance Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/allowance_line_items/bulk/create/scope": { "post": { "summary": "Show bulk create scope for allowance line items", "operationId": "allowance-line-items-bulk-create-scope", "tags": [ "Allowance Line Items" ], "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 (`\"pay_stub\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/AllowanceLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "pay_stub", "data": { "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "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, "apply_standard_tax_reductions": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_stubs/" } } ], "links": { "first": "http://localhost/allowance_line_items/bulk/create/scope?page=1", "last": "http://localhost/allowance_line_items/bulk/create/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/allowance_line_items/bulk/delete": { "post": { "summary": "Bulk delete allowance line items", "operationId": "allowance-line-items-bulk-delete", "tags": [ "Allowance Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/allowance_line_items/bulk/delete/scope": { "post": { "summary": "Show bulk delete scope for allowance line items", "operationId": "allowance-line-items-bulk-delete-scope", "tags": [ "Allowance Line Items" ], "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 (`\"allowance_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/AllowanceLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "allowance_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "allowance", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "accrued_vacation_pay": 0, "allowance_type": { "id": "", "object": "allowance_type", "data": { "type": "automobile_and_motor_vehicle", "label": "Vehicle allowance (taxable)" }, "links": { "self": "/allowance_types/automobile_and_motor_vehicle" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/allowance_line_items/" } } ], "links": { "first": "http://localhost/allowance_line_items/bulk/delete/scope?page=1", "last": "http://localhost/allowance_line_items/bulk/delete/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/allowance_line_items/bulk/update": { "post": { "summary": "Bulk update allowance line items", "operationId": "allowance-line-items-bulk-update", "tags": [ "Allowance Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/allowance_line_items/bulk/update/scope": { "post": { "summary": "Show bulk update scope for allowance line items", "operationId": "allowance-line-items-bulk-update-scope", "tags": [ "Allowance Line Items" ], "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 (`\"allowance_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/AllowanceLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "allowance_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "allowance", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "accrued_vacation_pay": 0, "allowance_type": { "id": "", "object": "allowance_type", "data": { "type": "automobile_and_motor_vehicle", "label": "Vehicle allowance (taxable)" }, "links": { "self": "/allowance_types/automobile_and_motor_vehicle" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/allowance_line_items/" } } ], "links": { "first": "http://localhost/allowance_line_items/bulk/update/scope?page=1", "last": "http://localhost/allowance_line_items/bulk/update/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/allowance_line_items": { "get": { "summary": "List allowance line items", "operationId": "allowance-line-items-index", "tags": [ "Allowance Line Items" ], "parameters": [ { "name": "pay_stub_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "payroll_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "payroll_status", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] }, { "type": "array", "items": { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] } } ] }, "required": false }, { "name": "payroll_type", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] }, { "type": "array", "items": { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] } } ] }, "required": false }, { "name": "payroll_period_start", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_period_start=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_period_start[gte]=2024-01-01&payroll_period_start[lt]=2024-12-31`" }, { "name": "payroll_period_end", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_period_end=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_period_end[gte]=2024-01-01&payroll_period_end[lt]=2024-12-31`" }, { "name": "payroll_pay_date", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_pay_date=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_pay_date[gte]=2024-01-01&payroll_pay_date[lt]=2024-12-31`" }, { "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": "contractor_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "business_entity_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": [ "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" ] }, { "type": "array", "items": { "type": "string", "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" ] } } ] }, "required": false }, { "name": "exclude_types", "in": "query", "schema": { "anyOf": [ { "type": "string", "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" ] }, { "type": "array", "items": { "type": "string", "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" ] } } ] }, "required": false }, { "name": "external_ref", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "earned_on", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Only return line items with an `earned_on` date matching the filter.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `earned_on=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `earned_on[gte]=2024-01-01&earned_on[lt]=2024-12-31`" }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "custom_expense_accounting_code", "custom_liability_accounting_code", "custom_tag_assignment", "expense_accounting_code", "liability_accounting_code", "managed_expense_accounting_code", "managed_liability_accounting_code", "managed_tag_assignment", "pay_stub", "recurrence", "source_adjustment", "tag_assignment", "tag_assignment_amounts" ] } }, "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 (`\"allowance_line_item\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AllowanceLineItem" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With pay_stub expanded", "properties": { "pay_stub": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayStub" } } } } }, { "type": "object", "title": "With recurrence expanded", "properties": { "recurrence": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Recurrence" } } } } }, { "type": "object", "title": "With business_preset expanded", "properties": { "business_preset": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessPreset" } } } } }, { "type": "object", "title": "With source_adjustment expanded", "properties": { "source_adjustment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SourceAdjustment" } } } } }, { "type": "object", "title": "With expense_accounting_code expanded", "properties": { "expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ExpenseAccountingCode" } } } } }, { "type": "object", "title": "With managed_expense_accounting_code expanded", "properties": { "managed_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedExpenseAccountingCode" } } } } }, { "type": "object", "title": "With custom_expense_accounting_code expanded", "properties": { "custom_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomExpenseAccountingCode" } } } } }, { "type": "object", "title": "With liability_accounting_code expanded", "properties": { "liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LiabilityAccountingCode" } } } } }, { "type": "object", "title": "With managed_liability_accounting_code expanded", "properties": { "managed_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedLiabilityAccountingCode" } } } } }, { "type": "object", "title": "With custom_liability_accounting_code expanded", "properties": { "custom_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomLiabilityAccountingCode" } } } } }, { "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" } } } } }, { "type": "object", "title": "With managed_tag_assignment expanded", "properties": { "managed_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/ManagedTagAssignment" } } } } }, { "type": "object", "title": "With custom_tag_assignment expanded", "properties": { "custom_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/CustomTagAssignment" } } } } }, { "type": "object", "title": "With tag_assignment_amounts expanded", "properties": { "tag_assignment_amounts": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/TagAssignmentAmount" } } } } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "allowance_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "allowance", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "accrued_vacation_pay": 0, "allowance_type": { "id": "", "object": "allowance_type", "data": { "type": "automobile_and_motor_vehicle", "label": "Vehicle allowance (taxable)" }, "links": { "self": "/allowance_types/automobile_and_motor_vehicle" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/allowance_line_items/" } } ], "links": { "first": "/allowance_line_items?pay_stub_id=&page=1", "last": "/allowance_line_items?pay_stub_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create an allowance line item", "operationId": "allowance-line-items-store", "tags": [ "Allowance Line Items" ], "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_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/AllowanceLineItem" } } }, "example": { "id": "", "object": "allowance_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "allowance", "is_managed": false, "amount": 0, "custom_amount": null, "managed_amount": null, "accrued_vacation_pay": 0, "allowance_type": { "id": "", "object": "allowance_type", "data": { "type": "automobile_and_motor_vehicle", "label": "Vehicle allowance (taxable)" }, "links": { "self": "/allowance_types/automobile_and_motor_vehicle" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/allowance_line_items/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "pay_stub_id": { "type": "string" }, "business_preset_id": { "type": "string" }, "allowance_type": { "type": "string", "description": "The type of allowance for this line item.\n\nMust 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" ] }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.", "format": "decimal", "maximum": 99999 }, "accrued_vacation_pay": { "type": "number", "description": "The vacation pay accrued on this line item, calculated based on the Work Assignment's Vacation Pay Settings.", "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 }, "component_settings": { "type": "object", "properties": { "attributes_locked": { "type": "boolean" } } }, "expense_accounting_code_id": { "type": "string" }, "custom_expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string" }, "custom_liability_accounting_code_id": { "type": "string" }, "custom_earned_on": { "type": "string", "format": "date" }, "external_ref": { "type": "string", "maxLength": 255 }, "custom_tag_assignment": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "amount", "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 } } } } } } } }, { "type": "object", "required": [ "pay_stub_id" ] } ] }, "example": { "pay_stub_id": "", "allowance_type": "automobile_and_motor_vehicle", "accrued_vacation_pay": "0", "custom_tag_assignment": { "unit": "percentage", "tag_allocations": [ { "tags": [ "" ], "value": 100 } ] } } } } } } }, "/allowance_line_items/search": { "post": { "summary": "Search allowance line items", "description": "Search line items under the given payroll, returning the same set the equivalent bulk update/delete operation would target with this body.", "operationId": "allowance-line-items-search", "tags": [ "Allowance Line Items" ], "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 (`\"allowance_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/AllowanceLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "allowance_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "allowance", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "accrued_vacation_pay": 0, "allowance_type": { "id": "", "object": "allowance_type", "data": { "type": "automobile_and_motor_vehicle", "label": "Vehicle allowance (taxable)" }, "links": { "self": "/allowance_types/automobile_and_motor_vehicle" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/allowance_line_items/" } } ], "links": { "first": "http://localhost/allowance_line_items/search?page=1", "last": "http://localhost/allowance_line_items/search?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/allowance_types": { "get": { "summary": "List allowance types", "operationId": "allowance-types-index", "tags": [ "Allowance Types" ], "parameters": [ { "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)." }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Comma-separated list of type identifiers to return." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Case-insensitive substring match against the human-readable label, in any supported locale." } ], "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 (`\"allowance_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/AllowanceType" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "allowance_type", "data": { "type": "automobile_and_motor_vehicle", "label": "Vehicle allowance (taxable)", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) 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": "Vehicle allowance (taxable) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Vehicle allowance (taxable) is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Vehicle allowance (taxable)", "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" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/allowance_types/automobile_and_motor_vehicle" } }, { "id": "", "object": "allowance_type", "data": { "type": "cell_phone_allowance", "label": "Cell phone allowance", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Cell phone allowance 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": "Cell phone allowance is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Cell phone allowance is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Cell phone allowance", "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" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/allowance_types/cell_phone_allowance" } }, { "id": "", "object": "allowance_type", "data": { "type": "child_care_expenses", "label": "Child care allowance", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Child care allowance 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": "Child care allowance is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Child care allowance is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Child care allowance", "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" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/allowance_types/child_care_expenses" } }, { "id": "", "object": "allowance_type", "data": { "type": "child_eduction_non_taxable", "label": "Educational allowances for children (non-taxable)", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/allowance_types/child_eduction_non_taxable" } }, { "id": "", "object": "allowance_type", "data": { "type": "child_eduction_taxable", "label": "Educational allowances for children (taxable)", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) 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": "Educational allowances for children (taxable) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Educational allowances for children (taxable) is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Educational allowances for children (taxable)", "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" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/allowance_types/child_eduction_taxable" } }, { "id": "", "object": "allowance_type", "data": { "type": "clothing_non_taxable", "label": "Uniforms and protective clothing \u2013 in cash (non-taxable)", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/allowance_types/clothing_non_taxable" } }, { "id": "", "object": "allowance_type", "data": { "type": "clothing_taxable", "label": "Uniforms and protective clothing \u2013 in cash (taxable)", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) 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": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Uniforms and protective clothing \u2013 in cash (taxable) is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/allowance_types/clothing_taxable" } }, { "id": "", "object": "allowance_type", "data": { "type": "education_and_professional_development", "label": "Education and professional development", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Education and professional development 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": "Education and professional development is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Education and professional development is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Education and professional development", "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" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/allowance_types/education_and_professional_development" } }, { "id": "", "object": "allowance_type", "data": { "type": "housing_allowance_cash", "label": "Housing allowance \u2013 in cash", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash 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": "Housing allowance \u2013 in cash is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Housing allowance \u2013 in cash is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" }, { "name": "30", "help_text": "Board and Lodging" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "V", "help_text": "Meals and lodging" } ] ] } ] }, "links": { "self": "/allowance_types/housing_allowance_cash" } }, { "id": "", "object": "allowance_type", "data": { "type": "internet_allowance", "label": "Internet allowance", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Internet allowance 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": "Internet allowance is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Internet allowance is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Internet allowance", "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" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/allowance_types/internet_allowance" } }, { "id": "", "object": "allowance_type", "data": { "type": "meals_taxable", "label": "Meals (taxable)", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Meals (taxable) 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": "Meals (taxable) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Meals (taxable) is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Meals (taxable)", "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" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/allowance_types/meals_taxable" } }, { "id": "", "object": "allowance_type", "data": { "type": "moving_allowance_non_taxable", "label": "Moving allowance - non-accountable $650 or less (non-taxable)", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/allowance_types/moving_allowance_non_taxable" } }, { "id": "", "object": "allowance_type", "data": { "type": "moving_allowance_taxable", "label": "Moving \u2013 non-accountable allowance over $650 (taxable)", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) 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": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Moving \u2013 non-accountable allowance over $650 (taxable) is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/allowance_types/moving_allowance_taxable" } }, { "id": "", "object": "allowance_type", "data": { "type": "municipal_officers_expense", "label": "Municipal officer's expense allowance", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance 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": "Municipal officer's expense allowance is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Municipal officer's expense allowance is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Municipal officer's expense allowance", "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" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/allowance_types/municipal_officers_expense" } }, { "id": "", "object": "allowance_type", "data": { "type": "non_taxable_allowance", "label": "Non-taxable allowance", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/allowance_types/non_taxable_allowance" } } ], "links": { "first": "/allowance_types?features=ca&page=1", "last": "/allowance_types?features=ca&page=2", "prev": null, "next": "/allowance_types?features=ca&page=2" }, "meta": { "current_page": 1, "last_page": 2, "per_page": 15, "total": 27, "has_more": true } } } } } } } }, "/bank_accounts": { "get": { "summary": "List bank accounts", "operationId": "bank-accounts-index", "tags": [ "Bank Accounts" ], "parameters": [ { "name": "employee_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "contractor_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_entity", "contractor", "employee" ] } }, "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 (`\"bank_account\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BankAccount" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With employee expanded", "properties": { "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/Employee" } } } } }, { "type": "object", "title": "With contractor expanded", "properties": { "contractor": { "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/Contractor" } } } } }, { "type": "object", "title": "With business_entity expanded", "properties": { "business_entity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessEntity" } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "bank_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "name": null, "institution_number": "320", "institution_name": "President's Choice Bank", "institution_name_translations": { "en": "President's Choice Bank", "fr": "Banque le Choix du Pr\u00e9sident" }, "institution_name_translated": "President's Choice Bank", "transit_number": "02002", "transit_address": "600-500 Lakeshore Blvd West POBOX600, Toronto, ON M5V 2V9", "account_number_last_3": "916", "is_primary": false, "is_deletable": true, "warnings": { "object": "list", "data": [] }, "is_pad_signed": false, "pad_signer_name": null, "pad_signer_email": null, "pad_signer_title": null, "pad_signed_at": null, "pad_file": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/bank_accounts/" } } ], "links": { "first": "/bank_accounts?business_entity_id=&page=1", "last": "/bank_accounts?business_entity_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create a bank account", "operationId": "bank-accounts-store", "tags": [ "Bank Accounts" ], "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 (`\"bank_account\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/BankAccount" } } }, "example": { "id": "", "object": "bank_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "name": null, "institution_number": "320", "institution_name": "President's Choice Bank", "institution_name_translations": { "en": "President's Choice Bank", "fr": "Banque le Choix du Pr\u00e9sident" }, "institution_name_translated": "President's Choice Bank", "transit_number": "02002", "transit_address": "600-500 Lakeshore Blvd West POBOX600, Toronto, ON M5V 2V9", "account_number_last_3": "916", "is_primary": true, "is_deletable": true, "warnings": { "object": "list", "data": [] }, "is_pad_signed": false, "pad_signer_name": null, "pad_signer_email": null, "pad_signer_title": null, "pad_signed_at": null, "pad_file": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/bank_accounts/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "employee_id": { "type": "string", "description": "Must be present when `contractor_id` and `business_entity_id` is either empty or not set." }, "contractor_id": { "type": "string", "description": "Must be present when `employee_id` and `business_entity_id` is either empty or not set." }, "business_entity_id": { "type": "string", "description": "Must be present when `employee_id` and `contractor_id` is either empty or not set." }, "account_number": { "type": "string", "description": "The bank account number. 1 to 12 digits, sent as a string. An account number that fails its institution's check-digit rules raises a `bank_account_invalid_account` warning rather than failing the request, so a successful response is not confirmation the account is valid. Validate details first with `POST /bank_accounts/lookup`." }, "transit_number": { "type": "string", "description": "The 5-digit bank transit number. A transit that is not a known branch of the given institution raises a `bank_account_unrecognized_transit` warning rather than failing the request." }, "institution_number": { "type": "string", "description": "The 3-digit bank institution number. An institution Nmbr does not hold raises a `bank_account_unrecognized_institution` warning rather than failing the request." }, "name": { "type": "string", "description": "An optional human-readable label for the bank account, such as \"Main chequing\". Useful for distinguishing accounts at the same institution.", "nullable": true, "maxLength": 255 }, "is_primary": { "type": "boolean", "description": "Whether this is the primary bank account for its owner.\n\nIndicates that this bank account is the primary bank account. Optional. Cannot be set to false is there is no other bank account for the same employee, contractor or business entity." }, "pad_signer_name": { "type": "string", "description": "The name of the person who signed the PAD agreement. Only applicable to Business Entity bank accounts.", "nullable": true }, "pad_signer_email": { "type": "string", "description": "The email address of the PAD agreement signer. Only applicable to Business Entity bank accounts." }, "pad_signer_title": { "type": "string", "description": "The title or role of the PAD agreement signer. Only applicable to Business Entity bank accounts.", "nullable": true }, "pad_signed_at": { "type": "string", "description": "The date and time the PAD agreement was signed. Only applicable to Business Entity bank accounts.", "format": "date" }, "pad_file": { "type": "string" } } }, { "type": "object", "required": [ "account_number", "transit_number", "institution_number" ] } ] }, "example": { "business_entity_id": "", "account_number": "3654916", "transit_number": "02002", "institution_number": "320" } } } } } }, "/bank_accounts/lookup": { "post": { "summary": "Look up bank account details", "operationId": "bank-accounts-lookup", "tags": [ "Bank Accounts" ], "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 (`\"bank_account_lookup\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/BankAccountLookup" } } }, "example": { "object": "bank_account_lookup", "data": { "warnings": { "object": "list", "data": [] }, "institution_name": "Bank of Montreal", "institution_name_translations": { "en": "Bank of Montreal", "fr": "Banque de Montr\u00e9al" }, "institution_name_translated": "Bank of Montreal", "transit_address": "Montreal (Succ. Principale), 119 rue Saint-Jacques, Montreal, QC H2Y 1L6" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "institution_number": { "type": "string", "description": "The 3-digit institution number to look up. Optional." }, "transit_number": { "type": "string", "description": "The 5-digit transit number to look up. Optional. Resolves a branch address only when sent alongside a recognised institution number." }, "account_number": { "type": "string", "description": "The account number to validate. Optional. Checked against the check-digit rules published for the given institution." } } }, "example": { "institution_number": "001", "transit_number": "00011" } } } } } }, "/bank_accounts/pad": { "get": { "summary": "Show PAD", "operationId": "bank-accounts-pad", "tags": [ "Bank Accounts" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {}, "example": { "data": { "html": "\n\n\n \n \n \n \n \n
\n

\n PAD Agreement\n

\n

\n \n

\n

\n The Nmbr Company Ltd.\n

\n

\n \n

\n

\n 40 Temperance Street - Suite 3200\n

\n

\n Toronto, ON \n

\n

\n M5H 0B4\n

\n

\n Email: billing@nmbr.co\n

\n

\n Pre-authorized debit agreement\n

\n

\n \n

\n

\n By accepting this Agreement, you acknowledge that you authorize The Nmbr Company Ltd. (Nmbr) to debit the specified bank account for any amount owed for charges arising from the use of services and/or purchase of products.\n

\n

\n You acknowledge that this PAD Agreement is provided for the benefit of Nmbr and your financial institution, and in consideration of your financial institution agreeing to process debits against your account in accordance with Rule H1, and any other applicable rules of the Canadian Payments Association, as may be amended from time to time (“Rule H1”). The submission and acceptance of this PAD Agreement to Nmbr constitutes delivery by you of the same to your financial institution.\n

\n

\n You hereby authorize Nmbr to debit/draw on your account specified above with your financial institution for the purpose of funding any third-party payments, which may include, without limitation, payroll/compensation payments to your employees and payments to taxing authorities on your behalf, as well as the fees and other charges for such services rendered by Nmbr (each such debit hereinafter referred to as a “PAD”). You understand and agree that the PADs will be for variable amounts as required to meet your obligations for payroll, taxes, fees, and other charges as contemplated in the applicable services agreement(s). The PADs will occur at recurring set intervals triggered by your pre-determined payroll processing schedule (regular and off-cycle) and corresponding funding deadline established by Nmbr in accordance with your services agreement for such payroll obligations, or for variable amounts as and when required in response to any other direct actions initiated by you either electronically, in writing, or by telephone. The PADs authorized and issued hereunder are “Business PADs” as defined in Rule H1.\n

\n

\n You acknowledge and agree that the amounts debited may vary as instructed and approved by you, and as such, no pre-notification of PAD changes is required. \n

\n

\n \n

\n

\n You further agree to a reduced confirmation period, whereby you will be notified of the first upcoming debit up to 1 (one) day before the payment is collected, instead of the standard 10 days.\n

\n

\n You represent and warrant that as of the execution date of this PAD Agreement, all persons whose signatures are required to sign on the account identified above have read and accepted this PAD Agreement (or the names and specimen signatures of such persons have been provided to Nmbr in a separate document).\n

\n

\n You may amend or cancel this authorization at any time by providing no less than thirty (30) days notice, prior to the next scheduled PAD, at billing@nmbr.co. This will not affect any debit transactions initiated prior to Nmbr acknowledging the amendment or cancellation. To obtain a sample cancellation form, or further information on cancelling a PAD agreement, please contact your financial institution or visit www.payments.ca.\n

\n

\n This PAD Agreement applies only to the method of payment and does not otherwise affect the Agreement or any other applicable terms governing the Services to which this PAD Agreement relates. Revocation of the authorization granted hereunder does not in and of itself terminate any such Agreement(s) between you and Nmbr, however, you acknowledge that the performance of the Services requires that either a valid PAD Agreement be in place or another mutually acceptable method of payment be established between you and Nmbr.\n

\n

\n You acknowledge that your financial institution is not required to verify that: (a) a PAD has been issued in accordance with this PAD Agreement including, but not limited to, the amount; or (b) any purpose of payment for which the PAD was issued has been fulfilled by Nmbr as a condition to honoring a PAD issued or caused to be issued by Nmbr on your account.\n

\n

\n You have certain recourse rights if any debit does not comply with this agreement. For example, you have the right to receive reimbursement for any debit that is not authorized or is not consistent with this PAD Agreement. To obtain more information on your recourse rights, you can contact your financial institution or visit\n \n  \n \n \n www.payments.ca\n \n .\n

\n

\n A PAD may be disputed by you if: (i) the PAD was not drawn in accordance with this PAD Agreement; or (ii) this PAD Agreement is revoked or terminated in accordance with the terms hereof (effective prior to such PAD being issued). To be reimbursed, you must complete and present a declaration to the branch of your financial institution in which your account is held no later than the close of business on the tenth (10th) business day after the date on which the PAD in dispute was debited from your account.\n

\n

\n You acknowledge that, after such date, a claim on the basis that the PAD Agreement was revoked or terminated, or for any other reason, is a matter to be resolved solely between Nmbr and you.\n

\n

\n You consent to the disclosure of any personal information contained herein to Nmbr’s sponsoring member (as defined in Rule H1) as far as any such disclosure of personal information is directly related to and necessary for the proper application of Rule H1.\n

\n

\n Any inquiries or notices relative to the PAD Agreement and the debits issued hereunder shall be directed to Nmbr at the address provided above.\n

\n

\n Nmbr may assign this PAD Agreement without your consent provided that Nmbr has provided you with written notice of the details of such assignment including the identity and contact information of the assignee.\n

\n

\n You hereby certify that all information supplied by you herein is true, complete, and accurate in every respect. You have caused an authorized signing officer of the Client to execute this PAD Agreement as of the date specified above.\n

\n

\n \n

\n
\n \n" } } } } } } } }, "/business_entities": { "get": { "summary": "List business entities", "description": "If the `tax_properties` are expanded, only Tax Properties active on the current date will be returned.", "operationId": "business-entities-index", "tags": [ "Business Entities" ], "parameters": [ { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "accounting_settings.default_bank_accounting_code", "accounting_settings.default_payroll_payable_accounting_code", "accounting_settings.primary_tag_group", "bank_accounts", "business_presets", "company", "default_bank_accounting_code", "default_payroll_payable_accounting_code", "effective_tax_properties", "pay_schedules", "payrolls", "primary_tag_group", "tax_properties" ] } }, "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 (`\"business_entity\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BusinessEntity" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With company expanded", "properties": { "company": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Company" } } } } }, { "type": "object", "title": "With pay_schedules expanded", "properties": { "pay_schedules": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/PaySchedule" } } } } } } } }, { "type": "object", "title": "With payrolls expanded", "properties": { "payrolls": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/Payroll" } } } } } } } }, { "type": "object", "title": "With bank_accounts expanded", "properties": { "bank_accounts": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/BankAccount" } } } } } } } }, { "type": "object", "title": "With business_presets expanded", "properties": { "business_presets": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/BusinessPreset" } } } } } } } }, { "type": "object", "title": "With tax_properties expanded", "properties": { "tax_properties": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/TaxProperty" } } } } } } } }, { "type": "object", "title": "With effective_tax_properties expanded", "properties": { "effective_tax_properties": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/EffectiveTaxProperty" } } } } } } } }, { "type": "object", "title": "With default_bank_accounting_code expanded", "properties": { "default_bank_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DefaultBankAccountingCode" } } } } }, { "type": "object", "title": "With default_payroll_payable_accounting_code expanded", "properties": { "default_payroll_payable_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DefaultPayrollPayableAccountingCode" } } } } }, { "type": "object", "title": "With primary_tag_group expanded", "properties": { "primary_tag_group": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PrimaryTagGroup" } } } } }, { "type": "object", "title": "With accounting_settings.default_bank_accounting_code expanded", "properties": { "accounting_settings": { "type": "object", "properties": { "default_bank_accounting_code": { "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/DefaultBankAccountingCode" } } } } } } }, { "type": "object", "title": "With accounting_settings.default_payroll_payable_accounting_code expanded", "properties": { "accounting_settings": { "type": "object", "properties": { "default_payroll_payable_accounting_code": { "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/DefaultPayrollPayableAccountingCode" } } } } } } }, { "type": "object", "title": "With accounting_settings.primary_tag_group expanded", "properties": { "accounting_settings": { "type": "object", "properties": { "primary_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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/PrimaryTagGroup" } } } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "business_entity", "data": { "business_number": "136549169RP9916", "name": "Bobs Burgers (#39616)", "legal_name": null, "legal_registration_number": null, "address_line_1": "13 Fake Street", "address_line_2": null, "city": "Toronto", "in_preview": false, "administrative_area": "ON", "province_code": "ON", "country_code": "CA", "postal_code": "M1M1M1", "contact_name": "Jean Smith", "contact_email": "smith@company.com", "contact_area_code": "111", "contact_phone_number": "2223333", "contact_extension": null, "pay_day_movement_setting": "inherit", "vacation_pay_formula_setting": "pay_date", "remitter_type": "regular", "status": "approved", "company": { "id": "", "object": "company", "links": { "self": "/companies/" } }, "warnings": { "object": "list", "data": [ { "object": "warning", "data": { "namespace": "onboarding", "type": "business_legal_information_not_provided" } }, { "object": "warning", "data": { "namespace": "onboarding", "type": "bank_account_doesnt_exists" } }, { "object": "warning", "data": { "namespace": "onboarding", "type": "bank_account_pad_not_signed" } } ] }, "external_ref": null, "available_tax_properties": [ "ca::tax_id", "ca::qc::tax_id", "ca::province_of_employment", "ca::federal_oc_surtax_exempt", "ca::on::eht", "ca::mb::eht", "ca::nl::eht", "ca::bc::eht", "ca::qc::eht" ], "effective_processing_speed": "three_day", "processing_speed": "inherit", "has_bank_accounts": false, "has_pay_schedules": false, "has_payrolls": false, "current_tax_jurisdiction": "ca_on", "ca_settings": { "roe_submission_setting": "manual" }, "accounting_settings": { "default_bank_accounting_code": null, "default_payroll_payable_accounting_code": null, "resolve_journal_entry_stat_withholdings": true, "primary_tag_group": null, "journal_entry_dimensions": [ { "id": "", "object": "tag_group", "links": { "self": "/tag_groups/" } }, { "id": "", "object": "tag_group", "links": { "self": "/tag_groups/" } } ], "block_approval_on_incomplete_journal_entries": false, "block_approval_on_missing_export_identifiers": false }, "default_bank_accounting_code": null, "default_payroll_payable_accounting_code": null, "preferred_locale": { "id": "", "object": "locale", "data": { "label": "English" } }, "hold_funding_for_verification": false, "resolve_journal_entry_stat_withholdings": true, "primary_tag_group": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/business_entities/" } } ], "links": { "first": "/business_entities?page=1", "last": "/business_entities?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create a business entity", "operationId": "business-entities-store", "tags": [ "Business Entities" ], "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 (`\"business_entity\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/BusinessEntity" } } }, "example": { "id": "", "object": "business_entity", "data": { "business_number": "136549169RP9916", "name": "Bobs Burgers (#39616)", "legal_name": null, "legal_registration_number": null, "address_line_1": "13 Fake Street", "address_line_2": null, "city": "Toronto", "in_preview": false, "administrative_area": "ON", "province_code": "ON", "country_code": "CA", "postal_code": "M1M1M1", "contact_name": "Jean Smith", "contact_email": "smith@company.com", "contact_area_code": "111", "contact_phone_number": "2223333", "contact_extension": null, "pay_day_movement_setting": "inherit", "vacation_pay_formula_setting": "pay_date", "remitter_type": "regular", "status": "onboarding", "company": { "id": "", "object": "company", "links": { "self": "/companies/" } }, "warnings": { "object": "list", "data": [ { "object": "warning", "data": { "namespace": "onboarding", "type": "business_legal_information_not_provided" } }, { "object": "warning", "data": { "namespace": "onboarding", "type": "bank_account_doesnt_exists" } }, { "object": "warning", "data": { "namespace": "onboarding", "type": "bank_account_pad_not_signed" } } ] }, "external_ref": "", "available_tax_properties": [ "ca::tax_id", "ca::qc::tax_id", "ca::province_of_employment", "ca::federal_oc_surtax_exempt", "ca::on::eht", "ca::mb::eht", "ca::nl::eht", "ca::bc::eht", "ca::qc::eht" ], "effective_processing_speed": "three_day", "processing_speed": "inherit", "has_bank_accounts": false, "has_pay_schedules": false, "has_payrolls": false, "current_tax_jurisdiction": "ca_on", "ca_settings": { "roe_submission_setting": "manual" }, "accounting_settings": { "default_bank_accounting_code": null, "default_payroll_payable_accounting_code": null, "resolve_journal_entry_stat_withholdings": true, "primary_tag_group": null, "journal_entry_dimensions": [], "block_approval_on_incomplete_journal_entries": false, "block_approval_on_missing_export_identifiers": false }, "default_bank_accounting_code": null, "default_payroll_payable_accounting_code": null, "preferred_locale": { "id": "", "object": "locale", "data": { "label": "English" } }, "hold_funding_for_verification": false, "resolve_journal_entry_stat_withholdings": true, "primary_tag_group": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/business_entities/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "business_number": { "type": "string", "description": "The Canada Revenue Agency (CRA) Business Number (BN) for this business entity, used to identify the business for payroll tax remittances. 15 characters (BN15): a 9-digit Business Number root, the 2-letter `RP` payroll program identifier, and a 4-digit reference number starting at 0001. The root begins with 1, 7, or 8 and carries a Luhn check digit." }, "name": { "type": "string", "description": "The business entity's operating or trade name.", "maxLength": 255 }, "legal_name": { "type": "string", "description": "The business entity's registered legal name.", "maxLength": 255 }, "legal_registration_number": { "type": "string", "description": "The provincial business registration number.", "maxLength": 255 }, "address_line_1": { "type": "string", "description": "The first line of the business entity's mailing address. Canada Revenue Agency forms (T4, RL-1) truncate this to the length those forms allow.", "nullable": true }, "address_line_2": { "type": "string", "description": "The second line of the business entity's mailing address. Canada Revenue Agency forms (T4, RL-1) truncate this to the length those forms allow.", "nullable": true }, "city": { "type": "string", "description": "The city of the business entity's mailing address.", "nullable": true }, "administrative_area": { "type": "string", "description": "The region of the business entity's mailing address \u2014 the province, state, or county, depending on the country. For Canadian business entities this is the province.\n\nFor a Canadian business entity, provide the province (e.g. ON).", "nullable": true, "maxLength": 255 }, "province_code": { "type": "string", "description": "This attribute is deprecated and will be removed.\n\nA deprecated alias of `administrative_area` that mirrors its value. Use `administrative_area` instead.\n\nIn Canada, must be an uppercase 2-letter province code: `AB`, `BC`, `MB`, `NB`, `NL`, `NS`, `NT`, `NU`, `ON`, `PE`, `QC`, `SK`, `YT`", "nullable": true, "deprecated": true }, "country_code": { "type": "string", "description": "The country code for the business entity's mailing address.\n\nMust be an uppercase 2-letter country code (ISO 3166-1 alpha-2, e.g., `CA`)." }, "postal_code": { "type": "string", "description": "The postal code for the business entity's mailing address.", "nullable": true, "maxLength": 10 }, "contact_name": { "type": "string", "description": "The name of the primary contact at the business entity.", "maxLength": 255 }, "contact_email": { "type": "string", "description": "The email address of the primary contact at the business entity." }, "contact_area_code": { "type": "string", "description": "The area code for the primary contact's phone number.", "nullable": true }, "contact_phone_number": { "type": "string", "description": "The primary contact's phone number, excluding area code.", "nullable": true }, "contact_extension": { "type": "string", "description": "The extension for the primary contact's phone number.", "maxLength": 5 }, "pay_day_movement_setting": { "type": "string", "description": "The business entity-level setting for how pay dates are adjusted when they fall on a weekend or bank holiday. If set to `inherit`, the Company's setting is used.", "enum": [ "inherit", "next_business_day", "previous_business_day" ] }, "vacation_pay_formula_setting": { "type": "string", "description": "The formula used to calculate vacation pay for Employees in this business entity.", "enum": [ "pay_date", "period_end", "period_start" ] }, "remitter_type": { "type": "string", "description": "The Canada Revenue Agency (CRA) remitter type, which determines the frequency of payroll tax remittances to the CRA.", "enum": [ "accelerated_threshold_1", "accelerated_threshold_2", "quarterly", "regular" ] }, "in_preview": { "type": "boolean", "description": "When `true`, the business entity is in preview mode. In preview mode, Payrolls can be run and approved but no real money movement occurs." }, "external_ref": { "type": "string", "maxLength": 255 }, "preferred_locale": { "type": "string", "description": "The locale used for payroll communications sent to Employees and Contractors within this business entity. If not set, the Company's locale is used.", "enum": [ "en", "fr" ] }, "hold_funding_for_verification": { "type": "boolean" }, "resolve_journal_entry_stat_withholdings": { "type": "boolean" }, "accounting_settings": { "type": "object", "properties": { "resolve_journal_entry_stat_withholdings": { "type": "boolean" }, "block_approval_on_incomplete_journal_entries": { "type": "boolean" }, "block_approval_on_missing_export_identifiers": { "type": "boolean" } } }, "tax_properties": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ca::ab::claim_amount", "ca::ab::total_income_less_than_total_claim_amount", "ca::ab::workers_compensation_class", "ca::bc::claim_amount", "ca::bc::eht", "ca::bc::total_income_less_than_total_claim_amount", "ca::bc::workers_compensation_class", "ca::cpp_exempt", "ca::ei_exempt", "ca::ei_premium_reduction", "ca::federal::additional_tax", "ca::federal::annual_deduction_at_source", "ca::federal::claim_amount", "ca::federal::commission_expenses", "ca::federal::commission_total_income", "ca::federal::income_tax_rate", "ca::federal::total_income_less_than_total_claim_amount", "ca::federal_oc_surtax_exempt", "ca::first_nation_exemptions", "ca::mb::claim_amount", "ca::mb::eht", "ca::mb::total_income_less_than_total_claim_amount", "ca::mb::workers_compensation_class", "ca::nb::claim_amount", "ca::nb::total_income_less_than_total_claim_amount", "ca::nb::workers_compensation_class", "ca::nl::claim_amount", "ca::nl::eht", "ca::nl::total_income_less_than_total_claim_amount", "ca::nl::workers_compensation_class", "ca::ns::claim_amount", "ca::ns::total_income_less_than_total_claim_amount", "ca::ns::workers_compensation_class", "ca::nt::claim_amount", "ca::nt::territorial_payroll_tax", "ca::nt::total_income_less_than_total_claim_amount", "ca::nt::workers_compensation_class", "ca::nu::claim_amount", "ca::nu::territorial_payroll_tax", "ca::nu::total_income_less_than_total_claim_amount", "ca::nu::workers_compensation_class", "ca::on::claim_amount", "ca::on::dependent_children_credit", "ca::on::eht", "ca::on::impaired_dependants_credit", "ca::on::total_income_less_than_total_claim_amount", "ca::on::workers_compensation_class", "ca::pe::claim_amount", "ca::pe::total_income_less_than_total_claim_amount", "ca::pe::workers_compensation_class", "ca::province_of_employment", "ca::province_of_work", "ca::provincial::income_tax_rate", "ca::qc::additional_tax", "ca::qc::claim_amount", "ca::qc::commission_percentage_taxed", "ca::qc::eht", "ca::qc::income_tax_rate", "ca::qc::qpip_exempt", "ca::qc::qpp_exempt", "ca::qc::tax_id", "ca::qc::total_income_less_than_total_claim_amount", "ca::qc::workers_compensation_class", "ca::sk::claim_amount", "ca::sk::total_income_less_than_total_claim_amount", "ca::sk::workers_compensation_class", "ca::statutory_holiday_pay", "ca::tax_id", "ca::yt::claim_amount", "ca::yt::total_income_less_than_total_claim_amount", "ca::yt::workers_compensation_class" ] }, "value": { "type": "string" }, "effective_from": { "type": "string", "format": "date" }, "effective_to": { "type": "string", "format": "date" }, "note": { "type": "string", "nullable": true }, "owner_id": { "type": "string" } } } } } }, { "type": "object", "required": [ "name" ] } ] }, "example": { "business_number": "136549169RP9916", "name": "Bobs Burgers (#39616)", "address_line_1": "13 Fake Street", "city": "Toronto", "administrative_area": "ON", "country_code": "CA", "postal_code": "M1M1M1", "contact_name": "Jean Smith", "contact_email": "smith@company.com", "contact_area_code": "111", "contact_phone_number": "2223333", "pay_day_movement_setting": "inherit", "vacation_pay_formula_setting": "pay_date", "remitter_type": "regular", "external_ref": "", "preferred_locale": "en", "resolve_journal_entry_stat_withholdings": true, "tax_properties": [ { "type": "ca::province_of_employment", "value": "ca_on", "effective_from": "2026-01-01", "effective_to": null, "note": null } ] } } } } } }, "/business_entity_roe_authorizations": { "get": { "summary": "List business entity ROE authorizations", "operationId": "business-entity-roe-authorizations-index", "tags": [ "Business Entity ROE Authorizations" ], "parameters": [ { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": true } ], "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 (`\"roe_authorization\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/BusinessEntityRoeAuthorization" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "roe_authorization", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "status": "processing", "note": "Vitae error architecto sint velit tempora illo itaque.", "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/business_entity_roe_authorizations/" } } ], "links": { "first": "/business_entity_roe_authorizations?business_entity_id=&page=1", "last": "/business_entity_roe_authorizations?business_entity_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create a business entity ROE authorization", "operationId": "business-entity-roe-authorizations-store", "tags": [ "Business Entity ROE Authorizations" ], "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 (`\"roe_authorization\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/BusinessEntityRoeAuthorization" } } }, "example": { "id": "", "object": "roe_authorization", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "status": "processing", "note": "Vitae error architecto sint velit tempora illo itaque.", "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/business_entity_roe_authorizations/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "business_entity_id": { "type": "string" }, "note": { "type": "string", "nullable": true, "maxLength": 1000 }, "consent_form": { "type": "string", "maxLength": 10240 } } }, { "type": "object", "required": [ "business_entity_id", "consent_form" ] } ] }, "example": { "business_entity_id": "", "note": "Vitae error architecto sint velit tempora illo itaque." } } } } } }, "/business_presets": { "get": { "summary": "List business presets", "operationId": "business-presets-index", "tags": [ "Business Presets" ], "parameters": [ { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "type", "in": "query", "schema": { "type": "string", "enum": [ "allowance", "deduction", "earning", "employee_benefit", "employer_benefit", "employer_statutory_withholding", "reimbursement", "statutory_withholding" ] }, "required": false }, { "name": "subtype", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "name", "subtype", "subtype.label", "title", "type", "type.label" ] }, "required": false, "description": "Sort order is specified using the format \n`sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by\nand `direction` is the optional sort direction (`asc` or `desc`)." }, { "name": "include_managed", "in": "query", "schema": { "type": "boolean" }, "required": false }, { "name": "external_ref", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "allowances", "business_entity", "deductions", "earnings", "employee_benefits", "employer_benefits", "expense_accounting_code", "liability_accounting_code", "pay_rates", "reimbursements", "remittance_account" ] } }, "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 (`\"business_preset\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BusinessPreset" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With business_entity expanded", "properties": { "business_entity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessEntity" } } } } }, { "type": "object", "title": "With remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } }, { "type": "object", "title": "With earnings expanded", "properties": { "earnings": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/Earning" } } } } } } } }, { "type": "object", "title": "With allowances expanded", "properties": { "allowances": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/Allowance" } } } } } } } }, { "type": "object", "title": "With employee_benefits expanded", "properties": { "employee_benefits": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployeeBenefit" } } } } } } } }, { "type": "object", "title": "With employer_benefits expanded", "properties": { "employer_benefits": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerBenefit" } } } } } } } }, { "type": "object", "title": "With deductions expanded", "properties": { "deductions": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/Deduction" } } } } } } } }, { "type": "object", "title": "With reimbursements expanded", "properties": { "reimbursements": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/Reimbursement" } } } } } } } }, { "type": "object", "title": "With pay_rates expanded", "properties": { "pay_rates": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/PayRate" } } } } } } } }, { "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" } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "business_preset", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "name": "Business Preset 08a620c8-1d8a-3f0c-9475-963b2e8a0d49", "name_translations": null, "name_translated": "Business Preset 08a620c8-1d8a-3f0c-9475-963b2e8a0d49", "title": "Business Preset", "title_translations": null, "title_translated": "Business Preset", "type": "earning", "subtype": null, "remittance_account": null, "is_managed": false, "expense_accounting_code": null, "liability_accounting_code": null, "income_basis": null, "income_includes": [], "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/business_presets/" } } ], "links": { "first": "/business_presets?business_entity_id=&page=1", "last": "/business_presets?business_entity_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create a business preset", "operationId": "business-presets-store", "tags": [ "Business Presets" ], "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 (`\"business_preset\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/BusinessPreset" } } }, "example": { "id": "", "object": "business_preset", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "name": "Business Preset 08a620c8-1d8a-3f0c-9475-963b2e8a0d49", "name_translations": null, "name_translated": "Business Preset 08a620c8-1d8a-3f0c-9475-963b2e8a0d49", "title": "Christmas Bonus", "title_translations": null, "title_translated": "Christmas Bonus", "type": "earning", "subtype": "bonus_discretionary", "remittance_account": null, "is_managed": false, "expense_accounting_code": null, "liability_accounting_code": null, "income_basis": null, "income_includes": [], "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/business_presets/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "business_entity_id": { "type": "string" }, "type": { "type": "string", "enum": [ "allowance", "deduction", "earning", "employee_benefit", "employer_benefit", "reimbursement" ] }, "subtype": { "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_unpaid", "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", "tips_controlled", "vacation_accrual_adjustment", "vacation_pay", "vacation_pay_employee_terminated", "vacation_pay_no_time_taken", "vacation_pay_time_taken", "wage" ] }, "name": { "type": "string", "maxLength": 255 }, "name_translations": { "type": "object", "description": "Optional translations for the `name` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "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 }, "remittance_account_id": { "type": "string" }, "expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string" }, "income_basis": { "type": "string", "enum": [ "all_earnings", "none", "regular_earnings", "total_income" ] }, "income_includes": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "allowance", "earning", "employer_benefit", "reimbursement" ] }, "subtype": { "type": "string" } } } }, "external_ref": { "type": "string", "maxLength": 255 } } }, { "type": "object", "required": [ "business_entity_id", "type", "name" ] } ] }, "example": { "business_entity_id": "", "type": "earning", "subtype": "bonus_discretionary", "name": "Business Preset 08a620c8-1d8a-3f0c-9475-963b2e8a0d49", "title": "Christmas Bonus" } } } } } }, "/calculations/statutory_holiday_pay": { "post": { "summary": "Explain statutory holiday pay calculation", "description": "Explain how statutory holiday pay would be calculated for the pay stub's work assignment, optionally overriding which dates are treated as holidays and/or the statutory holiday pay configuration. With no overrides, behaves as a pure explanation of how statutory holiday pay was or will be calculated under the work assignment's current configuration.", "operationId": "calculations-statutory-holiday-pay", "tags": [ "Calculations" ], "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 (`\"statutory_holiday_pay_explanation\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/StatutoryHolidayPayExplanation" } } }, "example": { "object": "statutory_holiday_pay_explanation", "data": { "not_applicable_reason": null, "jurisdiction": "ca_on", "configuration": { "calculate_entitlement": true, "calculation_strategy": "provincial_rules_only", "override_rule_set": null, "override_date_basis": null, "hours": null, "pay_rate": null }, "default_rules": [ { "id": "", "name": "Regular earnings", "explanation": "The last 4 weeks of eligible earnings, ending the day before the holiday week begins, divided by 20.", "earning_date_basis": "before_holiday_week", "eligible_days_in_range": 28, "eligible_work_days_in_range": 20, "eligible_earning_types": [ { "id": "", "object": "earning_type", "data": { "type": "wage", "label": "Wage", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/wage" } }, { "id": "", "object": "earning_type", "data": { "type": "retroactive_pay", "label": "Retroactive Pay", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/retroactive_pay" } }, { "id": "", "object": "earning_type", "data": { "type": "retroactive_pay_increase", "label": "Retroactive Pay Increase", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/retroactive_pay_increase" } }, { "id": "", "object": "earning_type", "data": { "type": "commission", "label": "Commission (Non-Periodic)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/commission" } }, { "id": "", "object": "earning_type", "data": { "type": "commission_periodic", "label": "Commission (Periodic)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/commission_periodic" } }, { "id": "", "object": "earning_type", "data": { "type": "bonus_non_discretionary", "label": "Bonus (Non-Discretionary)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/bonus_non_discretionary" } }, { "id": "", "object": "earning_type", "data": { "type": "bonus_non_taxable", "label": "Bonus (Non-Taxable)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/bonus_non_taxable" } }, { "id": "", "object": "earning_type", "data": { "type": "statutory_holiday_pay", "label": "Statutory Holiday Pay", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/statutory_holiday_pay" } }, { "id": "", "object": "earning_type", "data": { "type": "leave_sick", "label": "Leave (sick)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/leave_sick" } }, { "id": "", "object": "earning_type", "data": { "type": "leave_general", "label": "Leave (general)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/leave_general" } }, { "id": "", "object": "earning_type", "data": { "type": "leave_personal", "label": "Leave (personal)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/leave_personal" } }, { "id": "", "object": "earning_type", "data": { "type": "leave_bereavement", "label": "Leave (bereavement)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/leave_bereavement" } }, { "id": "", "object": "earning_type", "data": { "type": "leave_domestic_and_sexual_violence", "label": "Leave (domestic and sexual violence)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/leave_domestic_and_sexual_violence" } }, { "id": "", "object": "earning_type", "data": { "type": "leave_paternity", "label": "Leave (paternity)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/leave_paternity" } }, { "id": "", "object": "earning_type", "data": { "type": "leave_voting", "label": "Leave (voting)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/leave_voting" } }, { "id": "", "object": "earning_type", "data": { "type": "leave_wedding", "label": "Leave (wedding)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/leave_wedding" } }, { "id": "", "object": "earning_type", "data": { "type": "leave_citizenship", "label": "Leave (citizenship)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/leave_citizenship" } }, { "id": "", "object": "earning_type", "data": { "type": "leave_jury_duty", "label": "Leave (jury duty)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/leave_jury_duty" } }, { "id": "", "object": "earning_type", "data": { "type": "leave_organ_donor", "label": "Leave (organ donor)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/leave_organ_donor" } }, { "id": "", "object": "earning_type", "data": { "type": "leave_parental", "label": "Leave (parental)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/leave_parental" } }, { "id": "", "object": "earning_type", "data": { "type": "leave_maternity", "label": "Leave (maternity)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/leave_maternity" } }, { "id": "", "object": "earning_type", "data": { "type": "vacation_pay", "label": "Vacation pay (per period)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/vacation_pay" } }, { "id": "", "object": "earning_type", "data": { "type": "vacation_pay_employee_terminated", "label": "Vacation pay (employee terminated)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/vacation_pay_employee_terminated" } }, { "id": "", "object": "earning_type", "data": { "type": "vacation_pay_time_taken", "label": "Vacation pay (time taken)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/vacation_pay_time_taken" } }, { "id": "", "object": "earning_type", "data": { "type": "vacation_pay_no_time_taken", "label": "Vacation pay (no time taken)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/vacation_pay_no_time_taken" } }, { "id": "", "object": "earning_type", "data": { "type": "time_off_in_lieu", "label": "Time off in lieu", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/time_off_in_lieu" } } ], "eligible_allowance_types": [], "eligible_reimbursement_types": [] } ], "overridden_rules": null, "holidays": [ { "holiday": { "id": "", "object": "holiday", "data": { "jurisdiction": "ca_on", "type": "statutory", "name": "Victoria Day", "name_translations": { "en": "Victoria Day", "fr": "F\u00eate de la Reine" }, "name_translated": "Victoria Day", "original_date": "2026-05-18", "observed_date": "2026-05-18", "created_at": "2026-01-26T20:16:33.000000Z", "updated_at": "2026-01-26T20:16:33.000000Z" }, "links": { "self": "/holidays/" } }, "line_item_id": null, "amount": 229.57, "hours": 7.35, "gross_amount": 229.57, "gross_hours": 7.35, "already_allocated": null, "entitlement": { "fixed_hours_calculation": null, "provincial_rules_calculation": [ { "id": "", "amount": 229.57, "hours": 7.35, "eligible_date_range": { "start": "2026-04-17", "end": "2026-05-14" }, "totals": { "dated_amount": 0, "dated_hours": 0, "undated_amount": 10000, "undated_hours": 320, "undated_amount_prorated": 4591.39785, "undated_hours_prorated": 146.9247312, "effective_amount": 4591.39785, "effective_hours": 146.9247312 }, "payroll_summaries": [ { "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "pay_period": { "start": "2026-05-01", "end": "2026-05-31" }, "dated_amount_total": 0, "dated_hours_total": 0, "undated_amount_total": 5000, "undated_hours_total": 160, "eligible_days_in_pay_period": 14, "days_in_pay_period": 31, "undated_coverage_ratio": 0.4516129, "undated_amount_prorated": 2258.0645, "undated_hours_prorated": 72.258064, "effective_amount": 2258.0645, "effective_hours": 72.258064, "earlier_holidays_amount": 0, "earlier_holidays_hours": 0, "dated_line_items": [], "undated_line_items": [ { "id": "", "object": "earning_line_item", "title": "Hourly wage", "amount": 5000, "hours": 160 } ] }, { "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "pay_period": { "start": "2026-04-01", "end": "2026-04-30" }, "dated_amount_total": 0, "dated_hours_total": 0, "undated_amount_total": 5000, "undated_hours_total": 160, "eligible_days_in_pay_period": 14, "days_in_pay_period": 30, "undated_coverage_ratio": 0.46666667, "undated_amount_prorated": 2333.33335, "undated_hours_prorated": 74.6666672, "effective_amount": 2333.33335, "effective_hours": 74.6666672, "earlier_holidays_amount": 0, "earlier_holidays_hours": 0, "dated_line_items": [], "undated_line_items": [ { "id": "", "object": "earning_line_item", "title": "Hourly wage", "amount": 5000, "hours": 160 } ] } ] } ], "chosen_method": "provincial_rules" } } ] } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "pay_stub_id": { "type": "string", "description": "The pay stub to explain statutory holiday pay for." }, "holiday_dates": { "type": "array", "description": "Optional array of `Y-m-d` dates within the pay stub's pay period to treat as statutory holidays. When omitted, the statutory holidays for the work assignment's Province of Work (POW) are used.", "items": { "type": "string", "format": "date" } }, "configuration": { "type": "object", "description": "Optional override of the work assignment's statutory holiday pay configuration. When omitted, the work assignment's `ca_statutory_holiday_pay` tax property in effect at the start of the pay period is used.", "properties": { "calculate_entitlement": { "type": "boolean" }, "calculation_strategy": { "type": "string", "enum": [ "hours_only", "provincial_rules_only", "provincial_rules_or_hours" ] }, "override_rule_set": { "type": "string", "enum": [ "AB", "BC", "FEDERAL", "MB", "NB", "NL", "NS", "NT", "NU", "OC", "ON", "PE", "QC", "SK", "YT" ] }, "override_date_basis": { "type": "string", "enum": [ "before_holiday_day", "before_holiday_pay_period", "before_holiday_week" ] }, "hours": { "type": "number", "format": "decimal", "minimum": 0 }, "pay_rate": { "type": "string", "enum": [ "earliest_effective_from", "highest_expected_hours_per_week", "highest_expected_weekly_amount", "highest_rate", "latest_effective_from" ] } } } } }, { "type": "object", "required": [ "pay_stub_id" ] } ] }, "example": { "pay_stub_id": "", "configuration": { "calculate_entitlement": true, "calculation_strategy": "provincial_rules_only" } } } } } } }, "/companies": { "post": { "summary": "Create a company", "operationId": "companies-store", "tags": [ "Companies" ], "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 (`\"company\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Company" } } }, "example": { "id": "", "object": "company", "data": { "name": "Cutting-Edge Telecom Solutions", "pay_day_movement_setting": "inherit", "external_ref": null, "preferred_locale": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z", "token": { "access_token": "", "expires_in": 60, "expires_at": "2026-01-01T01:00:00.000000Z" } }, "links": { "self": "/companies/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "The company's name." }, "pay_day_movement_setting": { "type": "string", "description": "The company-level setting for how pay dates are adjusted when they fall on a weekend or bank holiday. Inherited by Business Entities and Pay Schedules whose own setting is `inherit`.", "enum": [ "inherit", "next_business_day", "previous_business_day" ] }, "external_ref": { "type": "string", "maxLength": 255 }, "preferred_locale": { "type": "string", "description": "The locale used for payroll communications sent to Employees and Contractors within this company. If not set, the Partner's locale is used.", "enum": [ "en", "fr" ] } } }, { "type": "object", "required": [ "name" ] } ] }, "example": { "name": "Cutting-Edge Telecom Solutions", "pay_day_movement_setting": "inherit" } } } } } }, "/contractors/batch/delete": { "post": { "summary": "Batch delete contractors", "operationId": "contractors-batch-delete", "tags": [ "Contractors" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "", "" ] } } } } }, "/contractors/batch/upsert": { "post": { "summary": "Batch upsert contractors", "operationId": "contractors-batch-upsert", "tags": [ "Contractors" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "minItems": 1, "maxItems": 100 }, "example": [ { "id": "", "first_name": "Dan", "last_name": "Smith" }, { "first_name": "Jane", "last_name": "Doe", "email": "jane.doe@example.com" } ] } } } } }, "/contractors": { "get": { "summary": "List contractors", "operationId": "contractors-index", "tags": [ "Contractors" ], "parameters": [ { "name": "include_archived", "in": "query", "schema": { "type": "boolean" }, "required": false }, { "name": "archived_at", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `archived_at=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `archived_at[gte]=2024-01-01&archived_at[lt]=2024-12-31`" }, { "name": "external_ref", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "search_names", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "business_name", "first_name", "last_name" ] }, "required": false, "description": "Sort order is specified using the format \n`sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by\nand `direction` is the optional sort direction (`asc` or `desc`)." }, { "name": "has_work_assignment_business_entity_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "has_work_assignment_pay_schedule_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "include_archived_work_assignments", "in": "query", "schema": { "type": "boolean" }, "required": false }, { "name": "has_work_assignment_tag_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "has_work_assignment_tag_group_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "requires_work_assignment_tag_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "requires_work_assignment_tag_group_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "company", "work_assignments" ] } }, "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 (`\"contractor\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Contractor" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With company expanded", "properties": { "company": { "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/Company" } } } } }, { "type": "object", "title": "With work_assignments expanded", "properties": { "work_assignments": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/WorkAssignment" } } } } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "contractor", "data": { "business_name": "Contractor Co", "first_name": "John", "last_name": "Smith", "middle_initial": null, "email": "john@smith.com", "business_number": null, "sin_last_3": null, "external_ref": null, "preferred_locale": null, "archived_at": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/contractors/" } } ], "links": { "first": "/contractors?page=1", "last": "/contractors?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create a contractor", "operationId": "contractors-store", "tags": [ "Contractors" ], "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 (`\"contractor\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Contractor" } } }, "example": { "id": "", "object": "contractor", "data": { "business_name": "Contractor Co", "first_name": "John", "last_name": "Smith", "middle_initial": null, "email": "john@smith.com", "business_number": null, "sin_last_3": null, "external_ref": "", "preferred_locale": null, "archived_at": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/contractors/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_name": { "type": "string", "description": "The contractor's business or corporation name. `null` for individual contractors.", "nullable": true, "maxLength": 255 }, "first_name": { "type": "string", "description": "The contractor's first name. `null` for corporation contractors.", "nullable": true, "maxLength": 50 }, "last_name": { "type": "string", "description": "The contractor's last name. `null` for corporation contractors.", "nullable": true, "maxLength": 50 }, "middle_initial": { "type": "string", "description": "The contractor's middle initial. `null` for corporation contractors.", "nullable": true, "maxLength": 1 }, "email": { "type": "string", "description": "The contractor's email address, used for payroll communications." }, "business_number": { "type": "string", "description": "The contractor's 15-character (BN15) Canada Revenue Agency (CRA) program account number, consisting of a 9-digit Business Number (BN), a 2-letter program identifier, and a 4-digit reference number. `null` for individual contractors. The 9-digit root begins with 1, 7, or 8 and carries a Luhn check digit; the reference number starts at 0001." }, "sin": { "type": "string", "description": "The contractor's Social Insurance Number (SIN). `null` for corporation contractors. 9 digits, sent as a string. Spaces and dashes are stripped before validation. The first digit cannot be 0 or 8, and the number must pass the Luhn checksum." }, "external_ref": { "type": "string", "maxLength": 255 }, "preferred_locale": { "type": "string", "description": "The locale used for payroll communications sent to this contractor, such as Pay Stub emails. If not set, the Company's locale is used.", "enum": [ "en", "fr" ] }, "archived_at": { "type": "string", "description": "The date the contractor was archived. Archiving a contractor also archives all Work Assignments that are not already archived. Archived contractors do not appear in active listings.", "format": "date" } } }, "example": { "business_name": "Contractor Co", "first_name": "John", "last_name": "Smith", "email": "john@smith.com", "external_ref": "" } } } } } }, "/deductions/batch/delete": { "post": { "summary": "Batch delete deductions", "operationId": "deductions-batch-delete", "tags": [ "Deductions" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "", "" ] } } } } }, "/deductions/batch/upsert": { "post": { "summary": "Batch upsert deductions", "operationId": "deductions-batch-upsert", "tags": [ "Deductions" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "minItems": 1, "maxItems": 100 }, "example": [ { "id": "", "amount": 75, "effective_from": "2026-01-01" }, { "work_assignment_id": "", "deduction_type": "garnishment_order", "amount": 150, "amount_type": "fixed", "frequency": "per_payroll", "effective_from": "2026-01-01" } ] } } } } }, "/deductions/bulk/create": { "post": { "summary": "Bulk create deductions", "operationId": "deductions-bulk-create", "tags": [ "Deductions" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } } } }, "/deductions/bulk/create/scope": { "post": { "summary": "Show bulk create scope for deductions", "operationId": "deductions-bulk-create-scope", "tags": [ "Deductions" ], "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/Deduction" } } } } } }, "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/deductions/bulk/create/scope?page=1", "last": "http://localhost/deductions/bulk/create/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } } } }, "/deductions/bulk/delete": { "post": { "summary": "Bulk delete deductions", "operationId": "deductions-bulk-delete", "tags": [ "Deductions" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this deduction is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this deduction is no longer applied. `null` if the deduction applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/deductions/bulk/delete/scope": { "post": { "summary": "Show bulk delete scope for deductions", "operationId": "deductions-bulk-delete-scope", "tags": [ "Deductions" ], "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 (`\"deduction\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Deduction" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "deduction", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "frequency": "per_month", "date_basis": "by_period_start_date", "pay_period_cadence": [ 1 ], "deduction_type": { "id": "", "object": "deduction_type", "data": { "type": "income_tax", "label": "Income tax debt", "locale": "en" }, "links": { "self": "/deduction_types/income_tax" } }, "amount": 35, "amount_type": "fixed", "income_basis": "all_earnings", "income_includes": [], "income_subtractions": [], "income_statutory_withholdings": "none", "income_exemption_amount": null, "income_exemption_percent": null, "effective_from": "2026-01-01", "effective_to": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account": 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": "/deductions/" } } ], "links": { "first": "http://localhost/deductions/bulk/delete/scope?page=1", "last": "http://localhost/deductions/bulk/delete/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this deduction is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this deduction is no longer applied. `null` if the deduction applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/deductions/bulk/update": { "post": { "summary": "Bulk update deductions", "operationId": "deductions-bulk-update", "tags": [ "Deductions" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this deduction is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this deduction is no longer applied. `null` if the deduction applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/deductions/bulk/update/scope": { "post": { "summary": "Show bulk update scope for deductions", "operationId": "deductions-bulk-update-scope", "tags": [ "Deductions" ], "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 (`\"deduction\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Deduction" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "deduction", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "frequency": "per_month", "date_basis": "by_period_start_date", "pay_period_cadence": [ 1 ], "deduction_type": { "id": "", "object": "deduction_type", "data": { "type": "income_tax", "label": "Income tax debt", "locale": "en" }, "links": { "self": "/deduction_types/income_tax" } }, "amount": 35, "amount_type": "fixed", "income_basis": "all_earnings", "income_includes": [], "income_subtractions": [], "income_statutory_withholdings": "none", "income_exemption_amount": null, "income_exemption_percent": null, "effective_from": "2026-01-01", "effective_to": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account": 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": "/deductions/" } } ], "links": { "first": "http://localhost/deductions/bulk/update/scope?page=1", "last": "http://localhost/deductions/bulk/update/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this deduction is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this deduction is no longer applied. `null` if the deduction applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/deductions": { "get": { "summary": "List deductions", "operationId": "deductions-index", "tags": [ "Deductions" ], "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": [ "charitable_donation", "garnishment_order", "income_tax", "other_deduction", "union_dues", "union_dues_post_tax" ] }, { "type": "array", "items": { "type": "string", "enum": [ "charitable_donation", "garnishment_order", "income_tax", "other_deduction", "union_dues", "union_dues_post_tax" ] } } ] }, "required": false }, { "name": "exclude_types", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "charitable_donation", "garnishment_order", "income_tax", "other_deduction", "union_dues", "union_dues_post_tax" ] }, { "type": "array", "items": { "type": "string", "enum": [ "charitable_donation", "garnishment_order", "income_tax", "other_deduction", "union_dues", "union_dues_post_tax" ] } } ] }, "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:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `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:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `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 \n`sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by\nand `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": "requires_tag_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "requires_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", "remittance_account", "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 (`\"deduction\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Deduction" } ], "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 remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } }, { "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": "deduction", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "frequency": "per_month", "date_basis": "by_period_start_date", "pay_period_cadence": [ 1 ], "deduction_type": { "id": "", "object": "deduction_type", "data": { "type": "income_tax", "label": "Income tax debt", "locale": "en" }, "links": { "self": "/deduction_types/income_tax" } }, "amount": 35, "amount_type": "fixed", "income_basis": "all_earnings", "income_includes": [], "income_subtractions": [], "income_statutory_withholdings": "none", "income_exemption_amount": null, "income_exemption_percent": null, "effective_from": "2026-01-01", "effective_to": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account": 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": "/deductions/" } } ], "links": { "first": "/deductions?work_assignment_id=&page=1", "last": "/deductions?work_assignment_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create a deduction", "operationId": "deductions-store", "tags": [ "Deductions" ], "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 (`\"deduction\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Deduction" } } }, "example": { "id": "", "object": "deduction", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "frequency": "per_month", "date_basis": "by_period_start_date", "pay_period_cadence": [ 1 ], "deduction_type": { "id": "", "object": "deduction_type", "data": { "type": "income_tax", "label": "Income tax debt", "locale": "en" }, "links": { "self": "/deduction_types/income_tax" } }, "amount": 35, "amount_type": "fixed", "income_basis": "all_earnings", "income_includes": [], "income_subtractions": [], "income_statutory_withholdings": "none", "income_exemption_amount": null, "income_exemption_percent": null, "effective_from": "2026-01-01", "effective_to": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account": 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": "/deductions/" } } } } } }, "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" }, "deduction_type": { "type": "string", "description": "The type of deduction, which determines how it is categorized and remitted.\n\nMust be present when `business_preset_id` is either empty or not set.", "enum": [ "charitable_donation", "garnishment_order", "income_tax", "other_deduction", "union_dues", "union_dues_post_tax" ] }, "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 deduction is applied to Pay Stubs. When `per_month`, the amount is distributed across selected Payrolls in the calendar month. `per_month` is only valid when `amount_type` is `fixed`; percent and per-hour deductions apply to every paycheque regardless of frequency.", "enum": [ "once", "per_month", "per_payroll" ] }, "amount": { "type": "number", "description": "The deduction amount per occurrence. When `amount_type` is `percent`, this is interpreted as a percentage of the income basis. When `fixed_per_hour`, it is multiplied by the hours on the Pay Stub's earning line items. Otherwise it is a fixed dollar amount.", "format": "decimal", "minimum": 0 }, "amount_type": { "type": "string", "description": "Whether `amount` is a fixed dollar value (`fixed`), a dollar value per hour worked (`fixed_per_hour`), or a percentage of the income basis (`percent`).", "enum": [ "fixed", "fixed_per_hour", "percent" ] }, "income_basis": { "type": "string", "description": "Determines the income used as the base for percentage-based deductions. `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": "array", "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`.", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "allowance", "earning", "employer_benefit", "reimbursement" ] }, "subtype": { "type": "string" } } } }, "income_subtractions": { "type": "array", "description": "An optional list of deductions and employee benefits to subtract from the income before the deduction amount is calculated.", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "deduction", "employee_benefit" ] }, "subtype": { "type": "string" } } } }, "income_statutory_withholdings": { "type": "string", "description": "Whether to subtract statutory withholdings (CPP, EI, income tax) from the income before the deduction amount is calculated.", "enum": [ "all", "none" ] }, "income_exemption_amount": { "type": "number", "description": "A fixed dollar amount to exempt from the income before calculating the deduction.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "income_exemption_percent": { "type": "number", "description": "A percentage of the income to exempt before calculating the deduction amount.", "format": "decimal", "minimum": 0, "maximum": 100 }, "effective_from": { "type": "string", "description": "The date from which this deduction is applied to Pay Stubs.", "format": "date" }, "effective_to": { "type": "string", "description": "The date after which this deduction is no longer applied. `null` if the deduction applies indefinitely.", "format": "date" }, "remittance_account_id": { "type": "string", "description": "The remittance account to which collected deduction amounts are remitted." }, "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 fixed-amount `per_month` deductions.", "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 fixed-amount `per_month` deductions.", "items": { "type": "integer" }, "minItems": 1 } } }, { "type": "object", "required": [ "work_assignment_id", "frequency", "amount", "amount_type", "effective_from" ] } ] }, "example": { "work_assignment_id": "", "deduction_type": "income_tax", "frequency": "per_month", "amount": "35", "amount_type": "fixed", "income_basis": "all_earnings", "income_statutory_withholdings": "none", "effective_from": "2026-01-01", "tag_assignment": { "unit": "percentage", "tag_allocations": [ { "tags": [ "" ], "value": 100 } ] } } } } } } }, "/deductions/search": { "post": { "summary": "Search deductions", "description": "Search deductions under the given business entity, returning the same set the equivalent bulk update/delete operation would target with this body.", "operationId": "deductions-search", "tags": [ "Deductions" ], "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 (`\"deduction\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Deduction" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "deduction", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "frequency": "per_month", "date_basis": "by_period_start_date", "pay_period_cadence": [ 1 ], "deduction_type": { "id": "", "object": "deduction_type", "data": { "type": "income_tax", "label": "Income tax debt", "locale": "en" }, "links": { "self": "/deduction_types/income_tax" } }, "amount": 35, "amount_type": "fixed", "income_basis": "all_earnings", "income_includes": [], "income_subtractions": [], "income_statutory_withholdings": "none", "income_exemption_amount": null, "income_exemption_percent": null, "effective_from": "2026-01-01", "effective_to": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account": 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": "/deductions/" } } ], "links": { "first": "http://localhost/deductions/search?page=1", "last": "http://localhost/deductions/search?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this deduction is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this deduction is no longer applied. `null` if the deduction applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/deduction_line_items/batch/delete": { "post": { "summary": "Batch delete deduction line items", "operationId": "deduction-line-items-batch-delete", "tags": [ "Deduction Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "", "" ] } } } } }, "/deduction_line_items/batch/upsert": { "post": { "summary": "Batch upsert deduction line items", "operationId": "deduction-line-items-batch-upsert", "tags": [ "Deduction Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "minItems": 1, "maxItems": 100 }, "example": [ { "id": "", "custom_amount": 75 }, { "pay_stub_id": "", "deduction_type": "garnishment_order", "custom_amount": 150 } ] } } } } }, "/deduction_line_items/bulk/create": { "post": { "summary": "Bulk create deduction line items", "operationId": "deduction-line-items-bulk-create", "tags": [ "Deduction Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/deduction_line_items/bulk/create/scope": { "post": { "summary": "Show bulk create scope for deduction line items", "operationId": "deduction-line-items-bulk-create-scope", "tags": [ "Deduction Line Items" ], "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 (`\"pay_stub\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/DeductionLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "pay_stub", "data": { "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "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, "apply_standard_tax_reductions": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_stubs/" } } ], "links": { "first": "http://localhost/deduction_line_items/bulk/create/scope?page=1", "last": "http://localhost/deduction_line_items/bulk/create/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/deduction_line_items/bulk/delete": { "post": { "summary": "Bulk delete deduction line items", "operationId": "deduction-line-items-bulk-delete", "tags": [ "Deduction Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/deduction_line_items/bulk/delete/scope": { "post": { "summary": "Show bulk delete scope for deduction line items", "operationId": "deduction-line-items-bulk-delete-scope", "tags": [ "Deduction Line Items" ], "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 (`\"deduction_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/DeductionLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "deduction_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "deduction", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "deduction_type": { "id": "", "object": "deduction_type", "data": { "type": "income_tax", "label": "Income tax debt", "locale": "en" }, "links": { "self": "/deduction_types/income_tax" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/deduction_line_items/" } } ], "links": { "first": "http://localhost/deduction_line_items/bulk/delete/scope?page=1", "last": "http://localhost/deduction_line_items/bulk/delete/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/deduction_line_items/bulk/update": { "post": { "summary": "Bulk update deduction line items", "operationId": "deduction-line-items-bulk-update", "tags": [ "Deduction Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/deduction_line_items/bulk/update/scope": { "post": { "summary": "Show bulk update scope for deduction line items", "operationId": "deduction-line-items-bulk-update-scope", "tags": [ "Deduction Line Items" ], "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 (`\"deduction_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/DeductionLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "deduction_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "deduction", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "deduction_type": { "id": "", "object": "deduction_type", "data": { "type": "income_tax", "label": "Income tax debt", "locale": "en" }, "links": { "self": "/deduction_types/income_tax" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/deduction_line_items/" } } ], "links": { "first": "http://localhost/deduction_line_items/bulk/update/scope?page=1", "last": "http://localhost/deduction_line_items/bulk/update/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/deduction_line_items": { "get": { "summary": "List deduction line items", "operationId": "deduction-line-items-index", "tags": [ "Deduction Line Items" ], "parameters": [ { "name": "pay_stub_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on the specified Pay Stub." }, { "name": "payroll_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on Pay Stubs on the specified Payroll." }, { "name": "payroll_status", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] }, { "type": "array", "items": { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] } } ] }, "required": false }, { "name": "payroll_type", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] }, { "type": "array", "items": { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] } } ] }, "required": false }, { "name": "payroll_period_start", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_period_start=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_period_start[gte]=2024-01-01&payroll_period_start[lt]=2024-12-31`" }, { "name": "payroll_period_end", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_period_end=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_period_end[gte]=2024-01-01&payroll_period_end[lt]=2024-12-31`" }, { "name": "payroll_pay_date", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_pay_date=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_pay_date[gte]=2024-01-01&payroll_pay_date[lt]=2024-12-31`" }, { "name": "pay_schedule_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on Pay Stubs on the specified Pay Schedule." }, { "name": "work_assignment_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on Pay Stubs for the specified Work Assignment." }, { "name": "employee_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on pay stubs for the specified Employee." }, { "name": "contractor_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on pay stubs for the specified Contractor." }, { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on Pay Stubs under the specified Business Entity." }, { "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": [ "charitable_donation", "garnishment_order", "income_tax", "other_deduction", "union_dues", "union_dues_post_tax" ] }, { "type": "array", "items": { "type": "string", "enum": [ "charitable_donation", "garnishment_order", "income_tax", "other_deduction", "union_dues", "union_dues_post_tax" ] } } ] }, "required": false, "description": "Only return line items with the specified types." }, { "name": "exclude_types", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "charitable_donation", "garnishment_order", "income_tax", "other_deduction", "union_dues", "union_dues_post_tax" ] }, { "type": "array", "items": { "type": "string", "enum": [ "charitable_donation", "garnishment_order", "income_tax", "other_deduction", "union_dues", "union_dues_post_tax" ] } } ] }, "required": false, "description": "Only return line items _without_ the specified types." }, { "name": "external_ref", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "custom_expense_accounting_code", "custom_liability_accounting_code", "custom_tag_assignment", "expense_accounting_code", "liability_accounting_code", "managed_expense_accounting_code", "managed_liability_accounting_code", "managed_tag_assignment", "pay_stub", "recurrence", "remittance_account", "source_adjustment", "tag_assignment", "tag_assignment_amounts" ] } }, "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 (`\"deduction_line_item\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeductionLineItem" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With pay_stub expanded", "properties": { "pay_stub": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayStub" } } } } }, { "type": "object", "title": "With recurrence expanded", "properties": { "recurrence": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Recurrence" } } } } }, { "type": "object", "title": "With remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } }, { "type": "object", "title": "With business_preset expanded", "properties": { "business_preset": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessPreset" } } } } }, { "type": "object", "title": "With source_adjustment expanded", "properties": { "source_adjustment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SourceAdjustment" } } } } }, { "type": "object", "title": "With expense_accounting_code expanded", "properties": { "expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ExpenseAccountingCode" } } } } }, { "type": "object", "title": "With managed_expense_accounting_code expanded", "properties": { "managed_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedExpenseAccountingCode" } } } } }, { "type": "object", "title": "With custom_expense_accounting_code expanded", "properties": { "custom_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomExpenseAccountingCode" } } } } }, { "type": "object", "title": "With liability_accounting_code expanded", "properties": { "liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LiabilityAccountingCode" } } } } }, { "type": "object", "title": "With managed_liability_accounting_code expanded", "properties": { "managed_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedLiabilityAccountingCode" } } } } }, { "type": "object", "title": "With custom_liability_accounting_code expanded", "properties": { "custom_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomLiabilityAccountingCode" } } } } }, { "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" } } } } }, { "type": "object", "title": "With managed_tag_assignment expanded", "properties": { "managed_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/ManagedTagAssignment" } } } } }, { "type": "object", "title": "With custom_tag_assignment expanded", "properties": { "custom_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/CustomTagAssignment" } } } } }, { "type": "object", "title": "With tag_assignment_amounts expanded", "properties": { "tag_assignment_amounts": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/TagAssignmentAmount" } } } } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "deduction_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "deduction", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "deduction_type": { "id": "", "object": "deduction_type", "data": { "type": "income_tax", "label": "Income tax debt", "locale": "en" }, "links": { "self": "/deduction_types/income_tax" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/deduction_line_items/" } } ], "links": { "first": "/deduction_line_items?pay_stub_id=&page=1", "last": "/deduction_line_items?pay_stub_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create a deduction line item", "operationId": "deduction-line-items-store", "tags": [ "Deduction Line Items" ], "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 (`\"deduction_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/DeductionLineItem" } } }, "example": { "id": "", "object": "deduction_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "deduction", "is_managed": false, "amount": 0, "custom_amount": null, "managed_amount": null, "deduction_type": { "id": "", "object": "deduction_type", "data": { "type": "income_tax", "label": "Income tax debt", "locale": "en" }, "links": { "self": "/deduction_types/income_tax" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/deduction_line_items/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "pay_stub_id": { "type": "string" }, "business_preset_id": { "type": "string" }, "deduction_type": { "type": "string", "description": "The type of deduction for this line item.\n\nMust be present when `business_preset_id` is either empty or not set.", "enum": [ "charitable_donation", "garnishment_order", "income_tax", "other_deduction", "union_dues", "union_dues_post_tax" ] }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.", "format": "decimal", "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 }, "remittance_account_id": { "type": "string" }, "expense_accounting_code_id": { "type": "string" }, "custom_expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string" }, "custom_liability_accounting_code_id": { "type": "string" }, "component_settings": { "type": "object", "properties": { "attributes_locked": { "type": "boolean" } } }, "external_ref": { "type": "string", "maxLength": 255 }, "custom_tag_assignment": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "amount", "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 } } } } } } } }, { "type": "object", "required": [ "pay_stub_id" ] } ] }, "example": { "pay_stub_id": "", "deduction_type": "income_tax", "custom_tag_assignment": { "unit": "percentage", "tag_allocations": [ { "tags": [ "" ], "value": 100 } ] } } } } } } }, "/deduction_line_items/search": { "post": { "summary": "Search deduction line items", "description": "Search line items under the given payroll, returning the same set the equivalent bulk update/delete operation would target with this body.", "operationId": "deduction-line-items-search", "tags": [ "Deduction Line Items" ], "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 (`\"deduction_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/DeductionLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "deduction_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "deduction", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "deduction_type": { "id": "", "object": "deduction_type", "data": { "type": "income_tax", "label": "Income tax debt", "locale": "en" }, "links": { "self": "/deduction_types/income_tax" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/deduction_line_items/" } } ], "links": { "first": "http://localhost/deduction_line_items/search?page=1", "last": "http://localhost/deduction_line_items/search?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/deduction_types": { "get": { "summary": "List deduction types", "operationId": "deduction-types-index", "tags": [ "Deduction Types" ], "parameters": [ { "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)." }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Comma-separated list of type identifiers to return." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Case-insensitive substring match against the human-readable label, in any supported locale." } ], "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 (`\"deduction_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/DeductionType" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "deduction_type", "data": { "type": "charitable_donation", "label": "Charitable donations", "locale": "en", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "46", "help_text": null } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "N", "help_text": null } ] ] } ] }, "links": { "self": "/deduction_types/charitable_donation" } }, { "id": "", "object": "deduction_type", "data": { "type": "garnishment_order", "label": "Garnishment Order", "locale": "en", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/deduction_types/garnishment_order" } }, { "id": "", "object": "deduction_type", "data": { "type": "income_tax", "label": "Income tax debt", "locale": "en", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/deduction_types/income_tax" } }, { "id": "", "object": "deduction_type", "data": { "type": "other_deduction", "label": "Other Deduction", "locale": "en", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/deduction_types/other_deduction" } }, { "id": "", "object": "deduction_type", "data": { "type": "union_dues", "label": "Union Dues", "locale": "en", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "reduces_base" ], "help_text": "Union Dues is deducted from taxable income before Income Tax is calculated.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "reduces_base" ], "help_text": "Union Dues is deducted from taxable income before Income Tax is calculated.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "reduces_base" ], "help_text": "Union Dues is deducted from taxable income before Income Tax is calculated.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "reduces_base" ], "help_text": "Union Dues is deducted from taxable income before Income Tax is calculated.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "reduces_base" ], "help_text": "Union Dues is deducted from taxable income before Income Tax is calculated.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "reduces_base" ], "help_text": "Union Dues is deducted from taxable income before Income Tax is calculated.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "reduces_base" ], "help_text": "Union Dues is deducted from taxable income before Income Tax is calculated.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "reduces_base" ], "help_text": "Union Dues is deducted from taxable income before Income Tax is calculated.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "reduces_base" ], "help_text": "Union Dues is deducted from taxable income before Income Tax is calculated.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "reduces_base" ], "help_text": "Union Dues is deducted from taxable income before Income Tax is calculated.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "reduces_base" ], "help_text": "Union Dues is deducted from taxable income before Income Tax is calculated.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "reduces_base" ], "help_text": "Union Dues is deducted from taxable income before Income Tax is calculated.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "reduces_base" ], "help_text": "Union Dues is deducted from taxable income before Income Tax is calculated.", "program_label": null }, { "jurisdiction": "ca_oc", "effects": [ "reduces_base" ], "help_text": "Union Dues is deducted from taxable income before Income Tax is calculated.", "program_label": null } ] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "44", "help_text": null } ] ] } ] }, "links": { "self": "/deduction_types/union_dues" } }, { "id": "", "object": "deduction_type", "data": { "type": "union_dues_post_tax", "label": "Union Dues Post Tax", "locale": "en", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/deduction_types/union_dues_post_tax" } } ], "links": { "first": "/deduction_types?features=ca&page=1", "last": "/deduction_types?features=ca&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 6, "has_more": false } } } } } } } }, "/earnings/batch/delete": { "post": { "summary": "Batch delete earnings", "operationId": "earnings-batch-delete", "tags": [ "Earnings" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "", "" ] } } } } }, "/earnings/batch/upsert": { "post": { "summary": "Batch upsert earnings", "operationId": "earnings-batch-upsert", "tags": [ "Earnings" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "minItems": 1, "maxItems": 100 }, "example": [ { "id": "", "amount": 3000, "effective_from": "2026-01-01" }, { "work_assignment_id": "", "earning_type": "salary_continuance", "amount": 5000, "frequency": "per_payroll", "effective_from": "2026-01-01" } ] } } } } }, "/earnings/bulk/create": { "post": { "summary": "Bulk create earnings", "operationId": "earnings-bulk-create", "tags": [ "Earnings" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } } } }, "/earnings/bulk/create/scope": { "post": { "summary": "Show bulk create scope for earnings", "operationId": "earnings-bulk-create-scope", "tags": [ "Earnings" ], "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/Earning" } } } } } }, "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/earnings/bulk/create/scope?page=1", "last": "http://localhost/earnings/bulk/create/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } } } }, "/earnings/bulk/delete": { "post": { "summary": "Bulk delete earnings", "operationId": "earnings-bulk-delete", "tags": [ "Earnings" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this earning is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this earning is no longer applied. `null` if the earning applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/earnings/bulk/delete/scope": { "post": { "summary": "Show bulk delete scope for earnings", "operationId": "earnings-bulk-delete-scope", "tags": [ "Earnings" ], "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": { "$ref": "#/components/schemas/Earning" } } } } } }, "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": "http://localhost/earnings/bulk/delete/scope?page=1", "last": "http://localhost/earnings/bulk/delete/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this earning is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this earning is no longer applied. `null` if the earning applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/earnings/bulk/update": { "post": { "summary": "Bulk update earnings", "operationId": "earnings-bulk-update", "tags": [ "Earnings" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this earning is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this earning is no longer applied. `null` if the earning applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/earnings/bulk/update/scope": { "post": { "summary": "Show bulk update scope for earnings", "operationId": "earnings-bulk-update-scope", "tags": [ "Earnings" ], "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": { "$ref": "#/components/schemas/Earning" } } } } } }, "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": "http://localhost/earnings/bulk/update/scope?page=1", "last": "http://localhost/earnings/bulk/update/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this earning is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this earning is no longer applied. `null` if the earning applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/earnings": { "get": { "summary": "List earnings", "operationId": "earnings-index", "tags": [ "Earnings" ], "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_unpaid", "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", "tips_controlled", "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_unpaid", "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", "tips_controlled", "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_unpaid", "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", "tips_controlled", "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_unpaid", "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", "tips_controlled", "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:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `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:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `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 \n`sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by\nand `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": "requires_tag_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "requires_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 } } } } } } }, "post": { "summary": "Create an earning", "operationId": "earnings-store", "tags": [ "Earnings" ], "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 (`\"earning\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Earning" } } }, "example": { "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/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "work_assignment_id": { "type": "string" }, "business_preset_id": { "type": "string" }, "earning_type": { "type": "string", "description": "The type of earning, which determines how it is taxed.\n\nMust be present when `business_preset_id` is either empty or not set.", "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", "tips_controlled", "vacation_pay", "vacation_pay_employee_terminated", "vacation_pay_no_time_taken", "vacation_pay_time_taken", "wage" ] }, "amount": { "type": "number", "description": "The monetary amount applied each time this earning is included on a Pay Stub.", "format": "decimal", "minimum": 0, "maximum": 9999 }, "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 earning is applied to Pay Stubs. When `per_month`, the amount is distributed evenly across all Payrolls in the calendar month.\n\nThe frequency that the earning is added to an Employees PayStub.", "enum": [ "once", "per_month", "per_payroll" ] }, "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.", "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": "", "earning_type": "parental_top_up_insurable", "amount": "5000", "frequency": "per_payroll", "effective_from": "2026-01-01", "tag_assignment": { "unit": "percentage", "tag_allocations": [ { "tags": [ "" ], "value": 100 } ] } } } } } } }, "/earnings/search": { "post": { "summary": "Search earnings", "description": "Search earnings under the given business entity, returning the same set the equivalent bulk update/delete operation would target with this body.", "operationId": "earnings-search", "tags": [ "Earnings" ], "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": { "$ref": "#/components/schemas/Earning" } } } } } }, "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": "http://localhost/earnings/search?page=1", "last": "http://localhost/earnings/search?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this earning is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this earning is no longer applied. `null` if the earning applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/earning_line_items/batch/delete": { "post": { "summary": "Batch delete earning line items", "operationId": "earning-line-items-batch-delete", "tags": [ "Earning Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "", "" ] } } } } }, "/earning_line_items/batch/upsert": { "post": { "summary": "Batch upsert earning line items", "operationId": "earning-line-items-batch-upsert", "tags": [ "Earning Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "minItems": 1, "maxItems": 100 }, "example": [ { "id": "", "custom_amount": 3000 }, { "pay_stub_id": "", "earning_type": "salary_continuance", "custom_amount": 5000 } ] } } } } }, "/earning_line_items/bulk/create": { "post": { "summary": "Bulk create earning line items", "operationId": "earning-line-items-bulk-create", "tags": [ "Earning Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/earning_line_items/bulk/create/scope": { "post": { "summary": "Show bulk create scope for earning line items", "operationId": "earning-line-items-bulk-create-scope", "tags": [ "Earning Line Items" ], "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 (`\"pay_stub\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EarningLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "pay_stub", "data": { "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "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, "apply_standard_tax_reductions": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_stubs/" } } ], "links": { "first": "http://localhost/earning_line_items/bulk/create/scope?page=1", "last": "http://localhost/earning_line_items/bulk/create/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/earning_line_items/bulk/delete": { "post": { "summary": "Bulk delete earning line items", "operationId": "earning-line-items-bulk-delete", "tags": [ "Earning Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/earning_line_items/bulk/delete/scope": { "post": { "summary": "Show bulk delete scope for earning line items", "operationId": "earning-line-items-bulk-delete-scope", "tags": [ "Earning Line Items" ], "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_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EarningLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "earning_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "amount": 3000, "custom_amount": 3000, "managed_amount": 0, "is_managed": false, "line_item_type": "earning", "earning_type": { "id": "", "object": "earning_type", "data": { "type": "wage", "label": "Wage", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/wage" } }, "hours": 0, "managed_hours": null, "custom_hours": 0, "accrued_vacation_pay": 0, "recurrence": null, "pay_rate": null, "overtime_rate": null, "title": null, "title_translations": null, "title_translated": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "business_preset": null, "source_adjustment": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/earning_line_items/" } } ], "links": { "first": "http://localhost/earning_line_items/bulk/delete/scope?page=1", "last": "http://localhost/earning_line_items/bulk/delete/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/earning_line_items/bulk/update": { "post": { "summary": "Bulk update earning line items", "operationId": "earning-line-items-bulk-update", "tags": [ "Earning Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/earning_line_items/bulk/update/scope": { "post": { "summary": "Show bulk update scope for earning line items", "operationId": "earning-line-items-bulk-update-scope", "tags": [ "Earning Line Items" ], "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_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EarningLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "earning_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "amount": 3000, "custom_amount": 3000, "managed_amount": 0, "is_managed": false, "line_item_type": "earning", "earning_type": { "id": "", "object": "earning_type", "data": { "type": "wage", "label": "Wage", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/wage" } }, "hours": 0, "managed_hours": null, "custom_hours": 0, "accrued_vacation_pay": 0, "recurrence": null, "pay_rate": null, "overtime_rate": null, "title": null, "title_translations": null, "title_translated": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "business_preset": null, "source_adjustment": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/earning_line_items/" } } ], "links": { "first": "http://localhost/earning_line_items/bulk/update/scope?page=1", "last": "http://localhost/earning_line_items/bulk/update/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/earning_line_items": { "get": { "summary": "List earning line items", "operationId": "earning-line-items-index", "tags": [ "Earning Line Items" ], "parameters": [ { "name": "pay_stub_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "payroll_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "payroll_status", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] }, { "type": "array", "items": { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] } } ] }, "required": false }, { "name": "payroll_type", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] }, { "type": "array", "items": { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] } } ] }, "required": false }, { "name": "payroll_period_start", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_period_start=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_period_start[gte]=2024-01-01&payroll_period_start[lt]=2024-12-31`" }, { "name": "payroll_period_end", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_period_end=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_period_end[gte]=2024-01-01&payroll_period_end[lt]=2024-12-31`" }, { "name": "payroll_pay_date", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_pay_date=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_pay_date[gte]=2024-01-01&payroll_pay_date[lt]=2024-12-31`" }, { "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": "contractor_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "business_entity_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_unpaid", "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", "tips_controlled", "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_unpaid", "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", "tips_controlled", "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_unpaid", "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", "tips_controlled", "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_unpaid", "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", "tips_controlled", "vacation_accrual_adjustment", "vacation_pay", "vacation_pay_employee_terminated", "vacation_pay_no_time_taken", "vacation_pay_time_taken", "wage" ] } } ] }, "required": false }, { "name": "external_ref", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "earned_on", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Only return line items with an `earned_on` date matching the filter.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `earned_on=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `earned_on[gte]=2024-01-01&earned_on[lt]=2024-12-31`" }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "custom_expense_accounting_code", "custom_liability_accounting_code", "custom_tag_assignment", "expense_accounting_code", "liability_accounting_code", "managed_expense_accounting_code", "managed_liability_accounting_code", "managed_tag_assignment", "overtime_rate", "pay_rate", "pay_stub", "recurrence", "source_adjustment", "tag_assignment", "tag_assignment_amounts" ] } }, "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_line_item\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EarningLineItem" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With pay_stub expanded", "properties": { "pay_stub": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayStub" } } } } }, { "type": "object", "title": "With recurrence expanded", "properties": { "recurrence": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Recurrence" } } } } }, { "type": "object", "title": "With pay_rate expanded", "properties": { "pay_rate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayRate" } } } } }, { "type": "object", "title": "With overtime_rate expanded", "properties": { "overtime_rate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OvertimeRate" } } } } }, { "type": "object", "title": "With business_preset expanded", "properties": { "business_preset": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessPreset" } } } } }, { "type": "object", "title": "With source_adjustment expanded", "properties": { "source_adjustment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SourceAdjustment" } } } } }, { "type": "object", "title": "With expense_accounting_code expanded", "properties": { "expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ExpenseAccountingCode" } } } } }, { "type": "object", "title": "With managed_expense_accounting_code expanded", "properties": { "managed_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedExpenseAccountingCode" } } } } }, { "type": "object", "title": "With custom_expense_accounting_code expanded", "properties": { "custom_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomExpenseAccountingCode" } } } } }, { "type": "object", "title": "With liability_accounting_code expanded", "properties": { "liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LiabilityAccountingCode" } } } } }, { "type": "object", "title": "With managed_liability_accounting_code expanded", "properties": { "managed_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedLiabilityAccountingCode" } } } } }, { "type": "object", "title": "With custom_liability_accounting_code expanded", "properties": { "custom_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomLiabilityAccountingCode" } } } } }, { "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" } } } } }, { "type": "object", "title": "With managed_tag_assignment expanded", "properties": { "managed_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/ManagedTagAssignment" } } } } }, { "type": "object", "title": "With custom_tag_assignment expanded", "properties": { "custom_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/CustomTagAssignment" } } } } }, { "type": "object", "title": "With tag_assignment_amounts expanded", "properties": { "tag_assignment_amounts": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/TagAssignmentAmount" } } } } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "earning_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "amount": 3000, "custom_amount": 3000, "managed_amount": 0, "is_managed": false, "line_item_type": "earning", "earning_type": { "id": "", "object": "earning_type", "data": { "type": "wage", "label": "Wage", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/wage" } }, "hours": 0, "managed_hours": null, "custom_hours": 0, "accrued_vacation_pay": 0, "recurrence": null, "pay_rate": null, "overtime_rate": null, "title": null, "title_translations": null, "title_translated": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "business_preset": null, "source_adjustment": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/earning_line_items/" } } ], "links": { "first": "/earning_line_items?pay_stub_id=&page=1", "last": "/earning_line_items?pay_stub_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create an earning line item", "operationId": "earning-line-items-store", "tags": [ "Earning Line Items" ], "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 (`\"earning_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EarningLineItem" } } }, "example": { "id": "", "object": "earning_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "amount": 3000, "custom_amount": 3000, "managed_amount": null, "is_managed": false, "line_item_type": "earning", "earning_type": { "id": "", "object": "earning_type", "data": { "type": "wage", "label": "Wage", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/wage" } }, "hours": 0, "managed_hours": null, "custom_hours": 0, "accrued_vacation_pay": 0, "recurrence": null, "pay_rate": null, "overtime_rate": null, "title": "Earning", "title_translations": null, "title_translated": "Earning", "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "business_preset": null, "source_adjustment": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/earning_line_items/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "pay_stub_id": { "type": "string" }, "business_preset_id": { "type": "string" }, "earning_type": { "type": "string", "description": "The type of earning for this line item.\n\nMust be present when `business_preset_id` is either empty or not set.", "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_unpaid", "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", "tips_controlled", "vacation_accrual_adjustment", "vacation_pay", "vacation_pay_employee_terminated", "vacation_pay_no_time_taken", "vacation_pay_time_taken", "wage" ] }, "pay_rate_id": { "type": "string", "description": "On line items of type `wage` and `overtime` you may pass a `pay_rate_id` and `hours` to automatically calculate the `amount`." }, "overtime_rate_id": { "type": "string", "description": "On line items of type `overtime` you may pass a `overtime_rate_id` and `hours` to automatically calculate the `amount`." }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.", "format": "decimal", "maximum": 999999 }, "custom_hours": { "type": "number", "description": "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.", "format": "decimal", "maximum": 9999 }, "accrued_vacation_pay": { "type": "number", "description": "The vacation pay accrued on this line item, calculated based on the Work Assignment's Vacation Pay Settings.", "format": "decimal", "minimum": -99999, "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 }, "component_settings": { "type": "object", "properties": { "attributes_locked": { "type": "boolean" } } }, "expense_accounting_code_id": { "type": "string" }, "custom_expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string" }, "custom_liability_accounting_code_id": { "type": "string" }, "custom_earned_on": { "type": "string", "format": "date" }, "external_ref": { "type": "string", "maxLength": 255 }, "custom_tag_assignment": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "amount", "hours", "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 } } } } } } } }, { "type": "object", "required": [ "pay_stub_id" ] } ] }, "example": { "pay_stub_id": "", "earning_type": "wage", "custom_amount": "3000", "custom_hours": "0", "accrued_vacation_pay": "0", "title": "Earning", "custom_tag_assignment": { "unit": "percentage", "tag_allocations": [ { "tags": [ "" ], "value": 100 } ] } } } } } } }, "/earning_line_items/search": { "post": { "summary": "Search earning line items", "description": "Search line items under the given payroll, returning the same set the equivalent bulk update/delete operation would target with this body.", "operationId": "earning-line-items-search", "tags": [ "Earning Line Items" ], "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_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EarningLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "earning_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "amount": 3000, "custom_amount": 3000, "managed_amount": 0, "is_managed": false, "line_item_type": "earning", "earning_type": { "id": "", "object": "earning_type", "data": { "type": "wage", "label": "Wage", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/wage" } }, "hours": 0, "managed_hours": null, "custom_hours": 0, "accrued_vacation_pay": 0, "recurrence": null, "pay_rate": null, "overtime_rate": null, "title": null, "title_translations": null, "title_translated": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "business_preset": null, "source_adjustment": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/earning_line_items/" } } ], "links": { "first": "http://localhost/earning_line_items/search?page=1", "last": "http://localhost/earning_line_items/search?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/earning_types": { "get": { "summary": "List earning types", "operationId": "earning-types-index", "tags": [ "Earning Types" ], "parameters": [ { "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)." }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Comma-separated list of type identifiers to return." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Case-insensitive substring match against the human-readable label, in any supported locale." } ], "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_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EarningType" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "earning_type", "data": { "type": "bonus_discretionary", "label": "Bonus (Discretionary)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true }, "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Discretionary) using the bonus method.", "program_label": null } ] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "CPP is calculated on Bonus (Discretionary) using the bonus method.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "CPP is calculated on Bonus (Discretionary) using the bonus method.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "QPP is calculated on Bonus (Discretionary) using the bonus method.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "EI is calculated on Bonus (Discretionary) using the bonus method.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "EI is calculated on Bonus (Discretionary) using the bonus method.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "QPIP is calculated on Bonus (Discretionary) using the bonus method.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Bonus (Discretionary) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Bonus (Discretionary) is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Bonus (Discretionary) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Bonus (Discretionary) is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Bonus (Discretionary) is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Bonus (Discretionary) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Bonus (Discretionary) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Bonus (Discretionary) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Bonus (Discretionary) is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Bonus (Discretionary) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Bonus (Discretionary) is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Bonus (Discretionary) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Bonus (Discretionary) is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Bonus (Discretionary) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Bonus (Discretionary) is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Bonus (Discretionary) is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Bonus (Discretionary) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Bonus (Discretionary) is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [ { "jurisdiction": "ca_nl", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Bonus (Discretionary) is included in statutory holiday pay.", "program_label": null } ] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" } ] ] } ] }, "links": { "self": "/earning_types/bonus_discretionary" } }, { "id": "", "object": "earning_type", "data": { "type": "bonus_non_discretionary", "label": "Bonus (Non-Discretionary)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true }, "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": null } ] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "CPP is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "CPP is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "QPP is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "EI is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "EI is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "QPIP is calculated on Bonus (Non-Discretionary) using the bonus method.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Bonus (Non-Discretionary) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Bonus (Non-Discretionary) is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Bonus (Non-Discretionary) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Bonus (Non-Discretionary) is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Bonus (Non-Discretionary) is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Bonus (Non-Discretionary) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Bonus (Non-Discretionary) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Bonus (Non-Discretionary) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Bonus (Non-Discretionary) is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Bonus (Non-Discretionary) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Bonus (Non-Discretionary) is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Bonus (Non-Discretionary) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Bonus (Non-Discretionary) is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Bonus (Non-Discretionary) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Bonus (Non-Discretionary) is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Bonus (Non-Discretionary) is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Bonus (Non-Discretionary) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Bonus (Non-Discretionary) 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 Bonus (Non-Discretionary)", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Discretionary)", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Discretionary)", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Discretionary)", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Discretionary)", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Discretionary)", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Discretionary)", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Discretionary)", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Discretionary)", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Discretionary)", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Discretionary)", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Discretionary)", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Discretionary)", "program_label": null } ] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Bonus (Non-Discretionary) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Bonus (Non-Discretionary) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Bonus (Non-Discretionary) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Bonus (Non-Discretionary) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Bonus (Non-Discretionary) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Bonus (Non-Discretionary) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Bonus (Non-Discretionary) is included in statutory holiday pay.", "program_label": null } ] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" } ] ] } ] }, "links": { "self": "/earning_types/bonus_non_discretionary" } }, { "id": "", "object": "earning_type", "data": { "type": "bonus_non_taxable", "label": "Bonus (Non-Taxable)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true }, "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Bonus (Non-Taxable) 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 Bonus (Non-Taxable)", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Taxable)", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Taxable)", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Taxable)", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Taxable)", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Taxable)", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Taxable)", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Taxable)", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Taxable)", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Taxable)", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Taxable)", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Taxable)", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Bonus (Non-Taxable)", "program_label": null } ] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Bonus (Non-Taxable) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Bonus (Non-Taxable) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Bonus (Non-Taxable) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Bonus (Non-Taxable) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Bonus (Non-Taxable) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Bonus (Non-Taxable) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Bonus (Non-Taxable) is included in statutory holiday pay.", "program_label": null } ] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" } ] ] } ] }, "links": { "self": "/earning_types/bonus_non_taxable" } }, { "id": "", "object": "earning_type", "data": { "type": "commission", "label": "Commission (Non-Periodic)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true }, "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Commission (Non-Periodic) using the bonus method. When a TD1X has been completed, Income Tax is calculated on Commission (Non-Periodic) using estimated income and expenses from the TD1X.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Commission (Non-Periodic) using the bonus method. For commission-based employees, Income Tax is calculated on Commission (Non-Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Commission (Non-Periodic) using the bonus method. For commission-based employees, Income Tax is calculated on Commission (Non-Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Commission (Non-Periodic) using the bonus method. For commission-based employees, Income Tax is calculated on Commission (Non-Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Commission (Non-Periodic) using the bonus method. For commission-based employees, Income Tax is calculated on Commission (Non-Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Commission (Non-Periodic) using the bonus method. For commission-based employees, Income Tax is calculated on Commission (Non-Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Commission (Non-Periodic) using the bonus method. For commission-based employees, Income Tax is calculated on Commission (Non-Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Commission (Non-Periodic) using the bonus method. For commission-based employees, Income Tax is calculated on Commission (Non-Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Commission (Non-Periodic) using the bonus method. For commission-based employees, Income Tax is calculated on Commission (Non-Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Commission (Non-Periodic) using the bonus method. For commission-based employees, Income Tax is calculated on Commission (Non-Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Commission (Non-Periodic) using the bonus method. For commission-based employees, Income Tax is calculated on Commission (Non-Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Commission (Non-Periodic) using the bonus method. When a TP-1015.3-V has been completed, Income Tax is calculated on Commission (Non-Periodic) 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": "Income Tax is calculated on Commission (Non-Periodic) using the bonus method. For commission-based employees, Income Tax is calculated on Commission (Non-Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Commission (Non-Periodic) using the bonus method. For commission-based employees, Income Tax is calculated on Commission (Non-Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Commission (Non-Periodic) using the bonus method. When a TD1X has been completed, Income Tax is calculated on Commission (Non-Periodic) using estimated income and expenses from the TD1X.", "program_label": null } ] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "CPP is calculated on Commission (Non-Periodic) using the bonus method. For commission-based employees, Commission (Non-Periodic) is subject to standard CPP calculations.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "CPP is calculated on Commission (Non-Periodic) using the bonus method. For commission-based employees, Commission (Non-Periodic) is subject to standard CPP calculations.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "QPP is calculated on Commission (Non-Periodic) using the bonus method.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "EI is calculated on Commission (Non-Periodic) using the bonus method. For commission-based employees, Commission (Non-Periodic) is subject to standard EI calculations.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "EI is calculated on Commission (Non-Periodic) using the bonus method. For commission-based employees, Commission (Non-Periodic) is subject to standard EI calculations.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "QPIP is calculated on Commission (Non-Periodic) using the bonus method.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Commission (Non-Periodic) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Commission (Non-Periodic) is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Commission (Non-Periodic) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Commission (Non-Periodic) is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Commission (Non-Periodic) is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Commission (Non-Periodic) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Commission (Non-Periodic) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Commission (Non-Periodic) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Commission (Non-Periodic) is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Commission (Non-Periodic) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Commission (Non-Periodic) is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Commission (Non-Periodic) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Commission (Non-Periodic) is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Commission (Non-Periodic) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Commission (Non-Periodic) is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Commission (Non-Periodic) is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Commission (Non-Periodic) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Commission (Non-Periodic) 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 Commission (Non-Periodic)", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Non-Periodic)", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Non-Periodic)", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Non-Periodic)", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Non-Periodic)", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Non-Periodic)", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Non-Periodic)", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Non-Periodic)", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Non-Periodic)", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Non-Periodic)", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Non-Periodic)", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Non-Periodic)", "program_label": null } ] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Non-Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Non-Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Non-Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Non-Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Non-Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Non-Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Non-Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Non-Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Non-Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Non-Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Non-Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Non-Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Non-Periodic) is included in statutory holiday pay.", "program_label": null } ] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" }, { "name": "42", "help_text": "Employment Commissions" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "M", "help_text": "Commissions" } ] ] } ] }, "links": { "self": "/earning_types/commission" } }, { "id": "", "object": "earning_type", "data": { "type": "commission_periodic", "label": "Commission (Periodic)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true }, "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to Federal Income Tax. When a TD1X has been completed, Income Tax is calculated on Commission (Periodic) using estimated income and expenses from the TD1X.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to Income Tax. For commission-based employees, Income Tax is calculated on Commission (Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to Income Tax. For commission-based employees, Income Tax is calculated on Commission (Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to Income Tax. For commission-based employees, Income Tax is calculated on Commission (Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to Income Tax. For commission-based employees, Income Tax is calculated on Commission (Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to Income Tax. For commission-based employees, Income Tax is calculated on Commission (Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to Income Tax. For commission-based employees, Income Tax is calculated on Commission (Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to Income Tax. For commission-based employees, Income Tax is calculated on Commission (Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to Income Tax. For commission-based employees, Income Tax is calculated on Commission (Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to Income Tax. For commission-based employees, Income Tax is calculated on Commission (Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to Income Tax. For commission-based employees, Income Tax is calculated on Commission (Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to Income Tax. When a TP-1015.3-V has been completed, Income Tax is calculated on Commission (Periodic) 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": "Commission (Periodic) is subject to Income Tax. For commission-based employees, Income Tax is calculated on Commission (Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to Income Tax. For commission-based employees, Income Tax is calculated on Commission (Periodic) using estimated income and expenses.", "program_label": null }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Federal Income Tax rates apply, plus the default outside-Canada surtax. When a TD1X has been completed, Income Tax is calculated on Commission (Periodic) using estimated income and expenses from the TD1X.", "program_label": null } ] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Commission (Periodic) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Commission (Periodic) 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 Commission (Periodic)", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Periodic)", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Periodic)", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Periodic)", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Periodic)", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Periodic)", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Periodic)", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Periodic)", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Periodic)", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Periodic)", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Periodic)", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Commission (Periodic)", "program_label": null } ] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Periodic) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Commission (Periodic) is included in statutory holiday pay.", "program_label": null } ] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" }, { "name": "42", "help_text": "Employment Commissions" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "M", "help_text": "Commissions" } ] ] } ] }, "links": { "self": "/earning_types/commission_periodic" } }, { "id": "", "object": "earning_type", "data": { "type": "commission_self_employed", "label": "Commission (Self-employed)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true }, "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "O-RM", "help_text": "Self-Employed Commissions" } ] ] }, { "form": "t4a", "form_label": "T4A", "mapping": [ [ { "name": "20", "help_text": "Self-Employed Commissions" } ] ] } ] }, "links": { "self": "/earning_types/commission_self_employed" } }, { "id": "", "object": "earning_type", "data": { "type": "death_benefit", "label": "Death Benefit", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true }, "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Death Benefit is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Death Benefit is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Death Benefit is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Death Benefit is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Death Benefit is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Death Benefit is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Death Benefit is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Death Benefit is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Death Benefit is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Death Benefit is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Death Benefit is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Death Benefit is subject to Income Tax. When a TP-1015.3-V has been completed, Income Tax is calculated on Death Benefit 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": "Death Benefit is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Death Benefit 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": "Death Benefit is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Death Benefit is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Death Benefit is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Death Benefit is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Death Benefit is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Death Benefit is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "O-RK", "help_text": "Death Benefit" } ] ] } ] }, "links": { "self": "/earning_types/death_benefit" } }, { "id": "", "object": "earning_type", "data": { "type": "gift_cash", "label": "Gift (Cash)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true }, "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to Income Tax. When a TP-1015.3-V has been completed, Income Tax is calculated on Gift (Cash) 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": "Gift (Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Gift (Cash) 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": "Gift (Cash) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Gift (Cash) is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Gift (Cash)", "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" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/earning_types/gift_cash" } }, { "id": "", "object": "earning_type", "data": { "type": "gratuity", "label": "Gratuity", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true }, "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Gratuity is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Gratuity is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Gratuity is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Gratuity is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Gratuity is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Gratuity is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Gratuity is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Gratuity is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Gratuity is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Gratuity is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Gratuity is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on Gratuity using the bonus method.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Gratuity is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Gratuity 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": "Gratuity is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Gratuity is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "QPP is calculated on Gratuity using the bonus method.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Gratuity is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Gratuity is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "QPIP is calculated on Gratuity using the bonus method.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Gratuity is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Gratuity is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Gratuity is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Gratuity is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Gratuity is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Gratuity is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Gratuity is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Gratuity is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Gratuity is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Gratuity is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Gratuity is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Gratuity is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Gratuity is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Gratuity is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Gratuity is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Gratuity is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Gratuity is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Gratuity is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [ { "jurisdiction": "ca_mb", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Gratuity", "program_label": null } ] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [ { "jurisdiction": "ca_mb", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Gratuity is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Gratuity is included in statutory holiday pay.", "program_label": null } ] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" } ] ] } ] }, "links": { "self": "/earning_types/gratuity" } }, { "id": "", "object": "earning_type", "data": { "type": "in_lieu_wages", "label": "In Lieu Wages (Dismissal Pay)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true }, "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on In Lieu Wages (Dismissal Pay) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on In Lieu Wages (Dismissal Pay) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on In Lieu Wages (Dismissal Pay) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on In Lieu Wages (Dismissal Pay) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on In Lieu Wages (Dismissal Pay) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on In Lieu Wages (Dismissal Pay) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on In Lieu Wages (Dismissal Pay) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on In Lieu Wages (Dismissal Pay) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on In Lieu Wages (Dismissal Pay) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on In Lieu Wages (Dismissal Pay) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on In Lieu Wages (Dismissal Pay) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Income Tax is calculated using Revenue Quebec's lump sum tax rates directly on the In Lieu Wages (Dismissal Pay) amount. Income Tax is calculated on In Lieu Wages (Dismissal Pay) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on In Lieu Wages (Dismissal Pay) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on In Lieu Wages (Dismissal Pay) using the bonus method.", "program_label": null }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Income Tax is calculated on In Lieu Wages (Dismissal Pay) using the bonus method.", "program_label": null } ] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "CPP is calculated on In Lieu Wages (Dismissal Pay) using the bonus method.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "CPP is calculated on In Lieu Wages (Dismissal Pay) using the bonus method.", "program_label": "CPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "EI is calculated on In Lieu Wages (Dismissal Pay) using the bonus method.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "EI is calculated on In Lieu Wages (Dismissal Pay) using the bonus method.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "In Lieu Wages (Dismissal Pay) is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "In Lieu Wages (Dismissal Pay) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "In Lieu Wages (Dismissal Pay) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "In Lieu Wages (Dismissal Pay) is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "In Lieu Wages (Dismissal Pay) is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "In Lieu Wages (Dismissal Pay) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "In Lieu Wages (Dismissal Pay) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "In Lieu Wages (Dismissal Pay) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "In Lieu Wages (Dismissal Pay) is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "In Lieu Wages (Dismissal Pay) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "In Lieu Wages (Dismissal Pay) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "In Lieu Wages (Dismissal Pay) is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "In Lieu Wages (Dismissal Pay) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "In Lieu Wages (Dismissal Pay) is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "In Lieu Wages (Dismissal Pay) is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "In Lieu Wages (Dismissal Pay) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "In Lieu Wages (Dismissal Pay) is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on In Lieu Wages (Dismissal Pay)", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on In Lieu Wages (Dismissal Pay)", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on In Lieu Wages (Dismissal Pay)", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on In Lieu Wages (Dismissal Pay)", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on In Lieu Wages (Dismissal Pay)", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on In Lieu Wages (Dismissal Pay)", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on In Lieu Wages (Dismissal Pay)", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on In Lieu Wages (Dismissal Pay)", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on In Lieu Wages (Dismissal Pay)", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on In Lieu Wages (Dismissal Pay)", "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" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "O-RJ", "help_text": "Retiring Allowance" } ] ] } ] }, "links": { "self": "/earning_types/in_lieu_wages" } }, { "id": "", "object": "earning_type", "data": { "type": "income_replacement_indemnity_non_taxable", "label": "Income Replacement Indemnity (Non-Taxable)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true }, "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/earning_types/income_replacement_indemnity_non_taxable" } }, { "id": "", "object": "earning_type", "data": { "type": "income_replacement_indemnity_taxable", "label": "Income Replacement Indemnity (Taxable)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true }, "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to Income Tax. When a TP-1015.3-V has been completed, Income Tax is calculated on Income Replacement Indemnity (Taxable) 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": "Income Replacement Indemnity (Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) 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": "Income Replacement Indemnity (Taxable) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Income Replacement Indemnity (Taxable) is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Income Replacement Indemnity (Taxable)", "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" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" } ] ] } ] }, "links": { "self": "/earning_types/income_replacement_indemnity_taxable" } }, { "id": "", "object": "earning_type", "data": { "type": "invoice_payment", "label": "Invoice Payment", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true }, "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4a", "form_label": "T4A", "mapping": [ [ { "name": "48", "help_text": "Fees for services" } ] ] } ] }, "links": { "self": "/earning_types/invoice_payment" } }, { "id": "", "object": "earning_type", "data": { "type": "invoice_sales_tax", "label": "Invoice sales tax", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true }, "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/earning_types/invoice_sales_tax" } }, { "id": "", "object": "earning_type", "data": { "type": "leave_bereavement", "label": "Leave (bereavement)", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true }, "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to Income Tax. When a TP-1015.3-V has been completed, Income Tax is calculated on Leave (bereavement) 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": "Leave (bereavement) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Leave (bereavement) 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": "Leave (bereavement) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Leave (bereavement) is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [ { "jurisdiction": "ca_pe", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Leave (bereavement)", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Leave (bereavement)", "program_label": null } ] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Leave (bereavement) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Leave (bereavement) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Leave (bereavement) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Leave (bereavement) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Leave (bereavement) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Leave (bereavement) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Leave (bereavement) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Leave (bereavement) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Leave (bereavement) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Leave (bereavement) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Leave (bereavement) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Leave (bereavement) is included in statutory holiday pay.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "included_in_stat_holiday_pay" ], "help_text": "Leave (bereavement) is included in statutory holiday pay.", "program_label": null } ] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" } ] ] } ] }, "links": { "self": "/earning_types/leave_bereavement" } } ], "links": { "first": "/earning_types?features=ca&page=1", "last": "/earning_types?features=ca&page=4", "prev": null, "next": "/earning_types?features=ca&page=2" }, "meta": { "current_page": 1, "last_page": 4, "per_page": 15, "total": 50, "has_more": true } } } } } } } }, "/effective_tax_properties": { "get": { "summary": "List effective tax properties", "operationId": "effective-tax-properties-index", "tags": [ "Effective Tax Properties" ], "parameters": [ { "name": "work_assignment_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Filter by Work Assignment. Required if `business_entity_id` is not provided.\n\nThe `work_assignment_id` field is required when `business_entity_id` is not present." }, { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Filter by Business Entity. Required if `work_assignment_id` is not provided.\n\nThe `business_entity_id` field is required when `work_assignment_id` is not present." }, { "name": "effective_on", "in": "query", "schema": { "type": "string" }, "required": false, "description": "The date on which to resolve Tax Property values. Defaults to today." }, { "name": "type", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "ca::ab::claim_amount", "ca::ab::total_income_less_than_total_claim_amount", "ca::ab::workers_compensation_class", "ca::bc::claim_amount", "ca::bc::eht", "ca::bc::total_income_less_than_total_claim_amount", "ca::bc::workers_compensation_class", "ca::cpp_exempt", "ca::ei_exempt", "ca::ei_premium_reduction", "ca::federal::additional_tax", "ca::federal::annual_deduction_at_source", "ca::federal::claim_amount", "ca::federal::commission_expenses", "ca::federal::commission_total_income", "ca::federal::income_tax_rate", "ca::federal::total_income_less_than_total_claim_amount", "ca::federal_oc_surtax_exempt", "ca::first_nation_exemptions", "ca::mb::claim_amount", "ca::mb::eht", "ca::mb::total_income_less_than_total_claim_amount", "ca::mb::workers_compensation_class", "ca::nb::claim_amount", "ca::nb::total_income_less_than_total_claim_amount", "ca::nb::workers_compensation_class", "ca::nl::claim_amount", "ca::nl::eht", "ca::nl::total_income_less_than_total_claim_amount", "ca::nl::workers_compensation_class", "ca::ns::claim_amount", "ca::ns::total_income_less_than_total_claim_amount", "ca::ns::workers_compensation_class", "ca::nt::claim_amount", "ca::nt::territorial_payroll_tax", "ca::nt::total_income_less_than_total_claim_amount", "ca::nt::workers_compensation_class", "ca::nu::claim_amount", "ca::nu::territorial_payroll_tax", "ca::nu::total_income_less_than_total_claim_amount", "ca::nu::workers_compensation_class", "ca::on::claim_amount", "ca::on::dependent_children_credit", "ca::on::eht", "ca::on::impaired_dependants_credit", "ca::on::total_income_less_than_total_claim_amount", "ca::on::workers_compensation_class", "ca::pe::claim_amount", "ca::pe::total_income_less_than_total_claim_amount", "ca::pe::workers_compensation_class", "ca::province_of_employment", "ca::province_of_work", "ca::provincial::income_tax_rate", "ca::qc::additional_tax", "ca::qc::claim_amount", "ca::qc::commission_percentage_taxed", "ca::qc::eht", "ca::qc::income_tax_rate", "ca::qc::qpip_exempt", "ca::qc::qpp_exempt", "ca::qc::tax_id", "ca::qc::total_income_less_than_total_claim_amount", "ca::qc::workers_compensation_class", "ca::sk::claim_amount", "ca::sk::total_income_less_than_total_claim_amount", "ca::sk::workers_compensation_class", "ca::statutory_holiday_pay", "ca::tax_id", "ca::yt::claim_amount", "ca::yt::total_income_less_than_total_claim_amount", "ca::yt::workers_compensation_class" ] }, { "type": "array", "items": { "type": "string", "enum": [ "ca::ab::claim_amount", "ca::ab::total_income_less_than_total_claim_amount", "ca::ab::workers_compensation_class", "ca::bc::claim_amount", "ca::bc::eht", "ca::bc::total_income_less_than_total_claim_amount", "ca::bc::workers_compensation_class", "ca::cpp_exempt", "ca::ei_exempt", "ca::ei_premium_reduction", "ca::federal::additional_tax", "ca::federal::annual_deduction_at_source", "ca::federal::claim_amount", "ca::federal::commission_expenses", "ca::federal::commission_total_income", "ca::federal::income_tax_rate", "ca::federal::total_income_less_than_total_claim_amount", "ca::federal_oc_surtax_exempt", "ca::first_nation_exemptions", "ca::mb::claim_amount", "ca::mb::eht", "ca::mb::total_income_less_than_total_claim_amount", "ca::mb::workers_compensation_class", "ca::nb::claim_amount", "ca::nb::total_income_less_than_total_claim_amount", "ca::nb::workers_compensation_class", "ca::nl::claim_amount", "ca::nl::eht", "ca::nl::total_income_less_than_total_claim_amount", "ca::nl::workers_compensation_class", "ca::ns::claim_amount", "ca::ns::total_income_less_than_total_claim_amount", "ca::ns::workers_compensation_class", "ca::nt::claim_amount", "ca::nt::territorial_payroll_tax", "ca::nt::total_income_less_than_total_claim_amount", "ca::nt::workers_compensation_class", "ca::nu::claim_amount", "ca::nu::territorial_payroll_tax", "ca::nu::total_income_less_than_total_claim_amount", "ca::nu::workers_compensation_class", "ca::on::claim_amount", "ca::on::dependent_children_credit", "ca::on::eht", "ca::on::impaired_dependants_credit", "ca::on::total_income_less_than_total_claim_amount", "ca::on::workers_compensation_class", "ca::pe::claim_amount", "ca::pe::total_income_less_than_total_claim_amount", "ca::pe::workers_compensation_class", "ca::province_of_employment", "ca::province_of_work", "ca::provincial::income_tax_rate", "ca::qc::additional_tax", "ca::qc::claim_amount", "ca::qc::commission_percentage_taxed", "ca::qc::eht", "ca::qc::income_tax_rate", "ca::qc::qpip_exempt", "ca::qc::qpp_exempt", "ca::qc::tax_id", "ca::qc::total_income_less_than_total_claim_amount", "ca::qc::workers_compensation_class", "ca::sk::claim_amount", "ca::sk::total_income_less_than_total_claim_amount", "ca::sk::workers_compensation_class", "ca::statutory_holiday_pay", "ca::tax_id", "ca::yt::claim_amount", "ca::yt::total_income_less_than_total_claim_amount", "ca::yt::workers_compensation_class" ] } } ] }, "required": false, "description": "Filter to specific Tax Property types. Accepts a comma-separated list." }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "source_tax_property" ] } }, "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 (`\"effective_tax_property\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EffectiveTaxProperty" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With source_tax_property expanded", "properties": { "source_tax_property": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TaxProperty" } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "object": "effective_tax_property", "data": { "type": "ca::province_of_employment", "value": "ca_on", "source_tax_property": { "id": "", "object": "tax_property", "links": { "self": "/tax_properties/" } } } }, { "object": "effective_tax_property", "data": { "type": "ca::province_of_work", "value": "ca_on", "source_tax_property": { "id": "", "object": "tax_property", "links": { "self": "/tax_properties/" } } } } ] } } } } } } }, "/employees/batch/delete": { "post": { "summary": "Batch delete employees", "operationId": "employees-batch-delete", "tags": [ "Employees" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "", "" ] } } } } }, "/employees/batch/upsert": { "post": { "summary": "Batch upsert employees", "operationId": "employees-batch-upsert", "tags": [ "Employees" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "minItems": 1, "maxItems": 100 }, "example": [ { "id": "", "first_name": "Dan", "last_name": "Smith" }, { "first_name": "Jane", "last_name": "Doe", "personal_email": "jane.doe@example.com" } ] } } } } }, "/employees": { "get": { "summary": "List employees", "operationId": "employees-index", "tags": [ "Employees" ], "parameters": [ { "name": "include_archived", "in": "query", "schema": { "type": "boolean" }, "required": false }, { "name": "archived_at", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `archived_at=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `archived_at[gte]=2024-01-01&archived_at[lt]=2024-12-31`" }, { "name": "external_ref", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "search_names", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "first_name", "last_name" ] }, "required": false, "description": "Sort order is specified using the format \n`sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by\nand `direction` is the optional sort direction (`asc` or `desc`)." }, { "name": "has_work_assignment_business_entity_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "has_work_assignment_pay_schedule_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "include_archived_work_assignments", "in": "query", "schema": { "type": "boolean" }, "required": false }, { "name": "has_work_assignment_tag_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "has_work_assignment_tag_group_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "requires_work_assignment_tag_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "requires_work_assignment_tag_group_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "company", "work_assignments" ] } }, "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 (`\"employee\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Employee" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With company expanded", "properties": { "company": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Company" } } } } }, { "type": "object", "title": "With work_assignments expanded", "properties": { "work_assignments": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/WorkAssignment" } } } } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "employee", "data": { "company": { "id": "", "object": "company", "links": { "self": "/companies/" } }, "employee_number": "001", "first_name": "Marley", "last_name": "Prosacco", "middle_initial": null, "personal_email": "marley.prosacco@personal.test", "work_email": "mprosacco@work.test", "address_line_1": "Angelina Ridge", "address_line_2": null, "city": "Toronto", "administrative_area": "ON", "province_code": "ON", "country_code": "CA", "postal_code": "M1M1M1", "sin": "196710156", "sin_last_3": "156", "date_of_birth": "1985-01-20", "warnings": { "object": "list", "data": [ { "object": "warning", "data": { "namespace": "onboarding", "type": "bank_account_doesnt_exists" } } ] }, "external_ref": null, "preferred_locale": null, "archived_at": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employees/" } } ], "links": { "first": "/employees?page=1", "last": "/employees?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create an employee", "operationId": "employees-store", "tags": [ "Employees" ], "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 (`\"employee\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Employee" } } }, "example": { "id": "", "object": "employee", "data": { "company": { "id": "", "object": "company", "links": { "self": "/companies/" } }, "employee_number": "001", "first_name": "Marley", "last_name": "Prosacco", "middle_initial": null, "personal_email": "marley.prosacco@personal.test", "work_email": "mprosacco@work.test", "address_line_1": "Angelina Ridge", "address_line_2": null, "city": "Toronto", "administrative_area": "ON", "province_code": "ON", "country_code": "CA", "postal_code": "M1M1M1", "sin": "196710156", "sin_last_3": "156", "date_of_birth": "1985-01-20", "warnings": { "object": "list", "data": [ { "object": "warning", "data": { "namespace": "onboarding", "type": "bank_account_doesnt_exists" } } ] }, "external_ref": null, "preferred_locale": null, "archived_at": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employees/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "employee_number": { "type": "string", "description": "An optional identifier for the employee within the partner's system, such as a badge number or HR system ID. Distinct from `id` and `external_ref`.", "nullable": true, "maxLength": 40 }, "first_name": { "type": "string", "description": "The employee's first name.", "maxLength": 50 }, "last_name": { "type": "string", "description": "The employee's last name.", "maxLength": 50 }, "middle_initial": { "type": "string", "description": "The employee's middle initial.", "nullable": true, "maxLength": 1 }, "personal_email": { "type": "string", "description": "The employee's personal email address, used as the primary address for payroll communications such as Pay Stub emails." }, "work_email": { "type": "string", "description": "The employee's work email address. Used for payroll communications if `personal_email` is not set." }, "address_line_1": { "type": "string", "description": "The first line of the employee's mailing address. Canada Revenue Agency forms (T4, RL-1) truncate this to the length those forms allow.", "nullable": true }, "address_line_2": { "type": "string", "description": "The second line of the employee's mailing address. Canada Revenue Agency forms (T4, RL-1) truncate this to the length those forms allow.", "nullable": true }, "city": { "type": "string", "description": "The city of the employee's mailing address.", "nullable": true }, "administrative_area": { "type": "string", "description": "The region of the employee's mailing address \u2014 the province, state, or county, depending on the country. For Canadian employees this is the Province of Residence (POR), not the Province of Employment (POE) or Province of Work (POW). POE and POW are configured via the Work Assignment's Tax Properties.", "nullable": true, "maxLength": 255 }, "province_code": { "type": "string", "description": "This attribute is deprecated and will be removed.\n\nA deprecated alias of `administrative_area` that mirrors its value. Use `administrative_area` instead.\n\nIn Canada, must be an uppercase 2-letter province code: `AB`, `BC`, `MB`, `NB`, `NL`, `NS`, `NT`, `NU`, `ON`, `PE`, `QC`, `SK`, `YT`", "nullable": true, "deprecated": true }, "country_code": { "type": "string", "description": "The country code for the employee's mailing address.", "enum": [ "CA", "GB" ] }, "postal_code": { "type": "string", "description": "The postal code for the employee's mailing address.", "nullable": true, "maxLength": 10 }, "sin": { "type": "string", "description": "The employee's Social Insurance Number (SIN), used for tax reporting. 9 digits, sent as a string. Spaces and dashes are stripped before validation. The first digit cannot be 0 or 8, and the number must pass the Luhn checksum. Required before year-end forms can be filed correctly, but not required to create the employee or run a payroll." }, "date_of_birth": { "type": "string", "description": "The employee's date of birth.", "format": "date" }, "external_ref": { "type": "string", "maxLength": 255 }, "preferred_locale": { "type": "string", "description": "The locale used for payroll communications sent to this employee, such as Pay Stub emails. If not set, the Company's locale is used.", "enum": [ "en", "fr" ] }, "archived_at": { "type": "string", "description": "The date the employee was archived. Archiving an employee also archives all Work Assignments that are not already archived. Archived employees do not appear in active listings.", "format": "date" } } }, { "type": "object", "required": [ "first_name", "last_name" ] } ] }, "example": { "employee_number": "001", "first_name": "Marley", "last_name": "Prosacco", "personal_email": "marley.prosacco@personal.test", "work_email": "mprosacco@work.test", "address_line_1": "Angelina Ridge", "city": "Toronto", "administrative_area": "ON", "country_code": "CA", "postal_code": "M1M1M1", "sin": "196710156", "date_of_birth": "1985-01-20" } } } } } }, "/employee_benefits/batch/delete": { "post": { "summary": "Batch delete employee benefits", "operationId": "employee-benefits-batch-delete", "tags": [ "Employee Benefits" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "", "" ] } } } } }, "/employee_benefits/batch/upsert": { "post": { "summary": "Batch upsert employee benefits", "operationId": "employee-benefits-batch-upsert", "tags": [ "Employee Benefits" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "minItems": 1, "maxItems": 100 }, "example": [ { "id": "", "amount": 50, "effective_from": "2026-01-01" }, { "work_assignment_id": "", "employee_benefit_type": "dental", "amount": 35, "amount_type": "fixed", "frequency": "per_payroll", "effective_from": "2026-01-01" } ] } } } } }, "/employee_benefits/bulk/create": { "post": { "summary": "Bulk create employee benefits", "operationId": "employee-benefits-bulk-create", "tags": [ "Employee Benefits" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } } } }, "/employee_benefits/bulk/create/scope": { "post": { "summary": "Show bulk create scope for employee benefits", "operationId": "employee-benefits-bulk-create-scope", "tags": [ "Employee Benefits" ], "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 } } } } } }, "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" } } } } } } }, "/employee_benefits/bulk/delete": { "post": { "summary": "Bulk delete employee benefits", "operationId": "employee-benefits-bulk-delete", "tags": [ "Employee Benefits" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this benefit is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this benefit is no longer applied. `null` if the benefit applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/employee_benefits/bulk/delete/scope": { "post": { "summary": "Show bulk delete scope for employee benefits", "operationId": "employee-benefits-bulk-delete-scope", "tags": [ "Employee Benefits" ], "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 (`\"employee_benefit\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployeeBenefit" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "employee_benefit", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "business_preset": null, "employee_benefit_type": { "id": "", "object": "employee_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employee_benefit_types/health" } }, "employer_benefit": null, "title": null, "title_translations": null, "title_translated": null, "income_basis": "regular_earnings", "income_includes": [], "max_annual_contribution_basis": "this_benefit", "apply_sales_tax": true, "remittance_account_id": null, "remittance_account": null, "amount": 35, "amount_type": "fixed", "coverage_multiplier": 1, "max_annual_contribution": null, "frequency": "per_payroll", "date_basis": null, "pay_period_cadence": null, "effective_from": "2026-01-01", "effective_to": 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": "/employee_benefits/" } } ], "links": { "first": "http://localhost/employee_benefits/bulk/delete/scope?page=1", "last": "http://localhost/employee_benefits/bulk/delete/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this benefit is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this benefit is no longer applied. `null` if the benefit applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/employee_benefits/bulk/update": { "post": { "summary": "Bulk update employee benefits", "operationId": "employee-benefits-bulk-update", "tags": [ "Employee Benefits" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this benefit is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this benefit is no longer applied. `null` if the benefit applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/employee_benefits/bulk/update/scope": { "post": { "summary": "Show bulk update scope for employee benefits", "operationId": "employee-benefits-bulk-update-scope", "tags": [ "Employee Benefits" ], "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 (`\"employee_benefit\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployeeBenefit" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "employee_benefit", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "business_preset": null, "employee_benefit_type": { "id": "", "object": "employee_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employee_benefit_types/health" } }, "employer_benefit": null, "title": null, "title_translations": null, "title_translated": null, "income_basis": "regular_earnings", "income_includes": [], "max_annual_contribution_basis": "this_benefit", "apply_sales_tax": true, "remittance_account_id": null, "remittance_account": null, "amount": 35, "amount_type": "fixed", "coverage_multiplier": 1, "max_annual_contribution": null, "frequency": "per_payroll", "date_basis": null, "pay_period_cadence": null, "effective_from": "2026-01-01", "effective_to": 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": "/employee_benefits/" } } ], "links": { "first": "http://localhost/employee_benefits/bulk/update/scope?page=1", "last": "http://localhost/employee_benefits/bulk/update/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this benefit is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this benefit is no longer applied. `null` if the benefit applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/employee_benefits": { "get": { "summary": "List employee benefits", "operationId": "employee-benefits-index", "tags": [ "Employee Benefits" ], "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": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "non_group_long_term_disability", "non_group_short_term_disability", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_rrsp_non_periodic", "pension_unregistered_prpp", "pension_vrsp", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "virtual_health_service", "wellness_spending_account" ] }, { "type": "array", "items": { "type": "string", "enum": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "non_group_long_term_disability", "non_group_short_term_disability", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_rrsp_non_periodic", "pension_unregistered_prpp", "pension_vrsp", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "virtual_health_service", "wellness_spending_account" ] } } ] }, "required": false }, { "name": "exclude_types", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "non_group_long_term_disability", "non_group_short_term_disability", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_rrsp_non_periodic", "pension_unregistered_prpp", "pension_vrsp", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "virtual_health_service", "wellness_spending_account" ] }, { "type": "array", "items": { "type": "string", "enum": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "non_group_long_term_disability", "non_group_short_term_disability", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_rrsp_non_periodic", "pension_unregistered_prpp", "pension_vrsp", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "virtual_health_service", "wellness_spending_account" ] } } ] }, "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:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `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:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `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 \n`sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by\nand `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": "requires_tag_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "requires_tag_group_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "employer_benefit", "expense_accounting_code", "liability_accounting_code", "remittance_account", "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 (`\"employee_benefit\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EmployeeBenefit" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With employer_benefit expanded", "properties": { "employer_benefit": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EmployerBenefit" } } } } }, { "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 remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } }, { "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": "employee_benefit", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "business_preset": null, "employee_benefit_type": { "id": "", "object": "employee_benefit_type", "data": { "type": "dental", "label": "Dental" }, "links": { "self": "/employee_benefit_types/dental" } }, "employer_benefit": null, "title": "Dental", "title_translations": { "en": "Dental", "fr": "Assurance dentaire" }, "title_translated": "Dental", "income_basis": "regular_earnings", "income_includes": [], "max_annual_contribution_basis": "this_benefit", "apply_sales_tax": false, "remittance_account_id": null, "remittance_account": null, "amount": 325.5, "amount_type": "fixed", "coverage_multiplier": 1, "max_annual_contribution": 2500.5, "frequency": "per_month", "date_basis": "by_period_start_date", "pay_period_cadence": [ 1 ], "effective_from": "2026-01-01", "effective_to": "2026-12-31", "expense_accounting_code": null, "liability_accounting_code": null, "external_ref": "01KG003XG877R33YKHA40HJP84", "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employee_benefits/" } }, { "id": "", "object": "employee_benefit", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "business_preset": null, "employee_benefit_type": { "id": "", "object": "employee_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employee_benefit_types/health" } }, "employer_benefit": null, "title": "Health", "title_translations": { "en": "Health", "fr": "Assurance sant\u00e9" }, "title_translated": "Health", "income_basis": "regular_earnings", "income_includes": [ { "type": "earning", "subtype": "commission" } ], "max_annual_contribution_basis": "all_line_items_of_type", "apply_sales_tax": true, "remittance_account_id": null, "remittance_account": null, "amount": 3.5, "amount_type": "percent", "coverage_multiplier": 1.5, "max_annual_contribution": 325.5, "frequency": "per_payroll", "date_basis": null, "pay_period_cadence": null, "effective_from": "2026-01-01", "effective_to": "2026-12-31", "expense_accounting_code": null, "liability_accounting_code": null, "external_ref": "01KG003F6KKVMV7P23FYT4HK59", "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employee_benefits/" } } ], "links": { "first": "/employee_benefits?work_assignment_id=&page=1", "last": "/employee_benefits?work_assignment_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 2, "has_more": false } } } } } } }, "post": { "summary": "Create an employee benefit", "operationId": "employee-benefits-store", "tags": [ "Employee Benefits" ], "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 (`\"employee_benefit\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployeeBenefit" } } }, "example": { "id": "", "object": "employee_benefit", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "business_preset": null, "employee_benefit_type": { "id": "", "object": "employee_benefit_type", "data": { "type": "dental", "label": "Dental" }, "links": { "self": "/employee_benefit_types/dental" } }, "employer_benefit": null, "title": "Dental", "title_translations": { "en": "Dental", "fr": "Assurance dentaire" }, "title_translated": "Dental", "income_basis": "regular_earnings", "income_includes": [], "max_annual_contribution_basis": "this_benefit", "apply_sales_tax": false, "remittance_account_id": null, "remittance_account": null, "amount": 325.5, "amount_type": "fixed", "coverage_multiplier": 1, "max_annual_contribution": 2500.5, "frequency": "per_month", "date_basis": "by_period_start_date", "pay_period_cadence": [ 1 ], "effective_from": "2026-01-01", "effective_to": "2026-12-31", "expense_accounting_code": null, "liability_accounting_code": null, "external_ref": "01KG003XG877R33YKHA40HJP84", "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employee_benefits/" } } } } } }, "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" }, "employee_benefit_type": { "type": "string", "description": "The type of employee benefit, which determines how it is taxed and reported.\n\nMust be present when `business_preset_id` is either empty or not set.", "enum": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "non_group_long_term_disability", "non_group_short_term_disability", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_rrsp_non_periodic", "pension_unregistered_prpp", "pension_vrsp", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "virtual_health_service", "wellness_spending_account" ] }, "employer_benefit_id": { "type": "string" }, "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" ] }, "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", "minimum": 0 }, "amount_type": { "type": "string", "description": "Whether `amount` is a fixed dollar value (`fixed`) or a percentage of the income basis (`percent`).", "enum": [ "fixed", "percent" ] }, "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": "array", "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`.", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "allowance", "earning", "reimbursement" ] }, "subtype": { "type": "string" } } } }, "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.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "max_annual_contribution_basis": { "type": "string", "description": "Which earlier contributions count toward `max_annual_contribution`. `this_benefit` counts only the contributions on line items created by this benefit earlier in the year. `all_line_items_of_type` counts every contribution of the same type on the Work Assignment earlier in the year, including those created by other benefits and those added directly to a Pay Stub.", "enum": [ "all_line_items_of_type", "this_benefit" ] }, "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", "minimum": 0, "maximum": 100 }, "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.", "format": "date" }, "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." }, "expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string" }, "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 }, "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` benefits.", "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` benefits.", "items": { "type": "integer" }, "minItems": 1 } } }, { "type": "object", "required": [ "work_assignment_id", "frequency", "amount", "amount_type", "effective_from" ] } ] }, "example": { "work_assignment_id": "", "employee_benefit_type": "dental", "frequency": "per_month", "amount": "325.5", "amount_type": "fixed", "income_basis": "regular_earnings", "max_annual_contribution": "2500.5", "max_annual_contribution_basis": "this_benefit", "coverage_multiplier": "1", "effective_from": "2026-01-01", "effective_to": "2026-12-31", "apply_sales_tax": false, "title": "Dental", "title_translations": { "en": "Dental", "fr": "Assurance dentaire" }, "external_ref": "01KG003XG877R33YKHA40HJP84", "tag_assignment": { "unit": "percentage", "tag_allocations": [ { "tags": [ "" ], "value": 100 } ] }, "date_basis": "by_period_start_date", "pay_period_cadence": [ 1 ] } } } } } }, "/employee_benefits/search": { "post": { "summary": "Search employee benefits", "description": "Search benefits under the given business entity, returning the same set the equivalent bulk update/delete operation would target with this body.", "operationId": "employee-benefits-search", "tags": [ "Employee Benefits" ], "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 (`\"employee_benefit\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployeeBenefit" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "employee_benefit", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "business_preset": null, "employee_benefit_type": { "id": "", "object": "employee_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employee_benefit_types/health" } }, "employer_benefit": null, "title": null, "title_translations": null, "title_translated": null, "income_basis": "regular_earnings", "income_includes": [], "max_annual_contribution_basis": "this_benefit", "apply_sales_tax": true, "remittance_account_id": null, "remittance_account": null, "amount": 35, "amount_type": "fixed", "coverage_multiplier": 1, "max_annual_contribution": null, "frequency": "per_payroll", "date_basis": null, "pay_period_cadence": null, "effective_from": "2026-01-01", "effective_to": 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": "/employee_benefits/" } } ], "links": { "first": "http://localhost/employee_benefits/search?page=1", "last": "http://localhost/employee_benefits/search?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this benefit is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this benefit is no longer applied. `null` if the benefit applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/employee_benefit_line_items/batch/delete": { "post": { "summary": "Batch delete employee benefit line items", "operationId": "employee-benefit-line-items-batch-delete", "tags": [ "Employee Benefit Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "", "" ] } } } } }, "/employee_benefit_line_items/batch/upsert": { "post": { "summary": "Batch upsert employee benefit line items", "operationId": "employee-benefit-line-items-batch-upsert", "tags": [ "Employee Benefit Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "minItems": 1, "maxItems": 100 }, "example": [ { "id": "", "custom_amount": 50 }, { "pay_stub_id": "", "employee_benefit_type": "dental", "custom_amount": 35 } ] } } } } }, "/employee_benefit_line_items/bulk/create": { "post": { "summary": "Bulk create employee benefit line items", "operationId": "employee-benefit-line-items-bulk-create", "tags": [ "Employee Benefit Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/employee_benefit_line_items/bulk/create/scope": { "post": { "summary": "Show bulk create scope for employee benefit line items", "operationId": "employee-benefit-line-items-bulk-create-scope", "tags": [ "Employee Benefit Line Items" ], "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 (`\"pay_stub\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployeeBenefitLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "pay_stub", "data": { "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "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, "apply_standard_tax_reductions": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_stubs/" } } ], "links": { "first": "http://localhost/employee_benefit_line_items/bulk/create/scope?page=1", "last": "http://localhost/employee_benefit_line_items/bulk/create/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/employee_benefit_line_items/bulk/delete": { "post": { "summary": "Bulk delete employee benefit line items", "operationId": "employee-benefit-line-items-bulk-delete", "tags": [ "Employee Benefit Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/employee_benefit_line_items/bulk/delete/scope": { "post": { "summary": "Show bulk delete scope for employee benefit line items", "operationId": "employee-benefit-line-items-bulk-delete-scope", "tags": [ "Employee Benefit Line Items" ], "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 (`\"employee_benefit_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployeeBenefitLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "employee_benefit_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employee_benefit", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "employee_benefit_type": { "id": "", "object": "employee_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employee_benefit_types/health" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account_id": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employee_benefit_line_items/" } } ], "links": { "first": "http://localhost/employee_benefit_line_items/bulk/delete/scope?page=1", "last": "http://localhost/employee_benefit_line_items/bulk/delete/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/employee_benefit_line_items/bulk/update": { "post": { "summary": "Bulk update employee benefit line items", "operationId": "employee-benefit-line-items-bulk-update", "tags": [ "Employee Benefit Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/employee_benefit_line_items/bulk/update/scope": { "post": { "summary": "Show bulk update scope for employee benefit line items", "operationId": "employee-benefit-line-items-bulk-update-scope", "tags": [ "Employee Benefit Line Items" ], "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 (`\"employee_benefit_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployeeBenefitLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "employee_benefit_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employee_benefit", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "employee_benefit_type": { "id": "", "object": "employee_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employee_benefit_types/health" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account_id": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employee_benefit_line_items/" } } ], "links": { "first": "http://localhost/employee_benefit_line_items/bulk/update/scope?page=1", "last": "http://localhost/employee_benefit_line_items/bulk/update/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/employee_benefit_line_items": { "get": { "summary": "List employee benefit line items", "operationId": "employee-benefit-line-items-index", "tags": [ "Employee Benefit Line Items" ], "parameters": [ { "name": "pay_stub_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on the specified Pay Stub." }, { "name": "payroll_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on Pay Stubs on the specified Payroll." }, { "name": "payroll_status", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] }, { "type": "array", "items": { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] } } ] }, "required": false }, { "name": "payroll_type", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] }, { "type": "array", "items": { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] } } ] }, "required": false }, { "name": "payroll_period_start", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_period_start=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_period_start[gte]=2024-01-01&payroll_period_start[lt]=2024-12-31`" }, { "name": "payroll_period_end", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_period_end=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_period_end[gte]=2024-01-01&payroll_period_end[lt]=2024-12-31`" }, { "name": "payroll_pay_date", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_pay_date=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_pay_date[gte]=2024-01-01&payroll_pay_date[lt]=2024-12-31`" }, { "name": "pay_schedule_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on Pay Stubs on the specified Pay Schedule." }, { "name": "work_assignment_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on Pay Stubs for the specified Work Assignment." }, { "name": "employee_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on pay stubs for the specified Employee." }, { "name": "contractor_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on pay stubs for the specified Contractor." }, { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on Pay Stubs under the specified Business Entity." }, { "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": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "non_group_long_term_disability", "non_group_short_term_disability", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_rrsp_non_periodic", "pension_unregistered_prpp", "pension_vrsp", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "virtual_health_service", "wellness_spending_account" ] }, { "type": "array", "items": { "type": "string", "enum": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "non_group_long_term_disability", "non_group_short_term_disability", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_rrsp_non_periodic", "pension_unregistered_prpp", "pension_vrsp", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "virtual_health_service", "wellness_spending_account" ] } } ] }, "required": false, "description": "Only return line items with the specified types." }, { "name": "exclude_types", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "non_group_long_term_disability", "non_group_short_term_disability", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_rrsp_non_periodic", "pension_unregistered_prpp", "pension_vrsp", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "virtual_health_service", "wellness_spending_account" ] }, { "type": "array", "items": { "type": "string", "enum": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "non_group_long_term_disability", "non_group_short_term_disability", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_rrsp_non_periodic", "pension_unregistered_prpp", "pension_vrsp", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "virtual_health_service", "wellness_spending_account" ] } } ] }, "required": false, "description": "Only return line items _without_ the specified types." }, { "name": "external_ref", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "custom_expense_accounting_code", "custom_liability_accounting_code", "custom_tag_assignment", "expense_accounting_code", "liability_accounting_code", "managed_expense_accounting_code", "managed_liability_accounting_code", "managed_tag_assignment", "pay_stub", "recurrence", "remittance_account", "source_adjustment", "tag_assignment", "tag_assignment_amounts" ] } }, "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 (`\"employee_benefit_line_item\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EmployeeBenefitLineItem" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With pay_stub expanded", "properties": { "pay_stub": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayStub" } } } } }, { "type": "object", "title": "With recurrence expanded", "properties": { "recurrence": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Recurrence" } } } } }, { "type": "object", "title": "With remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } }, { "type": "object", "title": "With business_preset expanded", "properties": { "business_preset": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessPreset" } } } } }, { "type": "object", "title": "With source_adjustment expanded", "properties": { "source_adjustment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SourceAdjustment" } } } } }, { "type": "object", "title": "With expense_accounting_code expanded", "properties": { "expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ExpenseAccountingCode" } } } } }, { "type": "object", "title": "With managed_expense_accounting_code expanded", "properties": { "managed_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedExpenseAccountingCode" } } } } }, { "type": "object", "title": "With custom_expense_accounting_code expanded", "properties": { "custom_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomExpenseAccountingCode" } } } } }, { "type": "object", "title": "With liability_accounting_code expanded", "properties": { "liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LiabilityAccountingCode" } } } } }, { "type": "object", "title": "With managed_liability_accounting_code expanded", "properties": { "managed_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedLiabilityAccountingCode" } } } } }, { "type": "object", "title": "With custom_liability_accounting_code expanded", "properties": { "custom_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomLiabilityAccountingCode" } } } } }, { "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" } } } } }, { "type": "object", "title": "With managed_tag_assignment expanded", "properties": { "managed_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/ManagedTagAssignment" } } } } }, { "type": "object", "title": "With custom_tag_assignment expanded", "properties": { "custom_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/CustomTagAssignment" } } } } }, { "type": "object", "title": "With tag_assignment_amounts expanded", "properties": { "tag_assignment_amounts": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/TagAssignmentAmount" } } } } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "employee_benefit_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employee_benefit", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "employee_benefit_type": { "id": "", "object": "employee_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employee_benefit_types/health" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account_id": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employee_benefit_line_items/" } } ], "links": { "first": "/employee_benefit_line_items?pay_stub_id=&page=1", "last": "/employee_benefit_line_items?pay_stub_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create an employee benefit line item", "operationId": "employee-benefit-line-items-store", "tags": [ "Employee Benefit Line Items" ], "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 (`\"employee_benefit_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployeeBenefitLineItem" } } }, "example": { "id": "", "object": "employee_benefit_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employee_benefit", "is_managed": false, "amount": 0, "custom_amount": null, "managed_amount": null, "employee_benefit_type": { "id": "", "object": "employee_benefit_type", "data": { "type": "dental", "label": "Dental" }, "links": { "self": "/employee_benefit_types/dental" } }, "recurrence": null, "title": "Dental", "title_translations": null, "title_translated": "Dental", "remittance_account_id": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employee_benefit_line_items/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "pay_stub_id": { "type": "string" }, "business_preset_id": { "type": "string" }, "employee_benefit_type": { "type": "string", "description": "The type of Employee Benefit for this line item.\n\nMust be present when `business_preset_id` is either empty or not set.", "enum": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "non_group_long_term_disability", "non_group_short_term_disability", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_rrsp_non_periodic", "pension_unregistered_prpp", "pension_vrsp", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "virtual_health_service", "wellness_spending_account" ] }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.", "format": "decimal", "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 }, "remittance_account_id": { "type": "string" }, "expense_accounting_code_id": { "type": "string" }, "custom_expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string" }, "custom_liability_accounting_code_id": { "type": "string" }, "component_settings": { "type": "object", "properties": { "attributes_locked": { "type": "boolean" } } }, "external_ref": { "type": "string", "maxLength": 255 }, "custom_tag_assignment": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "amount", "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 } } } } } } } }, { "type": "object", "required": [ "pay_stub_id" ] } ] }, "example": { "pay_stub_id": "", "employee_benefit_type": "dental", "title": "Dental", "custom_tag_assignment": { "unit": "percentage", "tag_allocations": [ { "tags": [ "" ], "value": 100 } ] } } } } } } }, "/employee_benefit_line_items/search": { "post": { "summary": "Search employee benefit line items", "description": "Search line items under the given payroll, returning the same set the equivalent bulk update/delete operation would target with this body.", "operationId": "employee-benefit-line-items-search", "tags": [ "Employee Benefit Line Items" ], "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 (`\"employee_benefit_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployeeBenefitLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "employee_benefit_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employee_benefit", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "employee_benefit_type": { "id": "", "object": "employee_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employee_benefit_types/health" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account_id": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employee_benefit_line_items/" } } ], "links": { "first": "http://localhost/employee_benefit_line_items/search?page=1", "last": "http://localhost/employee_benefit_line_items/search?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/employee_benefit_types": { "get": { "summary": "List employee benefit types", "operationId": "employee-benefit-types-index", "tags": [ "Employee Benefit Types" ], "parameters": [ { "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)." }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Comma-separated list of type identifiers to return." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Case-insensitive substring match against the human-readable label, in any supported locale." } ], "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 (`\"employee_benefit_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployeeBenefitType" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "employee_benefit_type", "data": { "type": "accident_insurance_plan", "label": "Accidental Death and Dismemberment", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/employee_benefit_types/accident_insurance_plan" } }, { "id": "", "object": "employee_benefit_type", "data": { "type": "critical_illness", "label": "Critical Illness", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/employee_benefit_types/critical_illness" } }, { "id": "", "object": "employee_benefit_type", "data": { "type": "debt_relief", "label": "Debt Relief", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/employee_benefit_types/debt_relief" } }, { "id": "", "object": "employee_benefit_type", "data": { "type": "dental", "label": "Dental", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "85", "help_text": "Employee Paid Premiums for Private Health Services Plans" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "235", "help_text": null } ] ] } ] }, "links": { "self": "/employee_benefit_types/dental" } }, { "id": "", "object": "employee_benefit_type", "data": { "type": "employee_assistance_program", "label": "Employee Assistance Program", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "85", "help_text": "Employee Paid Premiums for Private Health Services Plans" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "235", "help_text": null } ] ] } ] }, "links": { "self": "/employee_benefit_types/employee_assistance_program" } }, { "id": "", "object": "employee_benefit_type", "data": { "type": "fondaction", "label": "Fondactions", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Qu\u00e9bec credit.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_oc", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null } ] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/employee_benefit_types/fondaction" } }, { "id": "", "object": "employee_benefit_type", "data": { "type": "fondaction_rrsp", "label": "Fondactions (RRSP)", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Qu\u00e9bec credit.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_oc", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null } ] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/employee_benefit_types/fondaction_rrsp" } }, { "id": "", "object": "employee_benefit_type", "data": { "type": "fonds_solidarite_ftq", "label": "Fonds de solidarit\u00e9 FTQ", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Qu\u00e9bec credit.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_oc", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null } ] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/employee_benefit_types/fonds_solidarite_ftq" } }, { "id": "", "object": "employee_benefit_type", "data": { "type": "fonds_solidarite_ftq_rrsp", "label": "Fonds de solidarit\u00e9 FTQ (RRSP)", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Qu\u00e9bec credit.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_oc", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null } ] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/employee_benefit_types/fonds_solidarite_ftq_rrsp" } }, { "id": "", "object": "employee_benefit_type", "data": { "type": "group_dependent_life_insurance", "label": "Group Dependent Life Insurance", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/employee_benefit_types/group_dependent_life_insurance" } }, { "id": "", "object": "employee_benefit_type", "data": { "type": "group_term_life_insurance", "label": "Group Term Life Insurance", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/employee_benefit_types/group_term_life_insurance" } }, { "id": "", "object": "employee_benefit_type", "data": { "type": "health", "label": "Health", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "85", "help_text": "Employee Paid Premiums for Private Health Services Plans" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "235", "help_text": null } ] ] } ] }, "links": { "self": "/employee_benefit_types/health" } }, { "id": "", "object": "employee_benefit_type", "data": { "type": "health_spending_account", "label": "Health Spending Account (HSA)", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/employee_benefit_types/health_spending_account" } }, { "id": "", "object": "employee_benefit_type", "data": { "type": "long_term_disability", "label": "Long-Term Disability (Group Plan)", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/employee_benefit_types/long_term_disability" } }, { "id": "", "object": "employee_benefit_type", "data": { "type": "non_group_long_term_disability", "label": "Long-Term Disability (Non-Group Plan)", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/employee_benefit_types/non_group_long_term_disability" } } ], "links": { "first": "/employee_benefit_types?features=ca&page=1", "last": "/employee_benefit_types?features=ca&page=3", "prev": null, "next": "/employee_benefit_types?features=ca&page=2" }, "meta": { "current_page": 1, "last_page": 3, "per_page": 15, "total": 31, "has_more": true } } } } } } } }, "/employer_benefits/batch/delete": { "post": { "summary": "Batch delete employer benefits", "operationId": "employer-benefits-batch-delete", "tags": [ "Employer Benefits" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "", "" ] } } } } }, "/employer_benefits/batch/upsert": { "post": { "summary": "Batch upsert employer benefits", "operationId": "employer-benefits-batch-upsert", "tags": [ "Employer Benefits" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "minItems": 1, "maxItems": 100 }, "example": [ { "id": "", "amount": 100, "effective_from": "2026-01-01" }, { "work_assignment_id": "", "employer_benefit_type": "dental", "amount": 75, "amount_type": "fixed", "frequency": "per_payroll", "effective_from": "2026-01-01" } ] } } } } }, "/employer_benefits/bulk/create": { "post": { "summary": "Bulk create employer benefits", "operationId": "employer-benefits-bulk-create", "tags": [ "Employer Benefits" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } } } }, "/employer_benefits/bulk/create/scope": { "post": { "summary": "Show bulk create scope for employer benefits", "operationId": "employer-benefits-bulk-create-scope", "tags": [ "Employer Benefits" ], "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/EmployerBenefit" } } } } } }, "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/employer_benefits/bulk/create/scope?page=1", "last": "http://localhost/employer_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 } } } } } }, "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" } } } } } } }, "/employer_benefits/bulk/delete": { "post": { "summary": "Bulk delete employer benefits", "operationId": "employer-benefits-bulk-delete", "tags": [ "Employer Benefits" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this benefit is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this benefit is no longer applied. `null` if the benefit applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/employer_benefits/bulk/delete/scope": { "post": { "summary": "Show bulk delete scope for employer benefits", "operationId": "employer-benefits-bulk-delete-scope", "tags": [ "Employer Benefits" ], "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 (`\"employer_benefit\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerBenefit" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "employer_benefit", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "business_preset": null, "employer_benefit_type": { "id": "", "object": "employer_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employer_benefit_types/health" } }, "employee_benefit": null, "title": null, "title_translations": null, "title_translated": null, "apply_sales_tax": true, "income_basis": "regular_earnings", "income_includes": [], "remittance_account_id": null, "remittance_account": null, "amount": 35, "amount_type": "fixed", "coverage_multiplier": 1, "max_annual_contribution": null, "max_annual_contribution_basis": "this_benefit", "frequency": "per_payroll", "date_basis": null, "pay_period_cadence": null, "effective_from": "2026-01-01", "effective_to": 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": "/employer_benefits/" } } ], "links": { "first": "http://localhost/employer_benefits/bulk/delete/scope?page=1", "last": "http://localhost/employer_benefits/bulk/delete/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this benefit is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this benefit is no longer applied. `null` if the benefit applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/employer_benefits/bulk/update": { "post": { "summary": "Bulk update employer benefits", "operationId": "employer-benefits-bulk-update", "tags": [ "Employer Benefits" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this benefit is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this benefit is no longer applied. `null` if the benefit applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/employer_benefits/bulk/update/scope": { "post": { "summary": "Show bulk update scope for employer benefits", "operationId": "employer-benefits-bulk-update-scope", "tags": [ "Employer Benefits" ], "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 (`\"employer_benefit\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerBenefit" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "employer_benefit", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "business_preset": null, "employer_benefit_type": { "id": "", "object": "employer_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employer_benefit_types/health" } }, "employee_benefit": null, "title": null, "title_translations": null, "title_translated": null, "apply_sales_tax": true, "income_basis": "regular_earnings", "income_includes": [], "remittance_account_id": null, "remittance_account": null, "amount": 35, "amount_type": "fixed", "coverage_multiplier": 1, "max_annual_contribution": null, "max_annual_contribution_basis": "this_benefit", "frequency": "per_payroll", "date_basis": null, "pay_period_cadence": null, "effective_from": "2026-01-01", "effective_to": 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": "/employer_benefits/" } } ], "links": { "first": "http://localhost/employer_benefits/bulk/update/scope?page=1", "last": "http://localhost/employer_benefits/bulk/update/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this benefit is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this benefit is no longer applied. `null` if the benefit applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/employer_benefits": { "get": { "summary": "List employer benefits", "operationId": "employer-benefits-index", "tags": [ "Employer Benefits" ], "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": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "gift_near_cash", "gift_non_cash_non_taxable", "gift_non_cash_taxable", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "meals_subsidized_non_cash", "non_group_long_term_disability", "non_group_short_term_disability", "parking", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_unregistered_prpp", "pension_vrsp", "professional_membership", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "transit_pass", "transportation_to_from_work", "vehicle_employer_provided", "virtual_health_service", "wellness_spending_account" ] }, { "type": "array", "items": { "type": "string", "enum": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "gift_near_cash", "gift_non_cash_non_taxable", "gift_non_cash_taxable", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "meals_subsidized_non_cash", "non_group_long_term_disability", "non_group_short_term_disability", "parking", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_unregistered_prpp", "pension_vrsp", "professional_membership", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "transit_pass", "transportation_to_from_work", "vehicle_employer_provided", "virtual_health_service", "wellness_spending_account" ] } } ] }, "required": false }, { "name": "exclude_types", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "gift_near_cash", "gift_non_cash_non_taxable", "gift_non_cash_taxable", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "meals_subsidized_non_cash", "non_group_long_term_disability", "non_group_short_term_disability", "parking", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_unregistered_prpp", "pension_vrsp", "professional_membership", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "transit_pass", "transportation_to_from_work", "vehicle_employer_provided", "virtual_health_service", "wellness_spending_account" ] }, { "type": "array", "items": { "type": "string", "enum": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "gift_near_cash", "gift_non_cash_non_taxable", "gift_non_cash_taxable", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "meals_subsidized_non_cash", "non_group_long_term_disability", "non_group_short_term_disability", "parking", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_unregistered_prpp", "pension_vrsp", "professional_membership", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "transit_pass", "transportation_to_from_work", "vehicle_employer_provided", "virtual_health_service", "wellness_spending_account" ] } } ] }, "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:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `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:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `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 \n`sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by\nand `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": "requires_tag_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "requires_tag_group_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "employee_benefit", "expense_accounting_code", "liability_accounting_code", "remittance_account", "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 (`\"employer_benefit\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EmployerBenefit" } ], "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 remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } }, { "type": "object", "title": "With employee_benefit expanded", "properties": { "employee_benefit": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EmployeeBenefit" } } } } }, { "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": "employer_benefit", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "business_preset": null, "employer_benefit_type": { "id": "", "object": "employer_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employer_benefit_types/health" } }, "employee_benefit": null, "title": null, "title_translations": null, "title_translated": null, "apply_sales_tax": true, "income_basis": "regular_earnings", "income_includes": [], "remittance_account_id": null, "remittance_account": null, "amount": 50, "amount_type": "fixed", "coverage_multiplier": 1, "max_annual_contribution": null, "max_annual_contribution_basis": "this_benefit", "frequency": "per_payroll", "date_basis": null, "pay_period_cadence": null, "effective_from": "2026-01-01", "effective_to": 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": "/employer_benefits/" } } ], "links": { "first": "/employer_benefits?work_assignment_id=&page=1", "last": "/employer_benefits?work_assignment_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create an employer benefit", "operationId": "employer-benefits-store", "tags": [ "Employer Benefits" ], "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 (`\"employer_benefit\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerBenefit" } } }, "example": { "id": "", "object": "employer_benefit", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "business_preset": null, "employer_benefit_type": { "id": "", "object": "employer_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employer_benefit_types/health" } }, "employee_benefit": null, "title": "Health Benefit", "title_translations": null, "title_translated": "Health Benefit", "apply_sales_tax": false, "income_basis": "regular_earnings", "income_includes": [], "remittance_account_id": null, "remittance_account": null, "amount": 50, "amount_type": "fixed", "coverage_multiplier": 1, "max_annual_contribution": null, "max_annual_contribution_basis": "this_benefit", "frequency": "per_payroll", "date_basis": null, "pay_period_cadence": null, "effective_from": "2026-01-01", "effective_to": 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": "/employer_benefits/" } } } } } }, "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" }, "employer_benefit_type": { "type": "string", "description": "The type of employer benefit, which determines how it is categorized and reported.\n\nMust be present when `business_preset_id` is either empty or not set.", "enum": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "gift_near_cash", "gift_non_cash_non_taxable", "gift_non_cash_taxable", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "meals_subsidized_non_cash", "non_group_long_term_disability", "non_group_short_term_disability", "parking", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_unregistered_prpp", "pension_vrsp", "professional_membership", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "transit_pass", "transportation_to_from_work", "vehicle_employer_provided", "virtual_health_service", "wellness_spending_account" ] }, "employee_benefit_id": { "type": "string" }, "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" ] }, "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", "minimum": 0 }, "amount_type": { "type": "string", "description": "Whether `amount` is a fixed dollar value (`fixed`) or a percentage of the income basis (`percent`).", "enum": [ "fixed", "percent" ] }, "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": "array", "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`.", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "allowance", "earning", "reimbursement" ] }, "subtype": { "type": "string" } } } }, "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.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "max_annual_contribution_basis": { "type": "string", "description": "Which earlier contributions count toward `max_annual_contribution`. `this_benefit` counts only the contributions on line items created by this benefit earlier in the year. `all_line_items_of_type` counts every contribution of the same type on the Work Assignment earlier in the year, including those created by other benefits and those added directly to a Pay Stub.", "enum": [ "all_line_items_of_type", "this_benefit" ] }, "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", "minimum": 0, "maximum": 100 }, "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.", "format": "date" }, "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." }, "expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string" }, "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 }, "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` benefits.", "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` benefits.", "items": { "type": "integer" }, "minItems": 1 } } }, { "type": "object", "required": [ "work_assignment_id", "frequency", "amount", "amount_type", "effective_from" ] } ] }, "example": { "work_assignment_id": "", "employer_benefit_type": "health", "frequency": "per_payroll", "amount": 50, "amount_type": "fixed", "effective_from": "2026-01-01", "title": "Health Benefit", "tag_assignment": { "unit": "percentage", "tag_allocations": [ { "tags": [ "" ], "value": 100 } ] } } } } } } }, "/employer_benefits/search": { "post": { "summary": "Search employer benefits", "description": "Search benefits under the given business entity, returning the same set the equivalent bulk update/delete operation would target with this body.", "operationId": "employer-benefits-search", "tags": [ "Employer Benefits" ], "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 (`\"employer_benefit\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerBenefit" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "employer_benefit", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "business_preset": null, "employer_benefit_type": { "id": "", "object": "employer_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employer_benefit_types/health" } }, "employee_benefit": null, "title": null, "title_translations": null, "title_translated": null, "apply_sales_tax": true, "income_basis": "regular_earnings", "income_includes": [], "remittance_account_id": null, "remittance_account": null, "amount": 35, "amount_type": "fixed", "coverage_multiplier": 1, "max_annual_contribution": null, "max_annual_contribution_basis": "this_benefit", "frequency": "per_payroll", "date_basis": null, "pay_period_cadence": null, "effective_from": "2026-01-01", "effective_to": 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": "/employer_benefits/" } } ], "links": { "first": "http://localhost/employer_benefits/search?page=1", "last": "http://localhost/employer_benefits/search?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this benefit is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this benefit is no longer applied. `null` if the benefit applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/employer_benefit_line_items/batch/delete": { "post": { "summary": "Batch delete employer benefit line items", "operationId": "employer-benefit-line-items-batch-delete", "tags": [ "Employer Benefit Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "", "" ] } } } } }, "/employer_benefit_line_items/batch/upsert": { "post": { "summary": "Batch upsert employer benefit line items", "operationId": "employer-benefit-line-items-batch-upsert", "tags": [ "Employer Benefit Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "minItems": 1, "maxItems": 100 }, "example": [ { "id": "", "custom_amount": 100 }, { "pay_stub_id": "", "employer_benefit_type": "dental", "custom_amount": 75 } ] } } } } }, "/employer_benefit_line_items/bulk/create": { "post": { "summary": "Bulk create employer benefit line items", "operationId": "employer-benefit-line-items-bulk-create", "tags": [ "Employer Benefit Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/employer_benefit_line_items/bulk/create/scope": { "post": { "summary": "Show bulk create scope for employer benefit line items", "operationId": "employer-benefit-line-items-bulk-create-scope", "tags": [ "Employer Benefit Line Items" ], "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 (`\"pay_stub\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerBenefitLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "pay_stub", "data": { "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "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, "apply_standard_tax_reductions": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_stubs/" } } ], "links": { "first": "http://localhost/employer_benefit_line_items/bulk/create/scope?page=1", "last": "http://localhost/employer_benefit_line_items/bulk/create/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/employer_benefit_line_items/bulk/delete": { "post": { "summary": "Bulk delete employer benefit line items", "operationId": "employer-benefit-line-items-bulk-delete", "tags": [ "Employer Benefit Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/employer_benefit_line_items/bulk/delete/scope": { "post": { "summary": "Show bulk delete scope for employer benefit line items", "operationId": "employer-benefit-line-items-bulk-delete-scope", "tags": [ "Employer Benefit Line Items" ], "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 (`\"employer_benefit_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerBenefitLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "employer_benefit_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employer_benefit", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "employer_benefit_type": { "id": "", "object": "employer_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employer_benefit_types/health" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account_id": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employer_benefit_line_items/" } } ], "links": { "first": "http://localhost/employer_benefit_line_items/bulk/delete/scope?page=1", "last": "http://localhost/employer_benefit_line_items/bulk/delete/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/employer_benefit_line_items/bulk/update": { "post": { "summary": "Bulk update employer benefit line items", "operationId": "employer-benefit-line-items-bulk-update", "tags": [ "Employer Benefit Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/employer_benefit_line_items/bulk/update/scope": { "post": { "summary": "Show bulk update scope for employer benefit line items", "operationId": "employer-benefit-line-items-bulk-update-scope", "tags": [ "Employer Benefit Line Items" ], "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 (`\"employer_benefit_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerBenefitLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "employer_benefit_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employer_benefit", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "employer_benefit_type": { "id": "", "object": "employer_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employer_benefit_types/health" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account_id": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employer_benefit_line_items/" } } ], "links": { "first": "http://localhost/employer_benefit_line_items/bulk/update/scope?page=1", "last": "http://localhost/employer_benefit_line_items/bulk/update/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/employer_benefit_line_items": { "get": { "summary": "List employer benefit line items", "operationId": "employer-benefit-line-items-index", "tags": [ "Employer Benefit Line Items" ], "parameters": [ { "name": "pay_stub_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on the specified Pay Stub." }, { "name": "payroll_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on Pay Stubs on the specified Payroll." }, { "name": "payroll_status", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] }, { "type": "array", "items": { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] } } ] }, "required": false }, { "name": "payroll_type", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] }, { "type": "array", "items": { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] } } ] }, "required": false }, { "name": "payroll_period_start", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_period_start=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_period_start[gte]=2024-01-01&payroll_period_start[lt]=2024-12-31`" }, { "name": "payroll_period_end", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_period_end=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_period_end[gte]=2024-01-01&payroll_period_end[lt]=2024-12-31`" }, { "name": "payroll_pay_date", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_pay_date=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_pay_date[gte]=2024-01-01&payroll_pay_date[lt]=2024-12-31`" }, { "name": "pay_schedule_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on Pay Stubs on the specified Pay Schedule." }, { "name": "work_assignment_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on Pay Stubs for the specified Work Assignment." }, { "name": "employee_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on pay stubs for the specified Employee." }, { "name": "contractor_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on pay stubs for the specified Contractor." }, { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on Pay Stubs under the specified Business Entity." }, { "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": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "gift_near_cash", "gift_non_cash_non_taxable", "gift_non_cash_taxable", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "meals_subsidized_non_cash", "non_group_long_term_disability", "non_group_short_term_disability", "parking", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_unregistered_prpp", "pension_vrsp", "professional_membership", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "transit_pass", "transportation_to_from_work", "vehicle_employer_provided", "virtual_health_service", "wellness_spending_account" ] }, { "type": "array", "items": { "type": "string", "enum": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "gift_near_cash", "gift_non_cash_non_taxable", "gift_non_cash_taxable", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "meals_subsidized_non_cash", "non_group_long_term_disability", "non_group_short_term_disability", "parking", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_unregistered_prpp", "pension_vrsp", "professional_membership", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "transit_pass", "transportation_to_from_work", "vehicle_employer_provided", "virtual_health_service", "wellness_spending_account" ] } } ] }, "required": false, "description": "Only return line items with the specified types." }, { "name": "exclude_types", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "gift_near_cash", "gift_non_cash_non_taxable", "gift_non_cash_taxable", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "meals_subsidized_non_cash", "non_group_long_term_disability", "non_group_short_term_disability", "parking", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_unregistered_prpp", "pension_vrsp", "professional_membership", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "transit_pass", "transportation_to_from_work", "vehicle_employer_provided", "virtual_health_service", "wellness_spending_account" ] }, { "type": "array", "items": { "type": "string", "enum": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "gift_near_cash", "gift_non_cash_non_taxable", "gift_non_cash_taxable", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "meals_subsidized_non_cash", "non_group_long_term_disability", "non_group_short_term_disability", "parking", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_unregistered_prpp", "pension_vrsp", "professional_membership", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "transit_pass", "transportation_to_from_work", "vehicle_employer_provided", "virtual_health_service", "wellness_spending_account" ] } } ] }, "required": false, "description": "Only return line items _without_ the specified types." }, { "name": "external_ref", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "custom_expense_accounting_code", "custom_liability_accounting_code", "custom_tag_assignment", "expense_accounting_code", "liability_accounting_code", "managed_expense_accounting_code", "managed_liability_accounting_code", "managed_tag_assignment", "pay_stub", "recurrence", "remittance_account", "source_adjustment", "tag_assignment", "tag_assignment_amounts" ] } }, "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 (`\"employer_benefit_line_item\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EmployerBenefitLineItem" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With pay_stub expanded", "properties": { "pay_stub": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayStub" } } } } }, { "type": "object", "title": "With recurrence expanded", "properties": { "recurrence": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Recurrence" } } } } }, { "type": "object", "title": "With remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } }, { "type": "object", "title": "With business_preset expanded", "properties": { "business_preset": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessPreset" } } } } }, { "type": "object", "title": "With source_adjustment expanded", "properties": { "source_adjustment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SourceAdjustment" } } } } }, { "type": "object", "title": "With expense_accounting_code expanded", "properties": { "expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ExpenseAccountingCode" } } } } }, { "type": "object", "title": "With managed_expense_accounting_code expanded", "properties": { "managed_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedExpenseAccountingCode" } } } } }, { "type": "object", "title": "With custom_expense_accounting_code expanded", "properties": { "custom_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomExpenseAccountingCode" } } } } }, { "type": "object", "title": "With liability_accounting_code expanded", "properties": { "liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LiabilityAccountingCode" } } } } }, { "type": "object", "title": "With managed_liability_accounting_code expanded", "properties": { "managed_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedLiabilityAccountingCode" } } } } }, { "type": "object", "title": "With custom_liability_accounting_code expanded", "properties": { "custom_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomLiabilityAccountingCode" } } } } }, { "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" } } } } }, { "type": "object", "title": "With managed_tag_assignment expanded", "properties": { "managed_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/ManagedTagAssignment" } } } } }, { "type": "object", "title": "With custom_tag_assignment expanded", "properties": { "custom_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/CustomTagAssignment" } } } } }, { "type": "object", "title": "With tag_assignment_amounts expanded", "properties": { "tag_assignment_amounts": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/TagAssignmentAmount" } } } } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "employer_benefit_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employer_benefit", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "employer_benefit_type": { "id": "", "object": "employer_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employer_benefit_types/health" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account_id": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employer_benefit_line_items/" } } ], "links": { "first": "/employer_benefit_line_items?pay_stub_id=&page=1", "last": "/employer_benefit_line_items?pay_stub_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create an employer benefit line item", "operationId": "employer-benefit-line-items-store", "tags": [ "Employer Benefit Line Items" ], "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 (`\"employer_benefit_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerBenefitLineItem" } } }, "example": { "id": "", "object": "employer_benefit_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employer_benefit", "is_managed": false, "amount": 0, "custom_amount": null, "managed_amount": null, "employer_benefit_type": { "id": "", "object": "employer_benefit_type", "data": { "type": "dental", "label": "Dental" }, "links": { "self": "/employer_benefit_types/dental" } }, "recurrence": null, "title": "Dental", "title_translations": null, "title_translated": "Dental", "remittance_account_id": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employer_benefit_line_items/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "pay_stub_id": { "type": "string" }, "business_preset_id": { "type": "string" }, "employer_benefit_type": { "type": "string", "description": "The type of Employer Benefit for this line item.\n\nMust be present when `business_preset_id` is either empty or not set.", "enum": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "gift_near_cash", "gift_non_cash_non_taxable", "gift_non_cash_taxable", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "meals_subsidized_non_cash", "non_group_long_term_disability", "non_group_short_term_disability", "parking", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_unregistered_prpp", "pension_vrsp", "professional_membership", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "transit_pass", "transportation_to_from_work", "vehicle_employer_provided", "virtual_health_service", "wellness_spending_account" ] }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.", "format": "decimal", "maximum": 99999 }, "accrued_vacation_pay": { "type": "number", "description": "The vacation pay accrued on this line item, calculated based on the Work Assignment's Vacation Pay Settings.", "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 }, "remittance_account_id": { "type": "string" }, "expense_accounting_code_id": { "type": "string" }, "custom_expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string" }, "custom_liability_accounting_code_id": { "type": "string" }, "component_settings": { "type": "object", "properties": { "attributes_locked": { "type": "boolean" } } }, "external_ref": { "type": "string", "maxLength": 255 }, "custom_tag_assignment": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "amount", "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 } } } } } } } }, { "type": "object", "required": [ "pay_stub_id" ] } ] }, "example": { "pay_stub_id": "", "employer_benefit_type": "dental", "title": "Dental", "custom_tag_assignment": { "unit": "percentage", "tag_allocations": [ { "tags": [ "" ], "value": 100 } ] } } } } } } }, "/employer_benefit_line_items/search": { "post": { "summary": "Search employer benefit line items", "description": "Search line items under the given payroll, returning the same set the equivalent bulk update/delete operation would target with this body.", "operationId": "employer-benefit-line-items-search", "tags": [ "Employer Benefit Line Items" ], "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 (`\"employer_benefit_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerBenefitLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "employer_benefit_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employer_benefit", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "employer_benefit_type": { "id": "", "object": "employer_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employer_benefit_types/health" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account_id": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employer_benefit_line_items/" } } ], "links": { "first": "http://localhost/employer_benefit_line_items/search?page=1", "last": "http://localhost/employer_benefit_line_items/search?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/employer_benefit_types": { "get": { "summary": "List employer benefit types", "operationId": "employer-benefit-types-index", "tags": [ "Employer Benefit Types" ], "parameters": [ { "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)." }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Comma-separated list of type identifiers to return." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Case-insensitive substring match against the human-readable label, in any supported locale." } ], "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 (`\"employer_benefit_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerBenefitType" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "employer_benefit_type", "data": { "type": "accident_insurance_plan", "label": "Accidental Death and Dismemberment", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment 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": "Accidental Death and Dismemberment is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Accidental Death and Dismemberment is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/employer_benefit_types/accident_insurance_plan" } }, { "id": "", "object": "employer_benefit_type", "data": { "type": "critical_illness", "label": "Critical Illness", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Critical Illness 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": "Critical Illness is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Critical Illness is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/employer_benefit_types/critical_illness" } }, { "id": "", "object": "employer_benefit_type", "data": { "type": "debt_relief", "label": "Debt Relief", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Debt Relief 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": "Debt Relief is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Debt Relief is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/employer_benefit_types/debt_relief" } }, { "id": "", "object": "employer_benefit_type", "data": { "type": "dental", "label": "Dental", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Dental is subject to CNESST.", "program_label": "CNESST" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Dental is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "J", "help_text": "Private Health Services Plan" } ] ] } ] }, "links": { "self": "/employer_benefit_types/dental" } }, { "id": "", "object": "employer_benefit_type", "data": { "type": "employee_assistance_program", "label": "Employee Assistance Program", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Employee Assistance Program is subject to Income Tax.", "program_label": null } ] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Employee Assistance Program is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Employee Assistance Program is subject to CNESST.", "program_label": "CNESST" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Employee Assistance Program is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "J", "help_text": "Private Health Services Plan" } ] ] } ] }, "links": { "self": "/employer_benefit_types/employee_assistance_program" } }, { "id": "", "object": "employer_benefit_type", "data": { "type": "fondaction", "label": "Fondactions", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Fondactions is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Fondactions is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Fondactions is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Fondactions is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Fondactions is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Fondactions is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Fondactions is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Fondactions is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Fondactions is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Fondactions is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Fondactions is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Fondactions is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Fondactions is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Fondactions 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": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Fondactions is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Fondactions is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Fondactions is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Fondactions is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Fondactions is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Fondactions is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Fondactions is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Fondactions is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Fondactions is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Fondactions is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Fondactions is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Fondactions is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Fondactions is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/employer_benefit_types/fondaction" } }, { "id": "", "object": "employer_benefit_type", "data": { "type": "fondaction_rrsp", "label": "Fondactions (RRSP)", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Qu\u00e9bec credit.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_oc", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null } ] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/employer_benefit_types/fondaction_rrsp" } }, { "id": "", "object": "employer_benefit_type", "data": { "type": "fonds_solidarite_ftq", "label": "Fonds de solidarit\u00e9 FTQ", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ 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": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Fonds de solidarit\u00e9 FTQ is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/employer_benefit_types/fonds_solidarite_ftq" } }, { "id": "", "object": "employer_benefit_type", "data": { "type": "fonds_solidarite_ftq_rrsp", "label": "Fonds de solidarit\u00e9 FTQ (RRSP)", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Qu\u00e9bec credit.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null }, { "jurisdiction": "ca_oc", "effects": [ "tax_credit" ], "help_text": "LSF contribution with 30% combined Federal & Provincial credit.", "program_label": null } ] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/employer_benefit_types/fonds_solidarite_ftq_rrsp" } }, { "id": "", "object": "employer_benefit_type", "data": { "type": "gift_near_cash", "label": "Gift (Near-Cash)", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) 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": "Gift (Near-Cash) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to CPP.", "program_label": "CPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Gift (Near-Cash) is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] } ] }, "links": { "self": "/employer_benefit_types/gift_near_cash" } }, { "id": "", "object": "employer_benefit_type", "data": { "type": "gift_non_cash_non_taxable", "label": "Gift (Non-Cash, Non-Taxable)", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Gift (Non-Cash, Non-Taxable)", "program_label": null } ] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/employer_benefit_types/gift_non_cash_non_taxable" } }, { "id": "", "object": "employer_benefit_type", "data": { "type": "gift_non_cash_taxable", "label": "Gift (Non-Cash, Taxable)", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Gift (Non-Cash, Taxable) is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Gift (Non-Cash, Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Gift (Non-Cash, Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Gift (Non-Cash, Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Gift (Non-Cash, Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Gift (Non-Cash, Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Gift (Non-Cash, Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Gift (Non-Cash, Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Gift (Non-Cash, Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Gift (Non-Cash, Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Gift (Non-Cash, Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Gift (Non-Cash, Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Gift (Non-Cash, Taxable) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Gift (Non-Cash, Taxable) 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": "Gift (Non-Cash, Taxable) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Gift (Non-Cash, Taxable) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Gift (Non-Cash, Taxable) is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Gift (Non-Cash, Taxable)", "program_label": null } ] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/employer_benefit_types/gift_non_cash_taxable" } }, { "id": "", "object": "employer_benefit_type", "data": { "type": "group_dependent_life_insurance", "label": "Group Dependent Life Insurance", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance 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": "Group Dependent Life Insurance is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Group Dependent Life Insurance is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/employer_benefit_types/group_dependent_life_insurance" } }, { "id": "", "object": "employer_benefit_type", "data": { "type": "group_term_life_insurance", "label": "Group Term Life Insurance", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance 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": "Group Term Life Insurance is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/employer_benefit_types/group_term_life_insurance" } }, { "id": "", "object": "employer_benefit_type", "data": { "type": "health", "label": "Health", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Health is subject to Income Tax.", "program_label": null } ] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Health is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Health is subject to CNESST.", "program_label": "CNESST" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Health is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "J", "help_text": "Private Health Services Plan" } ] ] } ] }, "links": { "self": "/employer_benefit_types/health" } } ], "links": { "first": "/employer_benefit_types?features=ca&page=1", "last": "/employer_benefit_types?features=ca&page=3", "prev": null, "next": "/employer_benefit_types?features=ca&page=2" }, "meta": { "current_page": 1, "last_page": 3, "per_page": 15, "total": 39, "has_more": true } } } } } } } }, "/employer_statutory_withholding_line_items": { "get": { "summary": "List employer statutory withholding line items", "operationId": "employer-statutory-withholding-line-items-index", "tags": [ "Employer Statutory Withholding Line Items" ], "parameters": [ { "name": "pay_stub_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on the specified Pay Stub." }, { "name": "payroll_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on Pay Stubs on the specified Payroll." }, { "name": "payroll_status", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] }, { "type": "array", "items": { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] } } ] }, "required": false }, { "name": "payroll_type", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] }, { "type": "array", "items": { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] } } ] }, "required": false }, { "name": "payroll_period_start", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_period_start=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_period_start[gte]=2024-01-01&payroll_period_start[lt]=2024-12-31`" }, { "name": "payroll_period_end", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_period_end=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_period_end[gte]=2024-01-01&payroll_period_end[lt]=2024-12-31`" }, { "name": "payroll_pay_date", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_pay_date=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_pay_date[gte]=2024-01-01&payroll_pay_date[lt]=2024-12-31`" }, { "name": "pay_schedule_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on Pay Stubs on the specified Pay Schedule." }, { "name": "work_assignment_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on Pay Stubs for the specified Work Assignment." }, { "name": "employee_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on pay stubs for the specified Employee." }, { "name": "contractor_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on pay stubs for the specified Contractor." }, { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on Pay Stubs under the specified Business Entity." }, { "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": [ "cpp", "cpp_2", "eht", "ei", "qpip", "qpp", "qpp_2", "wcb" ] }, { "type": "array", "items": { "type": "string", "enum": [ "cpp", "cpp_2", "eht", "ei", "qpip", "qpp", "qpp_2", "wcb" ] } } ] }, "required": false, "description": "Only return line items with the specified types." }, { "name": "exclude_types", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "cpp", "cpp_2", "eht", "ei", "qpip", "qpp", "qpp_2", "wcb" ] }, { "type": "array", "items": { "type": "string", "enum": [ "cpp", "cpp_2", "eht", "ei", "qpip", "qpp", "qpp_2", "wcb" ] } } ] }, "required": false, "description": "Only return line items _without_ the specified types." }, { "name": "external_ref", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "custom_expense_accounting_code", "custom_liability_accounting_code", "expense_accounting_code", "liability_accounting_code", "managed_expense_accounting_code", "managed_liability_accounting_code", "managed_tag_assignment", "pay_stub", "remittance_account", "source_adjustment", "tag_assignment", "tag_assignment_amounts" ] } }, "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 (`\"employer_statutory_withholding_line_item\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EmployerStatutoryWithholdingLineItem" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With pay_stub expanded", "properties": { "pay_stub": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayStub" } } } } }, { "type": "object", "title": "With remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } }, { "type": "object", "title": "With source_adjustment expanded", "properties": { "source_adjustment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SourceAdjustment" } } } } }, { "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 managed_expense_accounting_code expanded", "properties": { "managed_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedExpenseAccountingCode" } } } } }, { "type": "object", "title": "With custom_expense_accounting_code expanded", "properties": { "custom_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomExpenseAccountingCode" } } } } }, { "type": "object", "title": "With liability_accounting_code expanded", "properties": { "liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LiabilityAccountingCode" } } } } }, { "type": "object", "title": "With managed_liability_accounting_code expanded", "properties": { "managed_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedLiabilityAccountingCode" } } } } }, { "type": "object", "title": "With custom_liability_accounting_code expanded", "properties": { "custom_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomLiabilityAccountingCode" } } } } }, { "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" } } } } }, { "type": "object", "title": "With managed_tag_assignment expanded", "properties": { "managed_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/ManagedTagAssignment" } } } } }, { "type": "object", "title": "With tag_assignment_amounts expanded", "properties": { "tag_assignment_amounts": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/TagAssignmentAmount" } } } } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "employer_statutory_withholding_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employer_statutory_withholding", "is_system": true, "is_managed": true, "amount": 0, "custom_amount": null, "managed_amount": 0, "employer_statutory_withholding_type": { "id": "", "object": "employer_statutory_withholding_type", "data": { "type": "ei", "label": "EI" }, "links": { "self": "/employer_statutory_withholding_types/ei" } }, "title": "EI", "title_translations": { "en": "EI", "fr": "AE" }, "title_translated": "EI", "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "source_adjustment": null, "business_preset": { "id": "", "object": "business_preset", "links": { "self": "/business_presets/" } }, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employer_statutory_withholding_line_items/" } }, { "id": "", "object": "employer_statutory_withholding_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employer_statutory_withholding", "is_system": true, "is_managed": true, "amount": 0, "custom_amount": null, "managed_amount": 0, "employer_statutory_withholding_type": { "id": "", "object": "employer_statutory_withholding_type", "data": { "type": "cpp", "label": "CPP" }, "links": { "self": "/employer_statutory_withholding_types/cpp" } }, "title": "CPP", "title_translations": { "en": "CPP", "fr": "RPC" }, "title_translated": "CPP", "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "source_adjustment": null, "business_preset": { "id": "", "object": "business_preset", "links": { "self": "/business_presets/" } }, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employer_statutory_withholding_line_items/" } }, { "id": "", "object": "employer_statutory_withholding_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employer_statutory_withholding", "is_system": true, "is_managed": true, "amount": 0, "custom_amount": null, "managed_amount": 0, "employer_statutory_withholding_type": { "id": "", "object": "employer_statutory_withholding_type", "data": { "type": "cpp_2", "label": "CPP 2" }, "links": { "self": "/employer_statutory_withholding_types/cpp_2" } }, "title": "CPP 2", "title_translations": { "en": "CPP 2", "fr": "RPC 2" }, "title_translated": "CPP 2", "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "source_adjustment": null, "business_preset": { "id": "", "object": "business_preset", "links": { "self": "/business_presets/" } }, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employer_statutory_withholding_line_items/" } }, { "id": "", "object": "employer_statutory_withholding_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employer_statutory_withholding", "is_system": true, "is_managed": true, "amount": 1235.11, "custom_amount": null, "managed_amount": 1235.11, "employer_statutory_withholding_type": { "id": "", "object": "employer_statutory_withholding_type", "data": { "type": "ei", "label": "EI" }, "links": { "self": "/employer_statutory_withholding_types/ei" } }, "title": "EI", "title_translations": { "en": "EI", "fr": "AE" }, "title_translated": "EI", "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "source_adjustment": null, "business_preset": { "id": "", "object": "business_preset", "links": { "self": "/business_presets/" } }, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employer_statutory_withholding_line_items/" } }, { "id": "", "object": "employer_statutory_withholding_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employer_statutory_withholding", "is_system": true, "is_managed": true, "amount": 2101.43, "custom_amount": null, "managed_amount": 2101.43, "employer_statutory_withholding_type": { "id": "", "object": "employer_statutory_withholding_type", "data": { "type": "cpp", "label": "CPP" }, "links": { "self": "/employer_statutory_withholding_types/cpp" } }, "title": "CPP", "title_translations": { "en": "CPP", "fr": "RPC" }, "title_translated": "CPP", "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "source_adjustment": null, "business_preset": { "id": "", "object": "business_preset", "links": { "self": "/business_presets/" } }, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employer_statutory_withholding_line_items/" } }, { "id": "", "object": "employer_statutory_withholding_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employer_statutory_withholding", "is_system": true, "is_managed": true, "amount": 355.22, "custom_amount": null, "managed_amount": 355.22, "employer_statutory_withholding_type": { "id": "", "object": "employer_statutory_withholding_type", "data": { "type": "cpp_2", "label": "CPP 2" }, "links": { "self": "/employer_statutory_withholding_types/cpp_2" } }, "title": "CPP 2", "title_translations": { "en": "CPP 2", "fr": "RPC 2" }, "title_translated": "CPP 2", "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "source_adjustment": null, "business_preset": { "id": "", "object": "business_preset", "links": { "self": "/business_presets/" } }, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employer_statutory_withholding_line_items/" } } ], "links": { "first": "/employer_statutory_withholding_line_items?pay_stub_id=&page=1", "last": "/employer_statutory_withholding_line_items?pay_stub_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 6, "has_more": false } } } } } } }, "post": { "summary": "Create an employer statutory withholding line item", "description": "Only available on correction and historical payrolls.", "operationId": "employer-statutory-withholding-line-items-store", "tags": [ "Employer Statutory Withholding Line Items" ], "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 (`\"employer_statutory_withholding_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerStatutoryWithholdingLineItem" } } }, "example": { "id": "", "object": "employer_statutory_withholding_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employer_statutory_withholding", "is_system": true, "is_managed": true, "amount": 0, "custom_amount": null, "managed_amount": 0, "employer_statutory_withholding_type": { "id": "", "object": "employer_statutory_withholding_type", "data": { "type": "ei", "label": "EI" }, "links": { "self": "/employer_statutory_withholding_types/ei" } }, "title": "EI", "title_translations": { "en": "EI", "fr": "AE" }, "title_translated": "EI", "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "source_adjustment": null, "business_preset": { "id": "", "object": "business_preset", "links": { "self": "/business_presets/" } }, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employer_statutory_withholding_line_items/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "pay_stub_id": { "type": "string" }, "business_preset_id": { "type": "string" }, "employer_statutory_withholding_type": { "type": "string", "description": "The type of employer statutory withholding for this line item.\n\nMust be present when `business_preset_id` is either empty or not set.", "enum": [ "cpp", "cpp_2", "eht", "ei", "qpip", "qpp", "qpp_2", "wcb" ] }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.", "format": "decimal", "maximum": 999999 }, "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 }, "remittance_account_id": { "type": "string" }, "expense_accounting_code_id": { "type": "string" }, "custom_expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string" }, "custom_liability_accounting_code_id": { "type": "string" }, "external_ref": { "type": "string", "maxLength": 255 } } }, { "type": "object", "required": [ "pay_stub_id" ] } ] }, "example": { "pay_stub_id": "", "employer_statutory_withholding_type": "ei" } } } } } }, "/employer_statutory_withholding_types": { "get": { "summary": "List employer statutory withholding types", "operationId": "employer-statutory-withholding-types-index", "tags": [ "Employer Statutory Withholding Types" ], "parameters": [ { "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)." }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Comma-separated list of type identifiers to return." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Case-insensitive substring match against the human-readable label, in any supported locale." } ], "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 (`\"employer_statutory_withholding_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerStatutoryWithholdingType" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "employer_statutory_withholding_type", "data": { "type": "cpp", "label": "CPP" }, "links": { "self": "/employer_statutory_withholding_types/cpp" } }, { "id": "", "object": "employer_statutory_withholding_type", "data": { "type": "cpp_2", "label": "CPP 2" }, "links": { "self": "/employer_statutory_withholding_types/cpp_2" } }, { "id": "", "object": "employer_statutory_withholding_type", "data": { "type": "eht", "label": "EHT" }, "links": { "self": "/employer_statutory_withholding_types/eht" } }, { "id": "", "object": "employer_statutory_withholding_type", "data": { "type": "ei", "label": "EI" }, "links": { "self": "/employer_statutory_withholding_types/ei" } }, { "id": "", "object": "employer_statutory_withholding_type", "data": { "type": "qpip", "label": "QPIP" }, "links": { "self": "/employer_statutory_withholding_types/qpip" } }, { "id": "", "object": "employer_statutory_withholding_type", "data": { "type": "qpp", "label": "QPP" }, "links": { "self": "/employer_statutory_withholding_types/qpp" } }, { "id": "", "object": "employer_statutory_withholding_type", "data": { "type": "qpp_2", "label": "QPP 2" }, "links": { "self": "/employer_statutory_withholding_types/qpp_2" } }, { "id": "", "object": "employer_statutory_withholding_type", "data": { "type": "wcb", "label": "WCB" }, "links": { "self": "/employer_statutory_withholding_types/wcb" } } ], "links": { "first": "/employer_statutory_withholding_types?page=1", "last": "/employer_statutory_withholding_types?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 8, "has_more": false } } } } } } } }, "/forms/batch/delete": { "post": { "summary": "Batch delete forms", "operationId": "forms-batch-delete", "tags": [ "Forms" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "", "" ] } } } } }, "/forms": { "get": { "summary": "List forms", "operationId": "forms-index", "tags": [ "Forms" ], "parameters": [ { "name": "owner_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Filter forms based on the owner." }, { "name": "work_assignment_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Filter forms based on the Work Assignment." }, { "name": "employee_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Filter forms owned by the Employee or the Employee's Work Assignments." }, { "name": "form_batch_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Filter forms by Form Batch." }, { "name": "type", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "rl1", "roe", "t4", "t4a", "td1", "td1ab", "td1bc", "td1mb", "td1nb", "td1nl", "td1ns", "td1nt", "td1nu", "td1on", "td1pe", "td1sk", "td1x", "td1yt", "tp_1015_3_v", "tp_1015_r_13_v" ] }, { "type": "array", "items": { "type": "string", "enum": [ "rl1", "roe", "t4", "t4a", "td1", "td1ab", "td1bc", "td1mb", "td1nb", "td1nl", "td1ns", "td1nt", "td1nu", "td1on", "td1pe", "td1sk", "td1x", "td1yt", "tp_1015_3_v", "tp_1015_r_13_v" ] } } ] }, "required": false, "description": "Filter forms based on the type of form." }, { "name": "status", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "approved", "done", "draft", "processing", "rejected", "submitted" ] }, { "type": "array", "items": { "type": "string", "enum": [ "approved", "done", "draft", "processing", "rejected", "submitted" ] } } ] }, "required": false, "description": "Filter forms based on the status of form." }, { "name": "owner_type", "in": "query", "schema": { "type": "string", "enum": [ "contractor", "employee", "work_assignment" ] }, "required": false, "description": "Filter forms based on the type of the form's owner." }, { "name": "owner_name", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Filter forms based on the owner's name." }, { "name": "created_at", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Only return forms with a `created_at` date matching the filter.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `created_at=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `created_at[gte]=2024-01-01&created_at[lt]=2024-12-31`" }, { "name": "fields", "in": "query", "schema": { "type": "array", "items": { "type": "object" } }, "required": false, "description": "Filter forms by field content. An array of objects with `field` (required) and `value` (optional) keys. Providing only `field` returns forms that have any value for that field; providing both returns forms where that field matches the given value." }, { "name": "fields.*", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "fields.*.field", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "fields.*.value", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "effective_date" ] }, "required": false, "description": "Sort order is specified using the format \n`sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by\nand `direction` is the optional sort direction (`asc` or `desc`)." }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "form_batch", "owner" ] } }, "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 (`\"form\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Form" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With owner expanded", "properties": { "owner": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FormOwner" } } } } }, { "type": "object", "title": "With form_batch expanded", "properties": { "form_batch": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FormBatch" } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "form", "data": { "owner": { "id": "", "object": "employee", "links": { "self": "/employees/" } }, "form_batch": null, "stage": "original", "note": null, "type": "roe", "effective_date": "2026-01-01", "version_year": "2026", "version_month": "january", "validation_error_count": 19, "status": "draft", "is_editable": true, "metadata": { "flags": { "is_editable": true, "is_submittable": false, "is_amendable": false, "is_xml_exportable": true }, "details": { "submission_setting": "manual", "business_entity_name": null, "roe_format": "standard" }, "submission_setting": "manual", "business_entity_name": null }, "block_1_serial_number": null, "block_2_serial_number_of_amended_or_replaced": null, "block_3_employer_payroll_reference_number": null, "block_5_cra_payroll_account_number": null, "block_6_pay_period_type": null, "block_8_social_insurance_number": null, "employee_first_name": null, "employee_initial": null, "employee_last_name": null, "employee_address_line_1": null, "employee_address_line_2": null, "employee_address_line_3": null, "employee_postal_code": null, "contact_first_name": null, "contact_last_name": null, "contact_area_code": null, "contact_phone_number": null, "contact_phone_number_extension": null, "block_10_first_day_worked": null, "block_11_last_day_for_which_paid": null, "block_12_final_pay_period_ending_date": null, "block_16_separation_code": null, "block_14_expected_recall_code": null, "block_14_expected_recall_date": null, "block_18_comments": null, "block_15_total_insurable_hours": null, "pp1_insurable_earnings": null, "pp2_insurable_earnings": null, "pp3_insurable_earnings": null, "pp4_insurable_earnings": null, "pp5_insurable_earnings": null, "pp6_insurable_earnings": null, "pp7_insurable_earnings": null, "pp8_insurable_earnings": null, "pp9_insurable_earnings": null, "pp10_insurable_earnings": null, "pp11_insurable_earnings": null, "pp12_insurable_earnings": null, "pp13_insurable_earnings": null, "pp14_insurable_earnings": null, "pp15_insurable_earnings": null, "pp16_insurable_earnings": null, "pp17_insurable_earnings": null, "pp18_insurable_earnings": null, "pp19_insurable_earnings": null, "pp20_insurable_earnings": null, "pp21_insurable_earnings": null, "pp22_insurable_earnings": null, "pp23_insurable_earnings": null, "pp24_insurable_earnings": null, "pp25_insurable_earnings": null, "pp26_insurable_earnings": null, "pp27_insurable_earnings": null, "pp28_insurable_earnings": null, "pp29_insurable_earnings": null, "pp30_insurable_earnings": null, "pp31_insurable_earnings": null, "pp32_insurable_earnings": null, "pp33_insurable_earnings": null, "pp34_insurable_earnings": null, "pp35_insurable_earnings": null, "pp36_insurable_earnings": null, "pp37_insurable_earnings": null, "pp38_insurable_earnings": null, "pp39_insurable_earnings": null, "pp40_insurable_earnings": null, "pp41_insurable_earnings": null, "pp42_insurable_earnings": null, "pp43_insurable_earnings": null, "pp44_insurable_earnings": null, "pp45_insurable_earnings": null, "pp46_insurable_earnings": null, "pp47_insurable_earnings": null, "pp48_insurable_earnings": null, "pp49_insurable_earnings": null, "pp50_insurable_earnings": null, "pp51_insurable_earnings": null, "pp52_insurable_earnings": null, "pp53_insurable_earnings": null, "vacation_pay_code": null, "vacation_pay_start_date": null, "vacation_pay_end_date": null, "vacation_pay_amount": null, "statutory_holiday_pay_for_date_1": null, "statutory_holiday_pay_for_amount_1": null, "statutory_holiday_pay_for_date_2": null, "statutory_holiday_pay_for_amount_2": null, "statutory_holiday_pay_for_date_3": null, "statutory_holiday_pay_for_amount_3": null, "statutory_holiday_pay_for_date_4": null, "statutory_holiday_pay_for_amount_4": null, "statutory_holiday_pay_for_date_5": null, "statutory_holiday_pay_for_amount_5": null, "statutory_holiday_pay_for_date_6": null, "statutory_holiday_pay_for_amount_6": null, "statutory_holiday_pay_for_date_7": null, "statutory_holiday_pay_for_amount_7": null, "statutory_holiday_pay_for_date_8": null, "statutory_holiday_pay_for_amount_8": null, "statutory_holiday_pay_for_date_9": null, "statutory_holiday_pay_for_amount_9": null, "statutory_holiday_pay_for_date_10": null, "statutory_holiday_pay_for_amount_10": null, "other_monies_code_1": null, "other_monies_start_date_1": null, "other_monies_end_date_1": null, "other_monies_amount_1": null, "other_monies_code_2": null, "other_monies_start_date_2": null, "other_monies_end_date_2": null, "other_monies_amount_2": null, "other_monies_code_3": null, "other_monies_start_date_3": null, "other_monies_end_date_3": null, "other_monies_amount_3": null, "special_payments_code_1": null, "special_payments_start_date_1": null, "special_payments_end_date_1": null, "special_payments_amount_1": null, "special_payments_period_1": null, "special_payments_code_2": null, "special_payments_start_date_2": null, "special_payments_end_date_2": null, "special_payments_amount_2": null, "special_payments_period_2": null, "special_payments_code_3": null, "special_payments_start_date_3": null, "special_payments_end_date_3": null, "special_payments_amount_3": null, "special_payments_period_3": null, "special_payments_code_4": null, "special_payments_start_date_4": null, "special_payments_end_date_4": null, "special_payments_amount_4": null, "special_payments_period_4": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/forms/" } }, { "id": "", "object": "form", "data": { "owner": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "form_batch": null, "stage": "original", "note": null, "type": "td1", "effective_date": "2026-01-01", "version_year": "2026", "version_month": "january", "validation_error_count": 0, "is_editable": true, "line_1_basic_personal_amount": null, "line_2_infirm_children_caregiver_amount": null, "line_3_age_amount": null, "line_4_pension_income_amount": null, "line_5_tuition": null, "line_6_disability_amount": null, "line_7_spouse_or_common_law_partner_amount": null, "line_8_eligible_dependent_amount": null, "line_9_infirm_dependent_caregiver_amount": null, "line_10_dependent_caregiver_amount": null, "line_11_spouse_or_common_law_transfer_amount": null, "line_12_dependent_transfer_amount": null, "line_13_total_claim_amount": null, "more_than_one_employer_or_payer": null, "total_income_less_than_total_claim_amount": null, "ninety_percent_world_income_taxable_income": null, "prescribed_zone_deduction": null, "additional_tax_deduction": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/forms/" } } ], "links": { "first": "/forms?page=1", "last": "/forms?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 2, "has_more": false } } } } } } }, "post": { "summary": "Create a form", "description": "Endpoint to create a Form.\n\nThe following example is for a 2026 TD1, but the response fields will differ depending on the specific Form instance requested.", "operationId": "forms-store", "tags": [ "Forms" ], "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 (`\"form\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Form" } } }, "example": { "id": "", "object": "form", "data": { "owner": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "form_batch": null, "stage": "original", "note": null, "type": "td1", "effective_date": "2026-01-01", "version_year": 2026, "version_month": "january", "validation_error_count": 0, "is_editable": true, "line_1_basic_personal_amount": null, "line_2_infirm_children_caregiver_amount": null, "line_3_age_amount": null, "line_4_pension_income_amount": null, "line_5_tuition": null, "line_6_disability_amount": null, "line_7_spouse_or_common_law_partner_amount": null, "line_8_eligible_dependent_amount": null, "line_9_infirm_dependent_caregiver_amount": null, "line_10_dependent_caregiver_amount": null, "line_11_spouse_or_common_law_transfer_amount": null, "line_12_dependent_transfer_amount": null, "line_13_total_claim_amount": null, "more_than_one_employer_or_payer": null, "total_income_less_than_total_claim_amount": null, "ninety_percent_world_income_taxable_income": null, "prescribed_zone_deduction": null, "additional_tax_deduction": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/forms/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "owner_id": { "type": "string" }, "form_batch_id": { "type": "string" }, "type": { "type": "string", "description": "The type of form (e.g. T4, ROE, RL-1).", "enum": [ "rl1", "roe", "t4", "t4a", "td1", "td1ab", "td1bc", "td1mb", "td1nb", "td1nl", "td1ns", "td1nt", "td1nu", "td1on", "td1pe", "td1sk", "td1x", "td1yt", "tp_1015_3_v", "tp_1015_r_13_v" ] }, "effective_date": { "type": "string", "description": "The effective date used to determine the form variant (e.g. the T4 tax year).\n\nDetermines the form variant. Defaults to the current date if not provided.", "format": "date" }, "note": { "type": "string", "description": "An optional note for this form.", "nullable": true, "maxLength": 65000 }, "line_1_basic_personal_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_2_infirm_children_caregiver_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_3_age_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_4_pension_income_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_5_tuition": { "type": "number", "format": "decimal", "minimum": 0 }, "line_6_disability_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_7_spouse_or_common_law_partner_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_8_eligible_dependent_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_9_infirm_dependent_caregiver_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_10_dependent_caregiver_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_11_spouse_or_common_law_transfer_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_12_dependent_transfer_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_13_total_claim_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "more_than_one_employer_or_payer": { "type": "boolean" }, "total_income_less_than_total_claim_amount": { "type": "boolean" }, "ninety_percent_world_income_taxable_income": { "type": "boolean" }, "prescribed_zone_deduction": { "type": "number", "format": "decimal", "minimum": 0 }, "additional_tax_deduction": { "type": "number", "format": "decimal", "minimum": 0 } } }, { "type": "object", "required": [ "owner_id", "type" ] } ] }, "example": { "owner_id": "", "type": "td1", "effective_date": "2026-01-01" } } } } } }, "/form_batches": { "get": { "summary": "List form batches", "operationId": "form-batches-index", "tags": [ "Form Batches" ], "parameters": [ { "name": "owner_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Filter form batches based on the owner. Accepts multiple comma-separated values." }, { "name": "owner_type", "in": "query", "schema": { "type": "string", "enum": [ "business_entity" ] }, "required": false, "description": "Filter form batches based on the type of owner." }, { "name": "form_type", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "rl1", "roe", "t4", "t4a", "td1", "td1ab", "td1bc", "td1mb", "td1nb", "td1nl", "td1ns", "td1nt", "td1nu", "td1on", "td1pe", "td1sk", "td1x", "td1yt", "tp_1015_3_v", "tp_1015_r_13_v" ] }, { "type": "array", "items": { "type": "string", "enum": [ "rl1", "roe", "t4", "t4a", "td1", "td1ab", "td1bc", "td1mb", "td1nb", "td1nl", "td1ns", "td1nt", "td1nu", "td1on", "td1pe", "td1sk", "td1x", "td1yt", "tp_1015_3_v", "tp_1015_r_13_v" ] } } ] }, "required": false, "description": "Filter form batches based on the form type." }, { "name": "form_stage", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "amendment", "cancellation", "original" ] }, { "type": "array", "items": { "type": "string", "enum": [ "amendment", "cancellation", "original" ] } } ] }, "required": false, "description": "Filter form batches based on the stage (original, amendment, cancellation)." }, { "name": "status", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "done", "draft", "processing", "submitted" ] }, { "type": "array", "items": { "type": "string", "enum": [ "done", "draft", "processing", "submitted" ] } } ] }, "required": false, "description": "Filter form batches based on the status." }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "effective_date" ] }, "required": false, "description": "Sort order is specified using the format \n`sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by\nand `direction` is the optional sort direction (`asc` or `desc`)." }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "owner" ] } }, "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 (`\"form_batch\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/FormBatch" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With owner expanded", "properties": { "owner": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FormBatchOwner" } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "form_batch", "data": { "owner": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "form_type": "t4", "form_stage": "original", "effective_date": "2026-01-01", "status": "draft", "contact_name": "Prof. Brody Ernser III", "contact_email": "weber.pierre@example.net", "contact_area_code": "657", "contact_phone_number": "3654916", "contact_extension": null, "note": null, "metadata": { "counts": { "total": 0, "valid": 0, "invalid": 0, "draft": 0, "approved": 0, "processing": 0, "submitted": 0, "done": 0, "rejected": 0 }, "flags": { "is_submittable": false }, "timestamps": { "submitted_at": null, "completed_at": null }, "identifiers": { "confirmation_number": null } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/form_batches/" } }, { "id": "", "object": "form_batch", "data": { "owner": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "form_type": "t4", "form_stage": "amendment", "effective_date": "2026-01-01", "status": "draft", "contact_name": "Prof. Brody Ernser III", "contact_email": "weber.pierre@example.net", "contact_area_code": "657", "contact_phone_number": "3654916", "contact_extension": null, "note": null, "metadata": { "counts": { "total": 0, "valid": 0, "invalid": 0, "draft": 0, "approved": 0, "processing": 0, "submitted": 0, "done": 0, "rejected": 0 }, "flags": { "is_submittable": false }, "timestamps": { "submitted_at": null, "completed_at": null }, "identifiers": { "confirmation_number": null } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/form_batches/" } } ], "links": { "first": "/form_batches?page=1", "last": "/form_batches?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 2, "has_more": false } } } } } } }, "post": { "summary": "Create a form batch", "operationId": "form-batches-store", "tags": [ "Form Batches" ], "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 (`\"form_batch\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/FormBatch" } } }, "example": { "id": "", "object": "form_batch", "data": { "owner": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "form_type": "t4", "form_stage": "original", "effective_date": "2026-01-01", "status": "draft", "contact_name": "Prof. Brody Ernser III", "contact_email": "weber.pierre@example.net", "contact_area_code": "657", "contact_phone_number": "3654916", "contact_extension": null, "note": null, "metadata": { "counts": { "total": 0, "valid": 0, "invalid": 0, "draft": 0, "approved": 0, "processing": 0, "submitted": 0, "done": 0, "rejected": 0 }, "flags": { "is_submittable": false }, "timestamps": { "submitted_at": null, "completed_at": null }, "identifiers": { "confirmation_number": null } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/form_batches/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "owner_id": { "type": "string" }, "form_type": { "type": "string", "description": "The type of Forms in this batch (e.g. T4, RL-1).\n\nMust be a form type that supports form batches. Not all form types support batches.", "enum": [ "rl1", "roe", "t4", "t4a", "td1", "td1ab", "td1bc", "td1mb", "td1nb", "td1nl", "td1ns", "td1nt", "td1nu", "td1on", "td1pe", "td1sk", "td1x", "td1yt", "tp_1015_3_v", "tp_1015_r_13_v" ] }, "effective_date": { "type": "string", "description": "The effective date used to determine the form variant for all Forms in this batch.\n\nDetermines the form variant. Defaults to January 1 of the current year if not provided.", "format": "date" }, "form_stage": { "type": "string", "description": "The lifecycle stage of the Forms in this batch: original, amendment, or cancellation.\n\nDefaults to `original` if not provided.", "enum": [ "amendment", "cancellation", "original" ] }, "contact_name": { "type": "string", "description": "The name of the contact person responsible for this submission.", "maxLength": 255 }, "contact_email": { "type": "string", "description": "The email address of the contact person.", "maxLength": 255 }, "contact_area_code": { "type": "string", "description": "The 3-digit area code of the contact's phone number." }, "contact_phone_number": { "type": "string", "description": "The 7-digit phone number of the contact." }, "contact_extension": { "type": "string", "description": "The optional extension for the contact's phone number.", "nullable": true }, "note": { "type": "string", "description": "An optional note for this form batch.", "nullable": true, "maxLength": 65000 } } }, { "type": "object", "required": [ "owner_id", "form_type", "contact_name", "contact_email", "contact_area_code", "contact_phone_number" ] } ] }, "example": { "owner_id": "", "form_type": "t4", "effective_date": "2026-01-01", "form_stage": "original", "contact_name": "Prof. Brody Ernser III", "contact_email": "weber.pierre@example.net", "contact_area_code": "657", "contact_phone_number": "3654916" } } } } } }, "/form_types": { "get": { "summary": "List form types", "operationId": "form-types-index", "tags": [ "Form Types" ], "parameters": [ { "name": "owner_type", "in": "query", "schema": { "type": "string", "enum": [ "contractor", "employee", "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 (`\"form_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/FormType" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "form_type", "data": { "type": "td1", "label": "TD1 Personal Tax Credits Return", "owner_types": [ "work_assignment" ] }, "links": { "self": "/form_types/td1" } }, { "id": "", "object": "form_type", "data": { "type": "td1ab", "label": "TD1AB Alberta Personal Tax Credits Return", "owner_types": [ "work_assignment" ] }, "links": { "self": "/form_types/td1ab" } }, { "id": "", "object": "form_type", "data": { "type": "td1bc", "label": "TD1BC British Columbia Personal Tax Credits Return", "owner_types": [ "work_assignment" ] }, "links": { "self": "/form_types/td1bc" } }, { "id": "", "object": "form_type", "data": { "type": "td1mb", "label": "TD1MB Manitoba Personal Tax Credits Return", "owner_types": [ "work_assignment" ] }, "links": { "self": "/form_types/td1mb" } }, { "id": "", "object": "form_type", "data": { "type": "td1nb", "label": "TD1NB New Brunswick Personal Tax Credits Return", "owner_types": [ "work_assignment" ] }, "links": { "self": "/form_types/td1nb" } }, { "id": "", "object": "form_type", "data": { "type": "td1nl", "label": "TD1NL Newfoundland and Labrador Personal Tax Credits Return", "owner_types": [ "work_assignment" ] }, "links": { "self": "/form_types/td1nl" } }, { "id": "", "object": "form_type", "data": { "type": "td1ns", "label": "TD1NS Nova Scotia Personal Tax Credits Return", "owner_types": [ "work_assignment" ] }, "links": { "self": "/form_types/td1ns" } }, { "id": "", "object": "form_type", "data": { "type": "td1nt", "label": "TD1NT Northwest Territories Personal Tax Credits Return", "owner_types": [ "work_assignment" ] }, "links": { "self": "/form_types/td1nt" } }, { "id": "", "object": "form_type", "data": { "type": "td1nu", "label": "TD1NU Nunavut Personal Tax Credits Return", "owner_types": [ "work_assignment" ] }, "links": { "self": "/form_types/td1nu" } }, { "id": "", "object": "form_type", "data": { "type": "td1on", "label": "TD1ON Ontario Personal Tax Credits Return", "owner_types": [ "work_assignment" ] }, "links": { "self": "/form_types/td1on" } }, { "id": "", "object": "form_type", "data": { "type": "td1pe", "label": "TD1PE Prince Edward Island Personal Tax Credits Return", "owner_types": [ "work_assignment" ] }, "links": { "self": "/form_types/td1pe" } }, { "id": "", "object": "form_type", "data": { "type": "td1sk", "label": "TD1SK Saskatchewan Personal Tax Credits Return", "owner_types": [ "work_assignment" ] }, "links": { "self": "/form_types/td1sk" } }, { "id": "", "object": "form_type", "data": { "type": "td1yt", "label": "TD1YT Yukon Personal Tax Credits Return", "owner_types": [ "work_assignment" ] }, "links": { "self": "/form_types/td1yt" } }, { "id": "", "object": "form_type", "data": { "type": "tp_1015_3_v", "label": "Qu\u00e9bec Source Deductions Return", "owner_types": [ "work_assignment" ] }, "links": { "self": "/form_types/tp_1015_3_v" } }, { "id": "", "object": "form_type", "data": { "type": "td1x", "label": "TD1X Statement of Commission Income and Expenses", "owner_types": [ "work_assignment" ] }, "links": { "self": "/form_types/td1x" } }, { "id": "", "object": "form_type", "data": { "type": "t4", "label": "T4 Statement of Remuneration Paid", "owner_types": [ "employee" ] }, "links": { "self": "/form_types/t4" } }, { "id": "", "object": "form_type", "data": { "type": "t4a", "label": "T4A Statement of Pension, Retirement, Annuity, and Other Income", "owner_types": [ "employee", "contractor" ] }, "links": { "self": "/form_types/t4a" } }, { "id": "", "object": "form_type", "data": { "type": "roe", "label": "Record of Employment", "owner_types": [ "employee" ] }, "links": { "self": "/form_types/roe" } }, { "id": "", "object": "form_type", "data": { "type": "tp_1015_r_13_v", "label": "Qu\u00e9bec Commissions and Expenses Statement", "owner_types": [ "work_assignment" ] }, "links": { "self": "/form_types/tp_1015_r_13_v" } }, { "id": "", "object": "form_type", "data": { "type": "rl1", "label": "Relev\u00e9 1 (RL-1) - Employment and Other Income", "owner_types": [ "employee" ] }, "links": { "self": "/form_types/rl1" } } ] } } } } } } }, "/holidays": { "get": { "summary": "List holidays", "operationId": "holidays-index", "tags": [ "Holidays" ], "parameters": [ { "name": "jurisdiction", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "type", "in": "query", "schema": { "type": "string", "enum": [ "bank", "statutory" ] }, "required": false }, { "name": "original_date", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `original_date=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `original_date[gte]=2024-01-01&original_date[lt]=2024-12-31`" }, { "name": "observed_date", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `observed_date=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `observed_date[gte]=2024-01-01&observed_date[lt]=2024-12-31`" } ], "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 (`\"holiday\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Holiday" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "holiday", "data": { "jurisdiction": "ca_federal", "type": "bank", "name": "New Year\u2019s Day", "name_translations": { "en": "New Year\u2019s Day", "fr": "Jour de l\u2019An" }, "name_translated": "New Year\u2019s Day", "original_date": "2026-01-01", "observed_date": "2026-01-01", "created_at": "2023-01-01T00:00:00.000000Z" }, "links": { "self": "/holidays/01J96T4XEGK81SZFSPPTK2E6NJ" } }, { "id": "", "object": "holiday", "data": { "jurisdiction": "ca_federal", "type": "bank", "name": "Good Friday", "name_translations": { "en": "Good Friday", "fr": "Vendredi Saint" }, "name_translated": "Good Friday", "original_date": "2026-04-03", "observed_date": "2026-04-03", "created_at": "2023-01-01T00:00:00.000000Z" }, "links": { "self": "/holidays/01J96T4XEGK81SZFSPPTK2E6NK" } }, { "id": "", "object": "holiday", "data": { "jurisdiction": "ca_federal", "type": "bank", "name": "Victoria Day", "name_translations": { "en": "Victoria Day", "fr": "F\u00eate de la Reine" }, "name_translated": "Victoria Day", "original_date": "2026-05-18", "observed_date": "2026-05-18", "created_at": "2023-01-01T00:00:00.000000Z" }, "links": { "self": "/holidays/01J96T4XEHE4F2KATNW7KFPKXM" } }, { "id": "", "object": "holiday", "data": { "jurisdiction": "ca_federal", "type": "bank", "name": "Canada Day", "name_translations": { "en": "Canada Day", "fr": "F\u00eate du Canada" }, "name_translated": "Canada Day", "original_date": "2026-07-01", "observed_date": "2026-07-01", "created_at": "2023-01-01T00:00:00.000000Z" }, "links": { "self": "/holidays/01J96T4XEHE4F2KATNW7KFPKXN" } }, { "id": "", "object": "holiday", "data": { "jurisdiction": "ca_federal", "type": "bank", "name": "Labour Day", "name_translations": { "en": "Labour Day", "fr": "F\u00eate du Travail" }, "name_translated": "Labour Day", "original_date": "2026-09-07", "observed_date": "2026-09-07", "created_at": "2023-01-01T00:00:00.000000Z" }, "links": { "self": "/holidays/01J96T4XEJGPAV5WXDB5V60TWE" } }, { "id": "", "object": "holiday", "data": { "jurisdiction": "ca_federal", "type": "bank", "name": "Truth and Reconciliation Day", "name_translations": { "en": "Truth and Reconciliation Day", "fr": "Journ\u00e9e V\u00e9rit\u00e9 et R\u00e9conciliation" }, "name_translated": "Truth and Reconciliation Day", "original_date": "2026-09-30", "observed_date": "2026-09-30", "created_at": "2023-01-01T00:00:00.000000Z" }, "links": { "self": "/holidays/01J96T4XEJGPAV5WXDB5V60TWF" } }, { "id": "", "object": "holiday", "data": { "jurisdiction": "ca_federal", "type": "bank", "name": "Thanksgiving Day", "name_translations": { "en": "Thanksgiving Day", "fr": "Action de Gr\u00e2ce" }, "name_translated": "Thanksgiving Day", "original_date": "2026-10-12", "observed_date": "2026-10-12", "created_at": "2023-01-01T00:00:00.000000Z" }, "links": { "self": "/holidays/01J96T4XEKG3Z5667MXBZ6J862" } }, { "id": "", "object": "holiday", "data": { "jurisdiction": "ca_federal", "type": "bank", "name": "Remembrance Day", "name_translations": { "en": "Remembrance Day", "fr": "Jour du Souvenir" }, "name_translated": "Remembrance Day", "original_date": "2026-11-11", "observed_date": "2026-11-11", "created_at": "2023-01-01T00:00:00.000000Z" }, "links": { "self": "/holidays/01J96T4XEKG3Z5667MXBZ6J863" } }, { "id": "", "object": "holiday", "data": { "jurisdiction": "ca_federal", "type": "bank", "name": "Christmas Day", "name_translations": { "en": "Christmas Day", "fr": "No\u00ebl" }, "name_translated": "Christmas Day", "original_date": "2026-12-25", "observed_date": "2026-12-25", "created_at": "2023-01-01T00:00:00.000000Z" }, "links": { "self": "/holidays/01J96T4XEMWDP03PKZSR0HZ91X" } }, { "id": "", "object": "holiday", "data": { "jurisdiction": "ca_federal", "type": "bank", "name": "Boxing Day", "name_translations": { "en": "Boxing Day", "fr": "Lendemain de No\u00ebl" }, "name_translated": "Boxing Day", "original_date": "2026-12-26", "observed_date": "2026-12-28", "created_at": "2023-01-01T00:00:00.000000Z" }, "links": { "self": "/holidays/01J96T4XEMWDP03PKZSR0HZ91Y" } }, { "id": "", "object": "holiday", "data": { "jurisdiction": "ca_ab", "type": "statutory", "name": "New Year\u2019s Day", "name_translations": { "en": "New Year\u2019s Day", "fr": "Jour de l\u2019An" }, "name_translated": "New Year\u2019s Day", "original_date": "2026-01-01", "observed_date": "2026-01-01", "created_at": "2026-01-26T20:16:32.000000Z", "updated_at": "2026-01-26T20:16:32.000000Z" }, "links": { "self": "/holidays/" } }, { "id": "", "object": "holiday", "data": { "jurisdiction": "ca_bc", "type": "statutory", "name": "New Year\u2019s Day", "name_translations": { "en": "New Year\u2019s Day", "fr": "Jour de l\u2019An" }, "name_translated": "New Year\u2019s Day", "original_date": "2026-01-01", "observed_date": "2026-01-01", "created_at": "2026-01-26T20:16:32.000000Z", "updated_at": "2026-01-26T20:16:32.000000Z" }, "links": { "self": "/holidays/" } }, { "id": "", "object": "holiday", "data": { "jurisdiction": "ca_mb", "type": "statutory", "name": "New Year\u2019s Day", "name_translations": { "en": "New Year\u2019s Day", "fr": "Jour de l\u2019An" }, "name_translated": "New Year\u2019s Day", "original_date": "2026-01-01", "observed_date": "2026-01-01", "created_at": "2026-01-26T20:16:32.000000Z", "updated_at": "2026-01-26T20:16:32.000000Z" }, "links": { "self": "/holidays/" } }, { "id": "", "object": "holiday", "data": { "jurisdiction": "ca_nb", "type": "statutory", "name": "New Year\u2019s Day", "name_translations": { "en": "New Year\u2019s Day", "fr": "Jour de l\u2019An" }, "name_translated": "New Year\u2019s Day", "original_date": "2026-01-01", "observed_date": "2026-01-01", "created_at": "2026-01-26T20:16:32.000000Z", "updated_at": "2026-01-26T20:16:32.000000Z" }, "links": { "self": "/holidays/" } }, { "id": "", "object": "holiday", "data": { "jurisdiction": "ca_nl", "type": "statutory", "name": "New Year\u2019s Day", "name_translations": { "en": "New Year\u2019s Day", "fr": "Jour de l\u2019An" }, "name_translated": "New Year\u2019s Day", "original_date": "2026-01-01", "observed_date": "2026-01-01", "created_at": "2026-01-26T20:16:32.000000Z", "updated_at": "2026-01-26T20:16:32.000000Z" }, "links": { "self": "/holidays/" } } ], "links": { "first": "/holidays?jurisdiction=ca&observed_date%5Bgte%5D=2026-01-01&observed_date%5Blte%5D=2026-12-31&page=1", "last": "/holidays?jurisdiction=ca&observed_date%5Bgte%5D=2026-01-01&observed_date%5Blte%5D=2026-12-31&page=9", "prev": null, "next": "/holidays?jurisdiction=ca&observed_date%5Bgte%5D=2026-01-01&observed_date%5Blte%5D=2026-12-31&page=2" }, "meta": { "current_page": 1, "last_page": 9, "per_page": 15, "total": 135, "has_more": true } } } } } } } }, "/integrations": { "get": { "summary": "List integrations", "operationId": "integrations-index", "tags": [ "Integrations" ], "parameters": [ { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": true } ], "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 (`\"integration\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Integration" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "integration", "data": { "label": "Xero", "is_enabled": false, "type": "accounting" }, "links": { "self": "/integrations/xero" } }, { "id": "", "object": "integration", "data": { "label": "QuickBooks", "is_enabled": false, "type": "accounting" }, "links": { "self": "/integrations/quickbooks" } } ] } } } } } } }, "/journal_entries": { "get": { "summary": "List journal entries", "operationId": "journal-entries-index", "tags": [ "Journal Entries" ], "parameters": [ { "name": "payroll_id", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "type", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "pay_stub_recording", "payroll_payment", "payroll_recording" ] }, { "type": "array", "items": { "type": "string", "enum": [ "pay_stub_recording", "payroll_payment", "payroll_recording" ] } } ] }, "required": false }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "journal_entry_rows", "pay_stub", "payroll" ] } }, "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 (`\"journal_entry\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/JournalEntry" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With payroll expanded", "properties": { "payroll": { "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/Payroll" } } } } }, { "type": "object", "title": "With pay_stub expanded", "properties": { "pay_stub": { "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/PayStub" } } } } }, { "type": "object", "title": "With journal_entry_rows expanded", "properties": { "journal_entry_rows": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/JournalEntryRow" } } } } } } } } ] } } } } } }, "example": { "object": "list", "data": [], "links": { "first": "/journal_entries?payroll_id=&page=1", "last": "/journal_entries?payroll_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 0, "has_more": false } } } } } } } }, "/overtime_rates/batch/delete": { "post": { "summary": "Batch delete overtime rates", "operationId": "overtime-rates-batch-delete", "tags": [ "Overtime Rates" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "", "" ] } } } } }, "/overtime_rates/batch/upsert": { "post": { "summary": "Batch upsert overtime rates", "operationId": "overtime-rates-batch-upsert", "tags": [ "Overtime Rates" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "minItems": 1, "maxItems": 100 }, "example": [ { "id": "", "rate_multiplier": 2 }, { "pay_rate_id": "", "rate_multiplier": 1.5 } ] } } } } }, "/overtime_rates/bulk/create": { "post": { "summary": "Bulk create overtime rates", "operationId": "overtime-rates-bulk-create", "tags": [ "Overtime Rates" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } } } }, "/overtime_rates/bulk/create/scope": { "post": { "summary": "Show bulk create scope for overtime rates", "operationId": "overtime-rates-bulk-create-scope", "tags": [ "Overtime Rates" ], "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 (`\"pay_rate\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/OvertimeRate" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "pay_rate", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "title": "Marketing Manager", "title_translations": null, "title_translated": "Marketing Manager", "type": "hourly", "rate": 15, "expected_hours_per_week": 40, "is_editable": true, "is_deletable": true, "effective_from": "2026-01-01", "earliest_valid_effective_to": "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": "/pay_rates/" } } ], "links": { "first": "http://localhost/overtime_rates/bulk/create/scope?page=1", "last": "http://localhost/overtime_rates/bulk/create/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } } } }, "/overtime_rates/bulk/delete": { "post": { "summary": "Bulk delete overtime rates", "operationId": "overtime-rates-bulk-delete", "tags": [ "Overtime Rates" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/overtime_rates/bulk/delete/scope": { "post": { "summary": "Show bulk delete scope for overtime rates", "operationId": "overtime-rates-bulk-delete-scope", "tags": [ "Overtime Rates" ], "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 (`\"overtime_rate\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/OvertimeRate" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "overtime_rate", "data": { "pay_rate": { "id": "", "object": "pay_rate", "links": { "self": "/pay_rates/" } }, "title": "1.5x", "title_translated": "1.5x", "rate_multiplier": 1.5, "hourly_rate": 22.5, "hourly_rate_override": null, "business_preset": null, "expense_accounting_code": null, "liability_accounting_code": null, "archived_at": null, "is_editable": true, "is_deletable": true, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/overtime_rates/" } } ], "links": { "first": "http://localhost/overtime_rates/bulk/delete/scope?page=1", "last": "http://localhost/overtime_rates/bulk/delete/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/overtime_rates/bulk/update": { "post": { "summary": "Bulk update overtime rates", "operationId": "overtime-rates-bulk-update", "tags": [ "Overtime Rates" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/overtime_rates/bulk/update/scope": { "post": { "summary": "Show bulk update scope for overtime rates", "operationId": "overtime-rates-bulk-update-scope", "tags": [ "Overtime Rates" ], "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 (`\"overtime_rate\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/OvertimeRate" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "overtime_rate", "data": { "pay_rate": { "id": "", "object": "pay_rate", "links": { "self": "/pay_rates/" } }, "title": "1.5x", "title_translated": "1.5x", "rate_multiplier": 1.5, "hourly_rate": 22.5, "hourly_rate_override": null, "business_preset": null, "expense_accounting_code": null, "liability_accounting_code": null, "archived_at": null, "is_editable": true, "is_deletable": true, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/overtime_rates/" } } ], "links": { "first": "http://localhost/overtime_rates/bulk/update/scope?page=1", "last": "http://localhost/overtime_rates/bulk/update/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/overtime_rates": { "get": { "summary": "List overtime rates", "operationId": "overtime-rates-index", "tags": [ "Overtime Rates" ], "parameters": [ { "name": "pay_rate_id", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "has_business_preset", "in": "query", "schema": { "type": "boolean" }, "required": false }, { "name": "business_preset_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "include_archived", "in": "query", "schema": { "type": "boolean" }, "required": false }, { "name": "archived_at", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `archived_at=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `archived_at[gte]=2024-01-01&archived_at[lt]=2024-12-31`" }, { "name": "external_ref", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "tag_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "tag_group_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "requires_tag_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "requires_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", "pay_rate", "tag_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 (`\"overtime_rate\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OvertimeRate" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With pay_rate expanded", "properties": { "pay_rate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayRate" } } } } }, { "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": "overtime_rate", "data": { "pay_rate": { "id": "", "object": "pay_rate", "links": { "self": "/pay_rates/" } }, "title": "1.5x", "title_translated": "1.5x", "rate_multiplier": 1.5, "hourly_rate": 22.5, "hourly_rate_override": null, "business_preset": null, "expense_accounting_code": null, "liability_accounting_code": null, "archived_at": null, "is_editable": true, "is_deletable": true, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/overtime_rates/" } } ], "links": { "first": "/overtime_rates?pay_rate_id=&page=1", "last": "/overtime_rates?pay_rate_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create an overtime rate", "operationId": "overtime-rates-store", "tags": [ "Overtime Rates" ], "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 (`\"overtime_rate\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/OvertimeRate" } } }, "example": { "id": "", "object": "overtime_rate", "data": { "pay_rate": { "id": "", "object": "pay_rate", "links": { "self": "/pay_rates/" } }, "title": "1.5x", "title_translated": "1.5x", "rate_multiplier": 1.5, "hourly_rate": 22.5, "hourly_rate_override": null, "business_preset": null, "expense_accounting_code": null, "liability_accounting_code": null, "archived_at": null, "is_editable": true, "is_deletable": true, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/overtime_rates/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "pay_rate_id": { "type": "string" }, "rate_multiplier": { "type": "number", "description": "The multiplier for this overtime, e.g `1.5` or `2`.", "format": "decimal", "minimum": 0, "maximum": 100 }, "hourly_rate_override": { "type": "number", "description": "If set, this amount is used for the hourly rate, not the calculated amount from the `rate_multiplier`.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "business_preset_id": { "type": "string" }, "expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string" }, "archived_at": { "type": "string", "format": "date" }, "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 } } } } } } } }, { "type": "object", "required": [ "pay_rate_id", "rate_multiplier" ] } ] }, "example": { "pay_rate_id": "", "rate_multiplier": "1.5", "tag_assignment": { "unit": "percentage", "tag_allocations": [ { "tags": [ "" ], "value": 100 } ] } } } } } } }, "/overtime_rates/search": { "post": { "summary": "Search overtime rates", "description": "Search overtime rates under the given business entity, returning the same set the equivalent bulk update/delete operation would target with this body.", "operationId": "overtime-rates-search", "tags": [ "Overtime Rates" ], "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 (`\"overtime_rate\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/OvertimeRate" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "overtime_rate", "data": { "pay_rate": { "id": "", "object": "pay_rate", "links": { "self": "/pay_rates/" } }, "title": "1.5x", "title_translated": "1.5x", "rate_multiplier": 1.5, "hourly_rate": 22.5, "hourly_rate_override": null, "business_preset": null, "expense_accounting_code": null, "liability_accounting_code": null, "archived_at": null, "is_editable": true, "is_deletable": true, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/overtime_rates/" } } ], "links": { "first": "http://localhost/overtime_rates/search?page=1", "last": "http://localhost/overtime_rates/search?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "pay_rates": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string", "enum": [ "hourly", "salary" ] }, "subtypes": { "type": "array", "items": { "type": "string", "enum": [ "hourly", "salary" ] } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments", "pay_rates" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" }, "pay_rates": { "include": "all" } } } } } } }, "/partner": { "get": { "summary": "Retrieve a partner", "operationId": "partners-show", "tags": [ "Partners" ], "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 (`\"partner\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Partner" } } }, "example": { "id": "", "object": "partner", "data": { "name": "prosacco-pro.biz", "preferred_locale": { "id": "", "object": "locale", "data": { "label": "English" } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/partner?partner=" } } } } } } } }, "/pay_rates/batch/delete": { "post": { "summary": "Batch delete pay rates", "operationId": "pay-rates-batch-delete", "tags": [ "Pay Rates" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "", "" ] } } } } }, "/pay_rates/batch/upsert": { "post": { "summary": "Batch upsert pay rates", "operationId": "pay-rates-batch-upsert", "tags": [ "Pay Rates" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "minItems": 1, "maxItems": 100 }, "example": [ { "id": "", "rate": 30, "expected_hours_per_week": 40, "effective_from": "2026-01-01" }, { "work_assignment_id": "", "type": "hourly", "title": "Overtime Rate", "rate": 45, "expected_hours_per_week": 10, "effective_from": "2026-03-01" } ] } } } } }, "/pay_rates/bulk/create": { "post": { "summary": "Bulk create pay rates", "operationId": "pay-rates-bulk-create", "tags": [ "Pay Rates" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } } } }, "/pay_rates/bulk/create/scope": { "post": { "summary": "Show bulk create scope for pay rates", "operationId": "pay-rates-bulk-create-scope", "tags": [ "Pay Rates" ], "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/PayRate" } } } } } }, "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/pay_rates/bulk/create/scope?page=1", "last": "http://localhost/pay_rates/bulk/create/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } } } }, "/pay_rates/bulk/delete": { "post": { "summary": "Bulk delete pay rates", "operationId": "pay-rates-bulk-delete", "tags": [ "Pay Rates" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this pay rate is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this pay rate is no longer applied and can no longer be used to create Earning Line Items. `null` if the pay rate applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/pay_rates/bulk/delete/scope": { "post": { "summary": "Show bulk delete scope for pay rates", "operationId": "pay-rates-bulk-delete-scope", "tags": [ "Pay Rates" ], "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 (`\"pay_rate\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/PayRate" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "pay_rate", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "title": "Marketing Manager", "title_translations": null, "title_translated": "Marketing Manager", "type": "hourly", "rate": 15, "expected_hours_per_week": 40, "is_editable": true, "is_deletable": true, "effective_from": "2026-01-01", "earliest_valid_effective_to": "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": "/pay_rates/" } } ], "links": { "first": "http://localhost/pay_rates/bulk/delete/scope?page=1", "last": "http://localhost/pay_rates/bulk/delete/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this pay rate is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this pay rate is no longer applied and can no longer be used to create Earning Line Items. `null` if the pay rate applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/pay_rates/bulk/update": { "post": { "summary": "Bulk update pay rates", "operationId": "pay-rates-bulk-update", "tags": [ "Pay Rates" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this pay rate is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this pay rate is no longer applied and can no longer be used to create Earning Line Items. `null` if the pay rate applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/pay_rates/bulk/update/scope": { "post": { "summary": "Show bulk update scope for pay rates", "operationId": "pay-rates-bulk-update-scope", "tags": [ "Pay Rates" ], "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 (`\"pay_rate\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/PayRate" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "pay_rate", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "title": "Marketing Manager", "title_translations": null, "title_translated": "Marketing Manager", "type": "hourly", "rate": 15, "expected_hours_per_week": 40, "is_editable": true, "is_deletable": true, "effective_from": "2026-01-01", "earliest_valid_effective_to": "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": "/pay_rates/" } } ], "links": { "first": "http://localhost/pay_rates/bulk/update/scope?page=1", "last": "http://localhost/pay_rates/bulk/update/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this pay rate is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this pay rate is no longer applied and can no longer be used to create Earning Line Items. `null` if the pay rate applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/pay_rates": { "get": { "summary": "List pay rates", "operationId": "pay-rates-index", "tags": [ "Pay Rates" ], "parameters": [ { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "work_assignment_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "pay_schedule_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "employee_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "business_preset_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "include_types", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "hourly", "salary" ] }, { "type": "array", "items": { "type": "string", "enum": [ "hourly", "salary" ] } } ] }, "required": false }, { "name": "exclude_types", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "hourly", "salary" ] }, { "type": "array", "items": { "type": "string", "enum": [ "hourly", "salary" ] } } ] }, "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:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `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:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, { "name": "is_editable", "in": "query", "schema": { "type": "boolean" }, "required": false }, { "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": [ "businessEntity.name", "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 \n`sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by\nand `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": "requires_tag_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "requires_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", "overtime_rates", "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 (`\"pay_rate\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PayRate" } ], "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 overtime_rates expanded", "properties": { "overtime_rates": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/OvertimeRate" } } } } } } } }, { "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": "pay_rate", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "title": "Marketing Manager", "title_translations": null, "title_translated": "Marketing Manager", "type": "hourly", "rate": 15, "expected_hours_per_week": 40, "is_editable": true, "is_deletable": true, "effective_from": "2026-01-01", "earliest_valid_effective_to": "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": "/pay_rates/" } } ], "links": { "first": "/pay_rates?work_assignment_id=&page=1", "last": "/pay_rates?work_assignment_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create a pay rate", "operationId": "pay-rates-store", "tags": [ "Pay Rates" ], "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 (`\"pay_rate\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/PayRate" } } }, "example": { "id": "", "object": "pay_rate", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "title": "Marketing Manager", "title_translations": null, "title_translated": "Marketing Manager", "type": "hourly", "rate": 15, "expected_hours_per_week": 40, "is_editable": true, "is_deletable": true, "effective_from": "2026-01-01", "earliest_valid_effective_to": "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": "/pay_rates/" } } } } } }, "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." }, "title": { "type": "string", "description": "Required unless the business preset referenced by `business_preset_id` already has a title. Either the pay rate or its preset must have one.", "nullable": true, "maxLength": 255 }, "title_translations": { "type": "object", "description": "Optional translations for the `title` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "has_business_preset": { "type": "boolean" }, "business_preset_id": { "type": "string" }, "type": { "type": "string", "description": "Whether this is a `salary` or `hourly` pay rate. Determines how `rate` is interpreted.\n\nMust be present when `business_preset_id` is either empty or not set.", "enum": [ "hourly", "salary" ] }, "rate": { "type": "number", "description": "The annual salary when `type` is `salary`, or the hourly wage when `type` is `hourly`.\n\nFor `salary` pay rates, `rate` is the annual salary (i.e. amount per year). For `wage` pay rates, `rate` is the hourly wage (i.e. amount per hour).", "format": "decimal", "minimum": 0, "maximum": 9999999 }, "expected_hours_per_week": { "type": "number", "description": "The expected number of working hours per week. Must be greater than `0` for `salary` pay rates. Used to calculate the equivalent hourly rate from salaries for overtime.", "format": "decimal", "minimum": 0, "maximum": 168 }, "effective_from": { "type": "string", "description": "The date from which this pay rate is applied to Pay Stubs.", "format": "date" }, "effective_to": { "type": "string", "description": "The date after which this pay rate is no longer applied and can no longer be used to create Earning Line Items. `null` if the pay rate 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 } } } } } } } }, { "type": "object", "required": [ "work_assignment_id", "rate", "expected_hours_per_week", "effective_from" ] } ] }, "example": { "work_assignment_id": "", "title": "Marketing Manager", "type": "hourly", "rate": "15", "expected_hours_per_week": "40", "effective_from": "2026-01-01", "tag_assignment": { "unit": "percentage", "tag_allocations": [ { "tags": [ "" ], "value": 100 } ] } } } } } } }, "/pay_rates/search": { "post": { "summary": "Search pay rates", "description": "Search pay rates under the given business entity. Returns the same set the equivalent bulk update/delete operation would target with this body. Useful for previewing the blast radius of a bulk operation, or for any general search using the same criteria grammar.", "operationId": "pay-rates-search", "tags": [ "Pay Rates" ], "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 (`\"pay_rate\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/PayRate" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "pay_rate", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "title": "Marketing Manager", "title_translations": null, "title_translated": "Marketing Manager", "type": "hourly", "rate": 15, "expected_hours_per_week": 40, "is_editable": true, "is_deletable": true, "effective_from": "2026-01-01", "earliest_valid_effective_to": "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": "/pay_rates/" } } ], "links": { "first": "http://localhost/pay_rates/search?page=1", "last": "http://localhost/pay_rates/search?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "business_entity_id": { "type": "string", "description": "The business entity whose pay rates to search." }, "work_assignments": { "type": "object", "description": "Filter pay rates by their work assignment.\n\n`work_assignments.include` must be either the string `\"all\"`, or an object containing one or more of `ids`, `payee_type` (`employee` or `contractor`), `pay_schedule_id`, `archived`.\n\n`work_assignments.exclude` (optional) accepts the same keys.", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "description": "Filter pay rates by id via `ids.include` / `ids.exclude` arrays.", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "pay_schedule_id": { "type": "string" }, "archived": { "type": "boolean" }, "payee_names": { "type": "string" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "description": "Filter pay rates by `business_preset_id` (include/exclude `ids`).", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "description": "Filter pay rates by id via `ids.include` / `ids.exclude` arrays.", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "description": "Filter pay rates by id via `ids.include` / `ids.exclude` arrays.", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "description": "Filter pay rates by `expense_accounting_code_id` (include/exclude `ids`).", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "description": "Filter pay rates by id via `ids.include` / `ids.exclude` arrays.", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "description": "Filter pay rates by id via `ids.include` / `ids.exclude` arrays.", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "description": "Filter pay rates by `liability_accounting_code_id` (include/exclude `ids`).", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "description": "Filter pay rates by id via `ids.include` / `ids.exclude` arrays.", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "description": "Filter pay rates by id via `ids.include` / `ids.exclude` arrays.", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this pay rate is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this pay rate is no longer applied and can no longer be used to create Earning Line Items. `null` if the pay rate applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "description": "Filter pay rates by `type` (`salary` or `hourly`) via `subtypes.include` / `subtypes.exclude` arrays.", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "description": "Filter pay rates by id via `ids.include` / `ids.exclude` arrays.", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/pay_schedules": { "get": { "summary": "List pay schedules", "operationId": "pay-schedules-index", "tags": [ "Pay Schedules" ], "parameters": [ { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "external_ref", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_entity", "payrolls" ] } }, "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 (`\"pay_schedule\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PaySchedule" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With business_entity expanded", "properties": { "business_entity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessEntity" } } } } }, { "type": "object", "title": "With payrolls expanded", "properties": { "payrolls": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/Payroll" } } } } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "pay_schedule", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "title": "Default Schedule", "title_translations": null, "title_translated": "Default Schedule", "pay_frequency": "monthly", "anchor_pay_date": "2026-01-31", "anchor_start_of_pay_period": "2026-01-01", "anchor_end_of_pay_period": "2026-01-31", "generate_payrolls_from": null, "day_1": -1, "day_2": null, "pay_day_movement_setting": "inherit", "send_empty_pay_stubs": true, "pay_stub_settings": { "show_vacation_pay_balance": false }, "custom_pay_periods_per_year": null, "is_editable": true, "is_deletable": true, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_schedules/" } } ], "links": { "first": "/pay_schedules?business_entity_id=&page=1", "last": "/pay_schedules?business_entity_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create a pay schedule", "operationId": "pay-schedules-store", "tags": [ "Pay Schedules" ], "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 (`\"pay_schedule\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/PaySchedule" } } }, "example": { "id": "", "object": "pay_schedule", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "title": "Default Schedule", "title_translations": null, "title_translated": "Default Schedule", "pay_frequency": "monthly", "anchor_pay_date": "2026-01-31", "anchor_start_of_pay_period": "2026-01-01", "anchor_end_of_pay_period": "2026-01-31", "generate_payrolls_from": null, "day_1": -1, "day_2": null, "pay_day_movement_setting": "inherit", "send_empty_pay_stubs": true, "pay_stub_settings": { "show_vacation_pay_balance": false }, "custom_pay_periods_per_year": null, "is_editable": true, "is_deletable": true, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_schedules/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "business_entity_id": { "type": "string" }, "title": { "type": "string", "maxLength": 255 }, "title_translations": { "type": "object", "description": "Optional translations for the `title` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "pay_frequency": { "type": "string", "description": "The frequency at which Payrolls are processed. Use `custom` for non-standard schedules where the number of pay periods per year is specified manually.", "enum": [ "bi-weekly", "custom", "monthly", "semi-monthly", "weekly" ] }, "anchor_pay_date": { "type": "string", "description": "The pay date of the anchor pay period. Together with `anchor_end_of_pay_period`, this establishes the pattern from which all future pay dates are calculated.\n\nDate must not be more than one year before now.", "format": "date" }, "anchor_start_of_pay_period": { "type": "string", "description": "The start date of the anchor pay period. Only required for semi-monthly pay schedules when `anchor_end_of_pay_period` is not the 15th or the last day of the month. For standard configurations it is derived automatically and does not need to be supplied.\n\nRequired for semi-monthly pay schedules when `anchor_end_of_pay_period` is not the 15th or the last day of the month.", "format": "date" }, "anchor_end_of_pay_period": { "type": "string", "description": "The end date of the anchor pay period. Together with `anchor_pay_date`, this defines the length and pattern of all future pay periods.\n\nDate must not be more than one year before now.", "format": "date" }, "generate_payrolls_from": { "type": "string", "description": "Only available in preview mode. When set, Payrolls are generated starting from this date rather than the default, allowing historical Payrolls to be created before the current date.\n\nAvailable in Preview mode, must be on or after `anchor_pay_date`. Allows for creation of Payrolls before the current date.", "format": "date" }, "day_1": { "type": "integer", "description": "For monthly pay schedules, the day of the month on which pay is issued. For semi-monthly pay schedules, the first of two pay days per month.\n\nRequired for monthly and semi-monthly pay schedules; must be `null` for other frequencies. For semi-monthly pay schedules, valid `(day_1, day_2)` pairs are `(16, 1)`, `(15, -1)`, and `(15, 31)`." }, "day_2": { "type": "integer", "description": "For semi-monthly pay schedules, the second of two pay days per month.\n\nRequired for semi-monthly pay schedules; must be `null` for other frequencies. For semi-monthly pay schedules, valid `(day_1, day_2)` pairs are `(16, 1)`, `(15, -1)`, and `(15, 31)`." }, "pay_day_movement_setting": { "type": "string", "description": "The pay schedule-level setting for how pay dates are adjusted when they fall on a weekend or bank holiday. If set to `inherit`, the Business Entity's setting is used.", "enum": [ "inherit", "next_business_day", "previous_business_day" ] }, "send_empty_pay_stubs": { "type": "boolean", "description": "Whether Pay Stubs are generated for employees with no earnings in a given pay period." }, "custom_pay_periods_per_year": { "type": "integer", "description": "When `pay_frequency` is `custom`, the number of pay periods per year.", "minimum": 1, "maximum": 366 }, "pay_stub_settings": { "type": "object", "description": "Settings that control Pay Stub display. The `show_vacation_pay_balance` field, when `true`, causes the employee's current Vacation Pay balance to appear on Pay Stubs.", "properties": { "show_vacation_pay_balance": { "type": "boolean" } } }, "external_ref": { "type": "string", "maxLength": 255 } } }, { "type": "object", "required": [ "business_entity_id", "title", "pay_frequency" ] } ] }, "example": { "business_entity_id": "", "title": "Default Schedule", "pay_frequency": "monthly", "anchor_pay_date": "2026-01-31", "anchor_end_of_pay_period": "2026-01-31", "day_1": -1, "pay_day_movement_setting": "inherit", "send_empty_pay_stubs": true } } } } } }, "/pay_splits": { "get": { "summary": "List pay splits", "operationId": "pay-splits-index", "tags": [ "Pay Splits" ], "parameters": [ { "name": "employee_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "The `employee_id` field is required when `contractor_id` is not present." }, { "name": "contractor_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "The `contractor_id` field is required when `employee_id` is not present." }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "contractor", "employee" ] } }, "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 (`\"pay_split\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PaySplit" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With employee expanded", "properties": { "employee": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Employee" } } } } }, { "type": "object", "title": "With contractor expanded", "properties": { "contractor": { "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/Contractor" } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "pay_split", "data": { "employee": { "id": "", "object": "employee", "links": { "self": "/employees/" } }, "type": "percentage", "title": null, "title_translations": null, "title_translated": null, "is_default": false, "priority_1_bank_account": { "id": "", "object": "bank_account", "data": { "employee": { "id": "", "object": "employee", "links": { "self": "/employees/" } }, "name": null, "institution_number": "320", "institution_name": "President's Choice Bank", "institution_name_translations": { "en": "President's Choice Bank", "fr": "Banque le Choix du Pr\u00e9sident" }, "institution_name_translated": "President's Choice Bank", "transit_number": "02002", "transit_address": "600-500 Lakeshore Blvd West POBOX600, Toronto, ON M5V 2V9", "account_number_last_3": "916", "is_primary": false, "is_deletable": false, "warnings": { "object": "list", "data": [] }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/bank_accounts/" } }, "priority_1_amount": 50, "priority_2_bank_account": { "id": "", "object": "bank_account", "data": { "employee": { "id": "", "object": "employee", "links": { "self": "/employees/" } }, "name": null, "institution_number": "320", "institution_name": "President's Choice Bank", "institution_name_translations": { "en": "President's Choice Bank", "fr": "Banque le Choix du Pr\u00e9sident" }, "institution_name_translated": "President's Choice Bank", "transit_number": "02002", "transit_address": "600-500 Lakeshore Blvd West POBOX600, Toronto, ON M5V 2V9", "account_number_last_3": "916", "is_primary": false, "is_deletable": false, "warnings": { "object": "list", "data": [] }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/bank_accounts/" } }, "priority_2_amount": 50, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_splits/" } } ], "links": { "first": "/pay_splits?employee_id=&page=1", "last": "/pay_splits?employee_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create a pay split", "operationId": "pay-splits-store", "tags": [ "Pay Splits" ], "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 (`\"pay_split\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/PaySplit" } } }, "example": { "id": "", "object": "pay_split", "data": { "employee": { "id": "", "object": "employee", "links": { "self": "/employees/" } }, "type": "percentage", "title": null, "title_translations": null, "title_translated": null, "is_default": false, "priority_1_bank_account": { "id": "", "object": "bank_account", "data": { "employee": { "id": "", "object": "employee", "links": { "self": "/employees/" } }, "name": null, "institution_number": "320", "institution_name": "President's Choice Bank", "institution_name_translations": { "en": "President's Choice Bank", "fr": "Banque le Choix du Pr\u00e9sident" }, "institution_name_translated": "President's Choice Bank", "transit_number": "02002", "transit_address": "600-500 Lakeshore Blvd West POBOX600, Toronto, ON M5V 2V9", "account_number_last_3": "916", "is_primary": false, "is_deletable": false, "warnings": { "object": "list", "data": [] }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/bank_accounts/" } }, "priority_1_amount": 50, "priority_2_bank_account": { "id": "", "object": "bank_account", "data": { "employee": { "id": "", "object": "employee", "links": { "self": "/employees/" } }, "name": null, "institution_number": "320", "institution_name": "President's Choice Bank", "institution_name_translations": { "en": "President's Choice Bank", "fr": "Banque le Choix du Pr\u00e9sident" }, "institution_name_translated": "President's Choice Bank", "transit_number": "02002", "transit_address": "600-500 Lakeshore Blvd West POBOX600, Toronto, ON M5V 2V9", "account_number_last_3": "916", "is_primary": false, "is_deletable": false, "warnings": { "object": "list", "data": [] }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/bank_accounts/" } }, "priority_2_amount": 50, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_splits/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "employee_id": { "type": "string", "description": "Must be present when `contractor_id` is either empty or not set." }, "contractor_id": { "type": "string", "description": "Must be present when `employee_id` is either empty or not set." }, "type": { "type": "string", "description": "The split strategy. `amount` sends fixed dollar amounts in priority order with the last configured Bank Account receiving the remaining balance. `percentage` distributes by percentage; percentage must total 100% across all accounts.", "enum": [ "amount", "percentage" ] }, "title": { "type": "string", "description": "A label for this pay split configuration.", "nullable": true, "maxLength": 255 }, "title_translations": { "type": "object", "description": "Optional translations for the `title` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "is_default": { "type": "boolean", "description": "Whether this is the default pay split for the Employee or Contractor." }, "priority_1_bank_account_id": { "type": "string" }, "priority_1_amount": { "type": "number", "description": "The amount or percentage allocated to the first priority Bank Account.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "priority_2_bank_account_id": { "type": "string" }, "priority_2_amount": { "type": "number", "description": "The amount or percentage for the second priority Bank Account. For `amount`-type splits, set to `null` if this is the last account (receives the remainder).", "format": "decimal", "minimum": 0, "maximum": 99999 }, "priority_3_bank_account_id": { "type": "string" }, "priority_3_amount": { "type": "number", "description": "The amount or percentage for the third priority Bank Account.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "priority_4_bank_account_id": { "type": "string" }, "priority_4_amount": { "type": "number", "description": "The amount or percentage for the fourth priority Bank Account.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "priority_5_bank_account_id": { "type": "string" }, "priority_5_amount": { "type": "number", "description": "The amount or percentage for the fifth priority Bank Account.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "priority_6_bank_account_id": { "type": "string" }, "priority_6_amount": { "type": "number", "description": "The amount or percentage for the sixth priority Bank Account.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "priority_7_bank_account_id": { "type": "string" }, "priority_7_amount": { "type": "number", "description": "The amount or percentage for the seventh priority Bank Account.", "format": "decimal", "minimum": 0, "maximum": 99999 } } }, { "type": "object", "required": [ "type", "priority_1_bank_account_id", "priority_1_amount", "priority_2_bank_account_id" ] } ] }, "example": { "employee_id": "", "type": "percentage", "priority_1_bank_account_id": "", "priority_1_amount": 50, "priority_2_bank_account_id": "", "priority_2_amount": 50 } } } } } }, "/pay_stubs/batch/delete": { "post": { "summary": "Batch delete pay stubs", "operationId": "pay-stubs-batch-delete", "tags": [ "Pay Stubs" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "" ] } } } } }, "/pay_stubs/batch/upsert": { "post": { "summary": "Batch upsert pay stubs", "operationId": "pay-stubs-batch-upsert", "tags": [ "Pay Stubs" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "minItems": 1, "maxItems": 100 }, "example": [ { "id": "", "note": "Updated pay stub" }, { "payroll_id": "", "work_assignment_id": "", "note": "New pay stub" } ] } } } } }, "/pay_stubs/bulk/create": { "post": { "summary": "Bulk create pay stubs", "description": "Bulk-create pay stubs under the given payroll, one for each selected work assignment on the payroll's pay schedule. Work assignments that already have a pay stub on the payroll are skipped. The payroll must be a once-off, historical, correction, or custom-schedule payroll in `draft` status - the same payrolls that accept manual pay stub creation.", "operationId": "pay-stubs-bulk-create", "tags": [ "Pay Stubs" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string", "description": "The payroll to create the pay stubs under." }, "work_assignments": { "type": "object", "description": "The work assignment selection criteria.\n\n`work_assignments.include` must be either the string `\"all\"`, or an object containing one or more of `ids` (string array), `payee_type` (`employee` or `contractor`), `pay_schedule_id`, `archived` (boolean), `payee_names` (string).\n\n`work_assignments.exclude` (optional) is an object containing one or more of the same keys.", "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": [ "payroll_id", "work_assignments" ] } ] }, "example": { "payroll_id": "", "work_assignments": { "include": "all" } } } } } } }, "/pay_stubs/bulk/create/scope": { "post": { "summary": "Show bulk create scope for pay stubs", "operationId": "pay-stubs-bulk-create-scope", "tags": [ "Pay Stubs" ], "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/PayStub" } } } } } }, "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/" } } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_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": [ "payroll_id", "work_assignments" ] } ] }, "example": { "payroll_id": "", "work_assignments": { "include": "all" } } } } } } }, "/pay_stubs/bulk/delete": { "post": { "summary": "Bulk delete pay stubs", "description": "Bulk-delete the pay stubs under the given payroll matching the selection criteria. The payroll must be in `draft` status.", "operationId": "pay-stubs-bulk-delete", "tags": [ "Pay Stubs" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string", "description": "The payroll whose pay stubs to delete." }, "pay_stubs": { "type": "object", "description": "The pay stub selection criteria (same grammar as bulk update).", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/pay_stubs/bulk/delete/scope": { "post": { "summary": "Show bulk delete scope for pay stubs", "operationId": "pay-stubs-bulk-delete-scope", "tags": [ "Pay Stubs" ], "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 (`\"pay_stub\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/PayStub" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "pay_stub", "data": { "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "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, "apply_standard_tax_reductions": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_stubs/" } } ], "links": { "first": "http://localhost/pay_stubs/bulk/delete/scope?page=1", "last": "http://localhost/pay_stubs/bulk/delete/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/pay_stubs/bulk/update": { "post": { "summary": "Bulk update pay stubs", "description": "Bulk-update the pay stubs under the given payroll matching the selection criteria. The payroll must be in `draft` status.", "operationId": "pay-stubs-bulk-update", "tags": [ "Pay Stubs" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string", "description": "The payroll whose pay stubs to update." }, "pay_stubs": { "type": "object", "description": "The pay stub selection criteria.\n\n`pay_stubs.include` must be either the string `\"all\"`, or an object containing one or more of `ids` (pay stub id string array), `work_assignment_ids` (string array - selects the stubs for those work assignments), `payee_type` (`employee` or `contractor`).\n\n`pay_stubs.exclude` (optional) is an object containing one or more of the same keys.", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/pay_stubs/bulk/update/scope": { "post": { "summary": "Show bulk update scope for pay stubs", "operationId": "pay-stubs-bulk-update-scope", "tags": [ "Pay Stubs" ], "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 (`\"pay_stub\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/PayStub" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "pay_stub", "data": { "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "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, "apply_standard_tax_reductions": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_stubs/" } } ], "links": { "first": "http://localhost/pay_stubs/bulk/update/scope?page=1", "last": "http://localhost/pay_stubs/bulk/update/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/pay_stubs": { "get": { "summary": "List pay stubs", "description": "Pay Stubs are sorted by the employees `last_name`, and contractors `business_name`, by default.", "operationId": "pay-stubs-index", "tags": [ "Pay Stubs" ], "parameters": [ { "name": "payroll_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return pay stubs under the specified business entity." }, { "name": "pay_schedule_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return pay stubs on the specified pay schedule." }, { "name": "work_assignment_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "payee.default", "payee.first_name", "payee.last_name", "payroll.pay_date", "work_assignment.payee.default", "work_assignment.payee.first_name", "work_assignment.payee.last_name" ] }, "required": false, "description": "Sort order is specified using the format \n`sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by\nand `direction` is the optional sort direction (`asc` or `desc`).\n\nThese sort fields are deprecated and will be removed. Use the replacement instead:\n- `payee.default`, replaced by `work_assignment.payee.default`\n- `payee.first_name`, replaced by `work_assignment.payee.first_name`\n- `payee.last_name`, replaced by `work_assignment.payee.last_name`" }, { "name": "next_pay_stubs", "in": "query", "schema": { "type": "string", "enum": [ "exclude", "only" ] }, "required": false, "description": "Filter paystubs to either include only (`only`), or exclude (`exclude`), the upcoming pay stubs.\n\nAn upcoming pay stub is defined as: - Any pay stub that belongs to the first Regular payroll in the pay schedule with a payroll `status` of either `draft` or `approved`. - Additionally, all pay stubs from `draft` or `approved` Off Cycle payrolls within the pay schedule are considered upcoming pay stubs." }, { "name": "employee_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "contractor_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "type", "in": "query", "schema": { "type": "string", "enum": [ "contractor", "employee" ] }, "required": false }, { "name": "payroll_status", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] }, { "type": "array", "items": { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] } } ] }, "required": false }, { "name": "payroll_type", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] }, { "type": "array", "items": { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] } } ] }, "required": false }, { "name": "has_accounting_code", "in": "query", "schema": { "type": "boolean" }, "required": false }, { "name": "payrolls.period_start", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payrolls.period_start=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payrolls.period_start[gte]=2024-01-01&payrolls.period_start[lt]=2024-12-31`" }, { "name": "payrolls.period_end", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payrolls.period_end=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payrolls.period_end[gte]=2024-01-01&payrolls.period_end[lt]=2024-12-31`" }, { "name": "payrolls.pay_date", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payrolls.pay_date=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payrolls.pay_date[gte]=2024-01-01&payrolls.pay_date[lt]=2024-12-31`" }, { "name": "external_ref", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "has_work_assignment_tag_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "has_work_assignment_tag_group_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "requires_work_assignment_tag_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "requires_work_assignment_tag_group_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "allowance_line_items", "deduction_line_items", "earning_line_items", "employee_benefit_line_items", "employer_benefit_line_items", "employer_statutory_withholding_line_items", "payroll", "reimbursement_line_items", "statutory_withholding_line_items", "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 (`\"pay_stub\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PayStub" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With payroll expanded", "properties": { "payroll": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Payroll" } } } } }, { "type": "object", "title": "With work_assignment expanded", "properties": { "work_assignment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WorkAssignment" } } } } }, { "type": "object", "title": "With earning_line_items expanded", "properties": { "earning_line_items": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/EarningLineItem" } } } } } } } }, { "type": "object", "title": "With statutory_withholding_line_items expanded", "properties": { "statutory_withholding_line_items": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/StatutoryWithholdingLineItem" } } } } } } } }, { "type": "object", "title": "With employer_statutory_withholding_line_items expanded", "properties": { "employer_statutory_withholding_line_items": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerStatutoryWithholdingLineItem" } } } } } } } }, { "type": "object", "title": "With allowance_line_items expanded", "properties": { "allowance_line_items": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/AllowanceLineItem" } } } } } } } }, { "type": "object", "title": "With reimbursement_line_items expanded", "properties": { "reimbursement_line_items": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/ReimbursementLineItem" } } } } } } } }, { "type": "object", "title": "With employee_benefit_line_items expanded", "properties": { "employee_benefit_line_items": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployeeBenefitLineItem" } } } } } } } }, { "type": "object", "title": "With employer_benefit_line_items expanded", "properties": { "employer_benefit_line_items": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerBenefitLineItem" } } } } } } } }, { "type": "object", "title": "With deduction_line_items expanded", "properties": { "deduction_line_items": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/DeductionLineItem" } } } } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "pay_stub", "data": { "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "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, "apply_standard_tax_reductions": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_stubs/" } } ], "links": { "first": "/pay_stubs?payroll_id=&page=1", "last": "/pay_stubs?payroll_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create a pay stub", "operationId": "pay-stubs-store", "tags": [ "Pay Stubs" ], "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 (`\"pay_stub\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/PayStub" } } }, "example": { "id": "", "object": "pay_stub", "data": { "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "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": "Off-cycle paystub", "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, "apply_standard_tax_reductions": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_stubs/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "work_assignment_id": { "type": "string" }, "payment_method": { "type": "string", "description": "The payment method for this pay stub.", "enum": [ "direct_deposit", "manual", "pad", "wire" ] }, "note": { "type": "string", "description": "An optional note on the pay stub, visible to the partner.", "nullable": true }, "external_ref": { "type": "string", "maxLength": 255 }, "apply_standard_tax_reductions": { "type": "boolean", "description": "When `true`, the standard tax reductions are applied to this pay stub's withholdings even in cases where they would otherwise be skipped to avoid applying them twice across related runs in the same period. In Canada these reductions are the employee's federal and provincial personal tax credits (their TD1 claim amounts) and the CPP/QPP basic exemption. Defaults to `false`, and has no effect where those reductions already apply." } } }, { "type": "object", "required": [ "payroll_id", "work_assignment_id" ] } ] } } } } } }, "/pay_stubs/search": { "post": { "summary": "Search pay stubs", "description": "Search pay stubs under the given payroll, returning the same set the equivalent bulk line item operation would target with this body. Useful for previewing the blast radius of a bulk operation, or for any general search using the same criteria grammar.", "operationId": "pay-stubs-search", "tags": [ "Pay Stubs" ], "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 (`\"pay_stub\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/PayStub" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "pay_stub", "data": { "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "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, "apply_standard_tax_reductions": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_stubs/" } } ], "links": { "first": "http://localhost/pay_stubs/search?page=1", "last": "http://localhost/pay_stubs/search?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string", "description": "The payroll whose pay stubs to search." }, "pay_stubs": { "type": "object", "description": "The selection criteria.\n\n`pay_stubs.include` must be either the string `\"all\"`, or an object containing one or more of `ids` (string array), `work_assignment_ids` (string array - selects the stubs for those work assignments), `payee_type` (`employee` or `contractor`).\n\n`pay_stubs.exclude` (optional) is an object containing one or more of the same keys.", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/payments": { "get": { "summary": "List payments", "operationId": "payments-index", "tags": [ "Payments" ], "parameters": [ { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "payroll_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "remittance_account_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "status", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "canceled", "failed", "overdue", "paid", "pending", "processing" ] }, { "type": "array", "items": { "type": "string", "enum": [ "canceled", "failed", "overdue", "paid", "pending", "processing" ] } } ] }, "required": false, "description": "Filter by payment status. Supports multiple comma-separated values." }, { "name": "destination", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "bill_pay", "cra", "employee", "internal", "no_op", "payroll_float", "rq" ] }, { "type": "array", "items": { "type": "string", "enum": [ "bill_pay", "cra", "employee", "internal", "no_op", "payroll_float", "rq" ] } } ] }, "required": false, "description": "Filter by payment destination. Supports multiple comma-separated values." }, { "name": "method", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "direct_deposit", "manual", "pad", "wire" ] }, { "type": "array", "items": { "type": "string", "enum": [ "direct_deposit", "manual", "pad", "wire" ] } } ] }, "required": false, "description": "Filter by payment method. Supports multiple comma-separated values." }, { "name": "is_held", "in": "query", "schema": { "type": "boolean" }, "required": false, "description": "Filter by hold status. `true` returns only held payments, `false` returns only non-held payments." }, { "name": "expected_at", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `expected_at=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `expected_at[gte]=2024-01-01&expected_at[lt]=2024-12-31`" }, { "name": "process_at", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `process_at=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `process_at[gte]=2024-01-01&process_at[lt]=2024-12-31`" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "amount", "destination", "expected_at", "process_at", "status" ] }, "required": false, "description": "Sort order is specified using the format \n`sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by\nand `direction` is the optional sort direction (`asc` or `desc`)." }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "payroll", "remittance_account" ] } }, "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 (`\"payment\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Payment" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With payroll expanded", "properties": { "payroll": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Payroll" } } } } }, { "type": "object", "title": "With remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "payment", "data": { "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "remittance_account": null, "destination": "payroll_float", "method": "pad", "amount": 0, "status": "pending", "process_at": "2026-01-27", "expected_at": "2026-01-27", "is_impacted_by_weekend_or_holiday": false, "is_held": false, "held_at": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/payments/" } } ], "links": { "first": "/payments?business_entity_id=&page=1", "last": "/payments?business_entity_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } } }, "/payrolls": { "get": { "summary": "List payrolls", "operationId": "payrolls-index", "tags": [ "Payrolls" ], "parameters": [ { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "The `business_entity_id` field is required when `pay_schedule_id` is not present." }, { "name": "pay_schedule_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "The `pay_schedule_id` field is required when `business_entity_id` is not present." }, { "name": "next_payrolls", "in": "query", "schema": { "type": "string", "enum": [ "exclude", "only" ] }, "required": false, "description": "Allows for restricting to only `next` payrolls, or to exclude any `next` payrolls. A payroll is the `next` payroll within a single PaySchedule, if it has a `status` of `draft`, `approved`, `processing`, or `failed`.\n\nIf an `off_cycle` payroll has been created, the next `off_cycle` payroll with a status of `draft`, `approved`, `processing`, or `failed` will also be returned by default." }, { "name": "source_payroll_in_year", "in": "query", "schema": { "type": "string" }, "required": false, "description": "If a year is passed, the payrolls will be restricted to only those which can be used as the `source_payroll_id` on an `off_cycle` payroll." }, { "name": "type", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] }, { "type": "array", "items": { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] } } ] }, "required": false }, { "name": "status", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] }, { "type": "array", "items": { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] } } ] }, "required": false, "description": "Filter by payroll status. Supports multiple comma-separated values, for example `status=draft,approved,processing`. The `partially_paid` status is deprecated and matches no payrolls." }, { "name": "period_start", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `period_start=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `period_start[gte]=2024-01-01&period_start[lt]=2024-12-31`" }, { "name": "period_end", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `period_end=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `period_end[gte]=2024-01-01&period_end[lt]=2024-12-31`" }, { "name": "pay_date", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `pay_date=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `pay_date[gte]=2024-01-01&pay_date[lt]=2024-12-31`" }, { "name": "external_ref", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "pay_date", "pay_schedule_id", "period_end", "period_start" ] }, "required": false, "description": "Sort order is specified using the format \n`sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by\nand `direction` is the optional sort direction (`asc` or `desc`)." }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_entity", "pay_schedule", "pay_stubs", "source_payroll" ] } }, "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 (`\"payroll\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Payroll" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With business_entity expanded", "properties": { "business_entity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessEntity" } } } } }, { "type": "object", "title": "With pay_schedule expanded", "properties": { "pay_schedule": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PaySchedule" } } } } }, { "type": "object", "title": "With pay_stubs expanded", "properties": { "pay_stubs": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/PayStub" } } } } } } } }, { "type": "object", "title": "With source_payroll expanded", "properties": { "source_payroll": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SourcePayroll" } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "payroll", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "pay_schedule": { "id": "", "object": "pay_schedule", "links": { "self": "/pay_schedules/" } }, "type": "regular", "period_number": 6, "period_label": "6", "period_start": "2026-06-01", "period_end": "2026-06-30", "pay_date": "2026-06-30", "original_pay_date": "2026-06-30", "debit_date": "2026-06-25", "approval_due_at": "2026-06-25T20:30:00.000000Z", "regular_periods_count": 12, "is_impacted_by_weekend_or_holiday": false, "is_blocked_by_draft": true, "note": null, "employee_summary": { "gross": null, "subtractions": null, "reimbursements": null, "net": null }, "contractor_summary": { "gross": null, "reimbursements": null, "net": null }, "company_summary": { "taxes_and_contributions": null, "benefits": null, "total": null }, "liability": null, "cash_requirement": null, "status": "draft", "approved_at": null, "is_stale": false, "stale_since": null, "source_payroll": 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": "/payrolls/" } }, { "id": "", "object": "payroll", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "pay_schedule": { "id": "", "object": "pay_schedule", "links": { "self": "/pay_schedules/" } }, "type": "regular", "period_number": 7, "period_label": "7", "period_start": "2026-07-01", "period_end": "2026-07-31", "pay_date": "2026-07-31", "original_pay_date": "2026-07-31", "debit_date": "2026-07-28", "approval_due_at": "2026-07-28T20:30:00.000000Z", "regular_periods_count": 12, "is_impacted_by_weekend_or_holiday": false, "is_blocked_by_draft": true, "note": null, "employee_summary": { "gross": null, "subtractions": null, "reimbursements": null, "net": null }, "contractor_summary": { "gross": null, "reimbursements": null, "net": null }, "company_summary": { "taxes_and_contributions": null, "benefits": null, "total": null }, "liability": null, "cash_requirement": null, "status": "draft", "approved_at": null, "is_stale": false, "stale_since": null, "source_payroll": 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": "/payrolls/" } }, { "id": "", "object": "payroll", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "pay_schedule": { "id": "", "object": "pay_schedule", "links": { "self": "/pay_schedules/" } }, "type": "regular", "period_number": 8, "period_label": "8", "period_start": "2026-08-01", "period_end": "2026-08-31", "pay_date": "2026-08-31", "original_pay_date": "2026-08-31", "debit_date": "2026-08-26", "approval_due_at": "2026-08-26T20:30:00.000000Z", "regular_periods_count": 12, "is_impacted_by_weekend_or_holiday": false, "is_blocked_by_draft": true, "note": null, "employee_summary": { "gross": null, "subtractions": null, "reimbursements": null, "net": null }, "contractor_summary": { "gross": null, "reimbursements": null, "net": null }, "company_summary": { "taxes_and_contributions": null, "benefits": null, "total": null }, "liability": null, "cash_requirement": null, "status": "draft", "approved_at": null, "is_stale": false, "stale_since": null, "source_payroll": 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": "/payrolls/" } }, { "id": "", "object": "payroll", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "pay_schedule": { "id": "", "object": "pay_schedule", "links": { "self": "/pay_schedules/" } }, "type": "regular", "period_number": 9, "period_label": "9", "period_start": "2026-09-01", "period_end": "2026-09-30", "pay_date": "2026-09-29", "original_pay_date": "2026-09-30", "debit_date": "2026-09-24", "approval_due_at": "2026-09-24T20:30:00.000000Z", "regular_periods_count": 12, "is_impacted_by_weekend_or_holiday": true, "is_blocked_by_draft": true, "note": null, "employee_summary": { "gross": null, "subtractions": null, "reimbursements": null, "net": null }, "contractor_summary": { "gross": null, "reimbursements": null, "net": null }, "company_summary": { "taxes_and_contributions": null, "benefits": null, "total": null }, "liability": null, "cash_requirement": null, "status": "draft", "approved_at": null, "is_stale": false, "stale_since": null, "source_payroll": 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": "/payrolls/" } }, { "id": "", "object": "payroll", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "pay_schedule": { "id": "", "object": "pay_schedule", "links": { "self": "/pay_schedules/" } }, "type": "regular", "period_number": 10, "period_label": "10", "period_start": "2026-10-01", "period_end": "2026-10-31", "pay_date": "2026-10-30", "original_pay_date": "2026-10-31", "debit_date": "2026-10-27", "approval_due_at": "2026-10-27T20:30:00.000000Z", "regular_periods_count": 12, "is_impacted_by_weekend_or_holiday": true, "is_blocked_by_draft": true, "note": null, "employee_summary": { "gross": null, "subtractions": null, "reimbursements": null, "net": null }, "contractor_summary": { "gross": null, "reimbursements": null, "net": null }, "company_summary": { "taxes_and_contributions": null, "benefits": null, "total": null }, "liability": null, "cash_requirement": null, "status": "draft", "approved_at": null, "is_stale": false, "stale_since": null, "source_payroll": 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": "/payrolls/" } }, { "id": "", "object": "payroll", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "pay_schedule": { "id": "", "object": "pay_schedule", "links": { "self": "/pay_schedules/" } }, "type": "regular", "period_number": 11, "period_label": "11", "period_start": "2026-11-01", "period_end": "2026-11-30", "pay_date": "2026-11-30", "original_pay_date": "2026-11-30", "debit_date": "2026-11-25", "approval_due_at": "2026-11-25T21:30:00.000000Z", "regular_periods_count": 12, "is_impacted_by_weekend_or_holiday": false, "is_blocked_by_draft": true, "note": null, "employee_summary": { "gross": null, "subtractions": null, "reimbursements": null, "net": null }, "contractor_summary": { "gross": null, "reimbursements": null, "net": null }, "company_summary": { "taxes_and_contributions": null, "benefits": null, "total": null }, "liability": null, "cash_requirement": null, "status": "draft", "approved_at": null, "is_stale": false, "stale_since": null, "source_payroll": 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": "/payrolls/" } }, { "id": "", "object": "payroll", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "pay_schedule": { "id": "", "object": "pay_schedule", "links": { "self": "/pay_schedules/" } }, "type": "regular", "period_number": 12, "period_label": "12", "period_start": "2026-12-01", "period_end": "2026-12-31", "pay_date": "2026-12-31", "original_pay_date": "2026-12-31", "debit_date": "2026-12-24", "approval_due_at": "2026-12-24T21:30:00.000000Z", "regular_periods_count": 12, "is_impacted_by_weekend_or_holiday": false, "is_blocked_by_draft": true, "note": null, "employee_summary": { "gross": null, "subtractions": null, "reimbursements": null, "net": null }, "contractor_summary": { "gross": null, "reimbursements": null, "net": null }, "company_summary": { "taxes_and_contributions": null, "benefits": null, "total": null }, "liability": null, "cash_requirement": null, "status": "draft", "approved_at": null, "is_stale": false, "stale_since": null, "source_payroll": 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": "/payrolls/" } }, { "id": "", "object": "payroll", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "pay_schedule": { "id": "", "object": "pay_schedule", "links": { "self": "/pay_schedules/" } }, "type": "regular", "period_number": 1, "period_label": "1", "period_start": "2027-01-01", "period_end": "2027-01-31", "pay_date": "2027-01-29", "original_pay_date": "2027-01-31", "debit_date": "2027-01-26", "approval_due_at": "2027-01-26T21:30:00.000000Z", "regular_periods_count": 12, "is_impacted_by_weekend_or_holiday": true, "is_blocked_by_draft": true, "note": null, "employee_summary": { "gross": null, "subtractions": null, "reimbursements": null, "net": null }, "contractor_summary": { "gross": null, "reimbursements": null, "net": null }, "company_summary": { "taxes_and_contributions": null, "benefits": null, "total": null }, "liability": null, "cash_requirement": null, "status": "draft", "approved_at": null, "is_stale": false, "stale_since": null, "source_payroll": 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": "/payrolls/" } } ], "links": { "first": "/payrolls?business_entity_id=&period_start%5Bgte%5D=2026-06-01&page=1", "last": "/payrolls?business_entity_id=&period_start%5Bgte%5D=2026-06-01&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 8, "has_more": false } } } } } } }, "post": { "summary": "Create a payroll", "operationId": "payrolls-store", "tags": [ "Payrolls" ], "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 (`\"payroll\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Payroll" } } }, "example": { "id": "", "object": "payroll", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "pay_schedule": { "id": "", "object": "pay_schedule", "links": { "self": "/pay_schedules/" } }, "type": "off_cycle", "period_number": 1, "period_label": "1 A", "period_start": "2026-01-01", "period_end": "2026-01-31", "pay_date": "2026-01-08", "original_pay_date": null, "debit_date": "2026-01-05", "approval_due_at": "2026-01-05T21:30:00.000000Z", "regular_periods_count": 12, "is_impacted_by_weekend_or_holiday": false, "is_blocked_by_draft": false, "note": null, "employee_summary": { "gross": null, "subtractions": null, "reimbursements": null, "net": null }, "contractor_summary": { "gross": null, "reimbursements": null, "net": null }, "company_summary": { "taxes_and_contributions": null, "benefits": null, "total": null }, "liability": null, "cash_requirement": null, "status": "draft", "approved_at": null, "is_stale": false, "stale_since": null, "source_payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "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": "/payrolls/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "pay_schedule_id": { "type": "string" }, "source_payroll_id": { "type": "string", "description": "The ID of the source regular payroll for `off_cycle` payrolls.\n\nOnly allowed when creating a Payroll of type `off_cycle`. The source payroll must be a regular payroll on the same pay-schedule." }, "type": { "type": "string", "description": "The type of payroll. `regular` payrolls are generated automatically on the Pay Schedule. `off_cycle` Payrolls are created manually against a source regular payroll. `historical` and `correction` payrolls are used to record or correct prior periods.", "enum": [ "correction", "historical", "off_cycle", "regular" ] }, "note": { "type": "string", "description": "An optional note on the payroll, visible to the partner.", "nullable": true }, "period_start": { "type": "string", "description": "The start date of the pay period.\n\nWhen creating a payroll of type `historical` or `correction`, a `period_start` date is required. A `period_start` date is prohibited on a `off_cycle` payroll.", "format": "date" }, "period_end": { "type": "string", "description": "The end date of the pay period.\n\nWhen creating a payroll of type `historical` or `correction`, a `period_end` date is required. A `period_end` date is prohibited on a `off_cycle` payroll.", "format": "date" }, "custom_pay_frequency": { "type": "string", "description": "For payrolls on a custom-frequency Pay Schedule, the pay frequency for this specific pay period.\n\nOnly allowed when creating a regular payroll on a custom frequency pay schedule where frequency is defined per payroll.", "enum": [ "bi-weekly", "monthly", "semi-monthly", "weekly" ] }, "pay_date": { "type": "string", "description": "The date on which Employees and Contractors are paid.", "format": "date" }, "original_pay_date": { "type": "string", "description": "For payrolls on a custom-frequency Pay Schedule, the originally scheduled pay date before any movement for weekends or bank holidays. Used for year-to-date calculations and tax year assignment.\n\nOnly allowed when creating a regular payroll on a custom frequency pay schedule.", "format": "date" }, "external_ref": { "type": "string", "maxLength": 255 } } }, { "type": "object", "required": [ "pay_schedule_id", "type" ] } ] }, "example": { "pay_schedule_id": "", "source_payroll_id": "", "type": "off_cycle", "pay_date": "2026-01-08" } } } } } }, "/reimbursements/batch/delete": { "post": { "summary": "Batch delete reimbursements", "operationId": "reimbursements-batch-delete", "tags": [ "Reimbursements" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "", "" ] } } } } }, "/reimbursements/batch/upsert": { "post": { "summary": "Batch upsert reimbursements", "operationId": "reimbursements-batch-upsert", "tags": [ "Reimbursements" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "minItems": 1, "maxItems": 100 }, "example": [ { "id": "", "amount": 250, "effective_from": "2026-01-01" }, { "work_assignment_id": "", "reimbursement_type": "non_taxable_reimbursement", "amount": 200, "frequency": "per_payroll", "effective_from": "2026-01-01" } ] } } } } }, "/reimbursements/bulk/create": { "post": { "summary": "Bulk create reimbursements", "operationId": "reimbursements-bulk-create", "tags": [ "Reimbursements" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } } } }, "/reimbursements/bulk/create/scope": { "post": { "summary": "Show bulk create scope for reimbursements", "operationId": "reimbursements-bulk-create-scope", "tags": [ "Reimbursements" ], "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/Reimbursement" } } } } } }, "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/reimbursements/bulk/create/scope?page=1", "last": "http://localhost/reimbursements/bulk/create/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } } } }, "/reimbursements/bulk/delete": { "post": { "summary": "Bulk delete reimbursements", "operationId": "reimbursements-bulk-delete", "tags": [ "Reimbursements" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this reimbursement is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this reimbursement is no longer applied. `null` if the reimbursement applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/reimbursements/bulk/delete/scope": { "post": { "summary": "Show bulk delete scope for reimbursements", "operationId": "reimbursements-bulk-delete-scope", "tags": [ "Reimbursements" ], "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 (`\"reimbursement\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Reimbursement" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "reimbursement", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "reimbursement_type": { "id": "", "object": "reimbursement_type", "data": { "type": "non_taxable_reimbursement", "label": "Non-Taxable Reimbursement" }, "links": { "self": "/reimbursement_types/non_taxable_reimbursement" } }, "title": null, "title_translations": null, "title_translated": null, "frequency": "per_payroll", "date_basis": null, "pay_period_cadence": null, "amount": 35, "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": "/reimbursements/" } } ], "links": { "first": "http://localhost/reimbursements/bulk/delete/scope?page=1", "last": "http://localhost/reimbursements/bulk/delete/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this reimbursement is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this reimbursement is no longer applied. `null` if the reimbursement applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/reimbursements/bulk/update": { "post": { "summary": "Bulk update reimbursements", "operationId": "reimbursements-bulk-update", "tags": [ "Reimbursements" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this reimbursement is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this reimbursement is no longer applied. `null` if the reimbursement applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/reimbursements/bulk/update/scope": { "post": { "summary": "Show bulk update scope for reimbursements", "operationId": "reimbursements-bulk-update-scope", "tags": [ "Reimbursements" ], "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 (`\"reimbursement\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Reimbursement" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "reimbursement", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "reimbursement_type": { "id": "", "object": "reimbursement_type", "data": { "type": "non_taxable_reimbursement", "label": "Non-Taxable Reimbursement" }, "links": { "self": "/reimbursement_types/non_taxable_reimbursement" } }, "title": null, "title_translations": null, "title_translated": null, "frequency": "per_payroll", "date_basis": null, "pay_period_cadence": null, "amount": 35, "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": "/reimbursements/" } } ], "links": { "first": "http://localhost/reimbursements/bulk/update/scope?page=1", "last": "http://localhost/reimbursements/bulk/update/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this reimbursement is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this reimbursement is no longer applied. `null` if the reimbursement applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/reimbursements": { "get": { "summary": "List reimbursements", "operationId": "reimbursements-index", "tags": [ "Reimbursements" ], "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": "contractor_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": [ "health_spending_account", "non_taxable_reimbursement", "professional_membership", "taxable_reimbursement", "transit_pass", "wellness_spending_account" ] }, { "type": "array", "items": { "type": "string", "enum": [ "health_spending_account", "non_taxable_reimbursement", "professional_membership", "taxable_reimbursement", "transit_pass", "wellness_spending_account" ] } } ] }, "required": false }, { "name": "exclude_types", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "health_spending_account", "non_taxable_reimbursement", "professional_membership", "taxable_reimbursement", "transit_pass", "wellness_spending_account" ] }, { "type": "array", "items": { "type": "string", "enum": [ "health_spending_account", "non_taxable_reimbursement", "professional_membership", "taxable_reimbursement", "transit_pass", "wellness_spending_account" ] } } ] }, "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:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `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:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `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 \n`sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by\nand `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": "requires_tag_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "requires_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 (`\"reimbursement\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Reimbursement" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With business_preset expanded", "properties": { "business_preset": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessPreset" } } } } }, { "type": "object", "title": "With work_assignment expanded", "properties": { "work_assignment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WorkAssignment" } } } } }, { "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": "reimbursement", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "reimbursement_type": { "id": "", "object": "reimbursement_type", "data": { "type": "non_taxable_reimbursement", "label": "Non-Taxable Reimbursement" }, "links": { "self": "/reimbursement_types/non_taxable_reimbursement" } }, "title": null, "title_translations": null, "title_translated": null, "frequency": "per_payroll", "date_basis": null, "pay_period_cadence": null, "amount": 35, "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": "/reimbursements/" } } ], "links": { "first": "/reimbursements?work_assignment_id=&page=1", "last": "/reimbursements?work_assignment_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create a reimbursement", "operationId": "reimbursements-store", "tags": [ "Reimbursements" ], "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 (`\"reimbursement\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Reimbursement" } } }, "example": { "id": "", "object": "reimbursement", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "reimbursement_type": { "id": "", "object": "reimbursement_type", "data": { "type": "non_taxable_reimbursement", "label": "Non-Taxable Reimbursement" }, "links": { "self": "/reimbursement_types/non_taxable_reimbursement" } }, "title": null, "title_translations": null, "title_translated": null, "frequency": "per_payroll", "date_basis": null, "pay_period_cadence": null, "amount": 35, "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": "/reimbursements/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "work_assignment_id": { "type": "string" }, "business_preset_id": { "type": "string" }, "reimbursement_type": { "type": "string", "description": "The type of reimbursement, which determines how it is categorized and reported on Pay Stubs.\n\nMust be present when `business_preset_id` is either empty or not set.", "enum": [ "health_spending_account", "non_taxable_reimbursement", "professional_membership", "taxable_reimbursement", "transit_pass", "wellness_spending_account" ] }, "amount": { "type": "number", "description": "The monetary amount applied each time this reimbursement is included on a Pay Stub.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "frequency": { "type": "string", "description": "The frequency at which this reimbursement 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 reimbursement is applied to Pay Stubs.", "format": "date" }, "effective_to": { "type": "string", "description": "The date after which this reimbursement is no longer applied. `null` if the reimbursement applies indefinitely.", "format": "date" }, "expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string" }, "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 }, "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": "", "reimbursement_type": "non_taxable_reimbursement", "amount": "35", "frequency": "per_payroll", "effective_from": "2026-01-01", "tag_assignment": { "unit": "percentage", "tag_allocations": [ { "tags": [ "" ], "value": 100 } ] } } } } } } }, "/reimbursements/search": { "post": { "summary": "Search reimbursements", "description": "Search reimbursements under the given business entity, returning the same set the equivalent bulk update/delete operation would target with this body.", "operationId": "reimbursements-search", "tags": [ "Reimbursements" ], "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 (`\"reimbursement\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Reimbursement" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "reimbursement", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "reimbursement_type": { "id": "", "object": "reimbursement_type", "data": { "type": "non_taxable_reimbursement", "label": "Non-Taxable Reimbursement" }, "links": { "self": "/reimbursement_types/non_taxable_reimbursement" } }, "title": null, "title_translations": null, "title_translated": null, "frequency": "per_payroll", "date_basis": null, "pay_period_cadence": null, "amount": 35, "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": "/reimbursements/" } } ], "links": { "first": "http://localhost/reimbursements/search?page=1", "last": "http://localhost/reimbursements/search?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "The date from which this reimbursement is applied to Pay Stubs.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "The date after which this reimbursement is no longer applied. `null` if the reimbursement applies indefinitely.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/reimbursement_line_items/batch/delete": { "post": { "summary": "Batch delete reimbursement line items", "operationId": "reimbursement-line-items-batch-delete", "tags": [ "Reimbursement Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "", "" ] } } } } }, "/reimbursement_line_items/batch/upsert": { "post": { "summary": "Batch upsert reimbursement line items", "operationId": "reimbursement-line-items-batch-upsert", "tags": [ "Reimbursement Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "minItems": 1, "maxItems": 100 }, "example": [ { "id": "", "custom_amount": 250 }, { "pay_stub_id": "", "reimbursement_type": "non_taxable_reimbursement", "custom_amount": 200 } ] } } } } }, "/reimbursement_line_items/bulk/create": { "post": { "summary": "Bulk create reimbursement line items", "operationId": "reimbursement-line-items-bulk-create", "tags": [ "Reimbursement Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/reimbursement_line_items/bulk/create/scope": { "post": { "summary": "Show bulk create scope for reimbursement line items", "operationId": "reimbursement-line-items-bulk-create-scope", "tags": [ "Reimbursement Line Items" ], "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 (`\"pay_stub\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/ReimbursementLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "pay_stub", "data": { "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "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, "apply_standard_tax_reductions": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_stubs/" } } ], "links": { "first": "http://localhost/reimbursement_line_items/bulk/create/scope?page=1", "last": "http://localhost/reimbursement_line_items/bulk/create/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/reimbursement_line_items/bulk/delete": { "post": { "summary": "Bulk delete reimbursement line items", "operationId": "reimbursement-line-items-bulk-delete", "tags": [ "Reimbursement Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/reimbursement_line_items/bulk/delete/scope": { "post": { "summary": "Show bulk delete scope for reimbursement line items", "operationId": "reimbursement-line-items-bulk-delete-scope", "tags": [ "Reimbursement Line Items" ], "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 (`\"reimbursement_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/ReimbursementLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "reimbursement_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "reimbursement", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "accrued_vacation_pay": 0, "reimbursement_type": { "id": "", "object": "reimbursement_type", "data": { "type": "non_taxable_reimbursement", "label": "Non-Taxable Reimbursement" }, "links": { "self": "/reimbursement_types/non_taxable_reimbursement" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reimbursement_line_items/" } } ], "links": { "first": "http://localhost/reimbursement_line_items/bulk/delete/scope?page=1", "last": "http://localhost/reimbursement_line_items/bulk/delete/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/reimbursement_line_items/bulk/update": { "post": { "summary": "Bulk update reimbursement line items", "operationId": "reimbursement-line-items-bulk-update", "tags": [ "Reimbursement Line Items" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/reimbursement_line_items/bulk/update/scope": { "post": { "summary": "Show bulk update scope for reimbursement line items", "operationId": "reimbursement-line-items-bulk-update-scope", "tags": [ "Reimbursement Line Items" ], "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 (`\"reimbursement_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/ReimbursementLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "reimbursement_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "reimbursement", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "accrued_vacation_pay": 0, "reimbursement_type": { "id": "", "object": "reimbursement_type", "data": { "type": "non_taxable_reimbursement", "label": "Non-Taxable Reimbursement" }, "links": { "self": "/reimbursement_types/non_taxable_reimbursement" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reimbursement_line_items/" } } ], "links": { "first": "http://localhost/reimbursement_line_items/bulk/update/scope?page=1", "last": "http://localhost/reimbursement_line_items/bulk/update/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/reimbursement_line_items": { "get": { "summary": "List reimbursement line items", "operationId": "reimbursement-line-items-index", "tags": [ "Reimbursement Line Items" ], "parameters": [ { "name": "pay_stub_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "payroll_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "payroll_status", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] }, { "type": "array", "items": { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] } } ] }, "required": false }, { "name": "payroll_type", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] }, { "type": "array", "items": { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] } } ] }, "required": false }, { "name": "payroll_period_start", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_period_start=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_period_start[gte]=2024-01-01&payroll_period_start[lt]=2024-12-31`" }, { "name": "payroll_period_end", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_period_end=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_period_end[gte]=2024-01-01&payroll_period_end[lt]=2024-12-31`" }, { "name": "payroll_pay_date", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_pay_date=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_pay_date[gte]=2024-01-01&payroll_pay_date[lt]=2024-12-31`" }, { "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": "contractor_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "business_entity_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": [ "health_spending_account", "non_taxable_reimbursement", "professional_membership", "taxable_reimbursement", "transit_pass", "wellness_spending_account" ] }, { "type": "array", "items": { "type": "string", "enum": [ "health_spending_account", "non_taxable_reimbursement", "professional_membership", "taxable_reimbursement", "transit_pass", "wellness_spending_account" ] } } ] }, "required": false }, { "name": "exclude_types", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "health_spending_account", "non_taxable_reimbursement", "professional_membership", "taxable_reimbursement", "transit_pass", "wellness_spending_account" ] }, { "type": "array", "items": { "type": "string", "enum": [ "health_spending_account", "non_taxable_reimbursement", "professional_membership", "taxable_reimbursement", "transit_pass", "wellness_spending_account" ] } } ] }, "required": false }, { "name": "external_ref", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "earned_on", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Only return line items with an `earned_on` date matching the filter.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `earned_on=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `earned_on[gte]=2024-01-01&earned_on[lt]=2024-12-31`" }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "custom_expense_accounting_code", "custom_liability_accounting_code", "custom_tag_assignment", "expense_accounting_code", "liability_accounting_code", "managed_expense_accounting_code", "managed_liability_accounting_code", "managed_tag_assignment", "pay_stub", "recurrence", "source_adjustment", "tag_assignment", "tag_assignment_amounts" ] } }, "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 (`\"reimbursement_line_item\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ReimbursementLineItem" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With pay_stub expanded", "properties": { "pay_stub": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayStub" } } } } }, { "type": "object", "title": "With recurrence expanded", "properties": { "recurrence": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Recurrence" } } } } }, { "type": "object", "title": "With business_preset expanded", "properties": { "business_preset": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessPreset" } } } } }, { "type": "object", "title": "With source_adjustment expanded", "properties": { "source_adjustment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SourceAdjustment" } } } } }, { "type": "object", "title": "With expense_accounting_code expanded", "properties": { "expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ExpenseAccountingCode" } } } } }, { "type": "object", "title": "With managed_expense_accounting_code expanded", "properties": { "managed_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedExpenseAccountingCode" } } } } }, { "type": "object", "title": "With custom_expense_accounting_code expanded", "properties": { "custom_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomExpenseAccountingCode" } } } } }, { "type": "object", "title": "With liability_accounting_code expanded", "properties": { "liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LiabilityAccountingCode" } } } } }, { "type": "object", "title": "With managed_liability_accounting_code expanded", "properties": { "managed_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedLiabilityAccountingCode" } } } } }, { "type": "object", "title": "With custom_liability_accounting_code expanded", "properties": { "custom_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomLiabilityAccountingCode" } } } } }, { "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" } } } } }, { "type": "object", "title": "With managed_tag_assignment expanded", "properties": { "managed_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/ManagedTagAssignment" } } } } }, { "type": "object", "title": "With custom_tag_assignment expanded", "properties": { "custom_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/CustomTagAssignment" } } } } }, { "type": "object", "title": "With tag_assignment_amounts expanded", "properties": { "tag_assignment_amounts": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/TagAssignmentAmount" } } } } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "reimbursement_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "reimbursement", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "accrued_vacation_pay": 0, "reimbursement_type": { "id": "", "object": "reimbursement_type", "data": { "type": "non_taxable_reimbursement", "label": "Non-Taxable Reimbursement" }, "links": { "self": "/reimbursement_types/non_taxable_reimbursement" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reimbursement_line_items/" } } ], "links": { "first": "/reimbursement_line_items?pay_stub_id=&page=1", "last": "/reimbursement_line_items?pay_stub_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create a reimbursement line item", "operationId": "reimbursement-line-items-store", "tags": [ "Reimbursement Line Items" ], "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 (`\"reimbursement_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/ReimbursementLineItem" } } }, "example": { "id": "", "object": "reimbursement_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "reimbursement", "is_managed": false, "amount": 0, "custom_amount": null, "managed_amount": null, "accrued_vacation_pay": 0, "reimbursement_type": { "id": "", "object": "reimbursement_type", "data": { "type": "non_taxable_reimbursement", "label": "Non-Taxable Reimbursement" }, "links": { "self": "/reimbursement_types/non_taxable_reimbursement" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reimbursement_line_items/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "pay_stub_id": { "type": "string" }, "business_preset_id": { "type": "string" }, "reimbursement_type": { "type": "string", "description": "The type of reimbursement for this line item.\n\nMust be present when `business_preset_id` is either empty or not set.", "enum": [ "health_spending_account", "non_taxable_reimbursement", "professional_membership", "taxable_reimbursement", "transit_pass", "wellness_spending_account" ] }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.", "format": "decimal", "maximum": 99999 }, "accrued_vacation_pay": { "type": "number", "description": "The vacation pay accrued on this line item, calculated based on the Work Assignment's Vacation Pay Settings.", "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 }, "expense_accounting_code_id": { "type": "string" }, "custom_expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string" }, "custom_liability_accounting_code_id": { "type": "string" }, "component_settings": { "type": "object", "properties": { "attributes_locked": { "type": "boolean" } } }, "custom_earned_on": { "type": "string", "format": "date" }, "external_ref": { "type": "string", "maxLength": 255 }, "custom_tag_assignment": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "amount", "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 } } } } } } } }, { "type": "object", "required": [ "pay_stub_id" ] } ] }, "example": { "pay_stub_id": "", "reimbursement_type": "non_taxable_reimbursement", "accrued_vacation_pay": "0", "custom_tag_assignment": { "unit": "percentage", "tag_allocations": [ { "tags": [ "" ], "value": 100 } ] } } } } } } }, "/reimbursement_line_items/search": { "post": { "summary": "Search reimbursement line items", "description": "Search line items under the given payroll, returning the same set the equivalent bulk update/delete operation would target with this body.", "operationId": "reimbursement-line-items-search", "tags": [ "Reimbursement Line Items" ], "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 (`\"reimbursement_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/ReimbursementLineItem" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "reimbursement_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "reimbursement", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "accrued_vacation_pay": 0, "reimbursement_type": { "id": "", "object": "reimbursement_type", "data": { "type": "non_taxable_reimbursement", "label": "Non-Taxable Reimbursement" }, "links": { "self": "/reimbursement_types/non_taxable_reimbursement" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reimbursement_line_items/" } } ], "links": { "first": "http://localhost/reimbursement_line_items/search?page=1", "last": "http://localhost/reimbursement_line_items/search?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "payroll_id": { "type": "string" }, "pay_stubs": { "type": "object", "properties": { "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "work_assignment_ids": { "type": "array", "items": { "type": "string" } } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "payroll_id", "pay_stubs" ] } ] }, "example": { "payroll_id": "", "pay_stubs": { "include": "all" } } } } } } }, "/reimbursement_types": { "get": { "summary": "List reimbursement types", "operationId": "reimbursement-types-index", "tags": [ "Reimbursement Types" ], "parameters": [ { "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)." }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Comma-separated list of type identifiers to return." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Case-insensitive substring match against the human-readable label, in any supported locale." } ], "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 (`\"reimbursement_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/ReimbursementType" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "reimbursement_type", "data": { "type": "health_spending_account", "label": "Health Spending Account (HSA)", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Health Spending Account (HSA) is subject to Income Tax.", "program_label": null } ] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Health Spending Account (HSA) is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Health Spending Account (HSA) is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Health Spending Account (HSA) is subject to CNESST.", "program_label": "CNESST" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Health Spending Account (HSA) is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Health Spending Account (HSA)", "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" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/reimbursement_types/health_spending_account" } }, { "id": "", "object": "reimbursement_type", "data": { "type": "non_taxable_reimbursement", "label": "Non-Taxable Reimbursement", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/reimbursement_types/non_taxable_reimbursement" } }, { "id": "", "object": "reimbursement_type", "data": { "type": "professional_membership", "label": "Professional Membership", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Professional Membership is subject to Income Tax.", "program_label": null } ] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Professional Membership is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Professional Membership is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Professional Membership is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Professional Membership is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Professional Membership is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Professional Membership is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Professional Membership is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Professional Membership is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Professional Membership is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Professional Membership is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Professional Membership is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Professional Membership is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Professional Membership is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Professional Membership is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/reimbursement_types/professional_membership" } }, { "id": "", "object": "reimbursement_type", "data": { "type": "taxable_reimbursement", "label": "Taxable Reimbursement", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement 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": "Taxable Reimbursement is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" } ] ] } ] }, "links": { "self": "/reimbursement_types/taxable_reimbursement" } }, { "id": "", "object": "reimbursement_type", "data": { "type": "transit_pass", "label": "Transit Pass", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Transit Pass 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": "Transit Pass is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to CPP.", "program_label": "CPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Transit Pass is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Transit Pass", "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" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] } ] }, "links": { "self": "/reimbursement_types/transit_pass" } }, { "id": "", "object": "reimbursement_type", "data": { "type": "wellness_spending_account", "label": "Wellness Spending Account (WSA)", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) 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": "Wellness Spending Account (WSA) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Wellness Spending Account (WSA) is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Wellness Spending Account (WSA)", "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" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/reimbursement_types/wellness_spending_account" } } ], "links": { "first": "/reimbursement_types?features=ca&page=1", "last": "/reimbursement_types?features=ca&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 6, "has_more": false } } } } } } } }, "/remittance_accounts": { "get": { "summary": "List remittance accounts", "operationId": "remittance-accounts-index", "tags": [ "Remittance Accounts" ], "parameters": [ { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "category", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "ca_benefit_provider", "ca_provincial_government", "ca_tax_agency", "ca_union", "ca_workers_compensation" ] }, { "type": "array", "items": { "type": "string", "enum": [ "ca_benefit_provider", "ca_provincial_government", "ca_tax_agency", "ca_union", "ca_workers_compensation" ] } } ] }, "required": false }, { "name": "has_payments", "in": "query", "schema": { "type": "boolean" }, "required": false }, { "name": "account_provider", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "ca_ab_workers_compensation", "ca_bc_eht", "ca_bc_workers_compensation", "ca_cra", "ca_mb_eht", "ca_mb_workers_compensation", "ca_nb_workers_compensation", "ca_nl_eht", "ca_nl_workers_compensation", "ca_ns_workers_compensation", "ca_nt_government", "ca_nt_workers_compensation", "ca_nu_government", "ca_nu_workers_compensation", "ca_on_eht", "ca_on_workers_compensation", "ca_pe_workers_compensation", "ca_rq", "ca_sk_workers_compensation", "ca_yt_workers_compensation" ] }, { "type": "array", "items": { "type": "string", "enum": [ "ca_ab_workers_compensation", "ca_bc_eht", "ca_bc_workers_compensation", "ca_cra", "ca_mb_eht", "ca_mb_workers_compensation", "ca_nb_workers_compensation", "ca_nl_eht", "ca_nl_workers_compensation", "ca_ns_workers_compensation", "ca_nt_government", "ca_nt_workers_compensation", "ca_nu_government", "ca_nu_workers_compensation", "ca_on_eht", "ca_on_workers_compensation", "ca_pe_workers_compensation", "ca_rq", "ca_sk_workers_compensation", "ca_yt_workers_compensation" ] } } ] }, "required": false }, { "name": "system_type", "in": "query", "schema": { "type": "string", "enum": [ "ca_ab_workers_compensation", "ca_bc_eht", "ca_bc_workers_compensation", "ca_cra", "ca_mb_eht", "ca_mb_workers_compensation", "ca_nb_workers_compensation", "ca_nl_eht", "ca_nl_workers_compensation", "ca_ns_workers_compensation", "ca_nt_government", "ca_nt_workers_compensation", "ca_nu_government", "ca_nu_workers_compensation", "ca_on_eht", "ca_on_workers_compensation", "ca_pe_workers_compensation", "ca_rq", "ca_sk_workers_compensation", "ca_yt_workers_compensation" ] }, "required": false }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_entity", "linked_remittance_account", "remittance_account_enrollments", "source_tax_property", "superseded_by" ] } }, "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 (`\"remittance_account\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RemittanceAccount" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With business_entity expanded", "properties": { "business_entity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessEntity" } } } } }, { "type": "object", "title": "With source_tax_property expanded", "properties": { "source_tax_property": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SourceTaxProperty" } } } } }, { "type": "object", "title": "With remittance_account_enrollments expanded", "properties": { "remittance_account_enrollments": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/RemittanceAccountEnrollment" } } } } } } } }, { "type": "object", "title": "With superseded_by expanded", "properties": { "superseded_by": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SupersededBy" } } } } }, { "type": "object", "title": "With linked_remittance_account expanded", "properties": { "linked_remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LinkedRemittanceAccount" } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "remittance_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "source_tax_property": null, "account_provider": "ca_on_workers_compensation", "is_default": false, "is_editable": true, "is_deletable": true, "linked_remittance_account": null, "category": "ca_workers_compensation", "label": "Workplace Safety and Insurance Board (WSIB Ontario)", "label_translations": { "en": "Workplace Safety and Insurance Board (WSIB Ontario)", "fr": "Commission de la s\u00e9curit\u00e9 professionnelle et de l'assurance contre les accidents du travail (WSIB Ontario)" }, "label_translated": "Workplace Safety and Insurance Board (WSIB Ontario)", "account_identifier": null, "superseded_by": null, "superseded_on": null, "remitter_type": null, "remittance_management": "manual", "note": null, "address_line_1": null, "address_line_2": null, "city": null, "administrative_area": null, "province_code": null, "country_code": null, "postal_code": null, "has_payments": false, "current_enrollments_count": 0, "pending_enrollments_count": 0, "metadata": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_accounts/" } }, { "id": "", "object": "remittance_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "source_tax_property": null, "account_provider": "ca_bc_workers_compensation", "is_default": false, "is_editable": true, "is_deletable": true, "linked_remittance_account": null, "category": "ca_workers_compensation", "label": "WorkSafeBC (WSBC British Columbia)", "label_translations": { "en": "WorkSafeBC (WSBC British Columbia)", "fr": "WorkSafeBC (WSBC British Columbia)" }, "label_translated": "WorkSafeBC (WSBC British Columbia)", "account_identifier": null, "superseded_by": null, "superseded_on": null, "remitter_type": null, "remittance_management": "manual", "note": null, "address_line_1": null, "address_line_2": null, "city": null, "administrative_area": null, "province_code": null, "country_code": null, "postal_code": null, "has_payments": false, "current_enrollments_count": 0, "pending_enrollments_count": 0, "metadata": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_accounts/" } }, { "id": "", "object": "remittance_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "source_tax_property": null, "account_provider": "ca_ab_workers_compensation", "is_default": false, "is_editable": true, "is_deletable": true, "linked_remittance_account": null, "category": "ca_workers_compensation", "label": "Workers Compensation Board (WCB Alberta)", "label_translations": { "en": "Workers Compensation Board (WCB Alberta)", "fr": "Commission des accidents du travail de l'Alberta (CAT-Alberta)" }, "label_translated": "Workers Compensation Board (WCB Alberta)", "account_identifier": null, "superseded_by": null, "superseded_on": null, "remitter_type": null, "remittance_management": "manual", "note": null, "address_line_1": null, "address_line_2": null, "city": null, "administrative_area": null, "province_code": null, "country_code": null, "postal_code": null, "has_payments": false, "current_enrollments_count": 0, "pending_enrollments_count": 0, "metadata": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_accounts/" } }, { "id": "", "object": "remittance_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "source_tax_property": null, "account_provider": "ca_sk_workers_compensation", "is_default": false, "is_editable": true, "is_deletable": true, "linked_remittance_account": null, "category": "ca_workers_compensation", "label": "Workers Compensation Board (WCB Saskatchewan)", "label_translations": { "en": "Workers Compensation Board (WCB Saskatchewan)", "fr": "Workers Compensation Board (WCB Saskatchewan)" }, "label_translated": "Workers Compensation Board (WCB Saskatchewan)", "account_identifier": null, "superseded_by": null, "superseded_on": null, "remitter_type": null, "remittance_management": "manual", "note": null, "address_line_1": null, "address_line_2": null, "city": null, "administrative_area": null, "province_code": null, "country_code": null, "postal_code": null, "has_payments": false, "current_enrollments_count": 0, "pending_enrollments_count": 0, "metadata": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_accounts/" } }, { "id": "", "object": "remittance_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "source_tax_property": null, "account_provider": "ca_mb_workers_compensation", "is_default": false, "is_editable": true, "is_deletable": true, "linked_remittance_account": null, "category": "ca_workers_compensation", "label": "Workers Compensation Board (WCB Manitoba)", "label_translations": { "en": "Workers Compensation Board (WCB Manitoba)", "fr": "Commission des accidents du travail du Manitoba (WCB Manitoba)" }, "label_translated": "Workers Compensation Board (WCB Manitoba)", "account_identifier": null, "superseded_by": null, "superseded_on": null, "remitter_type": null, "remittance_management": "manual", "note": null, "address_line_1": null, "address_line_2": null, "city": null, "administrative_area": null, "province_code": null, "country_code": null, "postal_code": null, "has_payments": false, "current_enrollments_count": 0, "pending_enrollments_count": 0, "metadata": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_accounts/" } }, { "id": "", "object": "remittance_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "source_tax_property": null, "account_provider": "ca_nb_workers_compensation", "is_default": false, "is_editable": true, "is_deletable": true, "linked_remittance_account": null, "category": "ca_workers_compensation", "label": "WorkSafeNB (WSNB New Brunswick)", "label_translations": { "en": "WorkSafeNB (WSNB New Brunswick)", "fr": "Travail s\u00e9curitaire NB (WSNB Nouveau-Brunswick)" }, "label_translated": "WorkSafeNB (WSNB New Brunswick)", "account_identifier": null, "superseded_by": null, "superseded_on": null, "remitter_type": null, "remittance_management": "manual", "note": null, "address_line_1": null, "address_line_2": null, "city": null, "administrative_area": null, "province_code": null, "country_code": null, "postal_code": null, "has_payments": false, "current_enrollments_count": 0, "pending_enrollments_count": 0, "metadata": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_accounts/" } }, { "id": "", "object": "remittance_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "source_tax_property": null, "account_provider": "ca_ns_workers_compensation", "is_default": false, "is_editable": true, "is_deletable": true, "linked_remittance_account": null, "category": "ca_workers_compensation", "label": "Workers Compensation Board (WCB Nova Scotia)", "label_translations": { "en": "Workers Compensation Board (WCB Nova Scotia)", "fr": "Workers Compensation Board (WCB Nova Scotia)" }, "label_translated": "Workers Compensation Board (WCB Nova Scotia)", "account_identifier": null, "superseded_by": null, "superseded_on": null, "remitter_type": null, "remittance_management": "manual", "note": null, "address_line_1": null, "address_line_2": null, "city": null, "administrative_area": null, "province_code": null, "country_code": null, "postal_code": null, "has_payments": false, "current_enrollments_count": 0, "pending_enrollments_count": 0, "metadata": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_accounts/" } }, { "id": "", "object": "remittance_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "source_tax_property": null, "account_provider": "ca_pe_workers_compensation", "is_default": false, "is_editable": true, "is_deletable": true, "linked_remittance_account": null, "category": "ca_workers_compensation", "label": "Workers Compensation Board (WCB Prince Edward Island)", "label_translations": { "en": "Workers Compensation Board (WCB Prince Edward Island)", "fr": "Workers Compensation Board (WCB Prince Edward Island)" }, "label_translated": "Workers Compensation Board (WCB Prince Edward Island)", "account_identifier": null, "superseded_by": null, "superseded_on": null, "remitter_type": null, "remittance_management": "manual", "note": null, "address_line_1": null, "address_line_2": null, "city": null, "administrative_area": null, "province_code": null, "country_code": null, "postal_code": null, "has_payments": false, "current_enrollments_count": 0, "pending_enrollments_count": 0, "metadata": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_accounts/" } }, { "id": "", "object": "remittance_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "source_tax_property": null, "account_provider": "ca_nl_workers_compensation", "is_default": false, "is_editable": true, "is_deletable": true, "linked_remittance_account": null, "category": "ca_workers_compensation", "label": "WorkplaceNL (WNL Newfoundland and Labrador)", "label_translations": { "en": "WorkplaceNL (WNL Newfoundland and Labrador)", "fr": "WorkplaceNL (WNL Newfoundland and Labrador)" }, "label_translated": "WorkplaceNL (WNL Newfoundland and Labrador)", "account_identifier": null, "superseded_by": null, "superseded_on": null, "remitter_type": null, "remittance_management": "manual", "note": null, "address_line_1": null, "address_line_2": null, "city": null, "administrative_area": null, "province_code": null, "country_code": null, "postal_code": null, "has_payments": false, "current_enrollments_count": 0, "pending_enrollments_count": 0, "metadata": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_accounts/" } }, { "id": "", "object": "remittance_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "source_tax_property": null, "account_provider": "ca_yt_workers_compensation", "is_default": false, "is_editable": true, "is_deletable": true, "linked_remittance_account": null, "category": "ca_workers_compensation", "label": "Workers' Safety and Compensation Board (WSCB Yukon)", "label_translations": { "en": "Workers' Safety and Compensation Board (WSCB Yukon)", "fr": "Commission de la s\u00e9curit\u00e9 et de l'indemnisation des travailleurs (WSCB Yukon)" }, "label_translated": "Workers' Safety and Compensation Board (WSCB Yukon)", "account_identifier": null, "superseded_by": null, "superseded_on": null, "remitter_type": null, "remittance_management": "manual", "note": null, "address_line_1": null, "address_line_2": null, "city": null, "administrative_area": null, "province_code": null, "country_code": null, "postal_code": null, "has_payments": false, "current_enrollments_count": 0, "pending_enrollments_count": 0, "metadata": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_accounts/" } }, { "id": "", "object": "remittance_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "source_tax_property": null, "account_provider": "ca_nt_workers_compensation", "is_default": false, "is_editable": true, "is_deletable": true, "linked_remittance_account": null, "category": "ca_workers_compensation", "label": "Workers Safety and Compensation Commission (WSCC Northwest Territories)", "label_translations": { "en": "Workers Safety and Compensation Commission (WSCC Northwest Territories)", "fr": "Commission de la s\u00e9curit\u00e9 au travail et de l'indemnisation des travailleurs (CSTIT Territoires du Nord-Ouest)" }, "label_translated": "Workers Safety and Compensation Commission (WSCC Northwest Territories)", "account_identifier": null, "superseded_by": null, "superseded_on": null, "remitter_type": null, "remittance_management": "manual", "note": null, "address_line_1": null, "address_line_2": null, "city": null, "administrative_area": null, "province_code": null, "country_code": null, "postal_code": null, "has_payments": false, "current_enrollments_count": 0, "pending_enrollments_count": 0, "metadata": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_accounts/" } }, { "id": "", "object": "remittance_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "source_tax_property": null, "account_provider": "ca_nu_workers_compensation", "is_default": false, "is_editable": true, "is_deletable": true, "linked_remittance_account": null, "category": "ca_workers_compensation", "label": "Workers Safety and Compensation Commission (WSCC Nunavut)", "label_translations": { "en": "Workers Safety and Compensation Commission (WSCC Nunavut)", "fr": "Commission de la s\u00e9curit\u00e9 au travail et de l'indemnisation des travailleurs (CSTIT Nunavut)" }, "label_translated": "Workers Safety and Compensation Commission (WSCC Nunavut)", "account_identifier": null, "superseded_by": null, "superseded_on": null, "remitter_type": null, "remittance_management": "manual", "note": null, "address_line_1": null, "address_line_2": null, "city": null, "administrative_area": null, "province_code": null, "country_code": null, "postal_code": null, "has_payments": false, "current_enrollments_count": 0, "pending_enrollments_count": 0, "metadata": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_accounts/" } }, { "id": "", "object": "remittance_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "source_tax_property": null, "account_provider": "ca_nt_government", "is_default": false, "is_editable": true, "is_deletable": true, "linked_remittance_account": null, "category": "ca_provincial_government", "label": "Government of Northwest Territories", "label_translations": { "en": "Government of Northwest Territories", "fr": "Gouvernement des Territoires du Nord-Ouest" }, "label_translated": "Government of Northwest Territories", "account_identifier": null, "superseded_by": null, "superseded_on": null, "remitter_type": null, "remittance_management": "manual", "note": null, "address_line_1": null, "address_line_2": null, "city": null, "administrative_area": null, "province_code": null, "country_code": null, "postal_code": null, "has_payments": false, "current_enrollments_count": 0, "pending_enrollments_count": 0, "metadata": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_accounts/" } }, { "id": "", "object": "remittance_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "source_tax_property": null, "account_provider": "ca_nu_government", "is_default": false, "is_editable": true, "is_deletable": true, "linked_remittance_account": null, "category": "ca_provincial_government", "label": "Government of Nunavut", "label_translations": { "en": "Government of Nunavut", "fr": "Gouvernement du Nunavut" }, "label_translated": "Government of Nunavut", "account_identifier": null, "superseded_by": null, "superseded_on": null, "remitter_type": null, "remittance_management": "manual", "note": null, "address_line_1": null, "address_line_2": null, "city": null, "administrative_area": null, "province_code": null, "country_code": null, "postal_code": null, "has_payments": false, "current_enrollments_count": 0, "pending_enrollments_count": 0, "metadata": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_accounts/" } }, { "id": "", "object": "remittance_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "source_tax_property": null, "account_provider": "ca_on_eht", "is_default": false, "is_editable": true, "is_deletable": true, "linked_remittance_account": null, "category": "ca_provincial_government", "label": "Ontario Ministry of Finance (EHT)", "label_translations": { "en": "Ontario Ministry of Finance (EHT)", "fr": "Minist\u00e8re des Finances de l'Ontario (ISE)" }, "label_translated": "Ontario Ministry of Finance (EHT)", "account_identifier": null, "superseded_by": null, "superseded_on": null, "remitter_type": null, "remittance_management": "manual", "note": null, "address_line_1": null, "address_line_2": null, "city": null, "administrative_area": null, "province_code": null, "country_code": null, "postal_code": null, "has_payments": false, "current_enrollments_count": 0, "pending_enrollments_count": 0, "metadata": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_accounts/" } } ], "links": { "first": "/remittance_accounts?business_entity_id=&page=1", "last": "/remittance_accounts?business_entity_id=&page=2", "prev": null, "next": "/remittance_accounts?business_entity_id=&page=2" }, "meta": { "current_page": 1, "last_page": 2, "per_page": 15, "total": 20, "has_more": true } } } } } } }, "post": { "summary": "Create a remittance account", "operationId": "remittance-accounts-store", "tags": [ "Remittance Accounts" ], "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 (`\"remittance_account\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/RemittanceAccount" } } }, "example": { "id": "", "object": "remittance_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "source_tax_property": { "id": "", "object": "tax_property", "links": { "self": "/tax_properties/" } }, "account_provider": "ca_cra", "is_default": true, "is_editable": true, "is_deletable": true, "linked_remittance_account": null, "category": "ca_tax_agency", "label": "CRA Payroll Account", "label_translations": null, "label_translated": "CRA Payroll Account", "account_identifier": "123456789RP0001", "superseded_by": null, "superseded_on": null, "remitter_type": "regular", "remittance_management": "automatic", "note": "Main payroll remittance account", "address_line_1": "555 MacKenzie Ave", "address_line_2": null, "city": "Ottawa", "administrative_area": "ON", "province_code": "ON", "country_code": "CA", "postal_code": "K1A 0L5", "has_payments": false, "current_enrollments_count": 0, "pending_enrollments_count": 0, "metadata": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_accounts/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "business_entity_id": { "type": "string" }, "account_provider": { "type": "string", "enum": [ "ca_ab_workers_compensation", "ca_bc_eht", "ca_bc_workers_compensation", "ca_cra", "ca_mb_eht", "ca_mb_workers_compensation", "ca_nb_workers_compensation", "ca_nl_eht", "ca_nl_workers_compensation", "ca_ns_workers_compensation", "ca_nt_government", "ca_nt_workers_compensation", "ca_nu_government", "ca_nu_workers_compensation", "ca_on_eht", "ca_on_workers_compensation", "ca_pe_workers_compensation", "ca_rq", "ca_sk_workers_compensation", "ca_yt_workers_compensation" ] }, "linked_remittance_account_id": { "type": "string", "description": "The id of a CRA remittance account in the same business entity whose enrollments this account should follow. When set, work assignments enrolled in that CRA account are automatically enrolled in this account with matching effective dates, and manual enrollments on this account become unavailable. Only a Revenue Qu\u00e9bec account may be linked, and only to a CRA account. An account that is the default for its authority cannot be linked; set is_default to false in the same request to link it. Clearing the value releases the generated enrollments, which stay in place and become editable and deletable again." }, "category": { "type": "string", "enum": [ "ca_benefit_provider", "ca_provincial_government", "ca_tax_agency", "ca_union", "ca_workers_compensation" ] }, "label": { "type": "string", "maxLength": 255 }, "label_translations": { "type": "object", "description": "Optional translations for the `label` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "account_identifier": { "type": "string", "nullable": true, "maxLength": 255 }, "is_default": { "type": "boolean" }, "remitter_type": { "type": "string", "enum": [ "accelerated_threshold_1", "accelerated_threshold_2", "quarterly", "regular" ] }, "remittance_management": { "type": "string", "enum": [ "automatic", "manual" ] }, "note": { "type": "string", "nullable": true }, "address_line_1": { "type": "string", "nullable": true }, "address_line_2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "administrative_area": { "type": "string", "nullable": true, "maxLength": 255 }, "province_code": { "type": "string", "description": "In Canada, must be an uppercase 2-letter province code: `AB`, `BC`, `MB`, `NB`, `NL`, `NS`, `NT`, `NU`, `ON`, `PE`, `QC`, `SK`, `YT`", "nullable": true }, "country_code": { "type": "string", "description": "Must be an uppercase 2-letter country code (ISO 3166-1 alpha-2, e.g., `CA`).", "nullable": true }, "postal_code": { "type": "string", "nullable": true, "maxLength": 10 }, "metadata": { "$ref": "#/components/schemas/RemittanceAccountMetadata" }, "tax_properties": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ca::ab::claim_amount", "ca::ab::total_income_less_than_total_claim_amount", "ca::ab::workers_compensation_class", "ca::bc::claim_amount", "ca::bc::eht", "ca::bc::total_income_less_than_total_claim_amount", "ca::bc::workers_compensation_class", "ca::cpp_exempt", "ca::ei_exempt", "ca::ei_premium_reduction", "ca::federal::additional_tax", "ca::federal::annual_deduction_at_source", "ca::federal::claim_amount", "ca::federal::commission_expenses", "ca::federal::commission_total_income", "ca::federal::income_tax_rate", "ca::federal::total_income_less_than_total_claim_amount", "ca::federal_oc_surtax_exempt", "ca::first_nation_exemptions", "ca::mb::claim_amount", "ca::mb::eht", "ca::mb::total_income_less_than_total_claim_amount", "ca::mb::workers_compensation_class", "ca::nb::claim_amount", "ca::nb::total_income_less_than_total_claim_amount", "ca::nb::workers_compensation_class", "ca::nl::claim_amount", "ca::nl::eht", "ca::nl::total_income_less_than_total_claim_amount", "ca::nl::workers_compensation_class", "ca::ns::claim_amount", "ca::ns::total_income_less_than_total_claim_amount", "ca::ns::workers_compensation_class", "ca::nt::claim_amount", "ca::nt::territorial_payroll_tax", "ca::nt::total_income_less_than_total_claim_amount", "ca::nt::workers_compensation_class", "ca::nu::claim_amount", "ca::nu::territorial_payroll_tax", "ca::nu::total_income_less_than_total_claim_amount", "ca::nu::workers_compensation_class", "ca::on::claim_amount", "ca::on::dependent_children_credit", "ca::on::eht", "ca::on::impaired_dependants_credit", "ca::on::total_income_less_than_total_claim_amount", "ca::on::workers_compensation_class", "ca::pe::claim_amount", "ca::pe::total_income_less_than_total_claim_amount", "ca::pe::workers_compensation_class", "ca::province_of_employment", "ca::province_of_work", "ca::provincial::income_tax_rate", "ca::qc::additional_tax", "ca::qc::claim_amount", "ca::qc::commission_percentage_taxed", "ca::qc::eht", "ca::qc::income_tax_rate", "ca::qc::qpip_exempt", "ca::qc::qpp_exempt", "ca::qc::tax_id", "ca::qc::total_income_less_than_total_claim_amount", "ca::qc::workers_compensation_class", "ca::sk::claim_amount", "ca::sk::total_income_less_than_total_claim_amount", "ca::sk::workers_compensation_class", "ca::statutory_holiday_pay", "ca::tax_id", "ca::yt::claim_amount", "ca::yt::total_income_less_than_total_claim_amount", "ca::yt::workers_compensation_class" ] }, "value": { "type": "string" }, "effective_from": { "type": "string", "format": "date" }, "effective_to": { "type": "string", "format": "date" }, "note": { "type": "string", "nullable": true }, "owner_id": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "label" ] } ] } } } } } }, "/remittance_account_enrollments/bulk/create": { "post": { "summary": "Bulk create remittance account enrollments", "operationId": "remittance-account-enrollments-bulk-create", "tags": [ "Remittance Account Enrollments" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } } } }, "/remittance_account_enrollments/bulk/create/scope": { "post": { "summary": "Show bulk create scope for remittance account enrollments", "operationId": "remittance-account-enrollments-bulk-create-scope", "tags": [ "Remittance Account Enrollments" ], "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/RemittanceAccountEnrollment" } } } } } }, "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/remittance_account_enrollments/bulk/create/scope?page=1", "last": "http://localhost/remittance_account_enrollments/bulk/create/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } } } }, "/remittance_account_enrollments/bulk/delete": { "post": { "summary": "Bulk delete remittance account enrollments", "operationId": "remittance-account-enrollments-bulk-delete", "tags": [ "Remittance Account Enrollments" ], "responses": { "202": { "description": "Accepted" } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/remittance_account_enrollments/bulk/delete/scope": { "post": { "summary": "Show bulk delete scope for remittance account enrollments", "operationId": "remittance-account-enrollments-bulk-delete-scope", "tags": [ "Remittance Account Enrollments" ], "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 (`\"remittance_account_enrollment\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/RemittanceAccountEnrollment" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "remittance_account_enrollment", "data": { "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "managing_enrollment": null, "effective_from": "2020-01-01", "effective_to": null, "is_editable": true, "is_deletable": true, "is_managed": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_account_enrollments/" } } ], "links": { "first": "http://localhost/remittance_account_enrollments/bulk/delete/scope?page=1", "last": "http://localhost/remittance_account_enrollments/bulk/delete/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } }, "has_business_preset": { "type": "boolean" }, "business_presets": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "expense_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "liability_accounting_codes": { "type": "object", "properties": { "include": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "nullable": true } } } } } }, "effective_on": { "type": "string", "format": "date" }, "not_effective_on": { "type": "string", "format": "date" }, "effective_from": { "type": "string", "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`" }, "effective_to": { "type": "string", "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, "subtypes": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "ids": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "required": [ "business_entity_id", "work_assignments" ] } ] }, "example": { "business_entity_id": "", "work_assignments": { "include": "all" } } } } } } }, "/remittance_account_enrollments": { "get": { "summary": "List remittance account enrollments", "operationId": "remittance-account-enrollments-index", "tags": [ "Remittance Account Enrollments" ], "parameters": [ { "name": "remittance_account_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "work_assignment_id", "in": "query", "schema": { "type": "string" }, "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:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `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:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "managing_enrollment", "remittance_account", "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 (`\"remittance_account_enrollment\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RemittanceAccountEnrollment" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With remittance_account expanded", "properties": { "remittance_account": { "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/RemittanceAccount" } } } } }, { "type": "object", "title": "With work_assignment expanded", "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/WorkAssignment" } } } } }, { "type": "object", "title": "With managing_enrollment expanded", "properties": { "managing_enrollment": { "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/ManagingEnrollment" } } } } } ] } } } } } }, "example": { "object": "list", "data": [], "links": { "first": "/remittance_account_enrollments?remittance_account_id=&page=1", "last": "/remittance_account_enrollments?remittance_account_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 0, "has_more": false } } } } } } }, "post": { "summary": "Create a remittance account enrollment", "operationId": "remittance-account-enrollments-store", "tags": [ "Remittance Account Enrollments" ], "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 (`\"remittance_account_enrollment\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/RemittanceAccountEnrollment" } } }, "example": { "id": "", "object": "remittance_account_enrollment", "data": { "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "managing_enrollment": null, "effective_from": "2025-01-01", "effective_to": null, "is_editable": true, "is_deletable": true, "is_managed": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_account_enrollments/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "remittance_account_id": { "type": "string" }, "work_assignment_id": { "type": "string" }, "effective_from": { "type": "string", "format": "date" }, "effective_to": { "type": "string", "format": "date" }, "overlap_strategy": { "type": "string", "description": "When set to `replace_existing`, overlapping enrollments for the same work assignment and account provider are resolved automatically instead of returning a validation error. Existing enrollments that started before the new `effective_from` are ended (their `effective_to` is set to the day before), and overlapping enrollments that start on or after the new `effective_from` are deleted.", "enum": [ "replace_existing" ] } } }, { "type": "object", "required": [ "remittance_account_id", "work_assignment_id", "effective_from" ] } ] }, "example": { "remittance_account_id": "", "work_assignment_id": "", "effective_from": "2025-01-01" } } } } } }, "/reports/cra-remittance": { "post": { "summary": "Create CRA remittance report", "description": "When a CRA Remittance Report is created, the report content will be created asynchronously. It may then be retrieved from the GET endpoint using an \"accept: text/csv\" header.\n\nTo filter which remittances should be included in the report, you must pass a filters object here, which must contain: `year`: The year to generate the report for. `remittance_account_id`: Optional. Limits the report to a single CRA remittance account; other CRA accounts on the same business entity are excluded. Must be a CRA account, and when `business_entity_id` is also set it must belong to that business entity.", "operationId": "reports-cra-remittance-store", "tags": [ "Reports" ], "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 (`\"report\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Report" } } }, "example": { "id": "", "object": "report", "data": { "type": "cra-remittance", "business_entity": null, "pay_schedule": null, "payroll": null, "filters": { "payroll_type": null, "payroll_status": [ "approved", "processing", "paid" ], "pay_date_from": "2026-01-01", "pay_date_to": "2026-12-31", "year": 2026 }, "has_results": false, "format": null, "sheet": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reports/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_entity_id": { "type": "string", "description": "Optional, the business entity to limit the report to." }, "filters": { "type": "object", "description": "Options to allow filtering the content of the report", "properties": { "year": { "type": "integer", "minimum": 2023, "maximum": 2026 }, "remittance_account_id": { "type": "string" } } } } }, "example": { "filters": { "year": 2026 } } } } } } }, "/reports/ei-cpp-balance": { "post": { "summary": "Create EI/CPP balance report", "description": "When an EI/CPP Balance Report is created, the report content will be created asynchronously. It may then be retrieved from the GET endpoint using an \"accept: text/csv\" header.\n\nTo filter which payrolls should be included in the report, you must pass a filters object here, which must contain: `year`: The year to generate the report for.", "operationId": "reports-ei-cpp-balance-store", "tags": [ "Reports" ], "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 (`\"report\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Report" } } }, "example": { "id": "", "object": "report", "data": { "type": "ei-cpp-balance", "business_entity": null, "pay_schedule": null, "payroll": null, "filters": { "payroll_type": null, "payroll_status": [ "approved", "processing", "paid" ], "pay_date_from": "2026-01-01", "pay_date_to": "2026-12-31", "year": 2026 }, "has_results": false, "format": null, "sheet": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reports/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_entity_id": { "type": "string", "description": "Optional, the business entity to limit the report to." }, "filters": { "type": "object", "description": "Options to allow filtering the content of the report", "properties": { "year": { "type": "integer", "minimum": 2023, "maximum": 2026 } } } } }, "example": { "filters": { "year": 2026 } } } } } } }, "/reports/ei-qpp-qpip-balance": { "post": { "summary": "Create EI/QPP/QPIP balance report", "description": "When an EI/QPP/QPIP Balance Report is created, the report content will be created asynchronously. It may then be retrieved from the GET endpoint using an \"accept: text/csv\" header.\n\nTo filter which payrolls should be included in the report, you must pass a filters object here, which must contain: `year`: The year to generate the report for.", "operationId": "reports-ei-qpp-qpip-balance-store", "tags": [ "Reports" ], "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 (`\"report\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Report" } } }, "example": { "id": "", "object": "report", "data": { "type": "ei-qpp-qpip-balance", "business_entity": null, "pay_schedule": null, "payroll": null, "filters": { "payroll_type": null, "payroll_status": [ "approved", "processing", "paid" ], "pay_date_from": "2026-01-01", "pay_date_to": "2026-12-31", "year": 2026 }, "has_results": false, "format": null, "sheet": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reports/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_entity_id": { "type": "string", "description": "Optional, the business entity to limit the report to." }, "filters": { "type": "object", "description": "Options to allow filtering the content of the report", "properties": { "year": { "type": "integer", "minimum": 2023, "maximum": 2026 } } } } }, "example": { "filters": { "year": 2026 } } } } } } }, "/reports/employer-health-tax": { "post": { "summary": "Create EHT report", "description": "When a Employer Health Tax Report is created, the report content will be created asynchronously. It may then be retrieved asynchronously from the GET endpoint using an \"accept: text/csv\" header.", "operationId": "reports-employer-health-tax-store", "tags": [ "Reports" ], "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 (`\"report\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Report" } } }, "example": { "id": "", "object": "report", "data": { "type": "employer-health-tax", "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "pay_schedule": null, "payroll": null, "filters": { "payroll_type": null, "payroll_status": null, "pay_date_from": null, "pay_date_to": null, "year": 2026 }, "has_results": false, "format": null, "sheet": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reports/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "business_entity_id": { "type": "string" }, "filters": { "type": "object", "properties": { "year": { "type": "integer", "minimum": 2024, "maximum": 2027 }, "province_of_employment": { "type": "string", "enum": [ "BC", "MB", "NL", "ON" ] } } } } }, { "type": "object", "required": [ "business_entity_id" ] } ] }, "example": { "business_entity_id": "", "filters": { "year": 2026, "province_of_employment": "ON" } } } } } } }, "/reports/journal-entry": { "post": { "summary": "Create journal entry report", "description": "When a Journal Entry Report is created, the report content will be created asynchronously. It may then be retrieved asynchronously from the GET endpoint using an \"accept: text/csv\", or \"accept: application/vnd.ms-excel\", header.", "operationId": "reports-journal-entry-store", "tags": [ "Reports" ], "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 (`\"report\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Report" } } }, "example": { "id": "", "object": "report", "data": { "type": "journal-entry", "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "pay_schedule": null, "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "filters": { "payroll_type": [ "regular", "off_cycle", "historical", "correction" ], "payroll_status": [ "paid" ], "pay_date_from": null, "pay_date_to": null, "year": null }, "has_results": false, "format": null, "sheet": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reports/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "business_entity_id": { "type": "string" }, "payroll_id": { "type": "string" }, "format": { "type": "string", "description": "Sets the output format for `/download`: `csv` or `xlsx`. Required to use `/download`. When omitted, both are rendered.", "enum": [ "csv", "xlsx" ] }, "sheet": { "type": "string", "description": "Selects which sheet the CSV output covers: `summary` or `detail`. When omitted, a CSV of each is rendered. The Excel workbook always contains both sheets, so this does not narrow it.", "enum": [ "detail", "summary" ] } } }, { "type": "object", "required": [ "business_entity_id", "payroll_id" ] } ] }, "example": { "business_entity_id": "", "payroll_id": "" } } } } } }, "/reports/liability": { "post": { "summary": "Create liability report", "description": "When a Liability Report is created, the report content will be created asynchronously. It may then be retrieved asynchronously from the GET endpoint using an \"accept: text/csv\" header.\n\nTo filter which payrolls should be included in the report, you may pass a filters object here, which may contain: `payroll_type`: One or more valid payroll `type`, as array or comma separated values. `payroll_status`: One or more valid payroll `status`, as array or comma separated values. `pay_date_from`: Limits payrolls to only from this pay-date and after. `pay_date_to`: Limits payrolls to only from this pay-date and before.", "operationId": "reports-liability-store", "tags": [ "Reports" ], "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 (`\"report\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Report" } } }, "example": { "id": "", "object": "report", "data": { "type": "liability", "business_entity": null, "pay_schedule": { "id": "", "object": "pay_schedule", "links": { "self": "/pay_schedules/" } }, "payroll": null, "filters": { "payroll_type": [ "regular", "off_cycle", "historical", "correction" ], "payroll_status": [ "paid" ], "pay_date_from": null, "pay_date_to": null, "year": null }, "has_results": false, "format": null, "sheet": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reports/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_entity_id": { "type": "string", "description": "One of `business_entity_id`, `pay_schedule_id` or `payroll_id` must be set.\n\nMust be present when `pay_schedule_id` and `payroll_id` is either empty or not set." }, "pay_schedule_id": { "type": "string", "description": "One of `business_entity_id`, `pay_schedule_id` or `payroll_id` must be set.\n\nMust be present when `business_entity_id` and `payroll_id` is either empty or not set." }, "payroll_id": { "type": "string", "description": "One of `business_entity_id`, `pay_schedule_id` or `payroll_id` must be set.\n\nMust be present when `business_entity_id` and `pay_schedule_id` is either empty or not set." }, "filters": { "type": "object", "description": "Options to allow filtering the content of the report", "properties": { "payroll_type": { "anyOf": [ { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] }, { "type": "array", "items": { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] } } ] }, "payroll_status": { "anyOf": [ { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] }, { "type": "array", "items": { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] } } ] }, "pay_date_from": { "type": "string", "format": "date" }, "pay_date_to": { "type": "string", "format": "date" } } } } }, "example": { "pay_schedule_id": "" } } } } } }, "/reports/payroll-register": { "post": { "summary": "Create payroll register report", "description": "When a Payroll Register Report is created, the report content will be created asynchronously. It may then be retrieved from `GET /reports/{id}/download`, or from `GET /reports/{id}` with an `Accept: text/csv` header.", "operationId": "reports-payroll-register-store", "tags": [ "Reports" ], "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 (`\"report\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Report" } } }, "example": { "id": "", "object": "report", "data": { "type": "payroll-register", "business_entity": null, "pay_schedule": null, "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "filters": { "payroll_type": [ "regular", "off_cycle", "historical", "correction" ], "payroll_status": null, "pay_date_from": null, "pay_date_to": null, "year": null }, "has_results": false, "format": null, "sheet": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reports/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "pay_schedule_id": { "type": "string", "description": "Must be present when `payroll_id` is either empty or not set." }, "payroll_id": { "type": "string", "description": "Must be present when `pay_schedule_id` is either empty or not set." }, "filters": { "type": "object", "properties": { "pay_date_from": { "type": "string", "format": "date" }, "pay_date_to": { "type": "string", "format": "date" }, "work_assignment_ids": { "type": "array", "items": { "type": "object" } } } }, "format": { "type": "string", "description": "Sets the output format for `/download`: `csv` or `xlsx`. Required to use `/download`.", "enum": [ "csv", "xlsx" ] }, "sheet": { "type": "string", "description": "For multi-sheet reports, selects which sheet `/download` returns. Payroll Register supports `summary` or `detail`.", "enum": [ "detail", "summary" ] } } }, "example": { "payroll_id": "" } } } } } }, "/reports/rl1-preview": { "post": { "summary": "Create RL1 preview report", "description": "When an RL-1 Preview Report is created, the report content will be created asynchronously. It may then be retrieved from the GET endpoint using an \"accept: text/csv\" header.\n\nTo filter which payrolls should be included in the report, you must pass a filters object here, which must contain: `year`: The year to generate the report for.", "operationId": "reports-rl1-preview-store", "tags": [ "Reports" ], "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 (`\"report\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Report" } } }, "example": { "id": "", "object": "report", "data": { "type": "rl1-preview", "business_entity": null, "pay_schedule": null, "payroll": null, "filters": { "payroll_type": null, "payroll_status": [ "approved", "processing", "paid" ], "pay_date_from": "2026-01-01", "pay_date_to": "2026-12-31", "year": 2026 }, "has_results": false, "format": null, "sheet": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reports/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_entity_id": { "type": "string", "description": "Optional, the business entity to limit the report to." }, "filters": { "type": "object", "description": "Options to allow filtering the content of the report", "properties": { "year": { "type": "integer", "minimum": 2023, "maximum": 2026 } } } } }, "example": { "filters": { "year": 2026 } } } } } } }, "/reports/rq-remittance": { "post": { "summary": "Create RQ remittance report", "description": "When a RQ Remittance Report is created, the report content will be created asynchronously. It may then be retrieved from the GET endpoint using an \"accept: text/csv\" header.\n\nTo filter which remittances should be included in the report, you must pass a filters object here, which must contain: `year`: The year to generate the report for. `remittance_account_id`: Optional. Limits the report to a single RQ remittance account; other RQ accounts on the same business entity are excluded. Must be an RQ account, and when `business_entity_id` is also set it must belong to that business entity.", "operationId": "reports-rq-remittance-store", "tags": [ "Reports" ], "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 (`\"report\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Report" } } }, "example": { "id": "", "object": "report", "data": { "type": "rq-remittance", "business_entity": null, "pay_schedule": null, "payroll": null, "filters": { "payroll_type": null, "payroll_status": [ "approved", "processing", "paid" ], "pay_date_from": "2026-01-01", "pay_date_to": "2026-12-31", "year": 2026 }, "has_results": false, "format": null, "sheet": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reports/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_entity_id": { "type": "string", "description": "Optional, the business entity to limit the report to." }, "filters": { "type": "object", "description": "Options to allow filtering the content of the report", "properties": { "year": { "type": "integer", "minimum": 2023, "maximum": 2026 }, "remittance_account_id": { "type": "string" } } } } }, "example": { "filters": { "year": 2026 } } } } } } }, "/reports/t4-preview": { "post": { "summary": "Create T4 preview report", "description": "When a T4 Preview Report is created, the report content will be created asynchronously. It may then be retrieved from the GET endpoint using an \"accept: text/csv\" header.\n\nTo filter which payrolls should be included in the report, you must pass a filters object here, which must contain: `year`: The year to generate the report for.", "operationId": "reports-t4-preview-store", "tags": [ "Reports" ], "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 (`\"report\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Report" } } }, "example": { "id": "", "object": "report", "data": { "type": "t4-preview", "business_entity": null, "pay_schedule": null, "payroll": null, "filters": { "payroll_type": null, "payroll_status": [ "approved", "processing", "paid" ], "pay_date_from": "2026-01-01", "pay_date_to": "2026-12-31", "year": 2026 }, "has_results": false, "format": null, "sheet": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reports/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_entity_id": { "type": "string", "description": "Optional, the business entity to limit the report to." }, "filters": { "type": "object", "description": "Options to allow filtering the content of the report", "properties": { "year": { "type": "integer", "minimum": 2023, "maximum": 2026 } } } } }, "example": { "filters": { "year": 2026 } } } } } } }, "/reports/vacation-accrual": { "post": { "summary": "Create vacation accrual report", "description": "When a Vacation Accrual Report is created, the report content will be created asynchronously. It may then be retrieved from the GET endpoint using an \"accept: text/csv\" header.\n\nTo filter which payrolls should be included in the report, you may pass a filters object here, which may contain: `pay_date_from`: Limits payrolls to only from this pay-date and after. `pay_date_to`: Limits payrolls to only from this pay-date and before.", "operationId": "reports-vacation-accrual-store", "tags": [ "Reports" ], "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 (`\"report\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Report" } } }, "example": { "id": "", "object": "report", "data": { "type": "vacation-accrual", "business_entity": null, "pay_schedule": { "id": "", "object": "pay_schedule", "links": { "self": "/pay_schedules/" } }, "payroll": null, "filters": { "payroll_type": [ "regular", "off_cycle", "historical", "correction" ], "payroll_status": [ "paid" ], "pay_date_from": null, "pay_date_to": null, "year": null }, "has_results": false, "format": null, "sheet": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reports/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "pay_schedule_id": { "type": "string", "description": "One of `business_entity_id`, `pay_schedule_id` or `payroll_id` must be set.\n\nMust be present when `payroll_id` is either empty or not set." }, "payroll_id": { "type": "string", "description": "One of `business_entity_id`, `pay_schedule_id` or `payroll_id` must be set.\n\nMust be present when `pay_schedule_id` is either empty or not set." }, "filters": { "type": "object", "description": "Options to allow filtering the content of the report", "properties": { "pay_date_from": { "type": "string", "format": "date" }, "pay_date_to": { "type": "string", "format": "date" }, "work_assignment_ids": { "type": "array", "items": { "type": "object" } } } } } }, "example": { "pay_schedule_id": "" } } } } } }, "/reports/workers-compensation": { "post": { "summary": "Create WCB report", "description": "When a Workers Compensation Board Report is created, the report content will be created asynchronously. It may then be retrieved asynchronously from the GET endpoint using an \"accept: text/csv\" header.", "operationId": "reports-workers-compensation-store", "tags": [ "Reports" ], "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 (`\"report\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Report" } } }, "example": { "id": "", "object": "report", "data": { "type": "workers-compensation", "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "pay_schedule": { "id": "", "object": "pay_schedule", "links": { "self": "/pay_schedules/" } }, "payroll": null, "filters": { "payroll_type": null, "payroll_status": null, "pay_date_from": null, "pay_date_to": null, "year": 2026 }, "has_results": false, "format": null, "sheet": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reports/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "business_entity_id": { "type": "string" }, "pay_schedule_id": { "type": "string", "description": "Must be present when `business_entity_id` and `payroll_id` is either empty or not set." }, "filters": { "type": "object", "description": "Must be present when `filters.province_of_work` is either empty or not set.", "properties": { "year": { "type": "integer", "minimum": 2024, "maximum": 2027 }, "province_of_work": { "type": "string", "enum": [ "AB", "BC", "FEDERAL", "MB", "NB", "NL", "NS", "NT", "NU", "OC", "ON", "PE", "QC", "SK", "YT" ] }, "province_of_employment": { "type": "string", "description": "Must be present when `filters.province_of_work` is either empty or not set.", "enum": [ "AB", "BC", "FEDERAL", "MB", "NB", "NL", "NS", "NT", "NU", "OC", "ON", "PE", "QC", "SK", "YT" ] } } } } }, { "type": "object", "required": [ "business_entity_id" ] } ] }, "example": { "business_entity_id": "", "pay_schedule_id": "", "filters": { "year": 2026, "province_of_work": "ON" } } } } } } }, "/reports/year-end-forms": { "post": { "summary": "Create year-end forms report", "description": "When a Year-End Forms Report is created, the report content will be created asynchronously. It may then be retrieved from the GET endpoint using an \"accept: text/csv\" header.\n\nThis report has one sheet per form type: `t4`, `t4a` and `rl1`. A CSV holds a single sheet, and no sheet is a stand-in for the others, so a CSV request must name one with `?sheet=` or it returns 422. Requesting the Excel format instead returns all three sheets in one file.\n\nTo filter which payrolls should be included in the report, you must pass a filters object here, which must contain: `year`: The year to generate the report for.", "operationId": "reports-year-end-forms-store", "tags": [ "Reports" ], "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 (`\"report\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Report" } } }, "example": { "id": "", "object": "report", "data": { "type": "year-end-forms", "business_entity": null, "pay_schedule": null, "payroll": null, "filters": { "payroll_type": null, "payroll_status": null, "pay_date_from": "2026-01-01", "pay_date_to": "2026-12-31", "year": null }, "has_results": false, "format": null, "sheet": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reports/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_entity_id": { "type": "string", "description": "Optional, the business entity to limit the report to." }, "filters": { "type": "object", "description": "Options to allow filtering the content of the report", "properties": { "year": { "type": "integer", "minimum": 2023, "maximum": 2026 }, "form_batch_id": { "type": "string" }, "form_status": { "type": "array", "items": { "type": "string", "enum": [ "approved", "done", "draft", "processing", "rejected", "submitted" ] } } } } } }, "example": { "filters": { "year": "2026" } } } } } } }, "/reports/year-to-date": { "post": { "summary": "Create year-to-date report", "description": "When a Year to Date Report is created, the report content will be created asynchronously. It may then be retrieved from the GET endpoint using an \"accept: text/csv\" header.\n\nTo filter which payrolls should be included in the report, you may pass a filters object here, which may contain: `pay_date_to`: Limits payrolls to only from this pay-date and before.", "operationId": "reports-year-to-date-store", "tags": [ "Reports" ], "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 (`\"report\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Report" } } }, "example": { "id": "", "object": "report", "data": { "type": "year-to-date", "business_entity": null, "pay_schedule": { "id": "", "object": "pay_schedule", "links": { "self": "/pay_schedules/" } }, "payroll": null, "filters": { "payroll_type": null, "payroll_status": [ "approved", "processing", "paid" ], "pay_date_from": null, "pay_date_to": "2026-12-31", "year": null }, "has_results": false, "format": null, "sheet": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reports/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "pay_schedule_id": { "type": "string", "description": "The pay schedule to generate the report for." }, "filters": { "type": "object", "description": "Options to allow filtering the content of the report", "properties": { "pay_date_to": { "type": "string", "format": "date" }, "work_assignment_ids": { "type": "array", "items": { "type": "object" } } } } } }, { "type": "object", "required": [ "pay_schedule_id" ] } ] }, "example": { "pay_schedule_id": "", "filters": { "pay_date_to": "2026-12-31" } } } } } } }, "/roe_sat_agreements": { "get": { "summary": "List ROE SAT agreements", "operationId": "roe-sat-agreements-index", "tags": [ "ROE SAT Agreements" ], "parameters": [ { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "business_number", "in": "query", "schema": { "type": "string" }, "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 (`\"roe_sat_agreement\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/RoeSatAgreement" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "roe_sat_agreement", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "business_number": "136549169RP9916", "business_legal_name": "Weber LLC", "signer_name": "Prof. Brody Ernser III", "signer_title": "Marketing Manager", "signed_on": "2026-01-01", "revoked_at": null, "locale": "en", "letter_was_uploaded": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/roe_sat_agreements/" } } ], "links": { "first": "/roe_sat_agreements?page=1", "last": "/roe_sat_agreements?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create an ROE SAT agreement", "operationId": "roe-sat-agreements-store", "tags": [ "ROE SAT Agreements" ], "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 (`\"roe_sat_agreement\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/RoeSatAgreement" } } }, "example": { "id": "", "object": "roe_sat_agreement", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "business_number": "123456782RP0001", "business_legal_name": "Bobs Burgers (#39616)", "signer_name": "Bob Belcher", "signer_title": "Owner", "signed_on": "2026-01-01", "revoked_at": null, "locale": "en", "letter_was_uploaded": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/roe_sat_agreements/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "business_entity_id": { "type": "string", "description": "The Business Entity the agreement is recorded under." }, "business_number": { "type": "string", "description": "The CRA payroll account number (BN15, e.g. 123456782RP0001) the agreement covers. Only one non-revoked agreement may cover a business number at a time." }, "business_legal_name": { "type": "string", "description": "The client's legal name as written on the letter. Defaults to the Business Entity's legal name when omitted.", "nullable": true, "maxLength": 255 }, "signer_name": { "type": "string", "description": "The person who signed the letter on the client's behalf.", "maxLength": 255 }, "signer_title": { "type": "string", "description": "The signer's job title.", "maxLength": 255 }, "signed_on": { "type": "string", "description": "The date written on the signed letter.", "format": "date" }, "locale": { "type": "string", "description": "The language of the letter (en or fr). Defaults to the Business Entity's language when omitted.", "enum": [ "en", "fr" ] }, "letter": { "type": "string", "description": "The client's signed copy of the letter as a PDF. When omitted, a copy of the letter recording the acceptance is generated and attached automatically.", "maxLength": 10240 } } }, { "type": "object", "required": [ "business_entity_id", "business_number", "signer_name", "signer_title", "signed_on" ] } ] } } } } } }, "/roe_sat_agreements/letter": { "get": { "summary": "Generate a blank ROE SAT agreement letter", "operationId": "roe-sat-agreements-letter", "tags": [ "ROE SAT Agreements" ], "parameters": [ { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": true, "description": "The Business Entity to generate the letter for." }, { "name": "business_number", "in": "query", "schema": { "type": "string" }, "required": false, "description": "The CRA payroll account number (BN15) to print on the letter. Defaults to the Business Entity's business number when omitted." }, { "name": "business_legal_name", "in": "query", "schema": { "type": "string" }, "required": false, "description": "The client's legal name to print on the letter. Defaults to the Business Entity's legal name when omitted." }, { "name": "locale", "in": "query", "schema": { "type": "string", "enum": [ "en", "fr" ] }, "required": false, "description": "The language of the letter (en or fr). Defaults to the Business Entity's language when omitted." } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": {} } } } } } }, "/statutory_withholding_line_items": { "get": { "summary": "List statutory withholding line items", "operationId": "statutory-withholding-line-items-index", "tags": [ "Statutory Withholding Line Items" ], "parameters": [ { "name": "pay_stub_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on the specified Pay Stub." }, { "name": "payroll_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on Pay Stubs on the specified Payroll." }, { "name": "payroll_status", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] }, { "type": "array", "items": { "type": "string", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] } } ] }, "required": false }, { "name": "payroll_type", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] }, { "type": "array", "items": { "type": "string", "enum": [ "correction", "historical", "off_cycle", "regular" ] } } ] }, "required": false }, { "name": "payroll_period_start", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_period_start=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_period_start[gte]=2024-01-01&payroll_period_start[lt]=2024-12-31`" }, { "name": "payroll_period_end", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_period_end=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_period_end[gte]=2024-01-01&payroll_period_end[lt]=2024-12-31`" }, { "name": "payroll_pay_date", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `payroll_pay_date=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `payroll_pay_date[gte]=2024-01-01&payroll_pay_date[lt]=2024-12-31`" }, { "name": "pay_schedule_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on Pay Stubs on the specified Pay Schedule." }, { "name": "work_assignment_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on Pay Stubs for the specified Work Assignment." }, { "name": "employee_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on pay stubs for the specified Employee." }, { "name": "contractor_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on pay stubs for the specified Contractor." }, { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return line items on Pay Stubs under the specified Business Entity." }, { "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": [ "cpp", "cpp_2", "ei", "federal_income_tax", "provincial_income_tax", "qpip", "qpp", "qpp_2", "territorial_income_tax", "uk_paye_income_tax" ] }, { "type": "array", "items": { "type": "string", "enum": [ "cpp", "cpp_2", "ei", "federal_income_tax", "provincial_income_tax", "qpip", "qpp", "qpp_2", "territorial_income_tax", "uk_paye_income_tax" ] } } ] }, "required": false, "description": "Only return line items with the specified types." }, { "name": "exclude_types", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "cpp", "cpp_2", "ei", "federal_income_tax", "provincial_income_tax", "qpip", "qpp", "qpp_2", "territorial_income_tax", "uk_paye_income_tax" ] }, { "type": "array", "items": { "type": "string", "enum": [ "cpp", "cpp_2", "ei", "federal_income_tax", "provincial_income_tax", "qpip", "qpp", "qpp_2", "territorial_income_tax", "uk_paye_income_tax" ] } } ] }, "required": false, "description": "Only return line items _without_ the specified types." }, { "name": "external_ref", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "custom_expense_accounting_code", "custom_liability_accounting_code", "expense_accounting_code", "liability_accounting_code", "managed_expense_accounting_code", "managed_liability_accounting_code", "managed_tag_assignment", "pay_stub", "remittance_account", "source_adjustment", "tag_assignment", "tag_assignment_amounts" ] } }, "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 (`\"statutory_withholding_line_item\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/StatutoryWithholdingLineItem" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With pay_stub expanded", "properties": { "pay_stub": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayStub" } } } } }, { "type": "object", "title": "With remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } }, { "type": "object", "title": "With source_adjustment expanded", "properties": { "source_adjustment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SourceAdjustment" } } } } }, { "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 managed_expense_accounting_code expanded", "properties": { "managed_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedExpenseAccountingCode" } } } } }, { "type": "object", "title": "With custom_expense_accounting_code expanded", "properties": { "custom_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomExpenseAccountingCode" } } } } }, { "type": "object", "title": "With liability_accounting_code expanded", "properties": { "liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LiabilityAccountingCode" } } } } }, { "type": "object", "title": "With managed_liability_accounting_code expanded", "properties": { "managed_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedLiabilityAccountingCode" } } } } }, { "type": "object", "title": "With custom_liability_accounting_code expanded", "properties": { "custom_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomLiabilityAccountingCode" } } } } }, { "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" } } } } }, { "type": "object", "title": "With managed_tag_assignment expanded", "properties": { "managed_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/ManagedTagAssignment" } } } } }, { "type": "object", "title": "With tag_assignment_amounts expanded", "properties": { "tag_assignment_amounts": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/TagAssignmentAmount" } } } } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "statutory_withholding_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "statutory_withholding", "is_system": true, "is_managed": true, "amount": 0, "custom_amount": null, "managed_amount": 0, "statutory_withholding_type": { "id": "", "object": "statutory_withholding_type", "data": { "type": "cpp", "label": "CPP" }, "links": { "self": "/statutory_withholding_types/cpp" } }, "title": "CPP", "title_translations": { "en": "CPP", "fr": "RPC" }, "title_translated": "CPP", "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "source_adjustment": null, "business_preset": { "id": "", "object": "business_preset", "links": { "self": "/business_presets/" } }, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/statutory_withholding_line_items/" } }, { "id": "", "object": "statutory_withholding_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "statutory_withholding", "is_system": true, "is_managed": true, "amount": 0, "custom_amount": null, "managed_amount": 0, "statutory_withholding_type": { "id": "", "object": "statutory_withholding_type", "data": { "type": "cpp_2", "label": "CPP 2" }, "links": { "self": "/statutory_withholding_types/cpp_2" } }, "title": "CPP 2", "title_translations": { "en": "CPP 2", "fr": "RPC 2" }, "title_translated": "CPP 2", "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "source_adjustment": null, "business_preset": { "id": "", "object": "business_preset", "links": { "self": "/business_presets/" } }, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/statutory_withholding_line_items/" } }, { "id": "", "object": "statutory_withholding_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "statutory_withholding", "is_system": true, "is_managed": true, "amount": 0, "custom_amount": null, "managed_amount": 0, "statutory_withholding_type": { "id": "", "object": "statutory_withholding_type", "data": { "type": "ei", "label": "EI" }, "links": { "self": "/statutory_withholding_types/ei" } }, "title": "EI", "title_translations": { "en": "EI", "fr": "AE" }, "title_translated": "EI", "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "source_adjustment": null, "business_preset": { "id": "", "object": "business_preset", "links": { "self": "/business_presets/" } }, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/statutory_withholding_line_items/" } }, { "id": "", "object": "statutory_withholding_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "statutory_withholding", "is_system": true, "is_managed": true, "amount": 0, "custom_amount": null, "managed_amount": 0, "statutory_withholding_type": { "id": "", "object": "statutory_withholding_type", "data": { "type": "federal_income_tax", "label": "Federal Income Tax" }, "links": { "self": "/statutory_withholding_types/federal_income_tax" } }, "title": "Federal Income Tax", "title_translations": { "en": "Federal Income Tax", "fr": "Imp\u00f4t f\u00e9d\u00e9ral" }, "title_translated": "Federal Income Tax", "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "source_adjustment": null, "business_preset": { "id": "", "object": "business_preset", "links": { "self": "/business_presets/" } }, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/statutory_withholding_line_items/" } }, { "id": "", "object": "statutory_withholding_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "statutory_withholding", "is_system": true, "is_managed": true, "amount": 0, "custom_amount": null, "managed_amount": 0, "statutory_withholding_type": { "id": "", "object": "statutory_withholding_type", "data": { "type": "provincial_income_tax", "label": "Provincial Income Tax" }, "links": { "self": "/statutory_withholding_types/provincial_income_tax" } }, "title": "Provincial Income Tax", "title_translations": { "en": "Provincial Income Tax", "fr": "Imp\u00f4t provincial" }, "title_translated": "Provincial Income Tax", "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "source_adjustment": null, "business_preset": { "id": "", "object": "business_preset", "links": { "self": "/business_presets/" } }, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/statutory_withholding_line_items/" } }, { "id": "", "object": "statutory_withholding_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "statutory_withholding", "is_system": true, "is_managed": true, "amount": 500, "custom_amount": null, "managed_amount": 500, "statutory_withholding_type": { "id": "", "object": "statutory_withholding_type", "data": { "type": "federal_income_tax", "label": "Federal Income Tax" }, "links": { "self": "/statutory_withholding_types/federal_income_tax" } }, "title": "Federal Income Tax", "title_translations": { "en": "Federal Income Tax", "fr": "Imp\u00f4t f\u00e9d\u00e9ral" }, "title_translated": "Federal Income Tax", "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "source_adjustment": null, "business_preset": { "id": "", "object": "business_preset", "links": { "self": "/business_presets/" } }, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/statutory_withholding_line_items/" } } ], "links": { "first": "/statutory_withholding_line_items?pay_stub_id=&page=1", "last": "/statutory_withholding_line_items?pay_stub_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 6, "has_more": false } } } } } } }, "post": { "summary": "Create a statutory withholding line item", "description": "Only available on correction and historical payrolls.", "operationId": "statutory-withholding-line-items-store", "tags": [ "Statutory Withholding Line Items" ], "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 (`\"statutory_withholding_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/StatutoryWithholdingLineItem" } } }, "example": { "id": "", "object": "statutory_withholding_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "statutory_withholding", "is_system": false, "is_managed": true, "amount": 0, "custom_amount": null, "managed_amount": 0, "statutory_withholding_type": { "id": "", "object": "statutory_withholding_type", "data": { "type": "federal_income_tax", "label": "Federal Income Tax" }, "links": { "self": "/statutory_withholding_types/federal_income_tax" } }, "title": "Federal Income Tax", "title_translations": { "en": "Federal Income Tax", "fr": "Imp\u00f4t f\u00e9d\u00e9ral" }, "title_translated": "Federal Income Tax", "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "source_adjustment": null, "business_preset": { "id": "", "object": "business_preset", "links": { "self": "/business_presets/" } }, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/statutory_withholding_line_items/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "pay_stub_id": { "type": "string" }, "business_preset_id": { "type": "string" }, "statutory_withholding_type": { "type": "string", "description": "The type of statutory withholding for this line item.\n\nMust be present when `business_preset_id` is either empty or not set.", "enum": [ "cpp", "cpp_2", "ei", "federal_income_tax", "provincial_income_tax", "qpip", "qpp", "qpp_2", "territorial_income_tax", "uk_paye_income_tax" ] }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.", "format": "decimal", "maximum": 999999 }, "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 }, "remittance_account_id": { "type": "string" }, "expense_accounting_code_id": { "type": "string" }, "custom_expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string" }, "custom_liability_accounting_code_id": { "type": "string" }, "external_ref": { "type": "string", "maxLength": 255 } } }, { "type": "object", "required": [ "pay_stub_id" ] } ] }, "example": { "pay_stub_id": "", "statutory_withholding_type": "federal_income_tax" } } } } } }, "/statutory_withholding_types": { "get": { "summary": "List employee statutory withholding types", "operationId": "statutory-withholding-types-index", "tags": [ "Statutory Withholding Types" ], "parameters": [ { "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)." }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Comma-separated list of type identifiers to return." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Case-insensitive substring match against the human-readable label, in any supported locale." } ], "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 (`\"statutory_withholding_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/StatutoryWithholdingType" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "statutory_withholding_type", "data": { "type": "cpp", "label": "CPP" }, "links": { "self": "/statutory_withholding_types/cpp" } }, { "id": "", "object": "statutory_withholding_type", "data": { "type": "cpp_2", "label": "CPP 2" }, "links": { "self": "/statutory_withholding_types/cpp_2" } }, { "id": "", "object": "statutory_withholding_type", "data": { "type": "ei", "label": "EI" }, "links": { "self": "/statutory_withholding_types/ei" } }, { "id": "", "object": "statutory_withholding_type", "data": { "type": "federal_income_tax", "label": "Federal Income Tax" }, "links": { "self": "/statutory_withholding_types/federal_income_tax" } }, { "id": "", "object": "statutory_withholding_type", "data": { "type": "provincial_income_tax", "label": "Provincial Income Tax" }, "links": { "self": "/statutory_withholding_types/provincial_income_tax" } }, { "id": "", "object": "statutory_withholding_type", "data": { "type": "qpip", "label": "QPIP" }, "links": { "self": "/statutory_withholding_types/qpip" } }, { "id": "", "object": "statutory_withholding_type", "data": { "type": "qpp", "label": "QPP" }, "links": { "self": "/statutory_withholding_types/qpp" } }, { "id": "", "object": "statutory_withholding_type", "data": { "type": "qpp_2", "label": "QPP 2" }, "links": { "self": "/statutory_withholding_types/qpp_2" } }, { "id": "", "object": "statutory_withholding_type", "data": { "type": "territorial_income_tax", "label": "Territorial Income Tax" }, "links": { "self": "/statutory_withholding_types/territorial_income_tax" } } ], "links": { "first": "/statutory_withholding_types?page=1", "last": "/statutory_withholding_types?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 9, "has_more": false } } } } } } } }, "/tags": { "get": { "summary": "List tags", "operationId": "tags-index", "tags": [ "Tags" ], "parameters": [ { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "tag_group_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "include_archived", "in": "query", "schema": { "type": "boolean" }, "required": false }, { "name": "archived_at", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `archived_at=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `archived_at[gte]=2024-01-01&archived_at[lt]=2024-12-31`" }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "counts", "tag_group" ] } }, "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 (`\"tag\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Tag" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With tag_group expanded", "properties": { "tag_group": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TagGroup" } } } } }, { "type": "object", "title": "With counts expanded", "properties": { "counts": { "type": "object", "properties": { "work_assignments": { "type": "integer", "description": "Number of work assignments referencing this tag." }, "employees": { "type": "integer", "description": "Number of distinct employees behind the work assignments referencing this tag." }, "contractors": { "type": "integer", "description": "Number of distinct contractors behind the work assignments referencing this tag." } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "tag", "data": { "label": "Engineering", "label_translations": null, "label_translated": "Engineering", "description": null, "description_translations": null, "description_translated": null, "archived_at": null, "is_deletable": true, "expense_segment": null, "liability_segment": null, "integrations": { "xero": { "id": null }, "quickbooks": { "id": null } }, "tag_group": { "id": "", "object": "tag_group", "links": { "self": "/tag_groups/" } }, "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/tags/" } }, { "id": "", "object": "tag", "data": { "label": "Engineering", "label_translations": null, "label_translated": "Engineering", "description": null, "description_translations": null, "description_translated": null, "archived_at": null, "is_deletable": true, "expense_segment": null, "liability_segment": null, "integrations": { "xero": { "id": null }, "quickbooks": { "id": null } }, "tag_group": { "id": "", "object": "tag_group", "links": { "self": "/tag_groups/" } }, "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/tags/" } }, { "id": "", "object": "tag", "data": { "label": "Engineering", "label_translations": null, "label_translated": "Engineering", "description": null, "description_translations": null, "description_translated": null, "archived_at": null, "is_deletable": true, "expense_segment": null, "liability_segment": null, "integrations": { "xero": { "id": null }, "quickbooks": { "id": null } }, "tag_group": { "id": "", "object": "tag_group", "links": { "self": "/tag_groups/" } }, "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/tags/" } } ], "links": { "first": "/tags?business_entity_id=&page=1", "last": "/tags?business_entity_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 3, "has_more": false } } } } } } }, "post": { "summary": "Create a tag", "operationId": "tags-store", "tags": [ "Tags" ], "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 (`\"tag\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Tag" } } }, "example": { "id": "", "object": "tag", "data": { "label": "Engineering", "label_translations": null, "label_translated": "Engineering", "description": null, "description_translations": null, "description_translated": null, "archived_at": null, "is_deletable": null, "expense_segment": "1000", "liability_segment": "E321", "integrations": { "xero": { "id": null }, "quickbooks": { "id": null } }, "tag_group": { "id": "", "object": "tag_group", "links": { "self": "/tag_groups/" } }, "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/tags/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "tag_group_id": { "type": "string", "description": "The tag group this tag belongs to. The business entity is inferred from the tag group." }, "label": { "type": "string", "maxLength": 255 }, "label_translations": { "type": "object", "description": "Optional translations for the `label` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "description": { "type": "string", "nullable": true }, "description_translations": { "type": "object", "description": "Optional translations for the `description` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "expense_segment": { "type": "string", "description": "The expense code piece this tag contributes to a generated expense code in the journal entry report, pulled in by a `tag_group` segment of an accounting code rule's expense template.", "nullable": true, "maxLength": 255 }, "liability_segment": { "type": "string", "description": "The liability code piece this tag contributes to a generated liability code in the journal entry report, pulled in by a `tag_group` segment of an accounting code rule's liability template.", "nullable": true, "maxLength": 255 }, "integrations": { "type": "object", "description": "Identifiers for this tag in external accounting integrations, used to sync tags imported from those systems.", "properties": { "xero": { "type": "object", "properties": { "id": { "type": "string" } } }, "quickbooks": { "type": "object", "properties": { "id": { "type": "string" } } } } } } }, { "type": "object", "required": [ "tag_group_id", "label" ] } ] }, "example": { "tag_group_id": "", "label": "Engineering", "expense_segment": "1000", "liability_segment": "E321" } } } } } }, "/tag_groups": { "get": { "summary": "List tag groups", "operationId": "tag-groups-index", "tags": [ "Tag Groups" ], "parameters": [ { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "include_archived", "in": "query", "schema": { "type": "boolean" }, "required": false }, { "name": "archived_at", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `archived_at=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `archived_at[gte]=2024-01-01&archived_at[lt]=2024-12-31`" }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "tags" ] } }, "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 (`\"tag_group\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/TagGroup" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With tags expanded", "properties": { "tags": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/Tag" } } } } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "tag_group", "data": { "label": "Department", "label_translations": null, "label_translated": "Department", "description": null, "description_translations": null, "description_translated": null, "color": null, "archived_at": null, "is_deletable": true, "is_component_locked": false, "is_journal_entry_dimension": false, "integrations": { "xero": { "id": null, "type": null }, "quickbooks": { "type": null } }, "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/tag_groups/" } }, { "id": "", "object": "tag_group", "data": { "label": "Department", "label_translations": null, "label_translated": "Department", "description": null, "description_translations": null, "description_translated": null, "color": null, "archived_at": null, "is_deletable": true, "is_component_locked": false, "is_journal_entry_dimension": false, "integrations": { "xero": { "id": null, "type": null }, "quickbooks": { "type": null } }, "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/tag_groups/" } }, { "id": "", "object": "tag_group", "data": { "label": "Department", "label_translations": null, "label_translated": "Department", "description": null, "description_translations": null, "description_translated": null, "color": null, "archived_at": null, "is_deletable": true, "is_component_locked": false, "is_journal_entry_dimension": false, "integrations": { "xero": { "id": null, "type": null }, "quickbooks": { "type": null } }, "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/tag_groups/" } } ], "links": { "first": "/tag_groups?business_entity_id=&page=1", "last": "/tag_groups?business_entity_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 3, "has_more": false } } } } } } }, "post": { "summary": "Create a tag group", "operationId": "tag-groups-store", "tags": [ "Tag Groups" ], "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 (`\"tag_group\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/TagGroup" } } }, "example": { "id": "", "object": "tag_group", "data": { "label": "Department", "label_translations": null, "label_translated": "Department", "description": "Departments within the organization", "description_translations": null, "description_translated": "Departments within the organization", "color": null, "archived_at": null, "is_deletable": null, "is_component_locked": null, "is_journal_entry_dimension": null, "integrations": { "xero": { "id": null, "type": null }, "quickbooks": { "type": null } }, "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/tag_groups/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "business_entity_id": { "type": "string" }, "label": { "type": "string", "maxLength": 255 }, "label_translations": { "type": "object", "description": "Optional translations for the `label` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "description": { "type": "string", "nullable": true }, "description_translations": { "type": "object", "description": "Optional translations for the `description` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "color": { "type": "string", "description": "A hex colour code for the tag group (e.g. `#AABBCC` or `#ABC`). Used for display.", "nullable": true }, "is_component_locked": { "type": "boolean", "description": "When `true`, prevents modification of tags in this group through the embedded portal. Tags can still be managed through the API." }, "is_journal_entry_dimension": { "type": "boolean", "description": "When `true`, marks this tag group as a journal entry dimension. A maximum of three tag groups per business entity can be journal entry dimensions." }, "integrations": { "type": "object", "description": "Identifiers and object types for this tag group in external accounting integrations, used to sync tag groups imported from those systems. QuickBooks does not expose a group-level identifier, so only the type is accepted for QuickBooks.", "properties": { "xero": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "tracking_category" ] } } }, "quickbooks": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "class", "department", "project" ] } } } } } } }, { "type": "object", "required": [ "business_entity_id", "label" ] } ] }, "example": { "business_entity_id": "", "label": "Department", "description": "Departments within the organization" } } } } } }, "/tax_properties/batch/delete": { "post": { "summary": "Batch delete tax properties", "operationId": "tax-properties-batch-delete", "tags": [ "Tax Properties" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "", "" ] } } } } }, "/tax_properties/batch/upsert": { "post": { "summary": "Batch upsert tax properties", "operationId": "tax-properties-batch-upsert", "tags": [ "Tax Properties" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "minItems": 1, "maxItems": 100 }, "example": [ { "id": "", "effective_to": "2026-12-31" }, { "owner_id": "", "type": "ca::province_of_work", "value": "ca_on", "effective_from": "2026-01-01" } ] } } } } }, "/tax_properties": { "get": { "summary": "List tax properties", "operationId": "tax-properties-index", "tags": [ "Tax Properties" ], "parameters": [ { "name": "owner_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Filter by owner. Accepts a comma-separated list of IDs." }, { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "type", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "ca::ab::claim_amount", "ca::ab::total_income_less_than_total_claim_amount", "ca::ab::workers_compensation_class", "ca::bc::claim_amount", "ca::bc::eht", "ca::bc::total_income_less_than_total_claim_amount", "ca::bc::workers_compensation_class", "ca::cpp_exempt", "ca::ei_exempt", "ca::ei_premium_reduction", "ca::federal::additional_tax", "ca::federal::annual_deduction_at_source", "ca::federal::claim_amount", "ca::federal::commission_expenses", "ca::federal::commission_total_income", "ca::federal::income_tax_rate", "ca::federal::total_income_less_than_total_claim_amount", "ca::federal_oc_surtax_exempt", "ca::first_nation_exemptions", "ca::mb::claim_amount", "ca::mb::eht", "ca::mb::total_income_less_than_total_claim_amount", "ca::mb::workers_compensation_class", "ca::nb::claim_amount", "ca::nb::total_income_less_than_total_claim_amount", "ca::nb::workers_compensation_class", "ca::nl::claim_amount", "ca::nl::eht", "ca::nl::total_income_less_than_total_claim_amount", "ca::nl::workers_compensation_class", "ca::ns::claim_amount", "ca::ns::total_income_less_than_total_claim_amount", "ca::ns::workers_compensation_class", "ca::nt::claim_amount", "ca::nt::territorial_payroll_tax", "ca::nt::total_income_less_than_total_claim_amount", "ca::nt::workers_compensation_class", "ca::nu::claim_amount", "ca::nu::territorial_payroll_tax", "ca::nu::total_income_less_than_total_claim_amount", "ca::nu::workers_compensation_class", "ca::on::claim_amount", "ca::on::dependent_children_credit", "ca::on::eht", "ca::on::impaired_dependants_credit", "ca::on::total_income_less_than_total_claim_amount", "ca::on::workers_compensation_class", "ca::pe::claim_amount", "ca::pe::total_income_less_than_total_claim_amount", "ca::pe::workers_compensation_class", "ca::province_of_employment", "ca::province_of_work", "ca::provincial::income_tax_rate", "ca::qc::additional_tax", "ca::qc::claim_amount", "ca::qc::commission_percentage_taxed", "ca::qc::eht", "ca::qc::income_tax_rate", "ca::qc::qpip_exempt", "ca::qc::qpp_exempt", "ca::qc::tax_id", "ca::qc::total_income_less_than_total_claim_amount", "ca::qc::workers_compensation_class", "ca::sk::claim_amount", "ca::sk::total_income_less_than_total_claim_amount", "ca::sk::workers_compensation_class", "ca::statutory_holiday_pay", "ca::tax_id", "ca::yt::claim_amount", "ca::yt::total_income_less_than_total_claim_amount", "ca::yt::workers_compensation_class" ] }, { "type": "array", "items": { "type": "string", "enum": [ "ca::ab::claim_amount", "ca::ab::total_income_less_than_total_claim_amount", "ca::ab::workers_compensation_class", "ca::bc::claim_amount", "ca::bc::eht", "ca::bc::total_income_less_than_total_claim_amount", "ca::bc::workers_compensation_class", "ca::cpp_exempt", "ca::ei_exempt", "ca::ei_premium_reduction", "ca::federal::additional_tax", "ca::federal::annual_deduction_at_source", "ca::federal::claim_amount", "ca::federal::commission_expenses", "ca::federal::commission_total_income", "ca::federal::income_tax_rate", "ca::federal::total_income_less_than_total_claim_amount", "ca::federal_oc_surtax_exempt", "ca::first_nation_exemptions", "ca::mb::claim_amount", "ca::mb::eht", "ca::mb::total_income_less_than_total_claim_amount", "ca::mb::workers_compensation_class", "ca::nb::claim_amount", "ca::nb::total_income_less_than_total_claim_amount", "ca::nb::workers_compensation_class", "ca::nl::claim_amount", "ca::nl::eht", "ca::nl::total_income_less_than_total_claim_amount", "ca::nl::workers_compensation_class", "ca::ns::claim_amount", "ca::ns::total_income_less_than_total_claim_amount", "ca::ns::workers_compensation_class", "ca::nt::claim_amount", "ca::nt::territorial_payroll_tax", "ca::nt::total_income_less_than_total_claim_amount", "ca::nt::workers_compensation_class", "ca::nu::claim_amount", "ca::nu::territorial_payroll_tax", "ca::nu::total_income_less_than_total_claim_amount", "ca::nu::workers_compensation_class", "ca::on::claim_amount", "ca::on::dependent_children_credit", "ca::on::eht", "ca::on::impaired_dependants_credit", "ca::on::total_income_less_than_total_claim_amount", "ca::on::workers_compensation_class", "ca::pe::claim_amount", "ca::pe::total_income_less_than_total_claim_amount", "ca::pe::workers_compensation_class", "ca::province_of_employment", "ca::province_of_work", "ca::provincial::income_tax_rate", "ca::qc::additional_tax", "ca::qc::claim_amount", "ca::qc::commission_percentage_taxed", "ca::qc::eht", "ca::qc::income_tax_rate", "ca::qc::qpip_exempt", "ca::qc::qpp_exempt", "ca::qc::tax_id", "ca::qc::total_income_less_than_total_claim_amount", "ca::qc::workers_compensation_class", "ca::sk::claim_amount", "ca::sk::total_income_less_than_total_claim_amount", "ca::sk::workers_compensation_class", "ca::statutory_holiday_pay", "ca::tax_id", "ca::yt::claim_amount", "ca::yt::total_income_less_than_total_claim_amount", "ca::yt::workers_compensation_class" ] } } ] }, "required": false }, { "name": "feature", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "eht", "first_nation_status", "general", "onboarding", "outside_canada", "statutory_holiday_pay", "tax_forms", "territorial_payroll_tax", "workers_compensation" ] }, { "type": "array", "items": { "type": "string", "enum": [ "eht", "first_nation_status", "general", "onboarding", "outside_canada", "statutory_holiday_pay", "tax_forms", "territorial_payroll_tax", "workers_compensation" ] } } ] }, "required": false, "description": "Filter by feature. Accepts a comma-separated list of feature values." }, { "name": "effective_on", "in": "query", "schema": { "type": "object", "pattern": "^\\d{4}-\\d{2}-\\d{2}$|^\\d{4}-\\d{2}$|^\\d{4}$" }, "required": false, "description": "Filter by effective date. Accepts a full date (`YYYY-MM-DD`), a year-month (`YYYY-MM`), or a year (`YYYY`). Returns Tax Properties that are in effect at any point during the specified period.\n\nPartial date filters support three formats:\n- `YYYY` \u2014 Returns all records matching the given year. Example: `effective_on=2024`\n- `YYYY-MM` \u2014 Returns all records matching the given month. Example: `effective_on=2024-06`\n- `YYYY-MM-DD` \u2014 Returns all records matching the specific date. Example: `effective_on=2024-06-15`" }, { "name": "not_effective_on", "in": "query", "schema": { "type": "string", "format": "date" }, "required": false, "description": "Filter to Tax Properties that are NOT in effect on the given date (`YYYY-MM-DD`)." }, { "name": "effective_from", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `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:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "effective_from", "effective_to" ] }, "required": false, "description": "Sort order is specified using the format \n`sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by\nand `direction` is the optional sort direction (`asc` or `desc`)." }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "owner" ] } }, "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 (`\"tax_property\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/TaxProperty" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With owner expanded", "properties": { "owner": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TaxPropertyOwner" } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "tax_property", "data": { "type": "ca::province_of_employment", "value": "ca_on", "effective_from": "2026-01-01", "effective_to": null, "earliest_valid_effective_to": "2026-01-01", "is_editable": true, "is_deletable": true, "label": "Province of Employment", "format": "string", "options": { "ca_ab": "Alberta", "ca_bc": "British Columbia", "ca_mb": "Manitoba", "ca_nb": "New Brunswick", "ca_nl": "Newfoundland and Labrador", "ca_ns": "Nova Scotia", "ca_nt": "Northwest Territories", "ca_nu": "Nunavut", "ca_on": "Ontario", "ca_pe": "Prince Edward Island", "ca_qc": "Quebec", "ca_sk": "Saskatchewan", "ca_yt": "Yukon", "ca_oc": "Outside Canada" }, "allow_concurrent": false, "feature": "onboarding", "owner": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "note": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/tax_properties/" } }, { "id": "", "object": "tax_property", "data": { "type": "ca::tax_id", "value": "136549169RP9916", "effective_from": "2026-01-01", "effective_to": null, "earliest_valid_effective_to": "2026-01-01", "is_editable": true, "is_deletable": true, "label": "Tax ID", "format": "string", "options": null, "allow_concurrent": true, "feature": "onboarding", "owner": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "note": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/tax_properties/" } } ], "links": { "first": "/tax_properties?owner_id=&page=1", "last": "/tax_properties?owner_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 2, "has_more": false } } } } } } }, "post": { "summary": "Create a tax property", "operationId": "tax-properties-store", "tags": [ "Tax Properties" ], "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 (`\"tax_property\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/TaxProperty" } } }, "example": { "id": "", "object": "tax_property", "data": { "type": "ca::province_of_employment", "value": "ca_nb", "effective_from": "2026-01-01", "effective_to": null, "earliest_valid_effective_to": "2026-01-01", "is_editable": true, "is_deletable": true, "label": "Province of Employment", "format": "string", "options": { "ca_ab": "Alberta", "ca_bc": "British Columbia", "ca_mb": "Manitoba", "ca_nb": "New Brunswick", "ca_nl": "Newfoundland and Labrador", "ca_ns": "Nova Scotia", "ca_nt": "Northwest Territories", "ca_nu": "Nunavut", "ca_on": "Ontario", "ca_pe": "Prince Edward Island", "ca_qc": "Quebec", "ca_sk": "Saskatchewan", "ca_yt": "Yukon", "ca_oc": "Outside Canada" }, "allow_concurrent": false, "feature": "onboarding", "owner": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "note": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/tax_properties/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "type": { "type": "string", "description": "The type of this tax property, determining its format, label, and validation rules.", "enum": [ "ca::ab::claim_amount", "ca::ab::total_income_less_than_total_claim_amount", "ca::ab::workers_compensation_class", "ca::bc::claim_amount", "ca::bc::eht", "ca::bc::total_income_less_than_total_claim_amount", "ca::bc::workers_compensation_class", "ca::cpp_exempt", "ca::ei_exempt", "ca::ei_premium_reduction", "ca::federal::additional_tax", "ca::federal::annual_deduction_at_source", "ca::federal::claim_amount", "ca::federal::commission_expenses", "ca::federal::commission_total_income", "ca::federal::income_tax_rate", "ca::federal::total_income_less_than_total_claim_amount", "ca::federal_oc_surtax_exempt", "ca::first_nation_exemptions", "ca::mb::claim_amount", "ca::mb::eht", "ca::mb::total_income_less_than_total_claim_amount", "ca::mb::workers_compensation_class", "ca::nb::claim_amount", "ca::nb::total_income_less_than_total_claim_amount", "ca::nb::workers_compensation_class", "ca::nl::claim_amount", "ca::nl::eht", "ca::nl::total_income_less_than_total_claim_amount", "ca::nl::workers_compensation_class", "ca::ns::claim_amount", "ca::ns::total_income_less_than_total_claim_amount", "ca::ns::workers_compensation_class", "ca::nt::claim_amount", "ca::nt::territorial_payroll_tax", "ca::nt::total_income_less_than_total_claim_amount", "ca::nt::workers_compensation_class", "ca::nu::claim_amount", "ca::nu::territorial_payroll_tax", "ca::nu::total_income_less_than_total_claim_amount", "ca::nu::workers_compensation_class", "ca::on::claim_amount", "ca::on::dependent_children_credit", "ca::on::eht", "ca::on::impaired_dependants_credit", "ca::on::total_income_less_than_total_claim_amount", "ca::on::workers_compensation_class", "ca::pe::claim_amount", "ca::pe::total_income_less_than_total_claim_amount", "ca::pe::workers_compensation_class", "ca::province_of_employment", "ca::province_of_work", "ca::provincial::income_tax_rate", "ca::qc::additional_tax", "ca::qc::claim_amount", "ca::qc::commission_percentage_taxed", "ca::qc::eht", "ca::qc::income_tax_rate", "ca::qc::qpip_exempt", "ca::qc::qpp_exempt", "ca::qc::tax_id", "ca::qc::total_income_less_than_total_claim_amount", "ca::qc::workers_compensation_class", "ca::sk::claim_amount", "ca::sk::total_income_less_than_total_claim_amount", "ca::sk::workers_compensation_class", "ca::statutory_holiday_pay", "ca::tax_id", "ca::yt::claim_amount", "ca::yt::total_income_less_than_total_claim_amount", "ca::yt::workers_compensation_class" ] }, "owner_id": { "type": "string", "description": "The ID of the owner of the tax property. Valid owner types depend on the `type`. Each template specifies which owner types it supports." }, "value": { "type": "string", "description": "The value of this tax property. Format depends on `format`: numeric types store a decimal string, boolean types store a boolean, select types store a string key, and object types store a structured value object.\n\nThe value to store. Validated according to the template's `format` and any template-specific rules." }, "effective_from": { "type": "string", "description": "The date from which this tax property takes effect.", "format": "date" }, "effective_to": { "type": "string", "description": "The date on which this tax property expires. `null` means no end date and the property remains in effect indefinitely.", "format": "date" }, "note": { "type": "string", "description": "An optional note for this tax property.", "nullable": true } } }, { "type": "object", "required": [ "type", "owner_id", "value", "effective_from" ] } ] }, "example": { "type": "ca::province_of_employment", "owner_id": "", "value": "ca_nb", "effective_from": "2026-01-01" } } } } } }, "/tax_properties/search": { "post": { "summary": "Search tax properties", "operationId": "tax-properties-search", "tags": [ "Tax Properties" ], "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 (`\"tax_property\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/TaxProperty" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "tax_property", "data": { "type": "ca::province_of_employment", "value": "ca_on", "effective_from": "2026-01-01", "effective_to": null, "earliest_valid_effective_to": "2026-01-01", "is_editable": true, "is_deletable": true, "label": "Province of Employment", "format": "string", "options": { "ca_ab": "Alberta", "ca_bc": "British Columbia", "ca_mb": "Manitoba", "ca_nb": "New Brunswick", "ca_nl": "Newfoundland and Labrador", "ca_ns": "Nova Scotia", "ca_nt": "Northwest Territories", "ca_nu": "Nunavut", "ca_on": "Ontario", "ca_pe": "Prince Edward Island", "ca_qc": "Quebec", "ca_sk": "Saskatchewan", "ca_yt": "Yukon", "ca_oc": "Outside Canada" }, "allow_concurrent": false, "feature": "onboarding", "owner": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "note": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/tax_properties/" } } ], "links": { "first": "http://localhost/tax_properties/search?page=1", "last": "http://localhost/tax_properties/search?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/token": { "post": { "summary": "Retrieve a new access token", "operationId": "tokens-issue", "tags": [ "Tokens" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {}, "example": { "access_token": "", "expires_in": 60, "expires_at": "2026-01-01T01:00:00.000000Z" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "company_id": { "type": "string" } } }, { "type": "object", "required": [ "company_id" ] } ] }, "example": { "company_id": "" } } } } }, "delete": { "summary": "Revoke access tokens", "operationId": "tokens-revoke", "tags": [ "Tokens" ], "responses": { "204": { "description": "No Content" } } } }, "/usage_records": { "get": { "summary": "List usage records", "operationId": "usage-records-index", "tags": [ "Usage Records" ], "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 (`\"usage_record\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/UsageRecord" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "usage_record", "data": { "company": { "id": "", "object": "company", "links": { "self": "/companies/" } }, "event": "employee_paid", "record": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/fake-id" } }, "recorded_at": "2026-01-01 00:00:00", "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/usage_records/" } } ], "links": { "first": "/usage_records?page=1", "last": "/usage_records?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } } }, "/usage_summaries": { "get": { "summary": "List usage summaries", "operationId": "usage-summaries-index", "tags": [ "Usage Summaries" ], "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 (`\"usage_summary\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/UsageSummary" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "usage_summary", "data": { "company": { "id": "", "object": "company", "links": { "self": "/companies/" } }, "event": "employee_paid", "count": 0, "period_start": "2026-01-01", "period_end": "2026-01-31", "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/usage_summaries/" } } ], "links": { "first": "/usage_summaries?page=1", "last": "/usage_summaries?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } } }, "/vacation_pay_balance": { "get": { "summary": "Get an employee's vacation pay balance for a work assignment", "description": "This endpoint gets an employee's vacation pay balance for a work assignment. The balance\ncovers a reporting period (specified using `period_start`, `period_end`, or `pay_date`\nfilters) and includes the opening balance, amount accrued, amount paid, and closing balance\nfor that period.\n\nIf you need a detailed history of vacation pay accruals, payments, and adjustments by\npayroll, use the vacation pay history endpoint instead.", "operationId": "vacation-pay-balance-index", "tags": [ "Vacation Pay" ], "parameters": [ { "name": "work_assignment_id", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "period_start", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Filter results by the payrolls' period start dates.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `period_start=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `period_start[gte]=2024-01-01&period_start[lt]=2024-12-31`" }, { "name": "period_end", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Filter results by the payrolls' period end dates.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `period_end=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `period_end[gte]=2024-01-01&period_end[lt]=2024-12-31`" }, { "name": "pay_date", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Filter results by the payrolls' pay dates.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `pay_date=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `pay_date[gte]=2024-01-01&pay_date[lt]=2024-12-31`" }, { "name": "include_next_payrolls", "in": "query", "schema": { "type": "boolean" }, "required": false, "description": "When true, includes the next (draft) payroll in the calculation." }, { "name": "include_approved_payrolls", "in": "query", "schema": { "type": "boolean" }, "required": false, "description": "When true, includes approved but not yet paid payrolls in the calculation." } ], "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 (`\"vacation_pay_balance\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/VacationPayBalance" } } } } } }, "example": { "object": "vacation_pay_balance", "data": { "vacation_pay_opening_balance": 0, "vacation_pay_accrued_in_period": 0, "vacation_pay_paid_in_period": 0, "vacation_pay_closing_balance": 0 } } } } } } } }, "/vacation_pay_history": { "get": { "summary": "Get an employee's vacation pay history for a work assignment", "description": "This endpoint gets an employee's vacation pay history for a work assignment. The history\nincludes one record per payroll in a reporting period (specified using `period_start`,\n`period_end`, or `pay_date` filters) and includes the opening balance, amount accrued,\namount paid, closing balance, and any balance adjustment line items for the payroll, as\nwell as basic payroll details.\n\nIf you just need a vacation pay balance, use the vacation pay balance endpoint instead.", "operationId": "vacation-pay-history-index", "tags": [ "Vacation Pay" ], "parameters": [ { "name": "work_assignment_id", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "period_start", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Filter results by the payrolls' period start dates.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `period_start=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `period_start[gte]=2024-01-01&period_start[lt]=2024-12-31`" }, { "name": "period_end", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Filter results by the payrolls' period end dates.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `period_end=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `period_end[gte]=2024-01-01&period_end[lt]=2024-12-31`" }, { "name": "pay_date", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Filter results by the payrolls' pay dates.\n\nDate filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `pay_date=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `pay_date[gte]=2024-01-01&pay_date[lt]=2024-12-31`" }, { "name": "include_next_payrolls", "in": "query", "schema": { "type": "boolean" }, "required": false, "description": "When true, includes the next (draft) payroll in the results." }, { "name": "include_approved_payrolls", "in": "query", "schema": { "type": "boolean" }, "required": false, "description": "When true, includes approved but not yet paid payrolls in the results." }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "pay_date" ] }, "required": false, "description": "Sort order is specified using the format \n`sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by\nand `direction` is the optional sort direction (`asc` or `desc`)." } ], "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 (`\"vacation_pay_history\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/VacationPayHistory" } } } } } }, "example": { "object": "list", "data": [] } } } } } } }, "/vacation_pay_settings/batch/delete": { "post": { "summary": "Batch delete vacation pay settings", "operationId": "vacation-pay-settings-batch-delete", "tags": [ "Vacation Pay Settings" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "", "" ] } } } } }, "/vacation_pay_settings/batch/upsert": { "post": { "summary": "Batch upsert vacation pay settings", "operationId": "vacation-pay-settings-batch-upsert", "tags": [ "Vacation Pay Settings" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "minItems": 1, "maxItems": 100 }, "example": [ { "id": "", "effective_to": "2025-06-30", "note": "Ended early due to plan change" }, { "work_assignment_id": "", "percentage": 6, "vacation_pay_method": "per_period", "effective_from": "2025-07-01", "overrides": [ { "type": "earning", "subtype": "commission", "percentage": 3, "method": "per_period" } ] } ] } } } } }, "/vacation_pay_settings": { "get": { "summary": "List vacation pay settings", "operationId": "vacation-pay-settings-index", "tags": [ "Vacation Pay Settings" ], "parameters": [ { "name": "business_entity_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": "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:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `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:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`" }, { "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 \n`sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by\nand `direction` is the optional sort direction (`asc` or `desc`)." }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "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 (`\"vacation_pay_setting\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/VacationPaySetting" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With work_assignment expanded", "properties": { "work_assignment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WorkAssignment" } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "vacation_pay_setting", "data": { "percentage": 4, "vacation_pay_method": "manual", "effective_from": "2026-01-01", "effective_to": null, "earliest_valid_effective_to": "2026-01-01", "is_editable": true, "is_deletable": true, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "note": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/vacation_pay_settings/" } } ], "links": { "first": "/vacation_pay_settings?work_assignment_id=&page=1", "last": "/vacation_pay_settings?work_assignment_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create a vacation pay setting", "operationId": "vacation-pay-settings-store", "tags": [ "Vacation Pay Settings" ], "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 (`\"vacation_pay_setting\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/VacationPaySetting" } } }, "example": { "id": "", "object": "vacation_pay_setting", "data": { "percentage": 4, "vacation_pay_method": "manual", "effective_from": "2026-01-01", "effective_to": null, "earliest_valid_effective_to": "2026-01-01", "is_editable": true, "is_deletable": true, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "note": "Vacation Pay", "overrides": [ { "type": "earning", "subtype": "commission", "percentage": "3", "method": "per_period" } ], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/vacation_pay_settings/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "work_assignment_id": { "type": "string" }, "effective_from": { "type": "string", "format": "date" }, "effective_to": { "type": "string", "format": "date" }, "percentage": { "type": "number", "format": "decimal", "minimum": 0, "maximum": 100 }, "vacation_pay_method": { "type": "string", "enum": [ "manual", "per_period" ] }, "overrides": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "allowance", "earning", "reimbursement" ] }, "subtype": { "type": "string" }, "percentage": { "type": "number", "format": "decimal", "minimum": 0, "maximum": 100 }, "method": { "type": "string", "enum": [ "manual", "per_period" ] } } } }, "note": { "type": "string", "nullable": true } } }, { "type": "object", "required": [ "work_assignment_id", "effective_from", "percentage" ] } ] }, "example": { "work_assignment_id": "", "effective_from": "2026-01-01", "percentage": 4, "vacation_pay_method": "manual", "note": "Vacation Pay", "overrides": [ { "type": "earning", "subtype": "commission", "percentage": 3, "method": "per_period" } ] } } } } } }, "/vacation_pay_settings/search": { "post": { "summary": "Search vacation pay settings", "operationId": "vacation-pay-settings-search", "tags": [ "Vacation Pay Settings" ], "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 (`\"vacation_pay_setting\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/VacationPaySetting" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "vacation_pay_setting", "data": { "percentage": 4, "vacation_pay_method": "manual", "effective_from": "2026-01-01", "effective_to": null, "earliest_valid_effective_to": "2026-01-01", "is_editable": true, "is_deletable": true, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "note": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/vacation_pay_settings/" } } ], "links": { "first": "http://localhost/vacation_pay_settings/search?page=1", "last": "http://localhost/vacation_pay_settings/search?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/webhooks": { "get": { "summary": "List webhooks", "operationId": "webhooks-index", "tags": [ "Webhooks" ], "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 (`\"webhook\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Webhook" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "webhook", "data": { "url": "https://partner.example.com/webhooks", "key": "", "is_enabled": true, "events": [ "resource_created", "resource_updated", "resource_deleted", "payroll_approved", "payroll_unapproved", "payroll_paid", "payroll_deadline_upcoming", "pay_stub_available", "async_task_completed", "form_completed", "form_batch_completed", "integration_authentication_success", "integration_authentication_failure", "integration_sync_account_codes_complete", "integration_sync_account_codes_failure", "integration_sync_journal_entries_complete", "integration_sync_journal_entries_failure", "integration_sync_tags_complete", "integration_sync_tags_failure" ], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/webhooks/" } } ], "links": { "first": "/webhooks?page=1", "last": "/webhooks?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create a webhook", "operationId": "webhooks-store", "tags": [ "Webhooks" ], "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 (`\"webhook\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Webhook" } } }, "example": { "id": "", "object": "webhook", "data": { "url": "https://partner.example.com/webhooks", "key": "", "is_enabled": true, "events": [ "resource_created", "resource_updated", "resource_deleted", "payroll_approved", "payroll_unapproved", "payroll_paid", "payroll_deadline_upcoming", "pay_stub_available", "async_task_completed", "form_completed", "form_batch_completed", "integration_authentication_success", "integration_authentication_failure", "integration_sync_account_codes_complete", "integration_sync_account_codes_failure", "integration_sync_journal_entries_complete", "integration_sync_journal_entries_failure", "integration_sync_tags_complete", "integration_sync_tags_failure" ], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/webhooks/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "url": { "type": "string", "description": "The HTTPS URL we deliver webhook calls to. Plain HTTP is not accepted.", "maxLength": 255 }, "is_enabled": { "type": "boolean" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "async_task_completed", "form_batch_completed", "form_completed", "integration_authentication_failure", "integration_authentication_success", "integration_sync_account_codes_complete", "integration_sync_account_codes_failure", "integration_sync_journal_entries_complete", "integration_sync_journal_entries_failure", "integration_sync_tags_complete", "integration_sync_tags_failure", "pay_stub_available", "payroll_approved", "payroll_deadline_upcoming", "payroll_paid", "payroll_unapproved", "ping", "resource_created", "resource_deleted", "resource_updated" ] } } } }, { "type": "object", "required": [ "url" ] } ] }, "example": { "url": "https://partner.example.com/webhooks", "is_enabled": true, "events": [ "resource_created", "resource_updated", "resource_deleted", "payroll_approved", "payroll_unapproved", "payroll_paid", "payroll_deadline_upcoming", "pay_stub_available", "async_task_completed", "form_completed", "form_batch_completed", "integration_authentication_success", "integration_authentication_failure", "integration_sync_account_codes_complete", "integration_sync_account_codes_failure", "integration_sync_journal_entries_complete", "integration_sync_journal_entries_failure", "integration_sync_tags_complete", "integration_sync_tags_failure" ] } } } } } }, "/work_assignments/batch/delete": { "post": { "summary": "Batch delete work assignments", "operationId": "work-assignments-batch-delete", "tags": [ "Work Assignments" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "The IDs of the objects to delete.", "items": { "type": "string" }, "minItems": 1, "maxItems": 100 }, "example": [ "", "" ] } } } } }, "/work_assignments/batch/upsert": { "post": { "summary": "Batch upsert work assignments", "operationId": "work-assignments-batch-upsert", "tags": [ "Work Assignments" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "minItems": 1, "maxItems": 100 }, "example": [ { "id": "", "title": "Senior Engineer", "tag_assignment": { "unit": "percentage", "tag_allocations": [ { "tags": [ "" ], "value": 100 } ] } }, { "employee_id": "", "pay_schedule_id": "", "title": "Engineer", "tag_assignment": { "unit": "percentage", "tag_allocations": [ { "tags": [ "" ], "value": 100 } ] } } ] } } } } }, "/work_assignments/bulk/create": { "post": { "summary": "Bulk create work assignments", "description": "Bulk-create work assignments for the selected payees (employees and contractors) on the target pay schedule. Payees that already have a work assignment on that pay schedule are skipped.", "operationId": "work-assignments-bulk-create", "tags": [ "Work Assignments" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "data": { "type": "object", "description": "The properties for each new work assignment, including the required `pay_schedule_id`. Accepts the same fields as creating a single work assignment.", "properties": { "pay_schedule_id": { "type": "string" } } }, "payees": { "type": "object", "description": "The payee selection criteria.\n\n`payees.include` must be either the string `\"all\"`, or an object containing one or more of `ids` (string array of employee/contractor ids), `payee_type` (`employee` or `contractor`), `payee_names` (string), `archived` (boolean).\n\n`payees.exclude` (optional) is an object containing one or more of the same keys.\n\nMust be present when `payees.include.payee_type`, `payees.include.payee_names` and `payees.include.archived` is either empty or not set.\n\nMust be present when `payees.include.ids`, `payees.include.payee_names` and `payees.include.archived` is either empty or not set.\n\nMust be present when `payees.include.ids`, `payees.include.payee_type` and `payees.include.archived` is either empty or not set.\n\nMust be present when `payees.include.ids`, `payees.include.payee_type` and `payees.include.payee_names` is either empty or not set.", "properties": { "include": { "type": "object", "description": "Must be present when `payees.include.payee_type`, `payees.include.payee_names` and `payees.include.archived` is either empty or not set.\n\nMust be present when `payees.include.ids`, `payees.include.payee_names` and `payees.include.archived` is either empty or not set.\n\nMust be present when `payees.include.ids`, `payees.include.payee_type` and `payees.include.archived` is either empty or not set.\n\nMust be present when `payees.include.ids`, `payees.include.payee_type` and `payees.include.payee_names` is either empty or not set.", "properties": { "ids": { "type": "array", "description": "Must be present when `payees.include.payee_type`, `payees.include.payee_names` and `payees.include.archived` is either empty or not set.", "items": { "type": "string" } }, "payee_type": { "type": "string", "description": "Must be present when `payees.include.ids`, `payees.include.payee_names` and `payees.include.archived` is either empty or not set.", "enum": [ "contractor", "employee" ] }, "payee_names": { "type": "string", "description": "Must be present when `payees.include.ids`, `payees.include.payee_type` and `payees.include.archived` is either empty or not set." }, "archived": { "type": "boolean", "description": "Must be present when `payees.include.ids`, `payees.include.payee_type` and `payees.include.payee_names` is either empty or not set." } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "payee_names": { "type": "string" }, "archived": { "type": "boolean" } } } } } } }, { "type": "object", "required": [ "payees" ] } ] }, "example": { "data": { "pay_schedule_id": "" }, "payees": { "include": { "ids": [ "" ] } } } } } } } }, "/work_assignments/bulk/create/scope": { "post": { "summary": "Show bulk create scope for work assignments", "operationId": "work-assignments-bulk-create-scope", "tags": [ "Work Assignments" ], "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 (`\"employee\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/WorkAssignment" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "employee", "data": { "company": { "id": "", "object": "company", "links": { "self": "/companies/" } }, "employee_number": "001", "first_name": "Marley", "last_name": "Prosacco", "middle_initial": null, "personal_email": "marley.prosacco@personal.test", "work_email": "mprosacco@work.test", "address_line_1": "Angelina Ridge", "address_line_2": null, "city": "Toronto", "administrative_area": "ON", "province_code": "ON", "country_code": "CA", "postal_code": "M1M1M1", "sin": "196710156", "sin_last_3": "156", "date_of_birth": "1985-01-20", "warnings": { "object": "list", "data": [ { "object": "warning", "data": { "namespace": "onboarding", "type": "bank_account_doesnt_exists" } } ] }, "external_ref": null, "preferred_locale": null, "archived_at": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employees/" } } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "pay_schedule_id": { "type": "string" } } }, "payees": { "type": "object", "description": "Must be present when `payees.include.payee_type`, `payees.include.payee_names` and `payees.include.archived` is either empty or not set.\n\nMust be present when `payees.include.ids`, `payees.include.payee_names` and `payees.include.archived` is either empty or not set.\n\nMust be present when `payees.include.ids`, `payees.include.payee_type` and `payees.include.archived` is either empty or not set.\n\nMust be present when `payees.include.ids`, `payees.include.payee_type` and `payees.include.payee_names` is either empty or not set.", "properties": { "include": { "type": "object", "description": "Must be present when `payees.include.payee_type`, `payees.include.payee_names` and `payees.include.archived` is either empty or not set.\n\nMust be present when `payees.include.ids`, `payees.include.payee_names` and `payees.include.archived` is either empty or not set.\n\nMust be present when `payees.include.ids`, `payees.include.payee_type` and `payees.include.archived` is either empty or not set.\n\nMust be present when `payees.include.ids`, `payees.include.payee_type` and `payees.include.payee_names` is either empty or not set.", "properties": { "ids": { "type": "array", "description": "Must be present when `payees.include.payee_type`, `payees.include.payee_names` and `payees.include.archived` is either empty or not set.", "items": { "type": "string" } }, "payee_type": { "type": "string", "description": "Must be present when `payees.include.ids`, `payees.include.payee_names` and `payees.include.archived` is either empty or not set.", "enum": [ "contractor", "employee" ] }, "payee_names": { "type": "string", "description": "Must be present when `payees.include.ids`, `payees.include.payee_type` and `payees.include.archived` is either empty or not set." }, "archived": { "type": "boolean", "description": "Must be present when `payees.include.ids`, `payees.include.payee_type` and `payees.include.payee_names` is either empty or not set." } } }, "exclude": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "payee_type": { "type": "string", "enum": [ "contractor", "employee" ] }, "payee_names": { "type": "string" }, "archived": { "type": "boolean" } } } } } } }, { "type": "object", "required": [ "payees" ] } ] }, "example": { "data": { "pay_schedule_id": "" }, "payees": { "include": { "ids": [ "" ] } } } } } } } }, "/work_assignments/bulk/update": { "post": { "summary": "Bulk update work assignments", "description": "Bulk-update the work assignments matching the selection criteria. Selection uses the same grammar as the work assignment search endpoint.", "operationId": "work-assignments-bulk-update", "tags": [ "Work Assignments" ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "business_entity_id": { "type": "string", "description": "The business entity whose work assignments to update." }, "work_assignments": { "type": "object", "description": "The selection criteria.\n\n`work_assignments.include` must be either the string `\"all\"`, or an object containing one or more of `ids` (string array), `payee_type` (`employee` or `contractor`), `pay_schedule_id`, `archived` (boolean), `payee_names` (string).\n\n`work_assignments.exclude` (optional) is an object containing one or more of the same keys.", "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" } } } } } } }, "/work_assignments/bulk/update/scope": { "post": { "summary": "Show bulk update scope for work assignments", "operationId": "work-assignments-bulk-update-scope", "tags": [ "Work Assignments" ], "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/WorkAssignment" } } } } } }, "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/work_assignments/bulk/update/scope?page=1", "last": "http://localhost/work_assignments/bulk/update/scope?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "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" } } } } } } }, "/work_assignments": { "get": { "summary": "List work assignments", "operationId": "work-assignments-index", "tags": [ "Work Assignments" ], "parameters": [ { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "pay_schedule_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "employee_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "contractor_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "payee_type", "in": "query", "schema": { "type": "string", "enum": [ "contractor", "employee" ] }, "required": false, "description": "Filter results by payee type." }, { "name": "search_payee_names", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "external_ref", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "tag_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "tag_group_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "requires_tag_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "requires_tag_group_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "include_archived", "in": "query", "schema": { "type": "boolean" }, "required": false }, { "name": "archived_at", "in": "query", "schema": { "type": "object" }, "required": false, "description": "Date filters support two formats:\nExact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `archived_at=2024-01-01`\nUse an array-like syntax to specify a range with one or more comparison operators:\n- `gt` (greater than)\n- `gte` (greater than or equal to)\n- `lte` (less than or equal to)\n- `lt` (less than)\nExample: `archived_at[gte]=2024-01-01&archived_at[lt]=2024-12-31`" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "payee.default", "payee.first_name", "payee.last_name" ] }, "required": false, "description": "Sort order is specified using the format \n`sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by\nand `direction` is the optional sort direction (`asc` or `desc`)." }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_entity", "contractor", "effective_tax_properties", "employee", "pay_rates", "pay_schedule", "pay_split", "remittance_accounts", "tag_assignment", "tax_properties" ] } }, "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 (`\"work_assignment\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/WorkAssignment" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With employee expanded", "properties": { "employee": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Employee" } } } } }, { "type": "object", "title": "With contractor expanded", "properties": { "contractor": { "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/Contractor" } } } } }, { "type": "object", "title": "With pay_rates expanded", "properties": { "pay_rates": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/PayRate" } } } } } } } }, { "type": "object", "title": "With pay_schedule expanded", "properties": { "pay_schedule": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PaySchedule" } } } } }, { "type": "object", "title": "With pay_split expanded", "properties": { "pay_split": { "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/PaySplit" } } } } }, { "type": "object", "title": "With business_entity expanded", "properties": { "business_entity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessEntity" } } } } }, { "type": "object", "title": "With tax_properties expanded", "properties": { "tax_properties": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/TaxProperty" } } } } } } } }, { "type": "object", "title": "With effective_tax_properties expanded", "properties": { "effective_tax_properties": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/EffectiveTaxProperty" } } } } } } } }, { "type": "object", "title": "With remittance_accounts expanded", "properties": { "remittance_accounts": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } } } } }, { "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": "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": "/work_assignments?employee_id=&page=1", "last": "/work_assignments?employee_id=&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } } }, "post": { "summary": "Create a work assignment", "operationId": "work-assignments-store", "tags": [ "Work Assignments" ], "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 (`\"work_assignment\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/WorkAssignment" } } }, "example": { "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/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "employee_id": { "type": "string", "description": "Must be present when `contractor_id` is either empty or not set." }, "contractor_id": { "type": "string", "description": "Must be present when `employee_id` is either empty or not set." }, "pay_schedule_id": { "type": "string" }, "pay_split_id": { "type": "string" }, "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." }, "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 }, "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.", "format": "date" }, "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 } } } } } }, "tax_properties": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ca::ab::claim_amount", "ca::ab::total_income_less_than_total_claim_amount", "ca::ab::workers_compensation_class", "ca::bc::claim_amount", "ca::bc::eht", "ca::bc::total_income_less_than_total_claim_amount", "ca::bc::workers_compensation_class", "ca::cpp_exempt", "ca::ei_exempt", "ca::ei_premium_reduction", "ca::federal::additional_tax", "ca::federal::annual_deduction_at_source", "ca::federal::claim_amount", "ca::federal::commission_expenses", "ca::federal::commission_total_income", "ca::federal::income_tax_rate", "ca::federal::total_income_less_than_total_claim_amount", "ca::federal_oc_surtax_exempt", "ca::first_nation_exemptions", "ca::mb::claim_amount", "ca::mb::eht", "ca::mb::total_income_less_than_total_claim_amount", "ca::mb::workers_compensation_class", "ca::nb::claim_amount", "ca::nb::total_income_less_than_total_claim_amount", "ca::nb::workers_compensation_class", "ca::nl::claim_amount", "ca::nl::eht", "ca::nl::total_income_less_than_total_claim_amount", "ca::nl::workers_compensation_class", "ca::ns::claim_amount", "ca::ns::total_income_less_than_total_claim_amount", "ca::ns::workers_compensation_class", "ca::nt::claim_amount", "ca::nt::territorial_payroll_tax", "ca::nt::total_income_less_than_total_claim_amount", "ca::nt::workers_compensation_class", "ca::nu::claim_amount", "ca::nu::territorial_payroll_tax", "ca::nu::total_income_less_than_total_claim_amount", "ca::nu::workers_compensation_class", "ca::on::claim_amount", "ca::on::dependent_children_credit", "ca::on::eht", "ca::on::impaired_dependants_credit", "ca::on::total_income_less_than_total_claim_amount", "ca::on::workers_compensation_class", "ca::pe::claim_amount", "ca::pe::total_income_less_than_total_claim_amount", "ca::pe::workers_compensation_class", "ca::province_of_employment", "ca::province_of_work", "ca::provincial::income_tax_rate", "ca::qc::additional_tax", "ca::qc::claim_amount", "ca::qc::commission_percentage_taxed", "ca::qc::eht", "ca::qc::income_tax_rate", "ca::qc::qpip_exempt", "ca::qc::qpp_exempt", "ca::qc::tax_id", "ca::qc::total_income_less_than_total_claim_amount", "ca::qc::workers_compensation_class", "ca::sk::claim_amount", "ca::sk::total_income_less_than_total_claim_amount", "ca::sk::workers_compensation_class", "ca::statutory_holiday_pay", "ca::tax_id", "ca::yt::claim_amount", "ca::yt::total_income_less_than_total_claim_amount", "ca::yt::workers_compensation_class" ] }, "value": { "type": "string" }, "effective_from": { "type": "string", "format": "date" }, "effective_to": { "type": "string", "format": "date" }, "note": { "type": "string", "nullable": true }, "owner_id": { "type": "string" } } } } } }, { "type": "object", "required": [ "pay_schedule_id" ] } ] } } } } } }, "/work_assignments/search": { "post": { "summary": "Search work assignments", "description": "Search work assignments under the given business entity, returning the same set the equivalent bulk recurrence operation would target with this body. Useful for previewing the blast radius of a bulk operation, or for any general search using the same criteria grammar.", "operationId": "work-assignments-search", "tags": [ "Work Assignments" ], "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/WorkAssignment" } } } } } }, "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/work_assignments/search?page=1", "last": "http://localhost/work_assignments/search?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "has_more": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "business_entity_id": { "type": "string", "description": "The business entity whose work assignments to search." }, "work_assignments": { "type": "object", "description": "The selection criteria.\n\n`work_assignments.include` must be either the string `\"all\"`, or an object containing one or more of `ids` (string array), `payee_type` (`employee` or `contractor`), `pay_schedule_id`, `archived` (boolean).\n\n`work_assignments.exclude` (optional) is an object containing one or more of the same keys.", "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" } } } } } } }, "/accounting_codes/{accounting_code}": { "delete": { "summary": "Delete an accounting code", "operationId": "accounting-codes-destroy", "tags": [ "Accounting Codes" ], "parameters": [ { "name": "accounting_code", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve an accounting code", "operationId": "accounting-codes-show", "tags": [ "Accounting Codes" ], "parameters": [ { "name": "accounting_code", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_entity", "business_presets" ] } }, "required": false } ], "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 (`\"accounting_code\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountingCode" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With business_entity expanded", "properties": { "business_entity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessEntity" } } } } }, { "type": "object", "title": "With business_presets expanded", "properties": { "business_presets": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/BusinessPreset" } } } } } } } } ] } } }, "example": { "id": "", "object": "accounting_code", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "type": "expense", "code": "9916", "title": "Vitae error architecto sint.", "title_translations": null, "title_translated": "Vitae error architecto sint.", "description": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "description_translations": null, "description_translated": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "mapping": { "xero": false, "quickbooks": false }, "fallback_mappings": [], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/accounting_codes/" } } } } } } }, "put": { "summary": "Update an accounting code", "operationId": "accounting-codes-update", "tags": [ "Accounting Codes" ], "parameters": [ { "name": "accounting_code", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"accounting_code\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/AccountingCode" } } }, "example": { "id": "", "object": "accounting_code", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "type": "expense", "code": "9916", "title": "Accounting Code", "title_translations": null, "title_translated": "Accounting Code", "description": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "description_translations": null, "description_translated": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "mapping": { "xero": false, "quickbooks": false }, "fallback_mappings": [], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/accounting_codes/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 255 }, "title_translations": { "type": "object", "description": "Optional translations for the `title` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "code": { "type": "string", "description": "The accounting code identifier as it appears in the chart of accounts.", "maxLength": 255 }, "description": { "type": "string", "nullable": true }, "description_translations": { "type": "object", "description": "Optional translations for the `description` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "type": { "type": "string", "description": "The type of accounting code.", "enum": [ "bank", "expense", "liability" ] }, "fallback_mappings": { "type": "array", "description": "Line Item type/subtype pairs that default to this accounting code when no specific mapping is configured. Each entry contains `type` and `subtype`.\n\nMust be an array of valid `type` and `subtype` pairs\n\nThe combination of `type` and `subtype` must be unique within the business entities accounting codes, for the same accounting code type.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of accounting code.", "enum": [ "allowance", "deduction", "earning", "employee_benefit", "employer_benefit", "employer_statutory_withholding", "reimbursement", "statutory_withholding" ] }, "subtype": { "type": "string", "enum": [ "accident_insurance_plan", "automobile_and_motor_vehicle", "bonus_discretionary", "bonus_non_discretionary", "bonus_non_taxable", "cell_phone_allowance", "charitable_donation", "child_care_expenses", "child_eduction_non_taxable", "child_eduction_taxable", "clothing_non_taxable", "clothing_taxable", "commission", "commission_periodic", "commission_self_employed", "cpp", "cpp_2", "critical_illness", "death_benefit", "debt_relief", "dental", "education_and_professional_development", "eht", "ei", "employee_assistance_program", "federal_income_tax", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "garnishment_order", "gift_cash", "gift_near_cash", "gift_non_cash_non_taxable", "gift_non_cash_taxable", "gratuity", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "housing_allowance_cash", "in_lieu_wages", "income_replacement_indemnity_non_taxable", "income_replacement_indemnity_taxable", "income_tax", "internet_allowance", "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_unpaid", "leave_voting", "leave_wedding", "long_term_disability", "meals_subsidized_non_cash", "meals_taxable", "moving_allowance_non_taxable", "moving_allowance_taxable", "municipal_officers_expense", "non_group_long_term_disability", "non_group_short_term_disability", "non_taxable_allowance", "non_taxable_reimbursement", "other_deduction", "overtime", "overtime_meals_non_taxable", "parental_top_up_insurable", "parental_top_up_non_insurable", "parking", "parking_allowance", "pension", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_rrsp_non_periodic", "pension_unregistered_prpp", "pension_vrsp", "professional_membership", "professional_membership_dues_taxable", "profit_sharing_dpsp", "provincial_income_tax", "qpip", "qpp", "qpp_2", "retiring_allowance", "retiring_allowance_eligible", "retroactive_pay", "retroactive_pay_increase", "salary", "salary_continuance", "savings_tfsa", "second_opinion_medical_consultation", "severance_pay", "short_term_disability", "social_event_allowance", "statutory_holiday_pay", "supplemental_unemployment", "taxable_cash_allowance", "taxable_reimbursement", "territorial_income_tax", "time_off_in_lieu", "time_off_in_lieu_overtime", "tips_controlled", "tools_allowance", "transit_pass", "transportation_to_from_work", "travelling_allowance_non_taxable", "travelling_allowance_taxable", "uk_paye_income_tax", "union_dues", "union_dues_post_tax", "utilities_allowance", "vacation_accrual_adjustment", "vacation_pay", "vacation_pay_employee_terminated", "vacation_pay_no_time_taken", "vacation_pay_time_taken", "vehicle_allowance_non_taxable", "vehicle_employer_provided", "virtual_health_service", "wage", "wcb", "wellness_spending_account" ] } } } } } }, "example": { "title": "Accounting Code" } } } } } }, "/accounting_codes/{accounting_code}/merge": { "post": { "summary": "Merge accounting codes", "description": "Merge manual generated accounting codes into other codes. A manual code is any code that has no `xero_id` or `quickbooks_id`, which indicates it was imported from an external accounting platform. The manual codes will be deleted after reassignment, with all references to them updated to the target accounting code.", "operationId": "accounting-codes-merge", "tags": [ "Accounting Codes" ], "parameters": [ { "name": "accounting_code", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"accounting_code\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/AccountingCode" } } }, "example": { "id": "", "object": "accounting_code", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "type": "expense", "code": "9916", "title": "Vitae error architecto sint.", "title_translations": null, "title_translated": "Vitae error architecto sint.", "description": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "description_translations": null, "description_translated": "Vitae error architecto sint velit tempora illo itaque consequuntur omnis ratione esse sint.", "mapping": { "xero": false, "quickbooks": false }, "fallback_mappings": [], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/accounting_codes/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "accounting_code_ids": { "type": "array", "description": "An array of one or more accounting code IDs to be removed from the system, with all references to them updated to the accounting code in the resource path. All accounting codes in this array must be of the same `type` as the accounting code in the resource path, and must belong to the same business entity.", "items": { "type": "string" } } } } } } } } }, "/accounting_code_rules/{accounting_code_rule}": { "delete": { "summary": "Delete an accounting code rule", "operationId": "accounting-code-rules-destroy", "tags": [ "Accounting Code Rules" ], "parameters": [ { "name": "accounting_code_rule", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve an accounting code rule", "operationId": "accounting-code-rules-show", "tags": [ "Accounting Code Rules" ], "parameters": [ { "name": "accounting_code_rule", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_entity", "business_preset", "expense_accounting_code", "liability_accounting_code", "tag", "tag_group" ] } }, "required": false } ], "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 (`\"accounting_code_rule\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountingCodeRule" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With business_entity expanded", "properties": { "business_entity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessEntity" } } } } }, { "type": "object", "title": "With tag_group expanded", "properties": { "tag_group": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TagGroup" } } } } }, { "type": "object", "title": "With tag expanded", "properties": { "tag": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Tag" } } } } }, { "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/AccountingCode" } } } } }, { "type": "object", "title": "With liability_accounting_code expanded", "properties": { "liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LiabilityAccountingCode" } } } } } ] } } }, "example": { "id": "", "object": "accounting_code_rule", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "tag_group": { "id": "", "object": "tag_group", "links": { "self": "/tag_groups/" } }, "tag": { "id": "", "object": "tag", "links": { "self": "/tags/" } }, "type": null, "subtype": null, "subtypes": [], "business_preset": null, "expense_accounting_code": { "id": "", "object": "accounting_code", "links": { "self": "/accounting_codes/" } }, "liability_accounting_code": null, "expense_segment_template": null, "liability_segment_template": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/accounting_code_rules/" } } } } } } }, "put": { "summary": "Update an accounting code rule", "operationId": "accounting-code-rules-update", "tags": [ "Accounting Code Rules" ], "parameters": [ { "name": "accounting_code_rule", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"accounting_code_rule\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/AccountingCodeRule" } } }, "example": { "id": "", "object": "accounting_code_rule", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "tag_group": { "id": "", "object": "tag_group", "links": { "self": "/tag_groups/" } }, "tag": { "id": "", "object": "tag", "links": { "self": "/tags/" } }, "type": null, "subtype": null, "subtypes": [], "business_preset": null, "expense_accounting_code": { "id": "", "object": "accounting_code", "links": { "self": "/accounting_codes/" } }, "liability_accounting_code": { "id": "", "object": "accounting_code", "links": { "self": "/accounting_codes/" } }, "expense_segment_template": null, "liability_segment_template": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/accounting_code_rules/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tag_group_id": { "type": "string" }, "tag_id": { "type": "string" }, "type": { "type": "string", "enum": [ "allowance", "deduction", "earning", "employee_benefit", "employer_benefit", "employer_statutory_withholding", "reimbursement", "statutory_withholding" ] }, "subtype": { "type": "string", "nullable": true }, "subtypes": { "type": "array", "items": { "type": "string" } }, "business_preset_id": { "type": "string" }, "expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string" }, "expense_segment_template": { "$ref": "#/components/schemas/SegmentTemplate" }, "liability_segment_template": { "$ref": "#/components/schemas/SegmentTemplate" } } }, "example": { "liability_accounting_code_id": "" } } } } } }, "/adjustments/{adjustment}": { "delete": { "summary": "Delete an adjustment", "operationId": "adjustments-destroy", "tags": [ "Adjustments" ], "parameters": [ { "name": "adjustment", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve an adjustment", "operationId": "adjustments-show", "tags": [ "Adjustments" ], "parameters": [ { "name": "adjustment", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "correction_line_item", "correction_pay_stub", "source_line_item" ] } }, "required": false } ], "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 (`\"adjustment\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Adjustment" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With correction_pay_stub expanded", "properties": { "correction_pay_stub": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayStub" } } } } } ] } } }, "example": { "id": "", "object": "adjustment", "data": { "source_line_item": { "id": "", "object": "earning_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "amount": 10000, "custom_amount": null, "managed_amount": 10000, "is_managed": true, "line_item_type": "earning", "earning_type": { "id": "", "object": "earning_type", "data": { "type": "salary", "label": "Salary", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/salary" } }, "hours": 173.33, "managed_hours": 173.33, "custom_hours": null, "accrued_vacation_pay": 0, "recurrence": { "id": "", "object": "pay_rate", "links": { "self": "/pay_rates/" } }, "pay_rate": { "id": "", "object": "pay_rate", "links": { "self": "/pay_rates/" } }, "overtime_rate": null, "title": "Salary Rate", "title_translations": null, "title_translated": "Salary Rate", "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "business_preset": null, "source_adjustment": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/earning_line_items/" } }, "correction_line_item": { "id": "", "object": "earning_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "amount": -8900, "custom_amount": null, "managed_amount": -8900, "is_managed": false, "line_item_type": "earning", "earning_type": { "id": "", "object": "earning_type", "data": { "type": "salary", "label": "Salary", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/salary" } }, "hours": null, "managed_hours": null, "custom_hours": null, "accrued_vacation_pay": 0, "recurrence": null, "pay_rate": null, "overtime_rate": null, "title": "Salary Rate Adjustment", "title_translations": { "en": "Salary Rate Adjustment", "fr": "Rajustement Salary Rate" }, "title_translated": "Salary Rate Adjustment", "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "business_preset": null, "source_adjustment": { "id": "", "object": "adjustment", "links": { "self": "/adjustments/" } }, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/earning_line_items/" } }, "correction_pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "type": "earning", "subtype": "salary", "expected_amount": 1100, "admin_note": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/adjustments/" } } } } } } }, "put": { "summary": "Update an adjustment", "operationId": "adjustments-update", "tags": [ "Adjustments" ], "parameters": [ { "name": "adjustment", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"adjustment\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Adjustment" } } }, "example": { "id": "", "object": "adjustment", "data": { "source_line_item": { "id": "", "object": "earning_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "amount": 10000, "custom_amount": null, "managed_amount": 10000, "is_managed": true, "line_item_type": "earning", "earning_type": { "id": "", "object": "earning_type", "data": { "type": "salary", "label": "Salary", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/salary" } }, "hours": 173.33, "managed_hours": 173.33, "custom_hours": null, "accrued_vacation_pay": 0, "recurrence": { "id": "", "object": "pay_rate", "links": { "self": "/pay_rates/" } }, "pay_rate": { "id": "", "object": "pay_rate", "links": { "self": "/pay_rates/" } }, "overtime_rate": null, "title": "Salary Rate", "title_translations": null, "title_translated": "Salary Rate", "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "business_preset": null, "source_adjustment": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/earning_line_items/" } }, "correction_line_item": { "id": "", "object": "earning_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "amount": -9000, "custom_amount": null, "managed_amount": -9000, "is_managed": false, "line_item_type": "earning", "earning_type": { "id": "", "object": "earning_type", "data": { "type": "salary", "label": "Salary", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/salary" } }, "hours": null, "managed_hours": null, "custom_hours": null, "accrued_vacation_pay": 0, "recurrence": null, "pay_rate": null, "overtime_rate": null, "title": "Salary Rate Adjustment", "title_translations": { "en": "Salary Rate Adjustment", "fr": "Rajustement Salary Rate" }, "title_translated": "Salary Rate Adjustment", "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "business_preset": null, "source_adjustment": { "id": "", "object": "adjustment", "links": { "self": "/adjustments/" } }, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/earning_line_items/" } }, "correction_pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "type": "earning", "subtype": "salary", "expected_amount": 1000, "admin_note": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/adjustments/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "correction_pay_stub_id": { "type": "string" }, "expected_amount": { "type": "number", "format": "decimal", "minimum": -99999, "maximum": 99999 }, "admin_note": { "type": "string", "nullable": true }, "external_ref": { "type": "string", "maxLength": 255 } } }, "example": { "expected_amount": 1000 } } } } } }, "/allowances/{allowance}": { "delete": { "summary": "Delete an allowance", "operationId": "allowances-destroy", "tags": [ "Allowances" ], "parameters": [ { "name": "allowance", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve an allowance", "operationId": "allowances-show", "tags": [ "Allowances" ], "parameters": [ { "name": "allowance", "in": "path", "schema": { "type": "string" }, "required": true }, { "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": { "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Allowance" } ], "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": { "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\u00e9l\u00e9phone 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/" } } } } } } }, "put": { "summary": "Update an allowance", "operationId": "allowances-update", "tags": [ "Allowances" ], "parameters": [ { "name": "allowance", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"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\u00e9l\u00e9phone 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/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_preset_id": { "type": "string" }, "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" ] }, "allowance_type": { "type": "string", "description": "The type of allowance, which determines how it is taxed and reported on Pay Stubs.", "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 }, "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 } } }, "example": { "frequency": "per_month", "allowance_type": "cell_phone_allowance", "amount": "75.25", "title": "Cell phone allowance", "title_translations": { "en": "Cell phone allowance", "fr": "Allocation de t\u00e9l\u00e9phone cellulaire" }, "effective_from": "2026-01-01", "effective_to": "2026-12-31", "external_ref": "01KFNHG3MNRS84XF1ERW0M7HP0", "date_basis": "by_period_start_date", "pay_period_cadence": [ 1 ] } } } } } }, "/allowance_line_items/{allowance_line_item}": { "delete": { "summary": "Delete an allowance line item", "operationId": "allowance-line-items-destroy", "tags": [ "Allowance Line Items" ], "parameters": [ { "name": "allowance_line_item", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve an allowance line item", "operationId": "allowance-line-items-show", "tags": [ "Allowance Line Items" ], "parameters": [ { "name": "allowance_line_item", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "custom_expense_accounting_code", "custom_liability_accounting_code", "custom_tag_assignment", "expense_accounting_code", "liability_accounting_code", "managed_expense_accounting_code", "managed_liability_accounting_code", "managed_tag_assignment", "pay_stub", "recurrence", "source_adjustment", "tag_assignment", "tag_assignment_amounts" ] } }, "required": false } ], "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 (`\"allowance_line_item\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AllowanceLineItem" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With pay_stub expanded", "properties": { "pay_stub": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayStub" } } } } }, { "type": "object", "title": "With recurrence expanded", "properties": { "recurrence": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Recurrence" } } } } }, { "type": "object", "title": "With business_preset expanded", "properties": { "business_preset": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessPreset" } } } } }, { "type": "object", "title": "With source_adjustment expanded", "properties": { "source_adjustment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SourceAdjustment" } } } } }, { "type": "object", "title": "With expense_accounting_code expanded", "properties": { "expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ExpenseAccountingCode" } } } } }, { "type": "object", "title": "With managed_expense_accounting_code expanded", "properties": { "managed_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedExpenseAccountingCode" } } } } }, { "type": "object", "title": "With custom_expense_accounting_code expanded", "properties": { "custom_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomExpenseAccountingCode" } } } } }, { "type": "object", "title": "With liability_accounting_code expanded", "properties": { "liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LiabilityAccountingCode" } } } } }, { "type": "object", "title": "With managed_liability_accounting_code expanded", "properties": { "managed_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedLiabilityAccountingCode" } } } } }, { "type": "object", "title": "With custom_liability_accounting_code expanded", "properties": { "custom_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomLiabilityAccountingCode" } } } } }, { "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" } } } } }, { "type": "object", "title": "With managed_tag_assignment expanded", "properties": { "managed_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/ManagedTagAssignment" } } } } }, { "type": "object", "title": "With custom_tag_assignment expanded", "properties": { "custom_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/CustomTagAssignment" } } } } }, { "type": "object", "title": "With tag_assignment_amounts expanded", "properties": { "tag_assignment_amounts": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/TagAssignmentAmount" } } } } } } } } ] } } }, "example": { "id": "", "object": "allowance_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "allowance", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "accrued_vacation_pay": 0, "allowance_type": { "id": "", "object": "allowance_type", "data": { "type": "automobile_and_motor_vehicle", "label": "Vehicle allowance (taxable)" }, "links": { "self": "/allowance_types/automobile_and_motor_vehicle" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/allowance_line_items/" } } } } } } }, "put": { "summary": "Update an allowance line item", "operationId": "allowance-line-items-update", "tags": [ "Allowance Line Items" ], "parameters": [ { "name": "allowance_line_item", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"allowance_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/AllowanceLineItem" } } }, "example": { "id": "", "object": "allowance_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "allowance", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "accrued_vacation_pay": 0, "allowance_type": { "id": "", "object": "allowance_type", "data": { "type": "automobile_and_motor_vehicle", "label": "Vehicle allowance (taxable)" }, "links": { "self": "/allowance_types/automobile_and_motor_vehicle" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/allowance_line_items/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_preset_id": { "type": "string", "description": "Writing may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false" }, "allowance_type": { "type": "string", "description": "The type of allowance for this line item.\n\nWriting may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false", "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" ] }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.\n\nEditing is prevented when `is_editable` is false", "format": "decimal", "maximum": 99999 }, "accrued_vacation_pay": { "type": "number", "description": "The vacation pay accrued on this line item, calculated based on the Work Assignment's Vacation Pay Settings.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "title": { "type": "string", "description": "Writing may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false", "nullable": true, "maxLength": 255 }, "title_translations": { "type": "object", "description": "Optional translations for the `title` property.\n\nWriting may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "expense_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "custom_expense_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "liability_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "custom_liability_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "component_settings": { "type": "object", "properties": { "attributes_locked": { "type": "boolean" } } }, "custom_earned_on": { "type": "string", "description": "Editing is prevented when `is_editable` is false", "format": "date" }, "external_ref": { "type": "string", "maxLength": 255 }, "custom_tag_assignment": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "amount", "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 } } } } } } } }, "example": { "allowance_type": "automobile_and_motor_vehicle", "accrued_vacation_pay": "0" } } } } } }, "/allowance_types/{allowance_type}": { "get": { "summary": "Retrieve an allowance type", "operationId": "allowance-types-show", "tags": [ "Allowance Types" ], "parameters": [ { "name": "allowance_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 (`\"allowance_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/AllowanceType" } } }, "example": { "id": "", "object": "allowance_type", "data": { "type": "taxable_cash_allowance", "label": "Taxable Cash Allowance", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance 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": "Taxable Cash Allowance is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Taxable Cash Allowance is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [ { "jurisdiction": "ca_qc", "effects": [ "accrues_vacation_pay" ], "help_text": "Vacation pay accrues on Taxable Cash Allowance", "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" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/allowance_types/taxable_cash_allowance" } } } } } } } }, "/async_tasks/{async_task}": { "get": { "summary": "Retrieve an async task", "description": "Endpoint to fetch an AsyncTask.\n\nAsync Tasks are created when a long-running process is initiated (e.g. form generation) and can be used to track the progress of that process and fetch the results once it is completed.\n\nA task starts as `processing` and ends as either `completed` or `error`. The `async_task_completed` webhook fires on both, whether the work succeeded or failed, so use this endpoint to read `status` and, on `error`, any failure details in `results`. `completed_at` is only set when the task succeeded.\n\nThe following example is for a Form Generation task, but the response fields will differ depending on the specific AsyncTask instance requested.", "operationId": "async-tasks-show", "tags": [ "Async Tasks" ], "parameters": [ { "name": "async_task", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"async_task\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/AsyncTask" } } }, "example": { "id": "", "object": "async_task", "data": { "type": "form_generation", "status": "processing", "completed_at": null, "results": [], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/async_tasks/" } } } } } } } }, "/bank_accounts/{bank_account}": { "delete": { "summary": "Delete a bank account", "operationId": "bank-accounts-destroy", "tags": [ "Bank Accounts" ], "parameters": [ { "name": "bank_account", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a bank account", "operationId": "bank-accounts-show", "tags": [ "Bank Accounts" ], "parameters": [ { "name": "bank_account", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_entity", "contractor", "employee" ] } }, "required": false } ], "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 (`\"bank_account\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BankAccount" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With employee expanded", "properties": { "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/Employee" } } } } }, { "type": "object", "title": "With contractor expanded", "properties": { "contractor": { "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/Contractor" } } } } }, { "type": "object", "title": "With business_entity expanded", "properties": { "business_entity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessEntity" } } } } } ] } } }, "example": { "id": "", "object": "bank_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "name": null, "institution_number": "320", "institution_name": "President's Choice Bank", "institution_name_translations": { "en": "President's Choice Bank", "fr": "Banque le Choix du Pr\u00e9sident" }, "institution_name_translated": "President's Choice Bank", "transit_number": "02002", "transit_address": "600-500 Lakeshore Blvd West POBOX600, Toronto, ON M5V 2V9", "account_number_last_3": "916", "is_primary": false, "is_deletable": true, "warnings": { "object": "list", "data": [] }, "is_pad_signed": false, "pad_signer_name": null, "pad_signer_email": null, "pad_signer_title": null, "pad_signed_at": null, "pad_file": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/bank_accounts/" } } } } } } }, "put": { "summary": "Update a bank account", "operationId": "bank-accounts-update", "tags": [ "Bank Accounts" ], "parameters": [ { "name": "bank_account", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"bank_account\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/BankAccount" } } }, "example": { "id": "", "object": "bank_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "name": null, "institution_number": "320", "institution_name": "President's Choice Bank", "institution_name_translations": { "en": "President's Choice Bank", "fr": "Banque le Choix du Pr\u00e9sident" }, "institution_name_translated": "President's Choice Bank", "transit_number": "02002", "transit_address": "600-500 Lakeshore Blvd West POBOX600, Toronto, ON M5V 2V9", "account_number_last_3": "916", "is_primary": false, "is_deletable": true, "warnings": { "object": "list", "data": [] }, "is_pad_signed": false, "pad_signer_name": null, "pad_signer_email": null, "pad_signer_title": null, "pad_signed_at": null, "pad_file": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/bank_accounts/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "account_number": { "type": "string" }, "transit_number": { "type": "string", "description": "The 5-digit bank transit number. A transit that is not a known branch of the given institution raises a `bank_account_unrecognized_transit` warning rather than failing the request." }, "institution_number": { "type": "string", "description": "The 3-digit bank institution number. An institution Nmbr does not hold raises a `bank_account_unrecognized_institution` warning rather than failing the request." }, "name": { "type": "string", "description": "An optional human-readable label for the bank account, such as \"Main chequing\". Useful for distinguishing accounts at the same institution.", "nullable": true, "maxLength": 255 }, "is_primary": { "type": "boolean", "description": "Whether this is the primary bank account for its owner.\n\nIndicates that this bank account is the primary bank account. Optional. To set a primary bank account as not primary, set another account as primary." }, "pad_signer_name": { "type": "string", "description": "The name of the person who signed the PAD agreement. Only applicable to Business Entity bank accounts.", "nullable": true }, "pad_signer_email": { "type": "string", "description": "The email address of the PAD agreement signer. Only applicable to Business Entity bank accounts." }, "pad_signer_title": { "type": "string", "description": "The title or role of the PAD agreement signer. Only applicable to Business Entity bank accounts.", "nullable": true }, "pad_signed_at": { "type": "string", "description": "The date and time the PAD agreement was signed. Only applicable to Business Entity bank accounts.", "format": "date" }, "pad_file": { "type": "string" } } }, "example": { "account_number": "3654916", "transit_number": "02002", "institution_number": "320" } } } } } }, "/bank_accounts/{bank_account}/reveal": { "get": { "summary": "Reveal bank account number", "operationId": "bank-accounts-reveal", "tags": [ "Bank Accounts" ], "parameters": [ { "name": "bank_account", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {}, "example": { "data": { "account_number": "3654916" } } } } } } } }, "/business_entities/{business_entity}": { "delete": { "summary": "Delete a business entity", "operationId": "business-entities-destroy", "tags": [ "Business Entities" ], "parameters": [ { "name": "business_entity", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a business entity", "description": "If the `tax_properties` are expanded, only Tax Properties active on the current date will be returned.", "operationId": "business-entities-show", "tags": [ "Business Entities" ], "parameters": [ { "name": "business_entity", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "accounting_settings.default_bank_accounting_code", "accounting_settings.default_payroll_payable_accounting_code", "accounting_settings.primary_tag_group", "bank_accounts", "business_presets", "company", "default_bank_accounting_code", "default_payroll_payable_accounting_code", "effective_tax_properties", "pay_schedules", "payrolls", "primary_tag_group", "tax_properties" ] } }, "required": false } ], "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 (`\"business_entity\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BusinessEntity" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With company expanded", "properties": { "company": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Company" } } } } }, { "type": "object", "title": "With pay_schedules expanded", "properties": { "pay_schedules": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/PaySchedule" } } } } } } } }, { "type": "object", "title": "With payrolls expanded", "properties": { "payrolls": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/Payroll" } } } } } } } }, { "type": "object", "title": "With bank_accounts expanded", "properties": { "bank_accounts": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/BankAccount" } } } } } } } }, { "type": "object", "title": "With business_presets expanded", "properties": { "business_presets": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/BusinessPreset" } } } } } } } }, { "type": "object", "title": "With tax_properties expanded", "properties": { "tax_properties": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/TaxProperty" } } } } } } } }, { "type": "object", "title": "With effective_tax_properties expanded", "properties": { "effective_tax_properties": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/EffectiveTaxProperty" } } } } } } } }, { "type": "object", "title": "With default_bank_accounting_code expanded", "properties": { "default_bank_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DefaultBankAccountingCode" } } } } }, { "type": "object", "title": "With default_payroll_payable_accounting_code expanded", "properties": { "default_payroll_payable_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DefaultPayrollPayableAccountingCode" } } } } }, { "type": "object", "title": "With primary_tag_group expanded", "properties": { "primary_tag_group": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PrimaryTagGroup" } } } } }, { "type": "object", "title": "With accounting_settings.default_bank_accounting_code expanded", "properties": { "accounting_settings": { "type": "object", "properties": { "default_bank_accounting_code": { "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/DefaultBankAccountingCode" } } } } } } }, { "type": "object", "title": "With accounting_settings.default_payroll_payable_accounting_code expanded", "properties": { "accounting_settings": { "type": "object", "properties": { "default_payroll_payable_accounting_code": { "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/DefaultPayrollPayableAccountingCode" } } } } } } }, { "type": "object", "title": "With accounting_settings.primary_tag_group expanded", "properties": { "accounting_settings": { "type": "object", "properties": { "primary_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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/PrimaryTagGroup" } } } } } } } ] } } }, "example": { "id": "", "object": "business_entity", "data": { "business_number": "136549169RP9916", "name": "Bobs Burgers (#39616)", "legal_name": null, "legal_registration_number": null, "address_line_1": "13 Fake Street", "address_line_2": null, "city": "Toronto", "in_preview": false, "administrative_area": "ON", "province_code": "ON", "country_code": "CA", "postal_code": "M1M1M1", "contact_name": "Jean Smith", "contact_email": "smith@company.com", "contact_area_code": "111", "contact_phone_number": "2223333", "contact_extension": null, "pay_day_movement_setting": "inherit", "vacation_pay_formula_setting": "pay_date", "remitter_type": "regular", "status": "approved", "company": { "id": "", "object": "company", "links": { "self": "/companies/" } }, "warnings": { "object": "list", "data": [ { "object": "warning", "data": { "namespace": "onboarding", "type": "business_legal_information_not_provided" } }, { "object": "warning", "data": { "namespace": "onboarding", "type": "bank_account_doesnt_exists" } }, { "object": "warning", "data": { "namespace": "onboarding", "type": "bank_account_pad_not_signed" } } ] }, "external_ref": null, "available_tax_properties": [ "ca::tax_id", "ca::qc::tax_id", "ca::province_of_employment", "ca::federal_oc_surtax_exempt", "ca::on::eht", "ca::mb::eht", "ca::nl::eht", "ca::bc::eht", "ca::qc::eht" ], "effective_processing_speed": "three_day", "processing_speed": "inherit", "has_bank_accounts": false, "has_pay_schedules": false, "has_payrolls": false, "current_tax_jurisdiction": "ca_on", "ca_settings": { "roe_submission_setting": "manual" }, "accounting_settings": { "default_bank_accounting_code": null, "default_payroll_payable_accounting_code": null, "resolve_journal_entry_stat_withholdings": true, "primary_tag_group": null, "journal_entry_dimensions": [ { "id": "", "object": "tag_group", "links": { "self": "/tag_groups/" } }, { "id": "", "object": "tag_group", "links": { "self": "/tag_groups/" } } ], "block_approval_on_incomplete_journal_entries": false, "block_approval_on_missing_export_identifiers": false }, "default_bank_accounting_code": null, "default_payroll_payable_accounting_code": null, "preferred_locale": { "id": "", "object": "locale", "data": { "label": "English" } }, "hold_funding_for_verification": false, "resolve_journal_entry_stat_withholdings": true, "primary_tag_group": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/business_entities/" } } } } } } }, "put": { "summary": "Update a business entity", "operationId": "business-entities-update", "tags": [ "Business Entities" ], "parameters": [ { "name": "business_entity", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"business_entity\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/BusinessEntity" } } }, "example": { "id": "", "object": "business_entity", "data": { "business_number": "136549169RP9916", "name": "Bobs Burgers (#39616)", "legal_name": null, "legal_registration_number": null, "address_line_1": "13 Fake Street", "address_line_2": null, "city": "Toronto", "in_preview": false, "administrative_area": "ON", "province_code": "ON", "country_code": "CA", "postal_code": "M1M1M1", "contact_name": "Jean Smith", "contact_email": "smith@company.com", "contact_area_code": "111", "contact_phone_number": "2223333", "contact_extension": null, "pay_day_movement_setting": "inherit", "vacation_pay_formula_setting": "pay_date", "remitter_type": "regular", "status": "approved", "company": { "id": "", "object": "company", "links": { "self": "/companies/" } }, "warnings": { "object": "list", "data": [ { "object": "warning", "data": { "namespace": "onboarding", "type": "business_legal_information_not_provided" } }, { "object": "warning", "data": { "namespace": "onboarding", "type": "bank_account_doesnt_exists" } }, { "object": "warning", "data": { "namespace": "onboarding", "type": "bank_account_pad_not_signed" } } ] }, "external_ref": null, "available_tax_properties": [ "ca::tax_id", "ca::qc::tax_id", "ca::province_of_employment", "ca::federal_oc_surtax_exempt", "ca::on::eht", "ca::mb::eht", "ca::nl::eht", "ca::bc::eht", "ca::qc::eht" ], "effective_processing_speed": "three_day", "processing_speed": "inherit", "has_bank_accounts": false, "has_pay_schedules": false, "has_payrolls": false, "current_tax_jurisdiction": "ca_on", "ca_settings": { "roe_submission_setting": "manual" }, "accounting_settings": { "default_bank_accounting_code": null, "default_payroll_payable_accounting_code": null, "resolve_journal_entry_stat_withholdings": true, "primary_tag_group": { "id": "", "object": "tag_group", "links": { "self": "/tag_groups/" } }, "journal_entry_dimensions": [ { "id": "", "object": "tag_group", "links": { "self": "/tag_groups/" } }, { "id": "", "object": "tag_group", "links": { "self": "/tag_groups/" } } ], "block_approval_on_incomplete_journal_entries": false, "block_approval_on_missing_export_identifiers": false }, "default_bank_accounting_code": null, "default_payroll_payable_accounting_code": null, "preferred_locale": { "id": "", "object": "locale", "data": { "label": "English" } }, "hold_funding_for_verification": false, "resolve_journal_entry_stat_withholdings": true, "primary_tag_group": { "id": "", "object": "tag_group", "links": { "self": "/tag_groups/" } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/business_entities/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_number": { "type": "string", "description": "The Canada Revenue Agency (CRA) Business Number (BN) for this business entity, used to identify the business for payroll tax remittances. 15 characters (BN15): a 9-digit Business Number root, the 2-letter `RP` payroll program identifier, and a 4-digit reference number starting at 0001. The root begins with 1, 7, or 8 and carries a Luhn check digit." }, "name": { "type": "string", "description": "The business entity's operating or trade name.", "maxLength": 255 }, "legal_name": { "type": "string", "description": "The business entity's registered legal name.", "maxLength": 255 }, "legal_registration_number": { "type": "string", "description": "The provincial business registration number.", "maxLength": 255 }, "address_line_1": { "type": "string", "description": "The first line of the business entity's mailing address. Canada Revenue Agency forms (T4, RL-1) truncate this to the length those forms allow.", "nullable": true }, "address_line_2": { "type": "string", "description": "The second line of the business entity's mailing address. Canada Revenue Agency forms (T4, RL-1) truncate this to the length those forms allow.", "nullable": true }, "city": { "type": "string", "description": "The city of the business entity's mailing address.", "nullable": true }, "administrative_area": { "type": "string", "description": "The region of the business entity's mailing address \u2014 the province, state, or county, depending on the country. For Canadian business entities this is the province.", "nullable": true, "maxLength": 255 }, "province_code": { "type": "string", "description": "This attribute is deprecated and will be removed.\n\nA deprecated alias of `administrative_area` that mirrors its value. Use `administrative_area` instead.\n\nIn Canada, must be an uppercase 2-letter province code: `AB`, `BC`, `MB`, `NB`, `NL`, `NS`, `NT`, `NU`, `ON`, `PE`, `QC`, `SK`, `YT`", "deprecated": true }, "country_code": { "type": "string", "description": "The country code for the business entity's mailing address.\n\nMust be an uppercase 2-letter country code (ISO 3166-1 alpha-2, e.g., `CA`)." }, "postal_code": { "type": "string", "description": "The postal code for the business entity's mailing address.", "nullable": true, "maxLength": 10 }, "contact_name": { "type": "string", "description": "The name of the primary contact at the business entity.", "maxLength": 255 }, "contact_email": { "type": "string", "description": "The email address of the primary contact at the business entity." }, "contact_area_code": { "type": "string", "description": "The area code for the primary contact's phone number.", "maxLength": 3 }, "contact_phone_number": { "type": "string", "description": "The primary contact's phone number, excluding area code.", "maxLength": 7 }, "contact_extension": { "type": "string", "description": "The extension for the primary contact's phone number.", "maxLength": 5 }, "pay_day_movement_setting": { "type": "string", "description": "The business entity-level setting for how pay dates are adjusted when they fall on a weekend or bank holiday. If set to `inherit`, the Company's setting is used.", "enum": [ "inherit", "next_business_day", "previous_business_day" ] }, "vacation_pay_formula_setting": { "type": "string", "description": "The formula used to calculate vacation pay for Employees in this business entity.", "enum": [ "pay_date", "period_end", "period_start" ] }, "remitter_type": { "type": "string", "description": "The Canada Revenue Agency (CRA) remitter type, which determines the frequency of payroll tax remittances to the CRA.", "enum": [ "accelerated_threshold_1", "accelerated_threshold_2", "quarterly", "regular" ] }, "in_preview": { "type": "boolean", "description": "When `true`, the business entity is in preview mode. In preview mode, Payrolls can be run and approved but no real money movement occurs." }, "external_ref": { "type": "string", "maxLength": 255 }, "default_bank_accounting_code_id": { "type": "string" }, "default_payroll_payable_accounting_code_id": { "type": "string" }, "preferred_locale": { "type": "string", "description": "The locale used for payroll communications sent to Employees and Contractors within this business entity. If not set, the Company's locale is used.", "enum": [ "en", "fr" ] }, "hold_funding_for_verification": { "type": "boolean" }, "resolve_journal_entry_stat_withholdings": { "type": "boolean" }, "primary_tag_group_id": { "type": "string" }, "accounting_settings": { "type": "object", "properties": { "default_bank_accounting_code_id": { "type": "string" }, "default_payroll_payable_accounting_code_id": { "type": "string" }, "resolve_journal_entry_stat_withholdings": { "type": "boolean" }, "primary_tag_group_id": { "type": "string" }, "journal_entry_dimensions": { "type": "array", "description": "The complete set of Tag Groups broken out as tracking dimensions on journal entries, given as tag group ids. The collection replaces the current set, so a group left out of it stops being a dimension and needs no separate call. The primary tag group is always a dimension: its id has to appear in the collection, and naming it claims one of the three available slots rather than two. A collection naming more than three groups, omitting the primary tag group, or naming a group that does not belong to this business entity is rejected, and nothing from the request is applied.", "items": { "type": "string" } }, "block_approval_on_incomplete_journal_entries": { "type": "boolean" }, "block_approval_on_missing_export_identifiers": { "type": "boolean" } } } } }, "example": { "business_number": "136549169RP9916", "name": "Bobs Burgers (#39616)", "address_line_1": "13 Fake Street", "city": "Toronto", "administrative_area": "ON", "country_code": "CA", "postal_code": "M1M1M1", "contact_name": "Jean Smith", "contact_email": "smith@company.com", "contact_area_code": "111", "contact_phone_number": "2223333", "pay_day_movement_setting": "inherit", "vacation_pay_formula_setting": "pay_date", "remitter_type": "regular", "preferred_locale": "en", "resolve_journal_entry_stat_withholdings": true, "accounting_settings": { "primary_tag_group_id": "", "journal_entry_dimensions": [ "", "" ] } } } } } } }, "/business_entities/{business_entity}/end_preview": { "post": { "summary": "End preview", "operationId": "business-entities-end-preview", "tags": [ "Business Entities" ], "parameters": [ { "name": "business_entity", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"business_entity\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/BusinessEntity" } } }, "example": { "id": "", "object": "business_entity", "data": { "business_number": "136549169RP9916", "name": "Bobs Burgers (#39616)", "legal_name": null, "legal_registration_number": null, "address_line_1": "13 Fake Street", "address_line_2": null, "city": "Toronto", "in_preview": false, "administrative_area": "ON", "province_code": "ON", "country_code": "CA", "postal_code": "M1M1M1", "contact_name": "Jean Smith", "contact_email": "smith@company.com", "contact_area_code": "111", "contact_phone_number": "2223333", "contact_extension": null, "pay_day_movement_setting": "inherit", "vacation_pay_formula_setting": "pay_date", "remitter_type": "regular", "status": "approved", "company": { "id": "", "object": "company", "links": { "self": "/companies/" } }, "warnings": { "object": "list", "data": [ { "object": "warning", "data": { "namespace": "onboarding", "type": "business_legal_information_not_provided" } }, { "object": "warning", "data": { "namespace": "onboarding", "type": "bank_account_doesnt_exists" } }, { "object": "warning", "data": { "namespace": "onboarding", "type": "bank_account_pad_not_signed" } } ] }, "external_ref": null, "available_tax_properties": [ "ca::tax_id", "ca::qc::tax_id", "ca::province_of_employment", "ca::federal_oc_surtax_exempt", "ca::on::eht", "ca::mb::eht", "ca::nl::eht", "ca::bc::eht", "ca::qc::eht" ], "effective_processing_speed": "three_day", "processing_speed": "inherit", "has_bank_accounts": false, "has_pay_schedules": false, "has_payrolls": false, "current_tax_jurisdiction": "ca_on", "ca_settings": { "roe_submission_setting": "manual" }, "accounting_settings": { "default_bank_accounting_code": null, "default_payroll_payable_accounting_code": null, "resolve_journal_entry_stat_withholdings": true, "primary_tag_group": null, "journal_entry_dimensions": [], "block_approval_on_incomplete_journal_entries": false, "block_approval_on_missing_export_identifiers": false }, "default_bank_accounting_code": null, "default_payroll_payable_accounting_code": null, "preferred_locale": null, "hold_funding_for_verification": false, "resolve_journal_entry_stat_withholdings": true, "primary_tag_group": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/business_entities/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "convert_paid_payrolls": { "type": "boolean" }, "preserve_draft_line_items": { "type": "boolean" }, "preserve_draft_off_cycles": { "type": "boolean" } } }, { "type": "object", "required": [ "convert_paid_payrolls" ] } ] }, "example": { "convert_paid_payrolls": false, "preserve_draft_line_items": false, "preserve_draft_off_cycles": false } } } } } }, "/business_entities/{business_entity}/reset_preview": { "post": { "summary": "Reset preview", "operationId": "business-entities-reset-preview", "tags": [ "Business Entities" ], "parameters": [ { "name": "business_entity", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"business_entity\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/BusinessEntity" } } }, "example": { "id": "", "object": "business_entity", "data": { "business_number": "136549169RP9916", "name": "Bobs Burgers (#39616)", "legal_name": null, "legal_registration_number": null, "address_line_1": "13 Fake Street", "address_line_2": null, "city": "Toronto", "in_preview": true, "administrative_area": "ON", "province_code": "ON", "country_code": "CA", "postal_code": "M1M1M1", "contact_name": "Jean Smith", "contact_email": "smith@company.com", "contact_area_code": "111", "contact_phone_number": "2223333", "contact_extension": null, "pay_day_movement_setting": "inherit", "vacation_pay_formula_setting": "pay_date", "remitter_type": "regular", "status": "approved", "company": { "id": "", "object": "company", "links": { "self": "/companies/" } }, "warnings": { "object": "list", "data": [ { "object": "warning", "data": { "namespace": "onboarding", "type": "business_legal_information_not_provided" } }, { "object": "warning", "data": { "namespace": "onboarding", "type": "bank_account_doesnt_exists" } }, { "object": "warning", "data": { "namespace": "onboarding", "type": "bank_account_pad_not_signed" } } ] }, "external_ref": null, "available_tax_properties": [ "ca::tax_id", "ca::qc::tax_id", "ca::province_of_employment", "ca::federal_oc_surtax_exempt", "ca::on::eht", "ca::mb::eht", "ca::nl::eht", "ca::bc::eht", "ca::qc::eht" ], "effective_processing_speed": "three_day", "processing_speed": "inherit", "has_bank_accounts": false, "has_pay_schedules": false, "has_payrolls": false, "current_tax_jurisdiction": "ca_on", "ca_settings": { "roe_submission_setting": "manual" }, "accounting_settings": { "default_bank_accounting_code": null, "default_payroll_payable_accounting_code": null, "resolve_journal_entry_stat_withholdings": true, "primary_tag_group": null, "journal_entry_dimensions": [], "block_approval_on_incomplete_journal_entries": false, "block_approval_on_missing_export_identifiers": false }, "default_bank_accounting_code": null, "default_payroll_payable_accounting_code": null, "preferred_locale": null, "hold_funding_for_verification": false, "resolve_journal_entry_stat_withholdings": true, "primary_tag_group": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/business_entities/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "delete_historical": { "type": "boolean" } } }, { "type": "object", "required": [ "delete_historical" ] } ] }, "example": { "delete_historical": false } } } } } }, "/business_entities/{business_entity}/verification": { "get": { "summary": "Retrieve a business entity verification", "operationId": "business-entities-verification-show", "tags": [ "Business Entity Verifications" ], "parameters": [ { "name": "business_entity", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"business_entity_verification\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/BusinessEntityVerification" } } }, "example": { "id": "", "object": "business_entity_verification", "data": { "status": "approved", "link_status": "complete", "link": "https://nmbr.co/kyb?token=", "external_id": "", "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" } } } } } } } }, "/business_entity_roe_authorizations/{roe_authorization}": { "delete": { "summary": "Delete a business entity ROE authorization", "operationId": "business-entity-roe-authorizations-destroy", "tags": [ "Business Entity ROE Authorizations" ], "parameters": [ { "name": "roe_authorization", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a business entity ROE authorization", "operationId": "business-entity-roe-authorizations-show", "tags": [ "Business Entity ROE Authorizations" ], "parameters": [ { "name": "roe_authorization", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"roe_authorization\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/BusinessEntityRoeAuthorization" } } }, "example": { "id": "", "object": "roe_authorization", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "status": "processing", "note": "Vitae error architecto sint velit tempora illo itaque.", "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/business_entity_roe_authorizations/" } } } } } } }, "put": { "summary": "Update a business entity ROE authorization", "operationId": "business-entity-roe-authorizations-update", "tags": [ "Business Entity ROE Authorizations" ], "parameters": [ { "name": "roe_authorization", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"roe_authorization\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/BusinessEntityRoeAuthorization" } } }, "example": { "id": "", "object": "roe_authorization", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "status": "processing", "note": "Updated note for the ROE authorization.", "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/business_entity_roe_authorizations/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "note": { "type": "string", "nullable": true, "maxLength": 1000 } } }, "example": { "note": "Updated note for the ROE authorization." } } } } } }, "/business_presets/{business_preset}": { "delete": { "summary": "Delete a business preset", "operationId": "business-presets-destroy", "tags": [ "Business Presets" ], "parameters": [ { "name": "business_preset", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a business preset", "operationId": "business-presets-show", "tags": [ "Business Presets" ], "parameters": [ { "name": "business_preset", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "allowances", "business_entity", "deductions", "earnings", "employee_benefits", "employer_benefits", "expense_accounting_code", "liability_accounting_code", "pay_rates", "reimbursements", "remittance_account" ] } }, "required": false } ], "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 (`\"business_preset\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BusinessPreset" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With business_entity expanded", "properties": { "business_entity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessEntity" } } } } }, { "type": "object", "title": "With remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } }, { "type": "object", "title": "With earnings expanded", "properties": { "earnings": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/Earning" } } } } } } } }, { "type": "object", "title": "With allowances expanded", "properties": { "allowances": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/Allowance" } } } } } } } }, { "type": "object", "title": "With employee_benefits expanded", "properties": { "employee_benefits": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployeeBenefit" } } } } } } } }, { "type": "object", "title": "With employer_benefits expanded", "properties": { "employer_benefits": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerBenefit" } } } } } } } }, { "type": "object", "title": "With deductions expanded", "properties": { "deductions": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/Deduction" } } } } } } } }, { "type": "object", "title": "With reimbursements expanded", "properties": { "reimbursements": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/Reimbursement" } } } } } } } }, { "type": "object", "title": "With pay_rates expanded", "properties": { "pay_rates": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/PayRate" } } } } } } } }, { "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" } } } } } ] } } }, "example": { "id": "", "object": "business_preset", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "name": "Business Preset 08a620c8-1d8a-3f0c-9475-963b2e8a0d49", "name_translations": null, "name_translated": "Business Preset 08a620c8-1d8a-3f0c-9475-963b2e8a0d49", "title": "Christmas Bonus", "title_translations": null, "title_translated": "Christmas Bonus", "type": "earning", "subtype": "bonus_discretionary", "remittance_account": null, "is_managed": false, "expense_accounting_code": null, "liability_accounting_code": null, "income_basis": null, "income_includes": [], "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/business_presets/" } } } } } } }, "put": { "summary": "Update a business preset", "operationId": "business-presets-update", "tags": [ "Business Presets" ], "parameters": [ { "name": "business_preset", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"business_preset\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/BusinessPreset" } } }, "example": { "id": "", "object": "business_preset", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "name": "Business Preset 08a620c8-1d8a-3f0c-9475-963b2e8a0d49", "name_translations": null, "name_translated": "Business Preset 08a620c8-1d8a-3f0c-9475-963b2e8a0d49", "title": "Holiday Bonus", "title_translations": null, "title_translated": "Holiday Bonus", "type": "earning", "subtype": "bonus_discretionary", "remittance_account": null, "is_managed": false, "expense_accounting_code": null, "liability_accounting_code": null, "income_basis": null, "income_includes": [], "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/business_presets/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "keep_existing_values": { "type": "string", "description": "Controls which preset values should be kept or updated on entities created from the preset when that value is updated on the preset. Defaults to `none`.", "enum": [ "all", "in_sync", "non_null", "none", "out_of_sync" ] }, "name": { "type": "string", "maxLength": 255 }, "name_translations": { "type": "object", "description": "Optional translations for the `name` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "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 }, "remittance_account_id": { "type": "string" }, "expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string" }, "income_basis": { "type": "string", "enum": [ "all_earnings", "none", "regular_earnings", "total_income" ] }, "income_includes": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "allowance", "earning", "employer_benefit", "reimbursement" ] }, "subtype": { "type": "string" } } } }, "external_ref": { "type": "string", "maxLength": 255 } } }, "example": { "title": "Holiday Bonus" } } } } } }, "/companies/{company}": { "delete": { "summary": "Delete a company", "description": "All Business Entities must be in Preview mode to be allowed.", "operationId": "companies-destroy", "tags": [ "Companies" ], "parameters": [ { "name": "company", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "202": { "description": "Accepted" } } }, "get": { "summary": "Retrieve a company", "operationId": "companies-show", "tags": [ "Companies" ], "parameters": [ { "name": "company", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_entities", "contractors", "employees", "partner" ] } }, "required": false } ], "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 (`\"company\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Company" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With business_entities expanded", "properties": { "business_entities": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/BusinessEntity" } } } } } } } }, { "type": "object", "title": "With employees expanded", "properties": { "employees": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/Employee" } } } } } } } }, { "type": "object", "title": "With contractors expanded", "properties": { "contractors": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/Contractor" } } } } } } } }, { "type": "object", "title": "With partner expanded", "properties": { "partner": { "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/Partner" } } } } } ] } } }, "example": { "id": "", "object": "company", "data": { "name": "Cutting-Edge Telecom Solutions", "pay_day_movement_setting": "inherit", "external_ref": null, "preferred_locale": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/companies/" } } } } } } }, "put": { "summary": "Update a company", "operationId": "companies-update", "tags": [ "Companies" ], "parameters": [ { "name": "company", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"company\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Company" } } }, "example": { "id": "", "object": "company", "data": { "name": "Cutting-Edge Telecom Solutions", "pay_day_movement_setting": "inherit", "external_ref": null, "preferred_locale": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/companies/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The company's name.", "maxLength": 255 }, "pay_day_movement_setting": { "type": "string", "description": "The company-level setting for how pay dates are adjusted when they fall on a weekend or bank holiday. Inherited by Business Entities and Pay Schedules whose own setting is `inherit`.", "enum": [ "inherit", "next_business_day", "previous_business_day" ] }, "external_ref": { "type": "string", "maxLength": 255 }, "preferred_locale": { "type": "string", "description": "The locale used for payroll communications sent to Employees and Contractors within this company. If not set, the Partner's locale is used.", "enum": [ "en", "fr" ] } } }, "example": { "name": "Cutting-Edge Telecom Solutions", "pay_day_movement_setting": "inherit" } } } } } }, "/contractors/{contractor}": { "delete": { "summary": "Delete a contractor", "operationId": "contractors-destroy", "tags": [ "Contractors" ], "parameters": [ { "name": "contractor", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a contractor", "operationId": "contractors-show", "tags": [ "Contractors" ], "parameters": [ { "name": "contractor", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "company", "work_assignments" ] } }, "required": false } ], "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 (`\"contractor\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Contractor" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With company expanded", "properties": { "company": { "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/Company" } } } } }, { "type": "object", "title": "With work_assignments expanded", "properties": { "work_assignments": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/WorkAssignment" } } } } } } } } ] } } }, "example": { "id": "", "object": "contractor", "data": { "business_name": "Contractor Co", "first_name": "John", "last_name": "Smith", "middle_initial": null, "email": "john@smith.com", "business_number": null, "sin_last_3": null, "external_ref": null, "preferred_locale": null, "archived_at": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/contractors/" } } } } } } }, "put": { "summary": "Update a contractor", "operationId": "contractors-update", "tags": [ "Contractors" ], "parameters": [ { "name": "contractor", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"contractor\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Contractor" } } }, "example": { "id": "", "object": "contractor", "data": { "business_name": "Contractor Co", "first_name": "John", "last_name": "Smith", "middle_initial": null, "email": "john@smith.com", "business_number": null, "sin_last_3": null, "external_ref": "", "preferred_locale": null, "archived_at": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/contractors/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_name": { "type": "string", "description": "The contractor's business or corporation name. `null` for individual contractors.", "nullable": true, "maxLength": 255 }, "first_name": { "type": "string", "description": "The contractor's first name. `null` for corporation contractors.", "nullable": true, "maxLength": 50 }, "last_name": { "type": "string", "description": "The contractor's last name. `null` for corporation contractors.", "nullable": true, "maxLength": 50 }, "middle_initial": { "type": "string", "description": "The contractor's middle initial. `null` for corporation contractors.", "nullable": true, "maxLength": 1 }, "email": { "type": "string", "description": "The contractor's email address, used for payroll communications." }, "business_number": { "type": "string", "description": "The contractor's 15-character (BN15) Canada Revenue Agency (CRA) program account number, consisting of a 9-digit Business Number (BN), a 2-letter program identifier, and a 4-digit reference number. `null` for individual contractors. The 9-digit root begins with 1, 7, or 8 and carries a Luhn check digit; the reference number starts at 0001." }, "sin": { "type": "string", "description": "The contractor's Social Insurance Number (SIN). `null` for corporation contractors. 9 digits, sent as a string. Spaces and dashes are stripped before validation. The first digit cannot be 0 or 8, and the number must pass the Luhn checksum." }, "external_ref": { "type": "string", "maxLength": 255 }, "preferred_locale": { "type": "string", "description": "The locale used for payroll communications sent to this contractor, such as Pay Stub emails. If not set, the Company's locale is used.", "enum": [ "en", "fr" ] }, "archived_at": { "type": "string", "description": "The date the contractor was archived. Archiving a contractor also archives all Work Assignments that are not already archived. Archived contractors do not appear in active listings.", "format": "date" } } }, "example": { "business_name": "Contractor Co", "first_name": "John", "last_name": "Smith", "email": "john@smith.com", "external_ref": "" } } } } } }, "/deductions/{deduction}": { "delete": { "summary": "Delete a deduction", "operationId": "deductions-destroy", "tags": [ "Deductions" ], "parameters": [ { "name": "deduction", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a deduction", "operationId": "deductions-show", "tags": [ "Deductions" ], "parameters": [ { "name": "deduction", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "expense_accounting_code", "liability_accounting_code", "remittance_account", "tag_assignment", "work_assignment" ] } }, "required": false } ], "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 (`\"deduction\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Deduction" } ], "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 remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } }, { "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": { "id": "", "object": "deduction", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "frequency": "per_month", "date_basis": "by_period_start_date", "pay_period_cadence": [ 1 ], "deduction_type": { "id": "", "object": "deduction_type", "data": { "type": "income_tax", "label": "Income tax debt", "locale": "en" }, "links": { "self": "/deduction_types/income_tax" } }, "amount": 35, "amount_type": "fixed", "income_basis": "all_earnings", "income_includes": [], "income_subtractions": [], "income_statutory_withholdings": "none", "income_exemption_amount": null, "income_exemption_percent": null, "effective_from": "2026-01-01", "effective_to": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account": 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": "/deductions/" } } } } } } }, "put": { "summary": "Update a deduction", "operationId": "deductions-update", "tags": [ "Deductions" ], "parameters": [ { "name": "deduction", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"deduction\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Deduction" } } }, "example": { "id": "", "object": "deduction", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "frequency": "per_month", "date_basis": "by_period_start_date", "pay_period_cadence": [ 1 ], "deduction_type": { "id": "", "object": "deduction_type", "data": { "type": "income_tax", "label": "Income tax debt", "locale": "en" }, "links": { "self": "/deduction_types/income_tax" } }, "amount": 35, "amount_type": "fixed", "income_basis": "all_earnings", "income_includes": [], "income_subtractions": [], "income_statutory_withholdings": "none", "income_exemption_amount": null, "income_exemption_percent": null, "effective_from": "2026-01-01", "effective_to": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account": 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": "/deductions/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_preset_id": { "type": "string" }, "frequency": { "type": "string", "description": "The frequency at which this deduction is applied to Pay Stubs. When `per_month`, the amount is distributed across selected Payrolls in the calendar month. `per_month` is only valid when `amount_type` is `fixed`; percent and per-hour deductions apply to every paycheque regardless of frequency.", "enum": [ "once", "per_month", "per_payroll" ] }, "deduction_type": { "type": "string", "description": "The type of deduction, which determines how it is categorized and remitted.", "enum": [ "charitable_donation", "garnishment_order", "income_tax", "other_deduction", "union_dues", "union_dues_post_tax" ] }, "remittance_account_id": { "type": "string", "description": "The remittance account to which collected deduction amounts are remitted." }, "amount": { "type": "number", "description": "The deduction amount per occurrence. When `amount_type` is `percent`, this is interpreted as a percentage of the income basis. When `fixed_per_hour`, it is multiplied by the hours on the Pay Stub's earning line items. Otherwise it is a fixed dollar amount.", "format": "decimal", "minimum": 0 }, "amount_type": { "type": "string", "description": "Whether `amount` is a fixed dollar value (`fixed`), a dollar value per hour worked (`fixed_per_hour`), or a percentage of the income basis (`percent`).", "enum": [ "fixed", "fixed_per_hour", "percent" ] }, "income_basis": { "type": "string", "description": "Determines the income used as the base for percentage-based deductions. `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": "array", "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`.", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "allowance", "earning", "employer_benefit", "reimbursement" ] }, "subtype": { "type": "string" } } } }, "income_subtractions": { "type": "array", "description": "An optional list of deductions and employee benefits to subtract from the income before the deduction amount is calculated.", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "deduction", "employee_benefit" ] }, "subtype": { "type": "string" } } } }, "income_statutory_withholdings": { "type": "string", "description": "Whether to subtract statutory withholdings (CPP, EI, income tax) from the income before the deduction amount is calculated.", "enum": [ "all", "none" ] }, "income_exemption_amount": { "type": "number", "description": "A fixed dollar amount to exempt from the income before calculating the deduction.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "income_exemption_percent": { "type": "number", "description": "A percentage of the income to exempt before calculating the deduction amount.", "format": "decimal", "minimum": 0, "maximum": 100 }, "effective_from": { "type": "string", "description": "The date from which this deduction is applied to Pay Stubs.", "format": "date" }, "effective_to": { "type": "string", "description": "The date after which this deduction is no longer applied. `null` if the deduction applies indefinitely.", "format": "date" }, "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 }, "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 fixed-amount `per_month` deductions.", "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 fixed-amount `per_month` deductions.", "items": { "type": "integer" }, "minItems": 1 } } }, "example": { "frequency": "per_month", "deduction_type": "income_tax", "amount": "35", "amount_type": "fixed", "income_basis": "all_earnings", "income_statutory_withholdings": "none", "effective_from": "2026-01-01", "date_basis": "by_period_start_date", "pay_period_cadence": [ 1 ] } } } } } }, "/deduction_line_items/{deduction_line_item}": { "delete": { "summary": "Delete a deduction line item", "operationId": "deduction-line-items-destroy", "tags": [ "Deduction Line Items" ], "parameters": [ { "name": "deduction_line_item", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a deduction line item", "operationId": "deduction-line-items-show", "tags": [ "Deduction Line Items" ], "parameters": [ { "name": "deduction_line_item", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "custom_expense_accounting_code", "custom_liability_accounting_code", "custom_tag_assignment", "expense_accounting_code", "liability_accounting_code", "managed_expense_accounting_code", "managed_liability_accounting_code", "managed_tag_assignment", "pay_stub", "recurrence", "remittance_account", "source_adjustment", "tag_assignment", "tag_assignment_amounts" ] } }, "required": false } ], "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 (`\"deduction_line_item\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeductionLineItem" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With pay_stub expanded", "properties": { "pay_stub": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayStub" } } } } }, { "type": "object", "title": "With recurrence expanded", "properties": { "recurrence": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Recurrence" } } } } }, { "type": "object", "title": "With remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } }, { "type": "object", "title": "With business_preset expanded", "properties": { "business_preset": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessPreset" } } } } }, { "type": "object", "title": "With source_adjustment expanded", "properties": { "source_adjustment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SourceAdjustment" } } } } }, { "type": "object", "title": "With expense_accounting_code expanded", "properties": { "expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ExpenseAccountingCode" } } } } }, { "type": "object", "title": "With managed_expense_accounting_code expanded", "properties": { "managed_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedExpenseAccountingCode" } } } } }, { "type": "object", "title": "With custom_expense_accounting_code expanded", "properties": { "custom_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomExpenseAccountingCode" } } } } }, { "type": "object", "title": "With liability_accounting_code expanded", "properties": { "liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LiabilityAccountingCode" } } } } }, { "type": "object", "title": "With managed_liability_accounting_code expanded", "properties": { "managed_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedLiabilityAccountingCode" } } } } }, { "type": "object", "title": "With custom_liability_accounting_code expanded", "properties": { "custom_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomLiabilityAccountingCode" } } } } }, { "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" } } } } }, { "type": "object", "title": "With managed_tag_assignment expanded", "properties": { "managed_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/ManagedTagAssignment" } } } } }, { "type": "object", "title": "With custom_tag_assignment expanded", "properties": { "custom_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/CustomTagAssignment" } } } } }, { "type": "object", "title": "With tag_assignment_amounts expanded", "properties": { "tag_assignment_amounts": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/TagAssignmentAmount" } } } } } } } } ] } } }, "example": { "id": "", "object": "deduction_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "deduction", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "deduction_type": { "id": "", "object": "deduction_type", "data": { "type": "income_tax", "label": "Income tax debt", "locale": "en" }, "links": { "self": "/deduction_types/income_tax" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/deduction_line_items/" } } } } } } }, "put": { "summary": "Update a deduction line item", "operationId": "deduction-line-items-update", "tags": [ "Deduction Line Items" ], "parameters": [ { "name": "deduction_line_item", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"deduction_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/DeductionLineItem" } } }, "example": { "id": "", "object": "deduction_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "deduction", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "deduction_type": { "id": "", "object": "deduction_type", "data": { "type": "income_tax", "label": "Income tax debt", "locale": "en" }, "links": { "self": "/deduction_types/income_tax" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/deduction_line_items/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_preset_id": { "type": "string", "description": "Writing may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false" }, "deduction_type": { "type": "string", "description": "The type of deduction for this line item.\n\nWriting may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false", "enum": [ "charitable_donation", "garnishment_order", "income_tax", "other_deduction", "union_dues", "union_dues_post_tax" ] }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.\n\nEditing is prevented when `is_editable` is false", "format": "decimal", "maximum": 99999 }, "title": { "type": "string", "description": "Writing may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false", "nullable": true, "maxLength": 255 }, "title_translations": { "type": "object", "description": "Optional translations for the `title` property.\n\nWriting may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "remittance_account_id": { "type": "string", "description": "Writing may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false" }, "expense_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "custom_expense_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "liability_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "custom_liability_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "component_settings": { "type": "object", "properties": { "attributes_locked": { "type": "boolean" } } }, "external_ref": { "type": "string", "maxLength": 255 }, "custom_tag_assignment": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "amount", "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 } } } } } } } }, "example": { "deduction_type": "income_tax" } } } } } }, "/deduction_types/{deduction_type}": { "get": { "summary": "Retrieve a deduction type", "operationId": "deduction-types-show", "tags": [ "Deduction Types" ], "parameters": [ { "name": "deduction_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 (`\"deduction_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/DeductionType" } } }, "example": { "id": "", "object": "deduction_type", "data": { "type": "income_tax", "label": "Income tax debt", "locale": "en", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/deduction_types/income_tax" } } } } } } } }, "/earnings/{earning}": { "delete": { "summary": "Delete an earning", "operationId": "earnings-destroy", "tags": [ "Earnings" ], "parameters": [ { "name": "earning", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve an earning", "operationId": "earnings-show", "tags": [ "Earnings" ], "parameters": [ { "name": "earning", "in": "path", "schema": { "type": "string" }, "required": true }, { "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": { "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": { "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/" } } } } } } }, "put": { "summary": "Update an earning", "operationId": "earnings-update", "tags": [ "Earnings" ], "parameters": [ { "name": "earning", "in": "path", "schema": { "type": "string" }, "required": true } ], "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\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Earning" } } }, "example": { "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/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_preset_id": { "type": "string" }, "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" ] }, "earning_type": { "type": "string", "description": "The type of earning, which determines how it is taxed.", "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", "tips_controlled", "vacation_pay", "vacation_pay_employee_terminated", "vacation_pay_no_time_taken", "vacation_pay_time_taken", "wage" ] }, "amount": { "type": "number", "description": "The monetary amount applied each time this earning is included on a Pay Stub.", "format": "decimal", "minimum": 0, "maximum": 9999 }, "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 }, "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.", "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 } } }, "example": { "frequency": "per_payroll", "earning_type": "parental_top_up_insurable", "amount": "5000", "effective_from": "2026-01-01" } } } } } }, "/earning_line_items/{earning_line_item}": { "delete": { "summary": "Delete an earning line item", "operationId": "earning-line-items-destroy", "tags": [ "Earning Line Items" ], "parameters": [ { "name": "earning_line_item", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve an earning line item", "operationId": "earning-line-items-show", "tags": [ "Earning Line Items" ], "parameters": [ { "name": "earning_line_item", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "custom_expense_accounting_code", "custom_liability_accounting_code", "custom_tag_assignment", "expense_accounting_code", "liability_accounting_code", "managed_expense_accounting_code", "managed_liability_accounting_code", "managed_tag_assignment", "overtime_rate", "pay_rate", "pay_stub", "recurrence", "source_adjustment", "tag_assignment", "tag_assignment_amounts" ] } }, "required": false } ], "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_line_item\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EarningLineItem" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With pay_stub expanded", "properties": { "pay_stub": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayStub" } } } } }, { "type": "object", "title": "With recurrence expanded", "properties": { "recurrence": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Recurrence" } } } } }, { "type": "object", "title": "With pay_rate expanded", "properties": { "pay_rate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayRate" } } } } }, { "type": "object", "title": "With overtime_rate expanded", "properties": { "overtime_rate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OvertimeRate" } } } } }, { "type": "object", "title": "With business_preset expanded", "properties": { "business_preset": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessPreset" } } } } }, { "type": "object", "title": "With source_adjustment expanded", "properties": { "source_adjustment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SourceAdjustment" } } } } }, { "type": "object", "title": "With expense_accounting_code expanded", "properties": { "expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ExpenseAccountingCode" } } } } }, { "type": "object", "title": "With managed_expense_accounting_code expanded", "properties": { "managed_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedExpenseAccountingCode" } } } } }, { "type": "object", "title": "With custom_expense_accounting_code expanded", "properties": { "custom_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomExpenseAccountingCode" } } } } }, { "type": "object", "title": "With liability_accounting_code expanded", "properties": { "liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LiabilityAccountingCode" } } } } }, { "type": "object", "title": "With managed_liability_accounting_code expanded", "properties": { "managed_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedLiabilityAccountingCode" } } } } }, { "type": "object", "title": "With custom_liability_accounting_code expanded", "properties": { "custom_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomLiabilityAccountingCode" } } } } }, { "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" } } } } }, { "type": "object", "title": "With managed_tag_assignment expanded", "properties": { "managed_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/ManagedTagAssignment" } } } } }, { "type": "object", "title": "With custom_tag_assignment expanded", "properties": { "custom_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/CustomTagAssignment" } } } } }, { "type": "object", "title": "With tag_assignment_amounts expanded", "properties": { "tag_assignment_amounts": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/TagAssignmentAmount" } } } } } } } } ] } } }, "example": { "id": "", "object": "earning_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "amount": 3000, "custom_amount": 3000, "managed_amount": 0, "is_managed": false, "line_item_type": "earning", "earning_type": { "id": "", "object": "earning_type", "data": { "type": "wage", "label": "Wage", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/wage" } }, "hours": 0, "managed_hours": null, "custom_hours": 0, "accrued_vacation_pay": 0, "recurrence": null, "pay_rate": null, "overtime_rate": null, "title": null, "title_translations": null, "title_translated": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "business_preset": null, "source_adjustment": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/earning_line_items/" } } } } } } }, "put": { "summary": "Update an earning line item", "description": "Earning Line Items on non-draft Pay Stubs will not be able to update attributes.\n\nAny Earning Line Item with `is_managed` set to `true` will only be able to update `custom_amount` and `custom_hours`", "operationId": "earning-line-items-update", "tags": [ "Earning Line Items" ], "parameters": [ { "name": "earning_line_item", "in": "path", "schema": { "type": "string" }, "required": true } ], "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_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EarningLineItem" } } }, "example": { "id": "", "object": "earning_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "amount": 3000, "custom_amount": 3000, "managed_amount": 0, "is_managed": false, "line_item_type": "earning", "earning_type": { "id": "", "object": "earning_type", "data": { "type": "wage", "label": "Wage", "supported_payroll_types": { "regular": true, "historical": true, "off_cycle": true } }, "links": { "self": "/earning_types/wage" } }, "hours": 0, "managed_hours": null, "custom_hours": 0, "accrued_vacation_pay": 0, "recurrence": null, "pay_rate": null, "overtime_rate": null, "title": "Earning", "title_translations": null, "title_translated": "Earning", "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "business_preset": null, "source_adjustment": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/earning_line_items/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_preset_id": { "type": "string", "description": "Writing may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false" }, "earning_type": { "type": "string", "description": "The type of earning for this line item.\n\nWriting may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false", "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_unpaid", "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", "tips_controlled", "vacation_accrual_adjustment", "vacation_pay", "vacation_pay_employee_terminated", "vacation_pay_no_time_taken", "vacation_pay_time_taken", "wage" ] }, "pay_rate_id": { "type": "string", "description": "Writing may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false" }, "overtime_rate_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.\n\nEditing is prevented when `is_editable` is false", "format": "decimal", "maximum": 999999 }, "custom_hours": { "type": "number", "description": "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.\n\nEditing is prevented when `is_editable` is false", "format": "decimal", "maximum": 9999 }, "accrued_vacation_pay": { "type": "number", "description": "The vacation pay accrued on this line item, calculated based on the Work Assignment's Vacation Pay Settings.", "format": "decimal", "minimum": -99999, "maximum": 99999 }, "title": { "type": "string", "description": "Writing may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false", "nullable": true, "maxLength": 255 }, "title_translations": { "type": "object", "description": "Optional translations for the `title` property.\n\nWriting may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "component_settings": { "type": "object", "properties": { "attributes_locked": { "type": "boolean" } } }, "expense_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "custom_expense_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "liability_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "custom_liability_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "custom_earned_on": { "type": "string", "description": "Editing is prevented when `is_editable` is false", "format": "date" }, "external_ref": { "type": "string", "maxLength": 255 }, "custom_tag_assignment": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "amount", "hours", "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 } } } } } } } }, "example": { "earning_type": "wage", "custom_amount": "3000", "custom_hours": "0", "accrued_vacation_pay": "0", "title": "Earning" } } } } } }, "/earning_types/{earning_type}": { "get": { "summary": "Retrieve an earning type", "operationId": "earning-types-show", "tags": [ "Earning Types" ], "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 }, "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_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" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" } ] ] } ] }, "links": { "self": "/earning_types/salary" } } } } } } } }, "/employees/{employee}": { "delete": { "summary": "Delete an employee", "operationId": "employees-destroy", "tags": [ "Employees" ], "parameters": [ { "name": "employee", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve an employee", "operationId": "employees-show", "tags": [ "Employees" ], "parameters": [ { "name": "employee", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "company", "work_assignments" ] } }, "required": false } ], "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 (`\"employee\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Employee" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With company expanded", "properties": { "company": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Company" } } } } }, { "type": "object", "title": "With work_assignments expanded", "properties": { "work_assignments": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/WorkAssignment" } } } } } } } } ] } } }, "example": { "id": "", "object": "employee", "data": { "company": { "id": "", "object": "company", "links": { "self": "/companies/" } }, "employee_number": "001", "first_name": "Marley", "last_name": "Prosacco", "middle_initial": null, "personal_email": "marley.prosacco@personal.test", "work_email": "mprosacco@work.test", "address_line_1": "Angelina Ridge", "address_line_2": null, "city": "Toronto", "administrative_area": "ON", "province_code": "ON", "country_code": "CA", "postal_code": "M1M1M1", "sin": "196710156", "sin_last_3": "156", "date_of_birth": "1985-01-20", "warnings": { "object": "list", "data": [ { "object": "warning", "data": { "namespace": "onboarding", "type": "bank_account_doesnt_exists" } } ] }, "external_ref": null, "preferred_locale": null, "archived_at": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employees/" } } } } } } }, "put": { "summary": "Update an employee", "operationId": "employees-update", "tags": [ "Employees" ], "parameters": [ { "name": "employee", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"employee\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Employee" } } }, "example": { "id": "", "object": "employee", "data": { "company": { "id": "", "object": "company", "links": { "self": "/companies/" } }, "employee_number": "001", "first_name": "Marley", "last_name": "Prosacco", "middle_initial": null, "personal_email": "marley.prosacco@personal.test", "work_email": "mprosacco@work.test", "address_line_1": "Angelina Ridge", "address_line_2": null, "city": "Toronto", "administrative_area": "ON", "province_code": "ON", "country_code": "CA", "postal_code": "M1M1M1", "sin": "196710156", "sin_last_3": "156", "date_of_birth": "1985-01-20", "warnings": { "object": "list", "data": [ { "object": "warning", "data": { "namespace": "onboarding", "type": "bank_account_doesnt_exists" } } ] }, "external_ref": null, "preferred_locale": null, "archived_at": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employees/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "employee_number": { "type": "string", "description": "An optional identifier for the employee within the partner's system, such as a badge number or HR system ID. Distinct from `id` and `external_ref`.", "nullable": true, "maxLength": 40 }, "first_name": { "type": "string", "description": "The employee's first name.", "maxLength": 50 }, "last_name": { "type": "string", "description": "The employee's last name.", "maxLength": 50 }, "middle_initial": { "type": "string", "description": "The employee's middle initial.", "nullable": true, "maxLength": 1 }, "personal_email": { "type": "string", "description": "The employee's personal email address, used as the primary address for payroll communications such as Pay Stub emails.", "nullable": true }, "work_email": { "type": "string", "description": "The employee's work email address. Used for payroll communications if `personal_email` is not set.", "nullable": true }, "address_line_1": { "type": "string", "description": "The first line of the employee's mailing address. Canada Revenue Agency forms (T4, RL-1) truncate this to the length those forms allow.", "nullable": true }, "address_line_2": { "type": "string", "description": "The second line of the employee's mailing address. Canada Revenue Agency forms (T4, RL-1) truncate this to the length those forms allow.", "nullable": true }, "city": { "type": "string", "description": "The city of the employee's mailing address.", "nullable": true }, "administrative_area": { "type": "string", "description": "The region of the employee's mailing address \u2014 the province, state, or county, depending on the country. For Canadian employees this is the Province of Residence (POR), not the Province of Employment (POE) or Province of Work (POW). POE and POW are configured via the Work Assignment's Tax Properties.", "nullable": true, "maxLength": 255 }, "province_code": { "type": "string", "description": "This attribute is deprecated and will be removed.\n\nA deprecated alias of `administrative_area` that mirrors its value. Use `administrative_area` instead.\n\nIn Canada, must be an uppercase 2-letter province code: `AB`, `BC`, `MB`, `NB`, `NL`, `NS`, `NT`, `NU`, `ON`, `PE`, `QC`, `SK`, `YT`", "nullable": true, "deprecated": true }, "country_code": { "type": "string", "description": "The country code for the employee's mailing address.", "enum": [ "CA", "GB" ] }, "postal_code": { "type": "string", "description": "The postal code for the employee's mailing address.", "nullable": true, "maxLength": 10 }, "sin": { "type": "string", "description": "The employee's Social Insurance Number (SIN), used for tax reporting. 9 digits, sent as a string. Spaces and dashes are stripped before validation. The first digit cannot be 0 or 8, and the number must pass the Luhn checksum. Required before year-end forms can be filed correctly, but not required to create the employee or run a payroll." }, "date_of_birth": { "type": "string", "description": "The employee's date of birth.", "format": "date" }, "external_ref": { "type": "string", "maxLength": 255 }, "preferred_locale": { "type": "string", "description": "The locale used for payroll communications sent to this employee, such as Pay Stub emails. If not set, the Company's locale is used.", "enum": [ "en", "fr" ] }, "archived_at": { "type": "string", "description": "The date the employee was archived. Archiving an employee also archives all Work Assignments that are not already archived. Archived employees do not appear in active listings.", "format": "date" } } }, "example": { "employee_number": "001", "first_name": "Marley", "last_name": "Prosacco", "personal_email": "marley.prosacco@personal.test", "work_email": "mprosacco@work.test", "address_line_1": "Angelina Ridge", "city": "Toronto", "administrative_area": "ON", "country_code": "CA", "postal_code": "M1M1M1", "sin": "196710156", "date_of_birth": "1985-01-20" } } } } } }, "/employees/{employee}/reveal": { "get": { "summary": "Reveal employee SIN", "operationId": "employees-reveal", "tags": [ "Employees" ], "parameters": [ { "name": "employee", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"employee_reveal\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Employee" } } }, "example": { "id": "", "object": "employee_reveal", "data": { "sin": "196710156", "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" } } } } } } } }, "/employee_benefits/{employee_benefit}": { "delete": { "summary": "Delete an employee benefit", "operationId": "employee-benefits-destroy", "tags": [ "Employee Benefits" ], "parameters": [ { "name": "employee_benefit", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve an employee benefit", "operationId": "employee-benefits-show", "tags": [ "Employee Benefits" ], "parameters": [ { "name": "employee_benefit", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "employer_benefit", "expense_accounting_code", "liability_accounting_code", "remittance_account", "tag_assignment", "work_assignment" ] } }, "required": false } ], "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 (`\"employee_benefit\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EmployeeBenefit" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With employer_benefit expanded", "properties": { "employer_benefit": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EmployerBenefit" } } } } }, { "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 remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } }, { "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": { "id": "", "object": "employee_benefit", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "business_preset": null, "employee_benefit_type": { "id": "", "object": "employee_benefit_type", "data": { "type": "dental", "label": "Dental" }, "links": { "self": "/employee_benefit_types/dental" } }, "employer_benefit": null, "title": "Dental", "title_translations": { "en": "Dental", "fr": "Assurance dentaire" }, "title_translated": "Dental", "income_basis": "regular_earnings", "income_includes": [], "max_annual_contribution_basis": "this_benefit", "apply_sales_tax": false, "remittance_account_id": null, "remittance_account": null, "amount": 325.5, "amount_type": "fixed", "coverage_multiplier": 1, "max_annual_contribution": 2500.5, "frequency": "per_month", "date_basis": "by_period_start_date", "pay_period_cadence": [ 1 ], "effective_from": "2026-01-01", "effective_to": "2026-12-31", "expense_accounting_code": null, "liability_accounting_code": null, "external_ref": "01KG003XG877R33YKHA40HJP84", "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employee_benefits/" } } } } } } }, "put": { "summary": "Update an employee benefit", "operationId": "employee-benefits-update", "tags": [ "Employee Benefits" ], "parameters": [ { "name": "employee_benefit", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"employee_benefit\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployeeBenefit" } } }, "example": { "id": "", "object": "employee_benefit", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "business_preset": null, "employee_benefit_type": { "id": "", "object": "employee_benefit_type", "data": { "type": "dental", "label": "Dental" }, "links": { "self": "/employee_benefit_types/dental" } }, "employer_benefit": null, "title": "Dental", "title_translations": { "en": "Dental", "fr": "Assurance dentaire" }, "title_translated": "Dental", "income_basis": "regular_earnings", "income_includes": [], "max_annual_contribution_basis": "this_benefit", "apply_sales_tax": false, "remittance_account_id": null, "remittance_account": null, "amount": 325.5, "amount_type": "fixed", "coverage_multiplier": 1, "max_annual_contribution": 2500.5, "frequency": "per_month", "date_basis": "by_period_start_date", "pay_period_cadence": [ 1 ], "effective_from": "2026-01-01", "effective_to": "2026-12-31", "expense_accounting_code": null, "liability_accounting_code": null, "external_ref": "01KG003XG877R33YKHA40HJP84", "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employee_benefits/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_preset_id": { "type": "string" }, "employee_benefit_type": { "type": "string", "description": "The type of employee benefit, which determines how it is taxed and reported.", "enum": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "non_group_long_term_disability", "non_group_short_term_disability", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_rrsp_non_periodic", "pension_unregistered_prpp", "pension_vrsp", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "virtual_health_service", "wellness_spending_account" ] }, "remittance_account_id": { "type": "string", "description": "The remittance account to which collected benefit amounts are remitted." }, "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", "minimum": 0 }, "amount_type": { "type": "string", "description": "Whether `amount` is a fixed dollar value (`fixed`) or a percentage of the income basis (`percent`).", "enum": [ "fixed", "percent" ] }, "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": "array", "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`.", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "allowance", "earning", "reimbursement" ] }, "subtype": { "type": "string" } } } }, "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", "minimum": 0, "maximum": 100 }, "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.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "max_annual_contribution_basis": { "type": "string", "description": "Which earlier contributions count toward `max_annual_contribution`. `this_benefit` counts only the contributions on line items created by this benefit earlier in the year. `all_line_items_of_type` counts every contribution of the same type on the Work Assignment earlier in the year, including those created by other benefits and those added directly to a Pay Stub.", "enum": [ "all_line_items_of_type", "this_benefit" ] }, "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" ] }, "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.", "format": "date" }, "apply_sales_tax": { "type": "boolean", "description": "Whether provincial sales tax is applied to the benefit amount." }, "expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string" }, "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 }, "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` benefits.", "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` benefits.", "items": { "type": "integer" }, "minItems": 1 } } }, "example": { "employee_benefit_type": "dental", "amount": "325.5", "amount_type": "fixed", "income_basis": "regular_earnings", "coverage_multiplier": "1", "max_annual_contribution": "2500.5", "max_annual_contribution_basis": "this_benefit", "frequency": "per_month", "effective_from": "2026-01-01", "effective_to": "2026-12-31", "apply_sales_tax": false, "title": "Dental", "title_translations": { "en": "Dental", "fr": "Assurance dentaire" }, "external_ref": "01KG003XG877R33YKHA40HJP84", "date_basis": "by_period_start_date", "pay_period_cadence": [ 1 ] } } } } } }, "/employee_benefit_line_items/{employee_benefit_line_item}": { "delete": { "summary": "Delete an employee benefit line item", "operationId": "employee-benefit-line-items-destroy", "tags": [ "Employee Benefit Line Items" ], "parameters": [ { "name": "employee_benefit_line_item", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve an employee benefit line item", "operationId": "employee-benefit-line-items-show", "tags": [ "Employee Benefit Line Items" ], "parameters": [ { "name": "employee_benefit_line_item", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "custom_expense_accounting_code", "custom_liability_accounting_code", "custom_tag_assignment", "expense_accounting_code", "liability_accounting_code", "managed_expense_accounting_code", "managed_liability_accounting_code", "managed_tag_assignment", "pay_stub", "recurrence", "remittance_account", "source_adjustment", "tag_assignment", "tag_assignment_amounts" ] } }, "required": false } ], "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 (`\"employee_benefit_line_item\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EmployeeBenefitLineItem" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With pay_stub expanded", "properties": { "pay_stub": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayStub" } } } } }, { "type": "object", "title": "With recurrence expanded", "properties": { "recurrence": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Recurrence" } } } } }, { "type": "object", "title": "With remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } }, { "type": "object", "title": "With business_preset expanded", "properties": { "business_preset": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessPreset" } } } } }, { "type": "object", "title": "With source_adjustment expanded", "properties": { "source_adjustment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SourceAdjustment" } } } } }, { "type": "object", "title": "With expense_accounting_code expanded", "properties": { "expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ExpenseAccountingCode" } } } } }, { "type": "object", "title": "With managed_expense_accounting_code expanded", "properties": { "managed_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedExpenseAccountingCode" } } } } }, { "type": "object", "title": "With custom_expense_accounting_code expanded", "properties": { "custom_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomExpenseAccountingCode" } } } } }, { "type": "object", "title": "With liability_accounting_code expanded", "properties": { "liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LiabilityAccountingCode" } } } } }, { "type": "object", "title": "With managed_liability_accounting_code expanded", "properties": { "managed_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedLiabilityAccountingCode" } } } } }, { "type": "object", "title": "With custom_liability_accounting_code expanded", "properties": { "custom_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomLiabilityAccountingCode" } } } } }, { "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" } } } } }, { "type": "object", "title": "With managed_tag_assignment expanded", "properties": { "managed_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/ManagedTagAssignment" } } } } }, { "type": "object", "title": "With custom_tag_assignment expanded", "properties": { "custom_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/CustomTagAssignment" } } } } }, { "type": "object", "title": "With tag_assignment_amounts expanded", "properties": { "tag_assignment_amounts": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/TagAssignmentAmount" } } } } } } } } ] } } }, "example": { "id": "", "object": "employee_benefit_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employee_benefit", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "employee_benefit_type": { "id": "", "object": "employee_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employee_benefit_types/health" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account_id": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employee_benefit_line_items/" } } } } } } }, "put": { "summary": "Update an employee benefit line item", "operationId": "employee-benefit-line-items-update", "tags": [ "Employee Benefit Line Items" ], "parameters": [ { "name": "employee_benefit_line_item", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"employee_benefit_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployeeBenefitLineItem" } } }, "example": { "id": "", "object": "employee_benefit_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employee_benefit", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "employee_benefit_type": { "id": "", "object": "employee_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employee_benefit_types/health" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account_id": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employee_benefit_line_items/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_preset_id": { "type": "string", "description": "Writing may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false" }, "employee_benefit_type": { "type": "string", "description": "The type of Employee Benefit for this line item.\n\nWriting may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false", "enum": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "non_group_long_term_disability", "non_group_short_term_disability", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_rrsp_non_periodic", "pension_unregistered_prpp", "pension_vrsp", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "virtual_health_service", "wellness_spending_account" ] }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.\n\nEditing is prevented when `is_editable` is false", "format": "decimal", "maximum": 99999 }, "title": { "type": "string", "description": "Writing may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false", "nullable": true, "maxLength": 255 }, "title_translations": { "type": "object", "description": "Optional translations for the `title` property.\n\nWriting may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "remittance_account_id": { "type": "string", "description": "Writing may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false" }, "expense_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "custom_expense_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "liability_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "custom_liability_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "component_settings": { "type": "object", "properties": { "attributes_locked": { "type": "boolean" } } }, "external_ref": { "type": "string", "maxLength": 255 }, "custom_tag_assignment": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "amount", "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 } } } } } } } } } } } } }, "/employee_benefit_types/{employee_benefit_type}": { "get": { "summary": "Retrieve an employee benefit type", "operationId": "employee-benefit-types-show", "tags": [ "Employee Benefit Types" ], "parameters": [ { "name": "employee_benefit_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 (`\"employee_benefit_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployeeBenefitType" } } }, "example": { "id": "", "object": "employee_benefit_type", "data": { "type": "group_term_life_insurance", "label": "Group Term Life Insurance", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [] }, { "type": "pensionable", "label": "Pensionable (CPP/QPP)", "definitions": [] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [] }, { "type": "eht", "label": "EPT", "definitions": [] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [] }, "links": { "self": "/employee_benefit_types/group_term_life_insurance" } } } } } } } }, "/employer_benefits/{employer_benefit}": { "delete": { "summary": "Delete an employer benefit", "operationId": "employer-benefits-destroy", "tags": [ "Employer Benefits" ], "parameters": [ { "name": "employer_benefit", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve an employer benefit", "operationId": "employer-benefits-show", "tags": [ "Employer Benefits" ], "parameters": [ { "name": "employer_benefit", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "employee_benefit", "expense_accounting_code", "liability_accounting_code", "remittance_account", "tag_assignment", "work_assignment" ] } }, "required": false } ], "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 (`\"employer_benefit\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EmployerBenefit" } ], "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 remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } }, { "type": "object", "title": "With employee_benefit expanded", "properties": { "employee_benefit": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EmployeeBenefit" } } } } }, { "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": { "id": "", "object": "employer_benefit", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "business_preset": null, "employer_benefit_type": { "id": "", "object": "employer_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employer_benefit_types/health" } }, "employee_benefit": null, "title": null, "title_translations": null, "title_translated": null, "apply_sales_tax": true, "income_basis": "regular_earnings", "income_includes": [], "remittance_account_id": null, "remittance_account": null, "amount": 50, "amount_type": "fixed", "coverage_multiplier": 1, "max_annual_contribution": null, "max_annual_contribution_basis": "this_benefit", "frequency": "per_payroll", "date_basis": null, "pay_period_cadence": null, "effective_from": "2026-01-01", "effective_to": 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": "/employer_benefits/" } } } } } } }, "put": { "summary": "Update an employer benefit", "operationId": "employer-benefits-update", "tags": [ "Employer Benefits" ], "parameters": [ { "name": "employer_benefit", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"employer_benefit\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerBenefit" } } }, "example": { "id": "", "object": "employer_benefit", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "business_preset": null, "employer_benefit_type": { "id": "", "object": "employer_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employer_benefit_types/health" } }, "employee_benefit": null, "title": null, "title_translations": null, "title_translated": null, "apply_sales_tax": true, "income_basis": "regular_earnings", "income_includes": [], "remittance_account_id": null, "remittance_account": null, "amount": 50, "amount_type": "fixed", "coverage_multiplier": 1, "max_annual_contribution": null, "max_annual_contribution_basis": "this_benefit", "frequency": "per_payroll", "date_basis": null, "pay_period_cadence": null, "effective_from": "2026-01-01", "effective_to": 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": "/employer_benefits/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_preset_id": { "type": "string" }, "employer_benefit_type": { "type": "string", "description": "The type of employer benefit, which determines how it is categorized and reported.", "enum": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "gift_near_cash", "gift_non_cash_non_taxable", "gift_non_cash_taxable", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "meals_subsidized_non_cash", "non_group_long_term_disability", "non_group_short_term_disability", "parking", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_unregistered_prpp", "pension_vrsp", "professional_membership", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "transit_pass", "transportation_to_from_work", "vehicle_employer_provided", "virtual_health_service", "wellness_spending_account" ] }, "remittance_account_id": { "type": "string", "description": "The remittance account to which collected benefit amounts are remitted." }, "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", "minimum": 0 }, "amount_type": { "type": "string", "description": "Whether `amount` is a fixed dollar value (`fixed`) or a percentage of the income basis (`percent`).", "enum": [ "fixed", "percent" ] }, "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": "array", "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`.", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "allowance", "earning", "reimbursement" ] }, "subtype": { "type": "string" } } } }, "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", "minimum": 0, "maximum": 100 }, "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.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "max_annual_contribution_basis": { "type": "string", "description": "Which earlier contributions count toward `max_annual_contribution`. `this_benefit` counts only the contributions on line items created by this benefit earlier in the year. `all_line_items_of_type` counts every contribution of the same type on the Work Assignment earlier in the year, including those created by other benefits and those added directly to a Pay Stub.", "enum": [ "all_line_items_of_type", "this_benefit" ] }, "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" ] }, "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.", "format": "date" }, "apply_sales_tax": { "type": "boolean", "description": "Whether provincial sales tax is applied to the benefit amount." }, "expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string" }, "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 }, "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` benefits.", "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` benefits.", "items": { "type": "integer" }, "minItems": 1 } } } } } } } }, "/employer_benefit_line_items/{employer_benefit_line_item}": { "delete": { "summary": "Delete an employer benefit line item", "operationId": "employer-benefit-line-items-destroy", "tags": [ "Employer Benefit Line Items" ], "parameters": [ { "name": "employer_benefit_line_item", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve an employer benefit line item", "operationId": "employer-benefit-line-items-show", "tags": [ "Employer Benefit Line Items" ], "parameters": [ { "name": "employer_benefit_line_item", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "custom_expense_accounting_code", "custom_liability_accounting_code", "custom_tag_assignment", "expense_accounting_code", "liability_accounting_code", "managed_expense_accounting_code", "managed_liability_accounting_code", "managed_tag_assignment", "pay_stub", "recurrence", "remittance_account", "source_adjustment", "tag_assignment", "tag_assignment_amounts" ] } }, "required": false } ], "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 (`\"employer_benefit_line_item\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EmployerBenefitLineItem" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With pay_stub expanded", "properties": { "pay_stub": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayStub" } } } } }, { "type": "object", "title": "With recurrence expanded", "properties": { "recurrence": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Recurrence" } } } } }, { "type": "object", "title": "With remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } }, { "type": "object", "title": "With business_preset expanded", "properties": { "business_preset": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessPreset" } } } } }, { "type": "object", "title": "With source_adjustment expanded", "properties": { "source_adjustment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SourceAdjustment" } } } } }, { "type": "object", "title": "With expense_accounting_code expanded", "properties": { "expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ExpenseAccountingCode" } } } } }, { "type": "object", "title": "With managed_expense_accounting_code expanded", "properties": { "managed_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedExpenseAccountingCode" } } } } }, { "type": "object", "title": "With custom_expense_accounting_code expanded", "properties": { "custom_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomExpenseAccountingCode" } } } } }, { "type": "object", "title": "With liability_accounting_code expanded", "properties": { "liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LiabilityAccountingCode" } } } } }, { "type": "object", "title": "With managed_liability_accounting_code expanded", "properties": { "managed_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedLiabilityAccountingCode" } } } } }, { "type": "object", "title": "With custom_liability_accounting_code expanded", "properties": { "custom_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomLiabilityAccountingCode" } } } } }, { "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" } } } } }, { "type": "object", "title": "With managed_tag_assignment expanded", "properties": { "managed_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/ManagedTagAssignment" } } } } }, { "type": "object", "title": "With custom_tag_assignment expanded", "properties": { "custom_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/CustomTagAssignment" } } } } }, { "type": "object", "title": "With tag_assignment_amounts expanded", "properties": { "tag_assignment_amounts": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/TagAssignmentAmount" } } } } } } } } ] } } }, "example": { "id": "", "object": "employer_benefit_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employer_benefit", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "employer_benefit_type": { "id": "", "object": "employer_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employer_benefit_types/health" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account_id": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employer_benefit_line_items/" } } } } } } }, "put": { "summary": "Update an employer benefit line item", "operationId": "employer-benefit-line-items-update", "tags": [ "Employer Benefit Line Items" ], "parameters": [ { "name": "employer_benefit_line_item", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"employer_benefit_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerBenefitLineItem" } } }, "example": { "id": "", "object": "employer_benefit_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employer_benefit", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "employer_benefit_type": { "id": "", "object": "employer_benefit_type", "data": { "type": "health", "label": "Health" }, "links": { "self": "/employer_benefit_types/health" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "remittance_account_id": null, "remittance_account": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employer_benefit_line_items/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_preset_id": { "type": "string", "description": "Writing may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false" }, "employer_benefit_type": { "type": "string", "description": "The type of Employer Benefit for this line item.\n\nWriting may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false", "enum": [ "accident_insurance_plan", "critical_illness", "debt_relief", "dental", "employee_assistance_program", "fondaction", "fondaction_rrsp", "fonds_solidarite_ftq", "fonds_solidarite_ftq_rrsp", "gift_near_cash", "gift_non_cash_non_taxable", "gift_non_cash_taxable", "group_dependent_life_insurance", "group_term_life_insurance", "health", "health_spending_account", "long_term_disability", "meals_subsidized_non_cash", "non_group_long_term_disability", "non_group_short_term_disability", "parking", "pension_dbpp", "pension_dcpp", "pension_mfpp", "pension_prpp", "pension_restricted_rrsp", "pension_rrsp", "pension_unregistered_prpp", "pension_vrsp", "professional_membership", "profit_sharing_dpsp", "savings_tfsa", "second_opinion_medical_consultation", "short_term_disability", "transit_pass", "transportation_to_from_work", "vehicle_employer_provided", "virtual_health_service", "wellness_spending_account" ] }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.\n\nEditing is prevented when `is_editable` is false", "format": "decimal", "maximum": 99999 }, "accrued_vacation_pay": { "type": "number", "description": "The vacation pay accrued on this line item, calculated based on the Work Assignment's Vacation Pay Settings.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "title": { "type": "string", "description": "Writing may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false", "nullable": true, "maxLength": 255 }, "title_translations": { "type": "object", "description": "Optional translations for the `title` property.\n\nWriting may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "remittance_account_id": { "type": "string", "description": "Writing may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false" }, "expense_accounting_code_id": { "type": "string", "description": "Writing may be blocked when entity is managed by a parent resource" }, "custom_expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string", "description": "Writing may be blocked when entity is managed by a parent resource" }, "custom_liability_accounting_code_id": { "type": "string" }, "component_settings": { "type": "object", "properties": { "attributes_locked": { "type": "boolean" } } }, "external_ref": { "type": "string", "maxLength": 255 }, "custom_tag_assignment": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "amount", "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 } } } } } } } } } } } } }, "/employer_benefit_types/{employer_benefit_type}": { "get": { "summary": "Retrieve an employer benefit type", "operationId": "employer-benefit-types-show", "tags": [ "Employer Benefit Types" ], "parameters": [ { "name": "employer_benefit_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 (`\"employer_benefit_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerBenefitType" } } }, "example": { "id": "", "object": "employer_benefit_type", "data": { "type": "group_term_life_insurance", "label": "Group Term Life Insurance", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance 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": "Group Term Life Insurance is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Group Term Life Insurance is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" }, { "name": "40", "help_text": "Other Taxable Allowances and Benefits" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" }, { "name": "L", "help_text": "Other Benefits" } ] ] } ] }, "links": { "self": "/employer_benefit_types/group_term_life_insurance" } } } } } } } }, "/employer_statutory_withholding_line_items/{line_item}": { "delete": { "summary": "Delete an employer statutory withholding line item", "operationId": "employer-statutory-withholding-line-items-destroy", "tags": [ "Employer Statutory Withholding Line Items" ], "parameters": [ { "name": "line_item", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve an employer statutory withholding line item", "operationId": "employer-statutory-withholding-line-items-show", "tags": [ "Employer Statutory Withholding Line Items" ], "parameters": [ { "name": "line_item", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "custom_expense_accounting_code", "custom_liability_accounting_code", "expense_accounting_code", "liability_accounting_code", "managed_expense_accounting_code", "managed_liability_accounting_code", "managed_tag_assignment", "pay_stub", "remittance_account", "source_adjustment", "tag_assignment", "tag_assignment_amounts" ] } }, "required": false } ], "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 (`\"employer_statutory_withholding_line_item\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EmployerStatutoryWithholdingLineItem" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With pay_stub expanded", "properties": { "pay_stub": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayStub" } } } } }, { "type": "object", "title": "With remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } }, { "type": "object", "title": "With source_adjustment expanded", "properties": { "source_adjustment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SourceAdjustment" } } } } }, { "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 managed_expense_accounting_code expanded", "properties": { "managed_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedExpenseAccountingCode" } } } } }, { "type": "object", "title": "With custom_expense_accounting_code expanded", "properties": { "custom_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomExpenseAccountingCode" } } } } }, { "type": "object", "title": "With liability_accounting_code expanded", "properties": { "liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LiabilityAccountingCode" } } } } }, { "type": "object", "title": "With managed_liability_accounting_code expanded", "properties": { "managed_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedLiabilityAccountingCode" } } } } }, { "type": "object", "title": "With custom_liability_accounting_code expanded", "properties": { "custom_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomLiabilityAccountingCode" } } } } }, { "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" } } } } }, { "type": "object", "title": "With managed_tag_assignment expanded", "properties": { "managed_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/ManagedTagAssignment" } } } } }, { "type": "object", "title": "With tag_assignment_amounts expanded", "properties": { "tag_assignment_amounts": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/TagAssignmentAmount" } } } } } } } } ] } } }, "example": { "id": "", "object": "employer_statutory_withholding_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employer_statutory_withholding", "is_system": true, "is_managed": true, "amount": 35, "custom_amount": null, "managed_amount": 35, "employer_statutory_withholding_type": { "id": "", "object": "employer_statutory_withholding_type", "data": { "type": "ei", "label": "EI" }, "links": { "self": "/employer_statutory_withholding_types/ei" } }, "title": "EI", "title_translations": { "en": "EI", "fr": "AE" }, "title_translated": "EI", "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "source_adjustment": null, "business_preset": { "id": "", "object": "business_preset", "links": { "self": "/business_presets/" } }, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employer_statutory_withholding_line_items/" } } } } } } }, "put": { "summary": "Update an employer statutory withholding line item", "description": "Only available on correction and historical payrolls.", "operationId": "employer-statutory-withholding-line-items-update", "tags": [ "Employer Statutory Withholding Line Items" ], "parameters": [ { "name": "line_item", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"employer_statutory_withholding_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerStatutoryWithholdingLineItem" } } }, "example": { "id": "", "object": "employer_statutory_withholding_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "employer_statutory_withholding", "is_system": true, "is_managed": true, "amount": 35, "custom_amount": null, "managed_amount": 35, "employer_statutory_withholding_type": { "id": "", "object": "employer_statutory_withholding_type", "data": { "type": "ei", "label": "EI" }, "links": { "self": "/employer_statutory_withholding_types/ei" } }, "title": "EI", "title_translations": { "en": "EI", "fr": "AE" }, "title_translated": "EI", "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "source_adjustment": null, "business_preset": { "id": "", "object": "business_preset", "links": { "self": "/business_presets/" } }, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/employer_statutory_withholding_line_items/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_preset_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "employer_statutory_withholding_type": { "type": "string", "description": "The type of employer statutory withholding for this line item.\n\nEditing is prevented when `is_editable` is false", "enum": [ "cpp", "cpp_2", "eht", "ei", "qpip", "qpp", "qpp_2", "wcb" ] }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.\n\nEditing is prevented when `is_editable` is false", "format": "decimal", "maximum": 999999 }, "title": { "type": "string", "description": "Editing is prevented when `is_editable` is false", "nullable": true, "maxLength": 255 }, "title_translations": { "type": "object", "description": "Optional translations for the `title` property.\n\nEditing is prevented when `is_editable` is false", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "remittance_account_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "expense_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "custom_expense_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "liability_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "custom_liability_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "external_ref": { "type": "string", "maxLength": 255 } } }, "example": { "business_preset_id": "", "employer_statutory_withholding_type": "ei", "title": "EI", "title_translations": { "en": "EI", "fr": "AE" }, "remittance_account_id": "" } } } } } }, "/employer_statutory_withholding_types/{withholding_type}": { "get": { "summary": "Retrieve an employer statutory withholding type", "operationId": "employer-statutory-withholding-types-show", "tags": [ "Employer Statutory Withholding Types" ], "parameters": [ { "name": "withholding_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 (`\"employer_statutory_withholding_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerStatutoryWithholdingType" } } }, "example": { "id": "", "object": "employer_statutory_withholding_type", "data": { "type": "cpp", "label": "CPP" }, "links": { "self": "/employer_statutory_withholding_types/cpp" } } } } } } } }, "/forms/{form}/amend": { "post": { "summary": "Amend a form", "description": "Endpoint to amend a Form.\n\nThe following example is for a T4, but the same flow will work for any amendable form.", "operationId": "forms-amend", "tags": [ "Forms" ], "parameters": [ { "name": "form", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"form\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Form" } } }, "example": { "id": "", "object": "form", "data": { "owner": { "id": "", "object": "employee", "links": { "self": "/employees/" } }, "form_batch": null, "stage": "amendment", "note": null, "source_form": { "id": "", "object": "form", "links": { "self": "/forms/" } }, "type": "t4", "effective_date": "2026-01-01", "version_year": "2026", "version_month": "january", "validation_error_count": 0, "status": "draft", "is_editable": true, "metadata": { "flags": { "is_editable": true, "is_amendable": false, "is_approvable": true, "is_unapprovable": false, "is_pdf_exportable": true } }, "tax_year": "2025", "employee_first_name": null, "employee_initial": null, "employee_surname": "Prosacco", "employee_address_line_1": null, "employee_address_line_2": null, "employee_city": null, "employee_province_or_territory_code": null, "employee_country_code": null, "employee_postal_code": null, "box_12_social_insurance_number": "196710156", "employee_number": null, "box_54_payroll_account_number": "123456789RP0001", "box_50_rpp_or_dpsp_registration_number": null, "box_28_cpp_or_qpp_exempt_code": false, "box_28_employment_insurance_exempt_code": false, "box_28_ppip_exempt_code": false, "box_29_employment_code": null, "box_10_province_territory_or_country_of_employment_code": "ON", "box_45_employer_offered_dental_benefits": "1", "box_14_employment_income": null, "box_16_employees_cpp_contributions": null, "box_16a_employees_cpp2_contributions": null, "box_17_employees_qpp_contributions": null, "box_17a_employees_qpp2_contributions": null, "box_18_employees_ei_premiums": null, "box_20_rpp_contributions": null, "box_22_income_tax_deducted": null, "box_24_ei_insurable_earnings": 1000.04, "box_26_cpp_or_qpp_pensionable_earnings": 2000.73, "box_27_employer_cpp_contributions": null, "box_27a_employer_cpp2_contributions": null, "box_19_employer_ei_premiums": null, "box_44_union_dues": null, "box_46_charitable_donations": null, "box_52_pension_adjustment": null, "box_55_employees_ppip_premiums": null, "box_56_ppip_insurable_earnings": null, "code_30_housing_board_and_lodging_amount": null, "code_31_special_work_site_amount": null, "code_32_travel_in_a_prescribed_zone_amount": null, "code_33_medical_travel_amount": null, "code_34_personal_use_of_employer_automobile_amount": null, "code_35_total_reasonable_per_kilometre_allowance_amount": null, "code_36_interest_free_and_low_interest_loan_amount": null, "code_37_employee_home_relocation_loan_deduction_amount": null, "code_97_stock_option_benefit_amount_before_february_28_2000": null, "code_38_security_options_benefits_before_june_25_2024": null, "code_39_security_options_deductions_110_1_d_before_june_25_2024": null, "code_40_other_taxable_allowance_and_benefits": null, "code_41_security_options_deduction_110_1_d1_before_june_25_2024": null, "code_42_employment_commissions": null, "code_43_canadian_armed_forces_personnel_and_police_deduction": null, "code_53_deferred_security_option_benefits": null, "code_57_employment_income_march_15_to_may_9_2020_tax_year_only": null, "code_58_employment_income_may_10_to_july_4_2020_tax_year_only": null, "code_59_employment_income_july_5_to_august_29_2020_tax_year_only": null, "code_60_employment_income_august_30_to_september_26_2020_tax_year_only": null, "code_66_eligible_retiring_allowances": null, "code_67_non_eligible_retiring_allowances": null, "code_69_indian_exempt_income_non_eligible_retiring_allowances": null, "code_71_indian_exempt_income_employment": null, "code_72_outside_of_canada_employment_income_amount_section_122_3": null, "code_73_employment_outside_of_canada_day_count": null, "code_74_pre_1990_past_service_contributions_while_a_contributor": null, "code_75_pre_1990_past_service_contributions_while_not_a_contributor": null, "code_77_workers_compensation_benefit_repaid_to_the_employer_amount": null, "code_78_fishers_gross_earnings": null, "code_79_fishers_net_partnership_amount": null, "code_80_fishers_shareperson_amount": null, "code_81_placement_or_employment_agency": null, "code_82_driver_of_taxi_or_other_passenger_carrying_vehicle": null, "code_83_barber_or_hairdresser": null, "code_84_public_transit_pass": null, "code_85_employee_paid_premiums_for_private_health_services_plans": null, "code_86_stock_option_cash_out_expense": null, "code_87_emergency_services_volunteer_exempt_amount": null, "code_88_indian_exempt_income_self_employment": null, "code_90_security_options_benefits_on_or_after_june_25_2024": null, "code_91_security_options_deduction_110_1_d_on_or_after_june_25_2024": null, "code_92_security_options_deduction_110_1_d1_on_or_after_june_25_2024": null, "code_94_indian_exempt_income_rpp_contributions": null, "code_95_indian_exempt_income_union_dues": null, "code_98_stock_option_and_share_deduction_110_1_d_amount_before_february_28_2000": null, "code_99_stock_option_and_share_deduction_110_1_d1_amount_before_february_28_2000": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/forms/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/forms/{form}/approve": { "post": { "summary": "Approve a form", "description": "Endpoint to approve a Form.\n\nThe following example is for a T4, but the same flow will work for any submittable form.", "operationId": "forms-approve", "tags": [ "Forms" ], "parameters": [ { "name": "form", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"form\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Form" } } }, "example": { "id": "", "object": "form", "data": { "owner": { "id": "", "object": "employee", "links": { "self": "/employees/" } }, "form_batch": null, "stage": "original", "note": null, "type": "t4", "effective_date": "2026-01-01", "version_year": "2026", "version_month": "january", "validation_error_count": 0, "status": "approved", "is_editable": false, "metadata": { "flags": { "is_editable": false, "is_amendable": false, "is_approvable": false, "is_unapprovable": true, "is_pdf_exportable": true } }, "tax_year": "2025", "employee_first_name": null, "employee_initial": null, "employee_surname": "Prosacco", "employee_address_line_1": null, "employee_address_line_2": null, "employee_city": null, "employee_province_or_territory_code": null, "employee_country_code": null, "employee_postal_code": null, "box_12_social_insurance_number": "196710156", "employee_number": null, "box_54_payroll_account_number": "123456789RP0001", "box_50_rpp_or_dpsp_registration_number": null, "box_28_cpp_or_qpp_exempt_code": false, "box_28_employment_insurance_exempt_code": false, "box_28_ppip_exempt_code": false, "box_29_employment_code": null, "box_10_province_territory_or_country_of_employment_code": "ON", "box_45_employer_offered_dental_benefits": "1", "box_14_employment_income": null, "box_16_employees_cpp_contributions": null, "box_16a_employees_cpp2_contributions": null, "box_17_employees_qpp_contributions": null, "box_17a_employees_qpp2_contributions": null, "box_18_employees_ei_premiums": null, "box_20_rpp_contributions": null, "box_22_income_tax_deducted": null, "box_24_ei_insurable_earnings": 1000.04, "box_26_cpp_or_qpp_pensionable_earnings": 2000.73, "box_27_employer_cpp_contributions": null, "box_27a_employer_cpp2_contributions": null, "box_19_employer_ei_premiums": null, "box_44_union_dues": null, "box_46_charitable_donations": null, "box_52_pension_adjustment": null, "box_55_employees_ppip_premiums": null, "box_56_ppip_insurable_earnings": null, "code_30_housing_board_and_lodging_amount": null, "code_31_special_work_site_amount": null, "code_32_travel_in_a_prescribed_zone_amount": null, "code_33_medical_travel_amount": null, "code_34_personal_use_of_employer_automobile_amount": null, "code_35_total_reasonable_per_kilometre_allowance_amount": null, "code_36_interest_free_and_low_interest_loan_amount": null, "code_37_employee_home_relocation_loan_deduction_amount": null, "code_97_stock_option_benefit_amount_before_february_28_2000": null, "code_38_security_options_benefits_before_june_25_2024": null, "code_39_security_options_deductions_110_1_d_before_june_25_2024": null, "code_40_other_taxable_allowance_and_benefits": null, "code_41_security_options_deduction_110_1_d1_before_june_25_2024": null, "code_42_employment_commissions": null, "code_43_canadian_armed_forces_personnel_and_police_deduction": null, "code_53_deferred_security_option_benefits": null, "code_57_employment_income_march_15_to_may_9_2020_tax_year_only": null, "code_58_employment_income_may_10_to_july_4_2020_tax_year_only": null, "code_59_employment_income_july_5_to_august_29_2020_tax_year_only": null, "code_60_employment_income_august_30_to_september_26_2020_tax_year_only": null, "code_66_eligible_retiring_allowances": null, "code_67_non_eligible_retiring_allowances": null, "code_69_indian_exempt_income_non_eligible_retiring_allowances": null, "code_71_indian_exempt_income_employment": null, "code_72_outside_of_canada_employment_income_amount_section_122_3": null, "code_73_employment_outside_of_canada_day_count": null, "code_74_pre_1990_past_service_contributions_while_a_contributor": null, "code_75_pre_1990_past_service_contributions_while_not_a_contributor": null, "code_77_workers_compensation_benefit_repaid_to_the_employer_amount": null, "code_78_fishers_gross_earnings": null, "code_79_fishers_net_partnership_amount": null, "code_80_fishers_shareperson_amount": null, "code_81_placement_or_employment_agency": null, "code_82_driver_of_taxi_or_other_passenger_carrying_vehicle": null, "code_83_barber_or_hairdresser": null, "code_84_public_transit_pass": null, "code_85_employee_paid_premiums_for_private_health_services_plans": null, "code_86_stock_option_cash_out_expense": null, "code_87_emergency_services_volunteer_exempt_amount": null, "code_88_indian_exempt_income_self_employment": null, "code_90_security_options_benefits_on_or_after_june_25_2024": null, "code_91_security_options_deduction_110_1_d_on_or_after_june_25_2024": null, "code_92_security_options_deduction_110_1_d1_on_or_after_june_25_2024": null, "code_94_indian_exempt_income_rpp_contributions": null, "code_95_indian_exempt_income_union_dues": null, "code_98_stock_option_and_share_deduction_110_1_d_amount_before_february_28_2000": null, "code_99_stock_option_and_share_deduction_110_1_d1_amount_before_february_28_2000": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/forms/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/forms/{form}": { "delete": { "summary": "Delete a form", "operationId": "forms-destroy", "tags": [ "Forms" ], "parameters": [ { "name": "form", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a form", "description": "Endpoint to fetch a Form.\n\nThe following example is for a 2026 TD1, but the response fields will differ depending on the specific Form instance requested.", "operationId": "forms-show", "tags": [ "Forms" ], "parameters": [ { "name": "form", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "form_batch", "owner" ] } }, "required": false } ], "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 (`\"form\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Form" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With owner expanded", "properties": { "owner": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FormOwner" } } } } }, { "type": "object", "title": "With form_batch expanded", "properties": { "form_batch": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FormBatch" } } } } } ] } } }, "example": { "id": "", "object": "form", "data": { "owner": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "form_batch": null, "stage": "original", "note": null, "type": "td1", "effective_date": "2026-01-01", "version_year": "2026", "version_month": "january", "validation_error_count": 0, "is_editable": true, "line_1_basic_personal_amount": null, "line_2_infirm_children_caregiver_amount": null, "line_3_age_amount": null, "line_4_pension_income_amount": null, "line_5_tuition": null, "line_6_disability_amount": null, "line_7_spouse_or_common_law_partner_amount": null, "line_8_eligible_dependent_amount": null, "line_9_infirm_dependent_caregiver_amount": null, "line_10_dependent_caregiver_amount": null, "line_11_spouse_or_common_law_transfer_amount": null, "line_12_dependent_transfer_amount": null, "line_13_total_claim_amount": null, "more_than_one_employer_or_payer": null, "total_income_less_than_total_claim_amount": null, "ninety_percent_world_income_taxable_income": null, "prescribed_zone_deduction": null, "additional_tax_deduction": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/forms/" } } } } } } }, "put": { "summary": "Update a form", "description": "Endpoint to update a Form.\n\nThe following example is for a 2026 TD1, but the response fields will differ depending on the specific Form instance requested.", "operationId": "forms-update", "tags": [ "Forms" ], "parameters": [ { "name": "form", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"form\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Form" } } }, "example": { "id": "", "object": "form", "data": { "owner": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "form_batch": null, "stage": "original", "note": null, "type": "td1", "effective_date": "2026-01-01", "version_year": "2026", "version_month": "january", "validation_error_count": 0, "is_editable": true, "line_1_basic_personal_amount": null, "line_2_infirm_children_caregiver_amount": null, "line_3_age_amount": null, "line_4_pension_income_amount": null, "line_5_tuition": null, "line_6_disability_amount": null, "line_7_spouse_or_common_law_partner_amount": null, "line_8_eligible_dependent_amount": null, "line_9_infirm_dependent_caregiver_amount": null, "line_10_dependent_caregiver_amount": null, "line_11_spouse_or_common_law_transfer_amount": null, "line_12_dependent_transfer_amount": null, "line_13_total_claim_amount": null, "more_than_one_employer_or_payer": null, "total_income_less_than_total_claim_amount": null, "ninety_percent_world_income_taxable_income": null, "prescribed_zone_deduction": null, "additional_tax_deduction": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/forms/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "form_batch_id": { "type": "string" }, "note": { "type": "string", "description": "An optional note for this form.", "nullable": true, "maxLength": 65000 }, "line_1_basic_personal_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_2_infirm_children_caregiver_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_3_age_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_4_pension_income_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_5_tuition": { "type": "number", "format": "decimal", "minimum": 0 }, "line_6_disability_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_7_spouse_or_common_law_partner_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_8_eligible_dependent_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_9_infirm_dependent_caregiver_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_10_dependent_caregiver_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_11_spouse_or_common_law_transfer_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_12_dependent_transfer_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "line_13_total_claim_amount": { "type": "number", "format": "decimal", "minimum": 0 }, "more_than_one_employer_or_payer": { "type": "boolean" }, "total_income_less_than_total_claim_amount": { "type": "boolean" }, "ninety_percent_world_income_taxable_income": { "type": "boolean" }, "prescribed_zone_deduction": { "type": "number", "format": "decimal", "minimum": 0 }, "additional_tax_deduction": { "type": "number", "format": "decimal", "minimum": 0 } } } } } } } }, "/forms/{form}/submit": { "post": { "summary": "Submit a form", "description": "Endpoint to submit a Form.\n\nThe following example is for an ROE, but the same flow will work for any submittable form.", "operationId": "forms-submit", "tags": [ "Forms" ], "parameters": [ { "name": "form", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"form\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Form" } } }, "example": { "id": "", "object": "form", "data": { "owner": { "id": "", "object": "employee", "links": { "self": "/employees/" } }, "form_batch": null, "stage": "original", "note": null, "type": "roe", "effective_date": "2026-09-01", "version_year": "2026", "version_month": "august", "validation_error_count": 0, "status": "done", "is_editable": false, "metadata": { "flags": { "is_editable": false, "is_submittable": false, "is_amendable": false, "is_xml_exportable": true, "is_pdf_exportable": false }, "details": { "submission_setting": "manual", "business_entity_name": null, "roe_format": "expanded" } }, "block_1_serial_number": null, "block_2_serial_number_of_amended_or_replaced": null, "block_3_employer_payroll_reference_number": null, "block_5_cra_payroll_account_number": "888888880RP0001", "block_6_pay_period_type": "B", "employer_name": "Acme Widgets Ltd", "employer_address_line_1": "200 King Street West", "employer_address_line_2": "Toronto ON", "employer_address_line_3": null, "employer_postal_code": "M5H3T4", "block_8_social_insurance_number": "196710156", "employee_first_name": "Marley", "employee_initial": "B", "employee_last_name": "Prosacco", "employee_address_line_1": "456 Oak Avenue", "employee_address_line_2": "Toronto", "employee_address_line_3": "ON CA", "employee_postal_code": "M4B1B3", "block_13_occupation": null, "block_10_first_day_worked": "2025-10-07", "block_11_last_day_for_which_paid": "2025-12-25", "block_12_final_pay_period_ending_date": "2025-12-29", "block_16_separation_code": "A00", "block_14_expected_recall_code": "U", "block_14_expected_recall_date": null, "contact_first_name": "Sam", "contact_last_name": "Smith", "contact_area_code": 555, "contact_phone_number": 5550199, "contact_phone_number_extension": null, "pp1_period_end_date": "2025-12-29", "pp1_insurable_earnings": 2000, "pp1_insurable_hours": 75, "pp2_period_end_date": "2025-12-15", "pp2_insurable_earnings": 2000, "pp2_insurable_hours": 75, "pp3_period_end_date": "2025-12-01", "pp3_insurable_earnings": 2000, "pp3_insurable_hours": 75, "pp4_period_end_date": "2025-11-17", "pp4_insurable_earnings": 2000, "pp4_insurable_hours": 75, "pp5_period_end_date": "2025-11-03", "pp5_insurable_earnings": 2000, "pp5_insurable_hours": 75, "pp6_period_end_date": "2025-10-20", "pp6_insurable_earnings": 2000, "pp6_insurable_hours": 75, "pp7_period_end_date": null, "pp7_insurable_earnings": null, "pp7_insurable_hours": null, "pp8_period_end_date": null, "pp8_insurable_earnings": null, "pp8_insurable_hours": null, "pp9_period_end_date": null, "pp9_insurable_earnings": null, "pp9_insurable_hours": null, "pp10_period_end_date": null, "pp10_insurable_earnings": null, "pp10_insurable_hours": null, "pp11_period_end_date": null, "pp11_insurable_earnings": null, "pp11_insurable_hours": null, "pp12_period_end_date": null, "pp12_insurable_earnings": null, "pp12_insurable_hours": null, "pp13_period_end_date": null, "pp13_insurable_earnings": null, "pp13_insurable_hours": null, "pp14_period_end_date": null, "pp14_insurable_earnings": null, "pp14_insurable_hours": null, "pp15_period_end_date": null, "pp15_insurable_earnings": null, "pp15_insurable_hours": null, "pp16_period_end_date": null, "pp16_insurable_earnings": null, "pp16_insurable_hours": null, "pp17_period_end_date": null, "pp17_insurable_earnings": null, "pp17_insurable_hours": null, "pp18_period_end_date": null, "pp18_insurable_earnings": null, "pp18_insurable_hours": null, "pp19_period_end_date": null, "pp19_insurable_earnings": null, "pp19_insurable_hours": null, "pp20_period_end_date": null, "pp20_insurable_earnings": null, "pp20_insurable_hours": null, "pp21_period_end_date": null, "pp21_insurable_earnings": null, "pp21_insurable_hours": null, "pp22_period_end_date": null, "pp22_insurable_earnings": null, "pp22_insurable_hours": null, "pp23_period_end_date": null, "pp23_insurable_earnings": null, "pp23_insurable_hours": null, "pp24_period_end_date": null, "pp24_insurable_earnings": null, "pp24_insurable_hours": null, "pp25_period_end_date": null, "pp25_insurable_earnings": null, "pp25_insurable_hours": null, "pp26_period_end_date": null, "pp26_insurable_earnings": null, "pp26_insurable_hours": null, "pp27_period_end_date": null, "pp27_insurable_earnings": null, "pp27_insurable_hours": null, "pp28_period_end_date": null, "pp28_insurable_earnings": null, "pp28_insurable_hours": null, "pp29_period_end_date": null, "pp29_insurable_earnings": null, "pp29_insurable_hours": null, "pp30_period_end_date": null, "pp30_insurable_earnings": null, "pp30_insurable_hours": null, "pp31_period_end_date": null, "pp31_insurable_earnings": null, "pp31_insurable_hours": null, "pp32_period_end_date": null, "pp32_insurable_earnings": null, "pp32_insurable_hours": null, "pp33_period_end_date": null, "pp33_insurable_earnings": null, "pp33_insurable_hours": null, "pp34_period_end_date": null, "pp34_insurable_earnings": null, "pp34_insurable_hours": null, "pp35_period_end_date": null, "pp35_insurable_earnings": null, "pp35_insurable_hours": null, "pp36_period_end_date": null, "pp36_insurable_earnings": null, "pp36_insurable_hours": null, "pp37_period_end_date": null, "pp37_insurable_earnings": null, "pp37_insurable_hours": null, "pp38_period_end_date": null, "pp38_insurable_earnings": null, "pp38_insurable_hours": null, "pp39_period_end_date": null, "pp39_insurable_earnings": null, "pp39_insurable_hours": null, "pp40_period_end_date": null, "pp40_insurable_earnings": null, "pp40_insurable_hours": null, "pp41_period_end_date": null, "pp41_insurable_earnings": null, "pp41_insurable_hours": null, "pp42_period_end_date": null, "pp42_insurable_earnings": null, "pp42_insurable_hours": null, "pp43_period_end_date": null, "pp43_insurable_earnings": null, "pp43_insurable_hours": null, "pp44_period_end_date": null, "pp44_insurable_earnings": null, "pp44_insurable_hours": null, "pp45_period_end_date": null, "pp45_insurable_earnings": null, "pp45_insurable_hours": null, "pp46_period_end_date": null, "pp46_insurable_earnings": null, "pp46_insurable_hours": null, "pp47_period_end_date": null, "pp47_insurable_earnings": null, "pp47_insurable_hours": null, "pp48_period_end_date": null, "pp48_insurable_earnings": null, "pp48_insurable_hours": null, "pp49_period_end_date": null, "pp49_insurable_earnings": null, "pp49_insurable_hours": null, "pp50_period_end_date": null, "pp50_insurable_earnings": null, "pp50_insurable_hours": null, "pp51_period_end_date": null, "pp51_insurable_earnings": null, "pp51_insurable_hours": null, "pp52_period_end_date": null, "pp52_insurable_earnings": null, "pp52_insurable_hours": null, "pp53_period_end_date": null, "pp53_insurable_earnings": null, "pp53_insurable_hours": null, "vacation_pay_code": null, "vacation_pay_start_date": null, "vacation_pay_end_date": null, "vacation_pay_amount": null, "statutory_holiday_pay_for_date_1": null, "statutory_holiday_pay_for_amount_1": null, "statutory_holiday_pay_for_date_2": null, "statutory_holiday_pay_for_amount_2": null, "statutory_holiday_pay_for_date_3": null, "statutory_holiday_pay_for_amount_3": null, "statutory_holiday_pay_for_date_4": null, "statutory_holiday_pay_for_amount_4": null, "statutory_holiday_pay_for_date_5": null, "statutory_holiday_pay_for_amount_5": null, "statutory_holiday_pay_for_date_6": null, "statutory_holiday_pay_for_amount_6": null, "statutory_holiday_pay_for_date_7": null, "statutory_holiday_pay_for_amount_7": null, "statutory_holiday_pay_for_date_8": null, "statutory_holiday_pay_for_amount_8": null, "statutory_holiday_pay_for_date_9": null, "statutory_holiday_pay_for_amount_9": null, "statutory_holiday_pay_for_date_10": null, "statutory_holiday_pay_for_amount_10": null, "other_monies_code_1": null, "other_monies_start_date_1": null, "other_monies_end_date_1": null, "other_monies_amount_1": null, "other_monies_code_2": null, "other_monies_start_date_2": null, "other_monies_end_date_2": null, "other_monies_amount_2": null, "other_monies_code_3": null, "other_monies_start_date_3": null, "other_monies_end_date_3": null, "other_monies_amount_3": null, "special_payments_code_1": null, "special_payments_start_date_1": null, "special_payments_end_date_1": null, "special_payments_amount_1": null, "special_payments_period_1": null, "special_payments_code_2": null, "special_payments_start_date_2": null, "special_payments_end_date_2": null, "special_payments_amount_2": null, "special_payments_period_2": null, "special_payments_code_3": null, "special_payments_start_date_3": null, "special_payments_end_date_3": null, "special_payments_amount_3": null, "special_payments_period_3": null, "special_payments_code_4": null, "special_payments_start_date_4": null, "special_payments_end_date_4": null, "special_payments_amount_4": null, "special_payments_period_4": null, "block_18_comments": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/forms/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/form_batches/{form_batch}": { "delete": { "summary": "Delete a form batch", "operationId": "form-batches-destroy", "tags": [ "Form Batches" ], "parameters": [ { "name": "form_batch", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a form batch", "operationId": "form-batches-show", "tags": [ "Form Batches" ], "parameters": [ { "name": "form_batch", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "owner" ] } }, "required": false } ], "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 (`\"form_batch\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/FormBatch" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With owner expanded", "properties": { "owner": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FormBatchOwner" } } } } } ] } } }, "example": { "id": "", "object": "form_batch", "data": { "owner": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "form_type": "t4", "form_stage": "original", "effective_date": "2026-01-01", "status": "draft", "contact_name": "Prof. Brody Ernser III", "contact_email": "weber.pierre@example.net", "contact_area_code": "657", "contact_phone_number": "3654916", "contact_extension": null, "note": null, "metadata": { "counts": { "total": 0, "valid": 0, "invalid": 0, "draft": 0, "approved": 0, "processing": 0, "submitted": 0, "done": 0, "rejected": 0 }, "flags": { "is_submittable": false }, "timestamps": { "submitted_at": null, "completed_at": null }, "identifiers": { "confirmation_number": null } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/form_batches/" } } } } } } }, "put": { "summary": "Update a form batch", "operationId": "form-batches-update", "tags": [ "Form Batches" ], "parameters": [ { "name": "form_batch", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"form_batch\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/FormBatch" } } }, "example": { "id": "", "object": "form_batch", "data": { "owner": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "form_type": "t4", "form_stage": "original", "effective_date": "2026-01-01", "status": "draft", "contact_name": "Prof. Brody Ernser III", "contact_email": "weber.pierre@example.net", "contact_area_code": "657", "contact_phone_number": "3654916", "contact_extension": null, "note": "Updated note for the form batch.", "metadata": { "counts": { "total": 0, "valid": 0, "invalid": 0, "draft": 0, "approved": 0, "processing": 0, "submitted": 0, "done": 0, "rejected": 0 }, "flags": { "is_submittable": false }, "timestamps": { "submitted_at": null, "completed_at": null }, "identifiers": { "confirmation_number": null } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/form_batches/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "owner_id": { "type": "string", "description": "Read-only after creation." }, "owner_type": { "type": "string" }, "form_type": { "type": "string", "description": "The type of Forms in this batch (e.g. T4, RL-1).\n\nRead-only after creation." }, "form_stage": { "type": "string", "description": "The lifecycle stage of the Forms in this batch: original, amendment, or cancellation.\n\nRead-only after creation." }, "effective_date": { "type": "string", "description": "The effective date used to determine the form variant for all Forms in this batch.\n\nRead-only after creation." }, "status": { "type": "string", "description": "The submission status of this batch.\n\nRead-only after creation." }, "contact_name": { "type": "string", "description": "The name of the contact person responsible for this submission.", "maxLength": 255 }, "contact_email": { "type": "string", "description": "The email address of the contact person.", "maxLength": 255 }, "contact_area_code": { "type": "string", "description": "The 3-digit area code of the contact's phone number." }, "contact_phone_number": { "type": "string", "description": "The 7-digit phone number of the contact." }, "contact_extension": { "type": "string", "description": "The optional extension for the contact's phone number.", "nullable": true }, "note": { "type": "string", "description": "An optional note for this form batch.", "nullable": true, "maxLength": 65000 } } }, "example": { "note": "Updated note for the form batch." } } } } } }, "/form_batches/{form_batch}/download": { "get": { "summary": "Download a form batch", "operationId": "form-batches-download", "tags": [ "Form Batches" ], "parameters": [ { "name": "form_batch", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "text/html; charset=utf-8": { "schema": {} } } } } } }, "/form_batches/{form_batch}/submit": { "post": { "summary": "Submit a form batch", "description": "Endpoint to submit a Form Batch.\n\nThe following example is for a T4, but the same flow will work for any submittable form batch.", "operationId": "form-batches-submit", "tags": [ "Form Batches" ], "parameters": [ { "name": "form_batch", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"form_batch\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/FormBatch" } } }, "example": { "id": "", "object": "form_batch", "data": { "owner": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "form_type": "t4", "form_stage": "original", "effective_date": "2026-01-01", "status": "processing", "contact_name": "Prof. Brody Ernser III", "contact_email": "weber.pierre@example.net", "contact_area_code": "657", "contact_phone_number": "3654916", "contact_extension": null, "note": null, "metadata": { "counts": { "total": 1, "valid": 1, "invalid": 0, "draft": 0, "approved": 1, "processing": 0, "submitted": 0, "done": 0, "rejected": 0 }, "flags": { "is_submittable": false }, "timestamps": { "submitted_at": null, "completed_at": null }, "identifiers": { "confirmation_number": null } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/form_batches/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/form_types/{form_type}/generate": { "post": { "summary": "Generate forms", "description": "Endpoint to generate forms with the values suggested by Nmbr.\n\nThis is only possible for forms that support generation (T4/T4A/RL-1).\n\nThis example uses a T4 form, but the same applies to other forms.", "operationId": "form-types-generate", "tags": [ "Form Types" ], "parameters": [ { "name": "form_type", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"async_task\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/FormType" } } }, "example": { "id": "", "object": "async_task", "data": { "type": "form_generation", "status": "processing", "completed_at": null, "results": [], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/async_tasks/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "form_batch_id": { "type": "string", "description": "The form batch to add the generated forms to." }, "effective_date": { "type": "string", "description": "Determines which form variant to generate. Must be a date for which a generator is configured for the given form type.", "format": "date" } } }, "example": { "effective_date": "2026-01-01" } } } } } }, "/form_types/{form_type}/populate": { "post": { "summary": "Populate a form", "description": "Endpoint to populate form fields with the values suggested by Nmbr.\n\nThis is only possible for forms that support population.\n\nThis example uses an ROE form, but the same applies to other forms.", "operationId": "form-types-populate", "tags": [ "Form Types" ], "parameters": [ { "name": "form_type", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"form_population_result\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/FormType" } } }, "example": { "id": "", "object": "form_population_result", "data": { "fields": { "block_8_social_insurance_number": "196710156", "employee_first_name": "Marley", "employee_last_name": "Prosacco", "employee_address_line_1": "Angelina Ridge", "employee_address_line_2": "Toronto", "employee_address_line_3": "ON CA", "employee_postal_code": "M1M1M1", "block_5_cra_payroll_account_number": "136549169RP9916", "contact_area_code": 111, "contact_phone_number": 2223333, "contact_phone_number_extension": null, "contact_first_name": "Jean", "contact_last_name": "Smith", "block_10_first_day_worked": "2026-01-01", "block_11_last_day_for_which_paid": "2026-01-31", "block_6_pay_period_type": "M", "block_12_final_pay_period_ending_date": "2026-01-31", "block_15_total_insurable_hours": "0", "pp1_insurable_earnings": 0 } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "effective_date": { "type": "string", "description": "Determines which form variant to populate. Must be a date for which a populator is configured for the given form type.", "format": "date" } } }, { "type": "object", "required": [ "effective_date" ] } ] }, "example": { "effective_date": "2026-01-01" } } } } } }, "/form_types/{form_type}": { "get": { "summary": "Retrieve a form type", "description": "Endpoint to fetch the structure of a Form.\n\nThe following example is for a 2026 TD1, but the response `fields` will differ depending on the specific Form instance requested.", "operationId": "form-types-show", "tags": [ "Form Types" ], "parameters": [ { "name": "form_type", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "effective_date", "in": "query", "schema": { "type": "string", "format": "date" }, "required": false } ], "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 (`\"form_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/FormType" } } }, "example": { "id": "", "object": "form_type", "data": { "type": "td1", "label": "TD1 Personal Tax Credits Return", "version_year": 2026, "version_month": "january", "owner_types": [ "work_assignment" ], "exportable_as": [], "supports_population": false, "supports_generation": false, "fields": [ { "key": "line_1_basic_personal_amount", "label": "Basic Personal Amount (Line 1)", "type": "currency", "required": false, "readonly": false }, { "key": "line_2_infirm_children_caregiver_amount", "label": "Infirm Children Caregiver Amount (Line 2)", "type": "currency", "required": false, "readonly": false }, { "key": "line_3_age_amount", "label": "Age Amount (Line 3)", "type": "currency", "required": false, "readonly": false }, { "key": "line_4_pension_income_amount", "label": "Pension Income Amount (Line 4)", "type": "currency", "required": false, "readonly": false }, { "key": "line_5_tuition", "label": "Tuition (Line 5)", "type": "currency", "required": false, "readonly": false }, { "key": "line_6_disability_amount", "label": "Disability Amount (Line 6)", "type": "currency", "required": false, "readonly": false }, { "key": "line_7_spouse_or_common_law_partner_amount", "label": "Spouse or Common-law Partner Amount (Line 7)", "type": "currency", "required": false, "readonly": false }, { "key": "line_8_eligible_dependent_amount", "label": "Eligible Dependent Amount (Line 8)", "type": "currency", "required": false, "readonly": false }, { "key": "line_9_infirm_dependent_caregiver_amount", "label": "Infirm Dependent Caregiver Amount (Line 9)", "type": "currency", "required": false, "readonly": false }, { "key": "line_10_dependent_caregiver_amount", "label": "Dependent Caregiver Amount (Line 10)", "type": "currency", "required": false, "readonly": false }, { "key": "line_11_spouse_or_common_law_transfer_amount", "label": "Spouse or Common-law Transfer Amount (Line 11)", "type": "currency", "required": false, "readonly": false }, { "key": "line_12_dependent_transfer_amount", "label": "Dependent Transfer Amount (Line 12)", "type": "currency", "required": false, "readonly": false }, { "key": "line_13_total_claim_amount", "label": "Total Claim Amount (Line 13)", "type": "currency", "required": false, "readonly": false }, { "key": "more_than_one_employer_or_payer", "label": "You have more than one employer or payer", "type": "boolean", "required": false, "readonly": false }, { "key": "total_income_less_than_total_claim_amount", "label": "Total income is less than total claim amount", "type": "boolean", "required": false, "readonly": false }, { "key": "ninety_percent_world_income_taxable_income", "label": "90% of World Income is Taxable in Canada", "type": "boolean", "required": false, "readonly": false }, { "key": "prescribed_zone_deduction", "label": "Prescribed Zone Deduction", "type": "currency", "required": false, "readonly": false }, { "key": "additional_tax_deduction", "label": "Additional Tax Deduction", "type": "currency", "required": false, "readonly": false } ] }, "links": { "self": "/form_types/td1" } } } } } } } }, "/form_types/{form_type}/validate": { "post": { "summary": "Validate a form", "description": "Endpoint to validate form fields.\n\nThe following example is for a 2026 TD1, but the response `fields` will differ depending on the specific Form instance requested.", "operationId": "form-types-validation", "tags": [ "Form Types" ], "parameters": [ { "name": "form_type", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {}, "example": { "data": { "errors": { "line_2_infirm_children_caregiver_amount": [ "The Infirm Children Caregiver Amount (Line 2) must be at least 0." ] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "effective_date": { "type": "string", "format": "date" } } }, "example": { "effective_date": "2026-01-01" } } } } } }, "/holidays/{holiday}": { "get": { "summary": "Retrieve a holiday", "operationId": "holidays-show", "tags": [ "Holidays" ], "parameters": [ { "name": "holiday", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"holiday\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Holiday" } } }, "example": { "id": "", "object": "holiday", "data": { "jurisdiction": "ca_on", "type": "statutory", "name": "Canada Day", "name_translations": { "en": "Canada Day", "fr": "F\u00eate du Canada" }, "name_translated": "Canada Day", "original_date": "2026-07-01", "observed_date": "2026-07-01", "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/holidays/" } } } } } } } }, "/integrations/{integration}/authenticate": { "post": { "summary": "Authenticate integration", "operationId": "integrations-authenticate", "tags": [ "Integrations" ], "parameters": [ { "name": "integration", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"oauth_auth_url\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Integration" } } }, "example": { "id": "", "object": "oauth_auth_url", "data": { "authentication_url": "https://example.com/authenticate" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "business_entity_id": { "type": "string" } } }, { "type": "object", "required": [ "business_entity_id" ] } ] }, "example": { "business_entity_id": "" } } } } } }, "/integrations/{integration}/connection": { "post": { "summary": "Import a partner-supplied OAuth connection", "description": "Register a QuickBooks or Xero connection using OAuth tokens the partner obtained directly from the provider. Pair with the partner integration credentials configured by support.", "operationId": "integrations-connection", "tags": [ "Integrations" ], "parameters": [ { "name": "integration", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"integration\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Integration" } } }, "example": { "id": "", "object": "integration", "data": { "label": "Xero", "is_enabled": true, "type": "accounting" }, "links": { "self": "/integrations/xero" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "business_entity_id": { "type": "string" }, "access_token": { "type": "string", "description": "OAuth access token issued by the partner's QBO/Xero app for the customer." }, "access_token_expires_in": { "type": "number", "description": "Lifetime of the access token, in seconds.", "format": "decimal", "minimum": 0 }, "refresh_token": { "type": "string", "description": "Long-lived refresh token paired with the access token." }, "refresh_token_expires_in": { "type": "number", "description": "Lifetime of the refresh token, in seconds.", "format": "decimal", "minimum": 0 }, "realm_id": { "type": "string", "description": "QuickBooks company id (QBO `realmId`). Required for QuickBooks, ignored for Xero." } } }, { "type": "object", "required": [ "business_entity_id", "access_token", "access_token_expires_in", "refresh_token", "refresh_token_expires_in" ] } ] }, "example": { "business_entity_id": "", "access_token": "", "access_token_expires_in": 3600, "refresh_token": "", "refresh_token_expires_in": 5184000 } } } } } }, "/integrations/{integration}": { "delete": { "summary": "Delete an integration", "description": "Deactivate the integration for a business entity.", "operationId": "integrations-destroy", "tags": [ "Integrations" ], "parameters": [ { "name": "integration", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"integration\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Integration" } } }, "example": { "id": "", "object": "integration", "data": { "label": "Xero", "is_enabled": false, "type": "accounting" }, "links": { "self": "/integrations/xero" } } } } } } }, "get": { "summary": "Retrieve an integration", "operationId": "integrations-show", "tags": [ "Integrations" ], "parameters": [ { "name": "integration", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": true } ], "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 (`\"integration\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Integration" } } }, "example": { "id": "", "object": "integration", "data": { "label": "Xero", "is_enabled": false, "type": "accounting" }, "links": { "self": "/integrations/xero" } } } } } } } }, "/integrations/{integration}/sync": { "post": { "summary": "Sync integration", "description": "Endpoint to import data from, or export data to, a connected accounting platform.\n\nThe work runs in the background. The endpoint responds `202 Accepted` with an [Async Task](/api-reference/async-tasks/retrieve-an-async-task) of type `integration_sync`, reading `processing`. Poll `GET /async_tasks/{id}` for the task to reach `completed` or `error`, or subscribe to the `async_task_completed` webhook, which fires on both.\n\nA sync task reports status only, so `results` is always empty.", "operationId": "integrations-sync", "tags": [ "Integrations" ], "parameters": [ { "name": "integration", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "sync": { "type": "string", "description": "Data to be synced with the provider: - `accounting_codes`: imports Accounting Codes from the provider. - `journal_entries`: exports Journal Entries to the provider, requires a `payroll_id`. - `category`: imports tracking categories (Xero Tracking Categories / QuickBooks Classes) as Tag Groups and Tags. - `department`: imports departments (QuickBooks Locations) as Tag Groups and Tags. QuickBooks only. - `project`: imports projects as Tag Groups and Tags. QuickBooks only.", "enum": [ "accounting_codes", "category", "department", "journal_entries", "project" ] }, "business_entity_id": { "type": "string" }, "payroll_id": { "type": "string" } } }, { "type": "object", "required": [ "sync" ] } ] }, "example": { "sync": "accounting_codes", "business_entity_id": "" } } } } } }, "/integrations/{integration}/tracking_dimensions/{dimension}": { "get": { "summary": "List integration tracking dimension values", "description": "List the values inside a single tracking-dimension group, fetched from the connected QuickBooks or Xero account.", "operationId": "integrations-tracking-dimensions-show", "tags": [ "Integrations" ], "parameters": [ { "name": "integration", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "dimension", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": true } ], "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 (`\"tracking_dimension\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/TrackingDimension" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "tracking_dimension", "data": { "label": "Overhead", "type": "class" } }, { "id": "", "object": "tracking_dimension", "data": { "label": "Direct", "type": "class" } } ] } } } } } } }, "/integrations/{integration}/tracking_dimensions": { "get": { "summary": "List integration tracking dimensions", "description": "List the tracking-dimension groups a connected QuickBooks or Xero account exposes, fetched live from the provider.", "operationId": "integrations-tracking-dimensions-index", "tags": [ "Integrations" ], "parameters": [ { "name": "integration", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "business_entity_id", "in": "query", "schema": { "type": "string" }, "required": true } ], "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 (`\"tracking_dimension\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/TrackingDimension" } } } } } }, "example": { "object": "list", "data": [ { "id": "", "object": "tracking_dimension", "data": { "label": "Class", "type": "class" } }, { "id": "", "object": "tracking_dimension", "data": { "label": "Department", "type": "department" } }, { "id": "", "object": "tracking_dimension", "data": { "label": "Project", "type": "project" } } ] } } } } } } }, "/journal_entries/{journal_entry}": { "get": { "summary": "Retrieve a journal entry", "operationId": "journal-entries-show", "tags": [ "Journal Entries" ], "parameters": [ { "name": "journal_entry", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "journal_entry_rows", "pay_stub", "payroll" ] } }, "required": false } ], "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 (`\"journal_entry\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/JournalEntry" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With payroll expanded", "properties": { "payroll": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Payroll" } } } } }, { "type": "object", "title": "With pay_stub expanded", "properties": { "pay_stub": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayStub" } } } } }, { "type": "object", "title": "With journal_entry_rows expanded", "properties": { "journal_entry_rows": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/JournalEntryRow" } } } } } } } } ] } } }, "example": { "id": "", "object": "journal_entry", "data": { "type": "payroll_recording", "title": "Payroll Accrual Entry", "title_translations": { "en": "Payroll Accrual Entry", "fr": "\u00c9criture de provision de la paie" }, "title_translated": "Payroll Accrual Entry", "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "pay_stub": null, "is_balanced": true, "total": 0, "is_missing_line_item_accounting_codes": true, "is_missing_default_account_payable": true, "is_missing_default_bank_account": false, "posted_on": "2026-01-30T00:00:00.000000Z", "invalid_expense_types": [ { "type": "employer_statutory_withholding", "subtype": "ei" }, { "type": "employer_statutory_withholding", "subtype": "cpp" }, { "type": "employer_statutory_withholding", "subtype": "cpp_2" } ], "invalid_liability_types": [ { "type": "statutory_withholding", "subtype": "cpp" }, { "type": "statutory_withholding", "subtype": "cpp_2" }, { "type": "statutory_withholding", "subtype": "ei" }, { "type": "statutory_withholding", "subtype": "federal_income_tax" }, { "type": "statutory_withholding", "subtype": "provincial_income_tax" }, { "type": "employer_statutory_withholding", "subtype": "ei" }, { "type": "employer_statutory_withholding", "subtype": "cpp" }, { "type": "employer_statutory_withholding", "subtype": "cpp_2" } ], "integrations": { "quickbooks": { "reference": null }, "xero": { "reference": null } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/journal_entries/" } } } } } } } }, "/overtime_rates/{overtime_rate}": { "delete": { "summary": "Delete an overtime rate", "operationId": "overtime-rates-destroy", "tags": [ "Overtime Rates" ], "parameters": [ { "name": "overtime_rate", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve an overtime rate", "operationId": "overtime-rates-show", "tags": [ "Overtime Rates" ], "parameters": [ { "name": "overtime_rate", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "expense_accounting_code", "liability_accounting_code", "pay_rate", "tag_assignment" ] } }, "required": false } ], "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 (`\"overtime_rate\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OvertimeRate" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With pay_rate expanded", "properties": { "pay_rate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayRate" } } } } }, { "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": { "id": "", "object": "overtime_rate", "data": { "pay_rate": { "id": "", "object": "pay_rate", "links": { "self": "/pay_rates/" } }, "title": "1.5x", "title_translated": "1.5x", "rate_multiplier": 1.5, "hourly_rate": 22.5, "hourly_rate_override": null, "business_preset": null, "expense_accounting_code": null, "liability_accounting_code": null, "archived_at": null, "is_editable": true, "is_deletable": true, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/overtime_rates/" } } } } } } }, "put": { "summary": "Update an overtime rate", "operationId": "overtime-rates-update", "tags": [ "Overtime Rates" ], "parameters": [ { "name": "overtime_rate", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"overtime_rate\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/OvertimeRate" } } }, "example": { "id": "", "object": "overtime_rate", "data": { "pay_rate": { "id": "", "object": "pay_rate", "links": { "self": "/pay_rates/" } }, "title": "$23", "title_translated": "$23", "rate_multiplier": 1.5, "hourly_rate": 22.5, "hourly_rate_override": 23, "business_preset": null, "expense_accounting_code": null, "liability_accounting_code": null, "archived_at": null, "is_editable": true, "is_deletable": true, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/overtime_rates/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "rate_multiplier": { "type": "number", "description": "The multiplier for this overtime, e.g `1.5` or `2`.\n\nEditing is prevented when `is_editable` is false", "format": "decimal", "minimum": 0, "maximum": 100 }, "hourly_rate_override": { "type": "number", "description": "If set, this amount is used for the hourly rate, not the calculated amount from the `rate_multiplier`.\n\nEditing is prevented when `is_editable` is false", "format": "decimal", "minimum": 0, "maximum": 99999 }, "business_preset_id": { "type": "string" }, "expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string" }, "archived_at": { "type": "string", "format": "date" }, "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 } } } } } } } }, "example": { "rate_multiplier": 1.5, "hourly_rate_override": 23 } } } } } }, "/pay_rates/{pay_rate}": { "delete": { "summary": "Delete a pay rate", "operationId": "pay-rates-destroy", "tags": [ "Pay Rates" ], "parameters": [ { "name": "pay_rate", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a pay rate", "operationId": "pay-rates-show", "tags": [ "Pay Rates" ], "parameters": [ { "name": "pay_rate", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "expense_accounting_code", "liability_accounting_code", "overtime_rates", "tag_assignment", "work_assignment" ] } }, "required": false } ], "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 (`\"pay_rate\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PayRate" } ], "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 overtime_rates expanded", "properties": { "overtime_rates": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/OvertimeRate" } } } } } } } }, { "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": { "id": "", "object": "pay_rate", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "title": "Marketing Manager", "title_translations": null, "title_translated": "Marketing Manager", "type": "hourly", "rate": 15, "expected_hours_per_week": 40, "is_editable": true, "is_deletable": true, "effective_from": "2026-01-01", "earliest_valid_effective_to": "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": "/pay_rates/" } } } } } } }, "put": { "summary": "Update a pay rate", "operationId": "pay-rates-update", "tags": [ "Pay Rates" ], "parameters": [ { "name": "pay_rate", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"pay_rate\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/PayRate" } } }, "example": { "id": "", "object": "pay_rate", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "title": "Marketing Manager", "title_translations": null, "title_translated": "Marketing Manager", "type": "hourly", "rate": 15, "expected_hours_per_week": 40, "is_editable": true, "is_deletable": true, "effective_from": "2026-01-01", "earliest_valid_effective_to": "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": "/pay_rates/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_preset_id": { "type": "string" }, "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 }, "type": { "type": "string", "description": "Whether this is a `salary` or `hourly` pay rate. Determines how `rate` is interpreted.\n\nEditing is prevented when `is_editable` is false", "enum": [ "hourly", "salary" ] }, "rate": { "type": "number", "description": "The annual salary when `type` is `salary`, or the hourly wage when `type` is `hourly`.\n\nFor `salary` pay rates, `rate` is the annual salary (i.e. amount per year). For `wage` pay rates, `rate` is the hourly wage (i.e. amount per hour).\n\nEditing is prevented when `is_editable` is false", "format": "decimal", "minimum": 0, "maximum": 9999999 }, "expected_hours_per_week": { "type": "number", "description": "The expected number of working hours per week. Must be greater than `0` for `salary` pay rates. Used to calculate the equivalent hourly rate from salaries for overtime.\n\nFor `salary` pay rates, `expected_hours_per_week` must be greater than 0.\n\nEditing is prevented when `is_editable` is false", "format": "decimal", "minimum": 0, "maximum": 168 }, "effective_from": { "type": "string", "description": "The date from which this pay rate is applied to Pay Stubs.\n\nEditing is prevented when `is_editable` is false", "format": "date" }, "effective_to": { "type": "string", "description": "The date after which this pay rate is no longer applied and can no longer be used to create Earning Line Items. `null` if the pay rate applies indefinitely.\n\nThe date must be after the `period_end` of the most recent non-draft payroll." }, "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 } } } } } } } }, "example": { "title": "Marketing Manager", "type": "hourly", "rate": "15", "expected_hours_per_week": "40", "effective_from": "2026-01-01" } } } } } }, "/pay_schedules/{pay_schedule}": { "delete": { "summary": "Delete a pay schedule", "operationId": "pay-schedules-destroy", "tags": [ "Pay Schedules" ], "parameters": [ { "name": "pay_schedule", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a pay schedule", "operationId": "pay-schedules-show", "tags": [ "Pay Schedules" ], "parameters": [ { "name": "pay_schedule", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_entity", "payrolls" ] } }, "required": false } ], "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 (`\"pay_schedule\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PaySchedule" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With business_entity expanded", "properties": { "business_entity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessEntity" } } } } }, { "type": "object", "title": "With payrolls expanded", "properties": { "payrolls": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/Payroll" } } } } } } } } ] } } }, "example": { "id": "", "object": "pay_schedule", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "title": "Default Schedule", "title_translations": null, "title_translated": "Default Schedule", "pay_frequency": "monthly", "anchor_pay_date": "2026-01-31", "anchor_start_of_pay_period": "2026-01-01", "anchor_end_of_pay_period": "2026-01-31", "generate_payrolls_from": null, "day_1": -1, "day_2": null, "pay_day_movement_setting": "inherit", "send_empty_pay_stubs": true, "pay_stub_settings": { "show_vacation_pay_balance": false }, "custom_pay_periods_per_year": null, "is_editable": true, "is_deletable": true, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_schedules/" } } } } } } }, "put": { "summary": "Update a pay schedule", "description": "Pay-Schedules with non-draft Payrolls (e.g `approved` or `paid`) may only have their `title` and `title_translations` fields updated.", "operationId": "pay-schedules-update", "tags": [ "Pay Schedules" ], "parameters": [ { "name": "pay_schedule", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"pay_schedule\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/PaySchedule" } } }, "example": { "id": "", "object": "pay_schedule", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "title": "Default Schedule", "title_translations": null, "title_translated": "Default Schedule", "pay_frequency": "monthly", "anchor_pay_date": "2026-01-31", "anchor_start_of_pay_period": "2026-01-01", "anchor_end_of_pay_period": "2026-01-31", "generate_payrolls_from": null, "day_1": -1, "day_2": null, "pay_day_movement_setting": "inherit", "send_empty_pay_stubs": true, "pay_stub_settings": { "show_vacation_pay_balance": false }, "custom_pay_periods_per_year": null, "is_editable": true, "is_deletable": true, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_schedules/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 255 }, "title_translations": { "type": "object", "description": "Optional translations for the `title` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "pay_frequency": { "type": "string", "description": "The frequency at which Payrolls are processed. Use `custom` for non-standard schedules where the number of pay periods per year is specified manually.\n\nEditing is prevented when `is_editable` is false", "enum": [ "bi-weekly", "custom", "monthly", "semi-monthly", "weekly" ] }, "anchor_pay_date": { "type": "string", "description": "The pay date of the anchor pay period. Together with `anchor_end_of_pay_period`, this establishes the pattern from which all future pay dates are calculated.\n\nDate must not be more than one year before the date the pay schedule is created.\n\nEditing is prevented when `is_editable` is false", "format": "date" }, "anchor_start_of_pay_period": { "type": "string", "description": "The start date of the anchor pay period. Only required for semi-monthly pay schedules when `anchor_end_of_pay_period` is not the 15th or the last day of the month. For standard configurations it is derived automatically and does not need to be supplied.\n\nRequired for semi-monthly pay schedules when `anchor_end_of_pay_period` is not the 15th or the last day of the month.\n\nEditing is prevented when `is_editable` is false", "format": "date" }, "anchor_end_of_pay_period": { "type": "string", "description": "The end date of the anchor pay period. Together with `anchor_pay_date`, this defines the length and pattern of all future pay periods.\n\nDate must not be more than one year before the date the pay schedule is created.\n\nEditing is prevented when `is_editable` is false", "format": "date" }, "generate_payrolls_from": { "type": "string", "description": "Only available in preview mode. When set, Payrolls are generated starting from this date rather than the default, allowing historical Payrolls to be created before the current date.\n\nAvailable in Preview mode, allows for the creation of Payrolls from an arbitrary date before the current date. Must be on or after `anchor_pay_date`.\n\nEditing is prevented when `is_editable` is false", "format": "date" }, "day_1": { "type": "integer", "description": "For monthly pay schedules, the day of the month on which pay is issued. For semi-monthly pay schedules, the first of two pay days per month.\n\nDay_1 is required for monthly and semi-monthly pay schedules. Otherwise, it must be `null`. On semi-monthly pay schedules, valid `(day_1, day_2)` pairs are `(16, 1)`, `(15, -1)` or `(15, 31)`.\n\nEditing is prevented when `is_editable` is false" }, "day_2": { "type": "integer", "description": "For semi-monthly pay schedules, the second of two pay days per month.\n\nday_2 is required for semi-monthly pay schedules. Otherwise, it must be `null`. On semi-monthly pay schedules, valid `(day_1, day_2)` pairs are `(16, 1)`, `(15, -1)` or `(15, 31)`.\n\nEditing is prevented when `is_editable` is false" }, "pay_day_movement_setting": { "type": "string", "description": "The pay schedule-level setting for how pay dates are adjusted when they fall on a weekend or bank holiday. If set to `inherit`, the Business Entity's setting is used.\n\nEditing is prevented when `is_editable` is false", "enum": [ "inherit", "next_business_day", "previous_business_day" ] }, "send_empty_pay_stubs": { "type": "boolean", "description": "Whether Pay Stubs are generated for employees with no earnings in a given pay period." }, "custom_pay_periods_per_year": { "type": "integer", "description": "When `pay_frequency` is `custom`, the number of pay periods per year.", "minimum": 1, "maximum": 366 }, "pay_stub_settings": { "type": "object", "description": "Settings that control Pay Stub display. The `show_vacation_pay_balance` field, when `true`, causes the employee's current Vacation Pay balance to appear on Pay Stubs.", "properties": { "show_vacation_pay_balance": { "type": "boolean" } } }, "external_ref": { "type": "string", "maxLength": 255 } } }, "example": { "title": "Default Schedule", "pay_frequency": "monthly", "anchor_pay_date": "2026-01-31", "anchor_end_of_pay_period": "2026-01-31", "day_1": -1, "pay_day_movement_setting": "inherit", "send_empty_pay_stubs": true } } } } } }, "/pay_splits/{pay_split}": { "delete": { "summary": "Delete a pay split", "operationId": "pay-splits-destroy", "tags": [ "Pay Splits" ], "parameters": [ { "name": "pay_split", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a pay split", "operationId": "pay-splits-show", "tags": [ "Pay Splits" ], "parameters": [ { "name": "pay_split", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "contractor", "employee" ] } }, "required": false } ], "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 (`\"pay_split\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PaySplit" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With employee expanded", "properties": { "employee": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Employee" } } } } }, { "type": "object", "title": "With contractor expanded", "properties": { "contractor": { "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/Contractor" } } } } } ] } } }, "example": { "id": "", "object": "pay_split", "data": { "employee": { "id": "", "object": "employee", "links": { "self": "/employees/" } }, "type": "percentage", "title": null, "title_translations": null, "title_translated": null, "is_default": false, "priority_1_bank_account": { "id": "", "object": "bank_account", "data": { "employee": { "id": "", "object": "employee", "links": { "self": "/employees/" } }, "name": null, "institution_number": "320", "institution_name": "President's Choice Bank", "institution_name_translations": { "en": "President's Choice Bank", "fr": "Banque le Choix du Pr\u00e9sident" }, "institution_name_translated": "President's Choice Bank", "transit_number": "02002", "transit_address": "600-500 Lakeshore Blvd West POBOX600, Toronto, ON M5V 2V9", "account_number_last_3": "916", "is_primary": false, "is_deletable": false, "warnings": { "object": "list", "data": [] }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/bank_accounts/" } }, "priority_1_amount": 50, "priority_2_bank_account": { "id": "", "object": "bank_account", "data": { "employee": { "id": "", "object": "employee", "links": { "self": "/employees/" } }, "name": null, "institution_number": "320", "institution_name": "President's Choice Bank", "institution_name_translations": { "en": "President's Choice Bank", "fr": "Banque le Choix du Pr\u00e9sident" }, "institution_name_translated": "President's Choice Bank", "transit_number": "02002", "transit_address": "600-500 Lakeshore Blvd West POBOX600, Toronto, ON M5V 2V9", "account_number_last_3": "916", "is_primary": false, "is_deletable": false, "warnings": { "object": "list", "data": [] }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/bank_accounts/" } }, "priority_2_amount": 50, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_splits/" } } } } } } }, "put": { "summary": "Update a pay split", "operationId": "pay-splits-update", "tags": [ "Pay Splits" ], "parameters": [ { "name": "pay_split", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"pay_split\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/PaySplit" } } }, "example": { "id": "", "object": "pay_split", "data": { "employee": { "id": "", "object": "employee", "links": { "self": "/employees/" } }, "type": "amount", "title": null, "title_translations": null, "title_translated": null, "is_default": false, "priority_1_bank_account": { "id": "", "object": "bank_account", "data": { "employee": { "id": "", "object": "employee", "links": { "self": "/employees/" } }, "name": null, "institution_number": "320", "institution_name": "President's Choice Bank", "institution_name_translations": { "en": "President's Choice Bank", "fr": "Banque le Choix du Pr\u00e9sident" }, "institution_name_translated": "President's Choice Bank", "transit_number": "02002", "transit_address": "600-500 Lakeshore Blvd West POBOX600, Toronto, ON M5V 2V9", "account_number_last_3": "916", "is_primary": false, "is_deletable": false, "warnings": { "object": "list", "data": [] }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/bank_accounts/" } }, "priority_1_amount": 600, "priority_2_bank_account": { "id": "", "object": "bank_account", "data": { "employee": { "id": "", "object": "employee", "links": { "self": "/employees/" } }, "name": null, "institution_number": "320", "institution_name": "President's Choice Bank", "institution_name_translations": { "en": "President's Choice Bank", "fr": "Banque le Choix du Pr\u00e9sident" }, "institution_name_translated": "President's Choice Bank", "transit_number": "02002", "transit_address": "600-500 Lakeshore Blvd West POBOX600, Toronto, ON M5V 2V9", "account_number_last_3": "916", "is_primary": false, "is_deletable": false, "warnings": { "object": "list", "data": [] }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/bank_accounts/" } }, "priority_2_amount": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_splits/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "employee_id": { "type": "string" }, "contractor_id": { "type": "string" }, "type": { "type": "string", "description": "The split strategy. `amount` sends fixed dollar amounts in priority order with the last configured Bank Account receiving the remaining balance. `percentage` distributes by percentage; percentage must total 100% across all accounts.", "enum": [ "amount", "percentage" ] }, "title": { "type": "string", "description": "A label for this pay split configuration.", "nullable": true, "maxLength": 255 }, "title_translations": { "type": "object", "description": "Optional translations for the `title` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "is_default": { "type": "boolean", "description": "Whether this is the default pay split for the Employee or Contractor." }, "priority_1_bank_account_id": { "type": "string" }, "priority_1_amount": { "type": "number", "description": "The amount or percentage allocated to the first priority Bank Account.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "priority_2_bank_account_id": { "type": "string" }, "priority_2_amount": { "type": "number", "description": "The amount or percentage for the second priority Bank Account. For `amount`-type splits, set to `null` if this is the last account (receives the remainder).", "format": "decimal", "minimum": 0, "maximum": 99999 }, "priority_3_bank_account_id": { "type": "string" }, "priority_3_amount": { "type": "number", "description": "The amount or percentage for the third priority Bank Account.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "priority_4_bank_account_id": { "type": "string" }, "priority_4_amount": { "type": "number", "description": "The amount or percentage for the fourth priority Bank Account.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "priority_5_bank_account_id": { "type": "string" }, "priority_5_amount": { "type": "number", "description": "The amount or percentage for the fifth priority Bank Account.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "priority_6_bank_account_id": { "type": "string" }, "priority_6_amount": { "type": "number", "description": "The amount or percentage for the sixth priority Bank Account.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "priority_7_bank_account_id": { "type": "string" }, "priority_7_amount": { "type": "number", "description": "The amount or percentage for the seventh priority Bank Account.", "format": "decimal", "minimum": 0, "maximum": 99999 } } }, { "type": "object", "required": [ "type", "priority_1_bank_account_id", "priority_1_amount", "priority_2_bank_account_id" ] } ] }, "example": { "type": "amount", "priority_1_bank_account_id": "", "priority_1_amount": 600, "priority_2_bank_account_id": "" } } } } } }, "/pay_stubs/{pay_stub}": { "delete": { "summary": "Delete a pay stub", "operationId": "pay-stubs-destroy", "tags": [ "Pay Stubs" ], "parameters": [ { "name": "pay_stub", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a pay stub", "operationId": "pay-stubs-show", "tags": [ "Pay Stubs" ], "parameters": [ { "name": "pay_stub", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "allowance_line_items", "deduction_line_items", "earning_line_items", "employee_benefit_line_items", "employer_benefit_line_items", "employer_statutory_withholding_line_items", "payroll", "reimbursement_line_items", "statutory_withholding_line_items", "work_assignment" ] } }, "required": false } ], "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 (`\"pay_stub\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PayStub" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With payroll expanded", "properties": { "payroll": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Payroll" } } } } }, { "type": "object", "title": "With work_assignment expanded", "properties": { "work_assignment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WorkAssignment" } } } } }, { "type": "object", "title": "With earning_line_items expanded", "properties": { "earning_line_items": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/EarningLineItem" } } } } } } } }, { "type": "object", "title": "With statutory_withholding_line_items expanded", "properties": { "statutory_withholding_line_items": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/StatutoryWithholdingLineItem" } } } } } } } }, { "type": "object", "title": "With employer_statutory_withholding_line_items expanded", "properties": { "employer_statutory_withholding_line_items": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerStatutoryWithholdingLineItem" } } } } } } } }, { "type": "object", "title": "With allowance_line_items expanded", "properties": { "allowance_line_items": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/AllowanceLineItem" } } } } } } } }, { "type": "object", "title": "With reimbursement_line_items expanded", "properties": { "reimbursement_line_items": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/ReimbursementLineItem" } } } } } } } }, { "type": "object", "title": "With employee_benefit_line_items expanded", "properties": { "employee_benefit_line_items": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployeeBenefitLineItem" } } } } } } } }, { "type": "object", "title": "With employer_benefit_line_items expanded", "properties": { "employer_benefit_line_items": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerBenefitLineItem" } } } } } } } }, { "type": "object", "title": "With deduction_line_items expanded", "properties": { "deduction_line_items": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/DeductionLineItem" } } } } } } } } ] } } }, "example": { "id": "", "object": "pay_stub", "data": { "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "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": "A PayStub Note", "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, "apply_standard_tax_reductions": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_stubs/" } } } } } } }, "put": { "summary": "Update a pay stub", "operationId": "pay-stubs-update", "tags": [ "Pay Stubs" ], "parameters": [ { "name": "pay_stub", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"pay_stub\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/PayStub" } } }, "example": { "id": "", "object": "pay_stub", "data": { "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "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, "apply_standard_tax_reductions": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/pay_stubs/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "payment_method": { "type": "string", "description": "The payment method for this pay stub.", "enum": [ "direct_deposit", "manual", "pad", "wire" ] }, "note": { "type": "string", "description": "An optional note on the pay stub, visible to the partner.", "nullable": true }, "external_ref": { "type": "string", "maxLength": 255 }, "apply_standard_tax_reductions": { "type": "boolean", "description": "When `true`, the standard tax reductions are applied to this pay stub's withholdings even in cases where they would otherwise be skipped to avoid applying them twice across related runs in the same period. In Canada these reductions are the employee's federal and provincial personal tax credits (their TD1 claim amounts) and the CPP/QPP basic exemption. Defaults to `false`, and has no effect where those reductions already apply." } } }, "example": { "payment_method": "direct_deposit", "apply_standard_tax_reductions": false } } } } } }, "/pay_stubs/{pay_stub}/render": { "get": { "summary": "Render a PDF pay stub", "operationId": "pay-stubs-render", "tags": [ "Pay Stubs" ], "parameters": [ { "name": "pay_stub", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": {} } } } } } }, "/payments/{payment}/hold": { "post": { "summary": "Hold a payment", "description": "Place a payment on hold.\n\nAny payment can be held regardless of its status or destination. What the hold means depends\non timing: holding a payment before it has been processed prevents it from being submitted to\nthe banking network. Holding a funding payment after it has settled blocks all downstream\npayments (employee, CRA, RQ) from being processed, but does not reverse the settled payment.", "operationId": "payments-hold", "tags": [ "Payments" ], "parameters": [ { "name": "payment", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"payment\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Payment" } } }, "example": { "id": "", "object": "payment", "data": { "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "remittance_account": null, "destination": "payroll_float", "method": "pad", "amount": 0, "status": "pending", "process_at": "2026-01-27", "expected_at": "2026-01-27", "is_impacted_by_weekend_or_holiday": false, "is_held": true, "held_at": "2026-01-01T00:00:00.000000Z", "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/payments/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/payments/{payment}/release": { "post": { "summary": "Release a held payment", "description": "Release a previously held payment so normal processing can resume.\n\nAny held payment can be released regardless of its current status. Once released, pending\npayments will be submitted in the next processing window. Releasing a held funding payment\nunblocks downstream payments that were waiting for verification.", "operationId": "payments-release", "tags": [ "Payments" ], "parameters": [ { "name": "payment", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"payment\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Payment" } } }, "example": { "id": "", "object": "payment", "data": { "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "remittance_account": null, "destination": "payroll_float", "method": "pad", "amount": 0, "status": "pending", "process_at": "2026-01-27", "expected_at": "2026-01-27", "is_impacted_by_weekend_or_holiday": false, "is_held": false, "held_at": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/payments/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/payments/{payment}": { "get": { "summary": "Retrieve a payment", "operationId": "payments-show", "tags": [ "Payments" ], "parameters": [ { "name": "payment", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "payroll", "remittance_account" ] } }, "required": false } ], "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 (`\"payment\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Payment" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With payroll expanded", "properties": { "payroll": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Payroll" } } } } }, { "type": "object", "title": "With remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } } ] } } }, "example": { "id": "", "object": "payment", "data": { "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "remittance_account": null, "destination": "payroll_float", "method": "pad", "amount": 0, "status": "pending", "process_at": "2026-01-27", "expected_at": "2026-01-27", "is_impacted_by_weekend_or_holiday": false, "is_held": false, "held_at": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/payments/" } } } } } } } }, "/payrolls/{payroll}/approve": { "post": { "summary": "Approve a payroll", "operationId": "payrolls-approve", "tags": [ "Payrolls" ], "parameters": [ { "name": "payroll", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"payroll\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Payroll" } } }, "example": { "id": "", "object": "payroll", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "pay_schedule": { "id": "", "object": "pay_schedule", "links": { "self": "/pay_schedules/" } }, "type": "regular", "period_number": 1, "period_label": "1", "period_start": "2026-01-01", "period_end": "2026-01-31", "pay_date": "2026-01-30", "original_pay_date": "2026-01-31", "debit_date": "2026-01-27", "approval_due_at": "2026-01-27T21:30:00.000000Z", "regular_periods_count": 12, "is_impacted_by_weekend_or_holiday": true, "is_blocked_by_draft": false, "note": null, "employee_summary": { "gross": null, "subtractions": null, "reimbursements": null, "net": null }, "contractor_summary": { "gross": null, "reimbursements": null, "net": null }, "company_summary": { "taxes_and_contributions": null, "benefits": null, "total": null }, "liability": null, "cash_requirement": null, "status": "approved", "approved_at": "2026-01-01", "is_stale": false, "stale_since": null, "source_payroll": 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": "/payrolls/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/payrolls/{payroll}": { "delete": { "summary": "Delete a payroll", "operationId": "payrolls-destroy", "tags": [ "Payrolls" ], "parameters": [ { "name": "payroll", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a payroll", "operationId": "payrolls-show", "tags": [ "Payrolls" ], "parameters": [ { "name": "payroll", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_entity", "pay_schedule", "pay_stubs", "payroll_overview", "source_payroll" ] } }, "required": false } ], "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 (`\"payroll\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Payroll" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With business_entity expanded", "properties": { "business_entity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessEntity" } } } } }, { "type": "object", "title": "With pay_schedule expanded", "properties": { "pay_schedule": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PaySchedule" } } } } }, { "type": "object", "title": "With pay_stubs expanded", "properties": { "pay_stubs": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/PayStub" } } } } } } } }, { "type": "object", "title": "With source_payroll expanded", "properties": { "source_payroll": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SourcePayroll" } } } } }, { "type": "object", "title": "With payroll_overview expanded", "properties": { "payroll_overview": { "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/PayrollOverview" } } } } } ] } } }, "example": { "id": "", "object": "payroll", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "pay_schedule": { "id": "", "object": "pay_schedule", "links": { "self": "/pay_schedules/" } }, "type": "regular", "period_number": 1, "period_label": "1", "period_start": "2026-01-01", "period_end": "2026-01-31", "pay_date": "2026-01-30", "original_pay_date": "2026-01-31", "debit_date": "2026-01-27", "approval_due_at": "2026-01-27T21:30:00.000000Z", "regular_periods_count": 12, "is_impacted_by_weekend_or_holiday": true, "is_blocked_by_draft": false, "note": null, "employee_summary": { "gross": null, "subtractions": null, "reimbursements": null, "net": null }, "contractor_summary": { "gross": null, "reimbursements": null, "net": null }, "company_summary": { "taxes_and_contributions": null, "benefits": null, "total": null }, "liability": null, "cash_requirement": null, "status": "draft", "approved_at": null, "is_stale": false, "stale_since": null, "source_payroll": 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": "/payrolls/" } } } } } } }, "put": { "summary": "Update a payroll", "operationId": "payrolls-update", "tags": [ "Payrolls" ], "parameters": [ { "name": "payroll", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"payroll\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Payroll" } } }, "example": { "id": "", "object": "payroll", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "pay_schedule": { "id": "", "object": "pay_schedule", "links": { "self": "/pay_schedules/" } }, "type": "historical", "period_number": 1, "period_label": "1", "period_start": "2026-01-01", "period_end": "2026-01-01", "pay_date": "2026-01-01", "original_pay_date": "2026-01-08", "debit_date": "2025-12-24", "approval_due_at": "2025-12-24T21:30:00.000000Z", "regular_periods_count": null, "is_impacted_by_weekend_or_holiday": false, "is_blocked_by_draft": false, "note": null, "employee_summary": { "gross": null, "subtractions": null, "reimbursements": null, "net": null }, "contractor_summary": { "gross": null, "reimbursements": null, "net": null }, "company_summary": { "taxes_and_contributions": null, "benefits": null, "total": null }, "liability": null, "cash_requirement": null, "status": "draft", "approved_at": null, "is_stale": false, "stale_since": null, "source_payroll": 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": "/payrolls/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "pay_date": { "type": "string", "description": "The date on which Employees and Contractors are paid.", "format": "date" }, "note": { "type": "string", "description": "An optional note on the payroll, visible to the partner.", "nullable": true }, "external_ref": { "type": "string", "maxLength": 255 }, "period_start": { "type": "string", "description": "The start date of the pay period.", "format": "date" }, "period_end": { "type": "string", "description": "The end date of the pay period.", "format": "date" } } }, "example": { "pay_date": "2026-01-01", "period_start": "2026-01-01", "period_end": "2026-01-01" } } } } } }, "/payrolls/{payroll}/hours": { "post": { "summary": "Batch upsert hours", "operationId": "payrolls-hours-batch-upsert", "tags": [ "Payrolls" ], "parameters": [ { "name": "payroll", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "202": { "description": "Accepted" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/payrolls/{payroll}/import": { "get": { "summary": "Generate a historical payroll import template", "description": "Downloads a CSV template pre-populated with employees on the pay schedule for importing historical payroll data.\n\nThe payroll must be a historical or correction payroll in draft status.", "operationId": "payrolls-import-generate-import", "tags": [ "Payrolls" ], "parameters": [ { "name": "payroll", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "template", "in": "query", "schema": { "type": "string", "enum": [ "all_types", "preset" ] }, "required": true, "description": "The template type to generate. `preset` includes only the business entity's configured presets. `all_types` includes all available types/subtypes in the system." } ], "responses": { "200": { "description": "OK", "content": { "text/csv; charset=UTF-8": { "schema": {} } } } } }, "post": { "summary": "Import historical payroll data from CSV", "description": "Imports historical or correction payroll data from a CSV file. The CSV should be generated\nusing the template from the generate import endpoint, filled in with the appropriate values.\n\nSend the CSV as a `multipart/form-data` request with the file in a field named `import_file`\n(a `.csv` file).\n\nThe payroll must be a historical or correction payroll in draft status.\n\nOn success, the pay stub line items are populated with the imported data. On failure, the error\nresponse format depends on the `Accept` header: `text/csv` returns the original CSV with an added\nvalidation column containing inline error messages, while `application/json` returns a standard\nJSON validation error response.", "operationId": "payrolls-import-import", "tags": [ "Payrolls" ], "parameters": [ { "name": "payroll", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {}, "example": { "message": "Success" } } } } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } } } }, "/payrolls/{payroll}/unapprove": { "post": { "summary": "Unapprove a payroll", "operationId": "payrolls-unapprove", "tags": [ "Payrolls" ], "parameters": [ { "name": "payroll", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"payroll\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Payroll" } } }, "example": { "id": "", "object": "payroll", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "pay_schedule": { "id": "", "object": "pay_schedule", "links": { "self": "/pay_schedules/" } }, "type": "regular", "period_number": 1, "period_label": "1", "period_start": "2026-01-01", "period_end": "2026-01-31", "pay_date": "2026-01-30", "original_pay_date": "2026-01-31", "debit_date": "2026-01-27", "approval_due_at": "2026-01-27T21:30:00.000000Z", "regular_periods_count": 12, "is_impacted_by_weekend_or_holiday": true, "is_blocked_by_draft": false, "note": null, "employee_summary": { "gross": null, "subtractions": null, "reimbursements": null, "net": null }, "contractor_summary": { "gross": null, "reimbursements": null, "net": null }, "company_summary": { "taxes_and_contributions": null, "benefits": null, "total": null }, "liability": null, "cash_requirement": null, "status": "draft", "approved_at": null, "is_stale": false, "stale_since": null, "source_payroll": 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": "/payrolls/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/reimbursements/{reimbursement}": { "delete": { "summary": "Delete a reimbursement", "operationId": "reimbursements-destroy", "tags": [ "Reimbursements" ], "parameters": [ { "name": "reimbursement", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a reimbursement", "operationId": "reimbursements-show", "tags": [ "Reimbursements" ], "parameters": [ { "name": "reimbursement", "in": "path", "schema": { "type": "string" }, "required": true }, { "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": { "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 (`\"reimbursement\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Reimbursement" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With business_preset expanded", "properties": { "business_preset": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessPreset" } } } } }, { "type": "object", "title": "With work_assignment expanded", "properties": { "work_assignment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WorkAssignment" } } } } }, { "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": { "id": "", "object": "reimbursement", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "reimbursement_type": { "id": "", "object": "reimbursement_type", "data": { "type": "non_taxable_reimbursement", "label": "Non-Taxable Reimbursement" }, "links": { "self": "/reimbursement_types/non_taxable_reimbursement" } }, "title": null, "title_translations": null, "title_translated": null, "frequency": "per_payroll", "date_basis": null, "pay_period_cadence": null, "amount": 35, "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": "/reimbursements/" } } } } } } }, "put": { "summary": "Update a reimbursement", "operationId": "reimbursements-update", "tags": [ "Reimbursements" ], "parameters": [ { "name": "reimbursement", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"reimbursement\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Reimbursement" } } }, "example": { "id": "", "object": "reimbursement", "data": { "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "reimbursement_type": { "id": "", "object": "reimbursement_type", "data": { "type": "non_taxable_reimbursement", "label": "Non-Taxable Reimbursement" }, "links": { "self": "/reimbursement_types/non_taxable_reimbursement" } }, "title": null, "title_translations": null, "title_translated": null, "frequency": "per_payroll", "date_basis": null, "pay_period_cadence": null, "amount": 35, "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": "/reimbursements/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_preset_id": { "type": "string" }, "frequency": { "type": "string", "description": "The frequency at which this reimbursement 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" ] }, "reimbursement_type": { "type": "string", "description": "The type of reimbursement, which determines how it is categorized and reported on Pay Stubs.", "enum": [ "health_spending_account", "non_taxable_reimbursement", "professional_membership", "taxable_reimbursement", "transit_pass", "wellness_spending_account" ] }, "amount": { "type": "number", "description": "The monetary amount applied each time this reimbursement is included on a Pay Stub.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "effective_from": { "type": "string", "description": "The date from which this reimbursement is applied to Pay Stubs.", "format": "date" }, "effective_to": { "type": "string", "description": "The date after which this reimbursement is no longer applied. `null` if the reimbursement applies indefinitely.", "format": "date" }, "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 }, "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 } } }, "example": { "frequency": "per_payroll", "reimbursement_type": "non_taxable_reimbursement", "amount": "35", "effective_from": "2026-01-01" } } } } } }, "/reimbursement_line_items/{reimbursement_line_item}": { "delete": { "summary": "Delete a reimbursement line item", "operationId": "reimbursement-line-items-destroy", "tags": [ "Reimbursement Line Items" ], "parameters": [ { "name": "reimbursement_line_item", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a reimbursement line item", "operationId": "reimbursement-line-items-show", "tags": [ "Reimbursement Line Items" ], "parameters": [ { "name": "reimbursement_line_item", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "custom_expense_accounting_code", "custom_liability_accounting_code", "custom_tag_assignment", "expense_accounting_code", "liability_accounting_code", "managed_expense_accounting_code", "managed_liability_accounting_code", "managed_tag_assignment", "pay_stub", "recurrence", "source_adjustment", "tag_assignment", "tag_assignment_amounts" ] } }, "required": false } ], "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 (`\"reimbursement_line_item\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ReimbursementLineItem" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With pay_stub expanded", "properties": { "pay_stub": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayStub" } } } } }, { "type": "object", "title": "With recurrence expanded", "properties": { "recurrence": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Recurrence" } } } } }, { "type": "object", "title": "With business_preset expanded", "properties": { "business_preset": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessPreset" } } } } }, { "type": "object", "title": "With source_adjustment expanded", "properties": { "source_adjustment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SourceAdjustment" } } } } }, { "type": "object", "title": "With expense_accounting_code expanded", "properties": { "expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ExpenseAccountingCode" } } } } }, { "type": "object", "title": "With managed_expense_accounting_code expanded", "properties": { "managed_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedExpenseAccountingCode" } } } } }, { "type": "object", "title": "With custom_expense_accounting_code expanded", "properties": { "custom_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomExpenseAccountingCode" } } } } }, { "type": "object", "title": "With liability_accounting_code expanded", "properties": { "liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LiabilityAccountingCode" } } } } }, { "type": "object", "title": "With managed_liability_accounting_code expanded", "properties": { "managed_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedLiabilityAccountingCode" } } } } }, { "type": "object", "title": "With custom_liability_accounting_code expanded", "properties": { "custom_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomLiabilityAccountingCode" } } } } }, { "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" } } } } }, { "type": "object", "title": "With managed_tag_assignment expanded", "properties": { "managed_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/ManagedTagAssignment" } } } } }, { "type": "object", "title": "With custom_tag_assignment expanded", "properties": { "custom_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/CustomTagAssignment" } } } } }, { "type": "object", "title": "With tag_assignment_amounts expanded", "properties": { "tag_assignment_amounts": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/TagAssignmentAmount" } } } } } } } } ] } } }, "example": { "id": "", "object": "reimbursement_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "reimbursement", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "accrued_vacation_pay": 0, "reimbursement_type": { "id": "", "object": "reimbursement_type", "data": { "type": "non_taxable_reimbursement", "label": "Non-Taxable Reimbursement" }, "links": { "self": "/reimbursement_types/non_taxable_reimbursement" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reimbursement_line_items/" } } } } } } }, "put": { "summary": "Update a reimbursement line item", "operationId": "reimbursement-line-items-update", "tags": [ "Reimbursement Line Items" ], "parameters": [ { "name": "reimbursement_line_item", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"reimbursement_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/ReimbursementLineItem" } } }, "example": { "id": "", "object": "reimbursement_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "reimbursement", "is_managed": false, "amount": 35, "custom_amount": null, "managed_amount": 35, "accrued_vacation_pay": 0, "reimbursement_type": { "id": "", "object": "reimbursement_type", "data": { "type": "non_taxable_reimbursement", "label": "Non-Taxable Reimbursement" }, "links": { "self": "/reimbursement_types/non_taxable_reimbursement" } }, "recurrence": null, "title": null, "title_translations": null, "title_translated": null, "business_preset": null, "source_adjustment": null, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "earned_on": null, "managed_earned_on": null, "custom_earned_on": null, "external_ref": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reimbursement_line_items/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_preset_id": { "type": "string", "description": "Writing may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false" }, "reimbursement_type": { "type": "string", "description": "The type of reimbursement for this line item.\n\nWriting may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false", "enum": [ "health_spending_account", "non_taxable_reimbursement", "professional_membership", "taxable_reimbursement", "transit_pass", "wellness_spending_account" ] }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.\n\nEditing is prevented when `is_editable` is false", "format": "decimal", "maximum": 99999 }, "accrued_vacation_pay": { "type": "number", "description": "The vacation pay accrued on this line item, calculated based on the Work Assignment's Vacation Pay Settings.", "format": "decimal", "minimum": 0, "maximum": 99999 }, "title": { "type": "string", "description": "Writing may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false", "nullable": true, "maxLength": 255 }, "title_translations": { "type": "object", "description": "Optional translations for the `title` property.\n\nWriting may be blocked when entity is managed by a parent resource\n\nEditing is prevented when `is_editable` is false", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "expense_accounting_code_id": { "type": "string", "description": "Writing may be blocked when entity is managed by a parent resource" }, "custom_expense_accounting_code_id": { "type": "string" }, "liability_accounting_code_id": { "type": "string", "description": "Writing may be blocked when entity is managed by a parent resource" }, "custom_liability_accounting_code_id": { "type": "string" }, "component_settings": { "type": "object", "properties": { "attributes_locked": { "type": "boolean" } } }, "custom_earned_on": { "type": "string", "description": "Editing is prevented when `is_editable` is false", "format": "date" }, "external_ref": { "type": "string", "maxLength": 255 }, "custom_tag_assignment": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "amount", "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 } } } } } } } }, "example": { "reimbursement_type": "non_taxable_reimbursement", "accrued_vacation_pay": "0" } } } } } }, "/reimbursement_types/{reimbursement_type}": { "get": { "summary": "Retrieve a reimbursement type", "operationId": "reimbursement-types-show", "tags": [ "Reimbursement Types" ], "parameters": [ { "name": "reimbursement_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 (`\"reimbursement_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/ReimbursementType" } } }, "example": { "id": "", "object": "reimbursement_type", "data": { "type": "taxable_reimbursement", "label": "Taxable Reimbursement", "features": [ { "type": "income_tax", "label": "Income Tax", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Federal Income Tax.", "program_label": null }, { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to Income Tax.", "program_label": null }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement 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": "Taxable Reimbursement is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to CPP.", "program_label": "CPP" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to QPP.", "program_label": "QPP" } ] }, { "type": "insurable", "label": "Insurable (EI/QPIP)", "definitions": [ { "jurisdiction": "ca_federal", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_oc", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to EI.", "program_label": "EI" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to QPIP.", "program_label": "QPIP" } ] }, { "type": "wcb", "label": "WCB", "definitions": [ { "jurisdiction": "ca_ab", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WorkSafeBC.", "program_label": "WorkSafeBC" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nb", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WorkSafeNB.", "program_label": "WorkSafeNB" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WorkplaceNL.", "program_label": "WorkplaceNL" }, { "jurisdiction": "ca_ns", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_nt", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_nu", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WSCC.", "program_label": "WSCC" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WSIB.", "program_label": "WSIB" }, { "jurisdiction": "ca_pe", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to CNESST.", "program_label": "CNESST" }, { "jurisdiction": "ca_sk", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WCB.", "program_label": "WCB" }, { "jurisdiction": "ca_yt", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to WCB.", "program_label": "WCB" } ] }, { "type": "eht", "label": "EPT", "definitions": [ { "jurisdiction": "ca_bc", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_mb", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to HE Levy.", "program_label": "HE Levy" }, { "jurisdiction": "ca_nl", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to HAPSET.", "program_label": "HAPSET" }, { "jurisdiction": "ca_on", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to EHT.", "program_label": "EHT" }, { "jurisdiction": "ca_qc", "effects": [ "withholding" ], "help_text": "Taxable Reimbursement is subject to HSF.", "program_label": "HSF" } ] }, { "type": "vacationable", "label": "Vacationable", "definitions": [] }, { "type": "stat_payable", "label": "Included in Statutory Holiday Pay", "definitions": [] } ], "form_mappings": [ { "form": "t4", "form_label": "T4", "mapping": [ [ { "name": "14", "help_text": "Employment Income" } ] ] }, { "form": "rl1", "form_label": "RL-1", "mapping": [ [ { "name": "A", "help_text": "Employment Income Before Source Deductions" } ] ] } ] }, "links": { "self": "/reimbursement_types/taxable_reimbursement" } } } } } } } }, "/remittance_accounts/{remittance_account}": { "delete": { "summary": "Delete a remittance account", "operationId": "remittance-accounts-destroy", "tags": [ "Remittance Accounts" ], "parameters": [ { "name": "remittance_account", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a remittance account", "operationId": "remittance-accounts-show", "tags": [ "Remittance Accounts" ], "parameters": [ { "name": "remittance_account", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_entity", "linked_remittance_account", "remittance_account_enrollments", "source_tax_property", "superseded_by" ] } }, "required": false } ], "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 (`\"remittance_account\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RemittanceAccount" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With business_entity expanded", "properties": { "business_entity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessEntity" } } } } }, { "type": "object", "title": "With source_tax_property expanded", "properties": { "source_tax_property": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TaxProperty" } } } } }, { "type": "object", "title": "With remittance_account_enrollments expanded", "properties": { "remittance_account_enrollments": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/RemittanceAccountEnrollment" } } } } } } } }, { "type": "object", "title": "With superseded_by expanded", "properties": { "superseded_by": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SupersededBy" } } } } }, { "type": "object", "title": "With linked_remittance_account expanded", "properties": { "linked_remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LinkedRemittanceAccount" } } } } } ] } } }, "example": { "id": "", "object": "remittance_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "source_tax_property": { "id": "", "object": "tax_property", "links": { "self": "/tax_properties/" } }, "account_provider": "ca_cra", "is_default": false, "is_editable": true, "is_deletable": true, "linked_remittance_account": null, "category": "ca_tax_agency", "label": "CRA Payroll Account", "label_translations": null, "label_translated": "CRA Payroll Account", "account_identifier": "123456789RP0001", "superseded_by": null, "superseded_on": null, "remitter_type": null, "remittance_management": "automatic", "note": null, "address_line_1": "555 MacKenzie Ave", "address_line_2": null, "city": "Ottawa", "administrative_area": "ON", "province_code": "ON", "country_code": "CA", "postal_code": "K1A 0L5", "has_payments": false, "current_enrollments_count": 0, "pending_enrollments_count": 0, "metadata": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_accounts/" } } } } } } }, "put": { "summary": "Update a remittance account", "operationId": "remittance-accounts-update", "tags": [ "Remittance Accounts" ], "parameters": [ { "name": "remittance_account", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"remittance_account\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/RemittanceAccount" } } }, "example": { "id": "", "object": "remittance_account", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "source_tax_property": { "id": "", "object": "tax_property", "links": { "self": "/tax_properties/" } }, "account_provider": "ca_cra", "is_default": false, "is_editable": true, "is_deletable": true, "linked_remittance_account": null, "category": "ca_tax_agency", "label": "CRA Payroll Account - Main", "label_translations": null, "label_translated": "CRA Payroll Account - Main", "account_identifier": "123456789RP0002", "superseded_by": null, "superseded_on": null, "remitter_type": "accelerated_threshold_1", "remittance_management": "automatic", "note": "Updated main payroll remittance account", "address_line_1": "555 MacKenzie Ave", "address_line_2": null, "city": "Ottawa", "administrative_area": "ON", "province_code": "ON", "country_code": "CA", "postal_code": "K1A 0L5", "has_payments": false, "current_enrollments_count": 0, "pending_enrollments_count": 0, "metadata": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_accounts/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "is_default": { "type": "boolean" }, "superseding_remittance_account_id": { "type": "string", "description": "The account that replaces this one after a business-number change or correction. Ties this account's paid history to its successor for combined year-to-date. Employees enrolled in this account are enrolled in the successor from the changeover date onward, and a work assignment created afterwards is enrolled in whichever account covers each part of its dates. Only one account in a line of accounts can have a replacement waiting to take effect at a time.\n\nMust be set together with `superseded_on`; providing one without the other is rejected." }, "superseded_on": { "type": "string", "description": "The date this account was replaced by its successor. Must be a future date, and later than the most recent pay date already paid through this account.\n\nMust be set together with `superseding_remittance_account_id`; providing one without the other is rejected.", "format": "date" }, "linked_remittance_account_id": { "type": "string", "description": "The id of a CRA remittance account in the same business entity whose enrollments this account should follow. When set, work assignments enrolled in that CRA account are automatically enrolled in this account with matching effective dates, and manual enrollments on this account become unavailable. Only a Revenue Qu\u00e9bec account may be linked, and only to a CRA account. An account that is the default for its authority cannot be linked; set is_default to false in the same request to link it. Clearing the value releases the generated enrollments, which stay in place and become editable and deletable again." }, "account_provider": { "type": "string" }, "category": { "type": "string", "enum": [ "ca_benefit_provider", "ca_provincial_government", "ca_tax_agency", "ca_union", "ca_workers_compensation" ] }, "label": { "type": "string", "maxLength": 255 }, "label_translations": { "type": "object", "description": "Optional translations for the `label` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "account_identifier": { "type": "string", "description": "Editing is prevented when `is_editable` is false", "nullable": true, "maxLength": 255 }, "remitter_type": { "type": "string", "enum": [ "accelerated_threshold_1", "accelerated_threshold_2", "quarterly", "regular" ] }, "remittance_management": { "type": "string", "enum": [ "automatic", "manual" ] }, "note": { "type": "string", "nullable": true }, "address_line_1": { "type": "string", "nullable": true }, "address_line_2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "administrative_area": { "type": "string", "nullable": true, "maxLength": 255 }, "province_code": { "type": "string", "description": "In Canada, must be an uppercase 2-letter province code: `AB`, `BC`, `MB`, `NB`, `NL`, `NS`, `NT`, `NU`, `ON`, `PE`, `QC`, `SK`, `YT`", "nullable": true }, "country_code": { "type": "string", "description": "Must be an uppercase 2-letter country code (ISO 3166-1 alpha-2, e.g., `CA`).", "nullable": true }, "postal_code": { "type": "string", "nullable": true, "maxLength": 10 }, "metadata": { "$ref": "#/components/schemas/RemittanceAccountMetadata" } } }, "example": { "label": "CRA Payroll Account - Main", "account_identifier": "123456789RP0002", "remitter_type": "accelerated_threshold_1", "remittance_management": "automatic", "note": "Updated main payroll remittance account", "address_line_1": "555 MacKenzie Ave", "city": "Ottawa", "administrative_area": "ON", "country_code": "CA", "postal_code": "K1A 0L5" } } } } } }, "/remittance_account_enrollments/{remittance_account_enrollment}": { "delete": { "summary": "Delete a remittance account enrollment", "operationId": "remittance-account-enrollments-destroy", "tags": [ "Remittance Account Enrollments" ], "parameters": [ { "name": "remittance_account_enrollment", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a remittance account enrollment", "operationId": "remittance-account-enrollments-show", "tags": [ "Remittance Account Enrollments" ], "parameters": [ { "name": "remittance_account_enrollment", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "managing_enrollment", "remittance_account", "work_assignment" ] } }, "required": false } ], "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 (`\"remittance_account_enrollment\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RemittanceAccountEnrollment" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } }, { "type": "object", "title": "With work_assignment expanded", "properties": { "work_assignment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WorkAssignment" } } } } }, { "type": "object", "title": "With managing_enrollment expanded", "properties": { "managing_enrollment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagingEnrollment" } } } } } ] } } }, "example": { "id": "", "object": "remittance_account_enrollment", "data": { "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "managing_enrollment": null, "effective_from": "2020-01-01", "effective_to": null, "is_editable": true, "is_deletable": true, "is_managed": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_account_enrollments/" } } } } } } }, "put": { "summary": "Update a remittance account enrollment", "operationId": "remittance-account-enrollments-update", "tags": [ "Remittance Account Enrollments" ], "parameters": [ { "name": "remittance_account_enrollment", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"remittance_account_enrollment\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/RemittanceAccountEnrollment" } } }, "example": { "id": "", "object": "remittance_account_enrollment", "data": { "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "managing_enrollment": null, "effective_from": "2020-01-01", "effective_to": "2025-12-31", "is_editable": true, "is_deletable": true, "is_managed": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/remittance_account_enrollments/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "effective_from": { "type": "string", "description": "Editing is prevented when `is_editable` is false", "format": "date" }, "effective_to": { "type": "string", "description": "Editing is prevented when `is_editable` is false", "format": "date" } } }, "example": { "effective_to": "2025-12-31" } } } } } }, "/payrolls/{payroll}/remittances": { "get": { "summary": "List remittance totals", "description": "Totals every statutory withholding, deduction and benefit on the payroll that names a remittance destination, and returns one figure per destination \u2014 what the payroll owes the CRA, Revenue Qu\u00e9bec, each benefit provider, union, workers' compensation board and employer health tax authority.\n\nTotals are computed when you ask for them, so they are available on a draft payroll that has never been approved, and on historical, correction and off-cycle payrolls that never produce payments at all. The whole list comes back in one response \u2014 there are no pages.\n\nLine items that name no remittance destination are left out entirely; there is no catch-all entry for them. A payroll with nothing to remit returns an empty list.", "operationId": "payrolls-remittances-index", "tags": [ "Remittance Totals" ], "parameters": [ { "name": "payroll", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "account_provider", "in": "query", "schema": { "anyOf": [ { "type": "string", "enum": [ "ca_ab_workers_compensation", "ca_bc_eht", "ca_bc_workers_compensation", "ca_cra", "ca_mb_eht", "ca_mb_workers_compensation", "ca_nb_workers_compensation", "ca_nl_eht", "ca_nl_workers_compensation", "ca_ns_workers_compensation", "ca_nt_government", "ca_nt_workers_compensation", "ca_nu_government", "ca_nu_workers_compensation", "ca_on_eht", "ca_on_workers_compensation", "ca_pe_workers_compensation", "ca_rq", "ca_sk_workers_compensation", "ca_yt_workers_compensation" ] }, { "type": "array", "items": { "type": "string", "enum": [ "ca_ab_workers_compensation", "ca_bc_eht", "ca_bc_workers_compensation", "ca_cra", "ca_mb_eht", "ca_mb_workers_compensation", "ca_nb_workers_compensation", "ca_nl_eht", "ca_nl_workers_compensation", "ca_ns_workers_compensation", "ca_nt_government", "ca_nt_workers_compensation", "ca_nu_government", "ca_nu_workers_compensation", "ca_on_eht", "ca_on_workers_compensation", "ca_pe_workers_compensation", "ca_rq", "ca_sk_workers_compensation", "ca_yt_workers_compensation" ] } } ] }, "required": false, "description": "Only return totals for these authorities. Supports multiple comma-separated values." }, { "name": "remittance_account_id", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Only return totals for these remittance accounts. Supports multiple comma-separated values." }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "remittance_account" ] } }, "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 (`\"remittance_total\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RemittanceTotal" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } } ] } } } } } }, "example": { "object": "list", "data": [ { "object": "remittance_total", "data": { "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "account_provider": null, "label_translated": "IBEW Local 353 \u2014 Dues", "amount": 245, "details": { "employee_amount": 245, "employer_amount": 0 } } }, { "object": "remittance_total", "data": { "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "account_provider": "ca_cra", "label_translated": "Canada Revenue Agency (CRA)", "amount": 918.73, "details": { "employee_amount": 611.42, "employer_amount": 307.31 } } } ] } } } } } } }, "/reports/{report}": { "delete": { "summary": "Delete a report", "operationId": "reports-destroy", "tags": [ "Reports" ], "parameters": [ { "name": "report", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a report", "description": "This endpoint allows you to retrieve the data associated with a specific report. Use the ULID provided when the report was originally generated to make the request.\n\nTo download the report in CSV format, include the `Accept` header with the value `text/csv` in your request. Alternatively, the rendered file can be retrieved from `GET /reports/{id}/download` using the `format` and `sheet` supplied at creation.", "operationId": "reports-show", "tags": [ "Reports" ], "parameters": [ { "name": "report", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "sheet", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Specify the report sheet you want to retrieve when requesting the CSV format. When `sheet` was supplied at creation, that value takes precedence and this query param is ignored. Multi-sheet reports whose sheets hold unrelated data (Year-End Forms) require it for a CSV request." } ], "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 (`\"report\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Report" } } }, "example": { "id": "", "object": "report", "data": { "type": "liability", "business_entity": null, "pay_schedule": null, "payroll": { "id": "", "object": "payroll", "links": { "self": "/payrolls/" } }, "filters": { "payroll_type": null, "payroll_status": null, "pay_date_from": null, "pay_date_to": null, "year": null }, "has_results": true, "format": null, "sheet": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/reports/" } } } } } } } }, "/reports/{report}/download": { "get": { "description": "Stream the rendered report file using the `format` and `sheet` stored on the report at creation.\n\n`format` is required: it must be supplied on the original `POST /reports/*` request for this endpoint to return a file. For multi-sheet reports (e.g. Payroll Register), `sheet` must also be supplied on the POST when a specific sheet is wanted. Request-side hints (`Accept` header, `?sheet=` query param) are ignored here.\n\nReturns 422 when `format` was not stored on the report, and 404 when the report's results have not yet been generated.", "operationId": "reports-download", "tags": [ "Reports" ], "parameters": [ { "name": "report", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "text/csv; charset=utf-8": { "schema": {} } } } } } }, "/roe_sat_agreements/{roe_sat_agreement}/letter": { "get": { "summary": "Download an ROE SAT agreement letter", "operationId": "roe-sat-agreements-download-letter", "tags": [ "ROE SAT Agreements" ], "parameters": [ { "name": "roe_sat_agreement", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": {} } } } } } }, "/roe_sat_agreements/{roe_sat_agreement}/revoke": { "post": { "summary": "Revoke an ROE SAT agreement", "operationId": "roe-sat-agreements-revoke", "tags": [ "ROE SAT Agreements" ], "parameters": [ { "name": "roe_sat_agreement", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"roe_sat_agreement\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/RoeSatAgreement" } } }, "example": { "id": "", "object": "roe_sat_agreement", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "business_number": "136549169RP9916", "business_legal_name": "Weber LLC", "signer_name": "Prof. Brody Ernser III", "signer_title": "Marketing Manager", "signed_on": "2026-01-01", "revoked_at": "2026-01-01T00:00:00.000000Z", "locale": "en", "letter_was_uploaded": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/roe_sat_agreements/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/roe_sat_agreements/{roe_sat_agreement}": { "get": { "summary": "Retrieve an ROE SAT agreement", "operationId": "roe-sat-agreements-show", "tags": [ "ROE SAT Agreements" ], "parameters": [ { "name": "roe_sat_agreement", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"roe_sat_agreement\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/RoeSatAgreement" } } }, "example": { "id": "", "object": "roe_sat_agreement", "data": { "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "business_number": "136549169RP9916", "business_legal_name": "Weber LLC", "signer_name": "Prof. Brody Ernser III", "signer_title": "Marketing Manager", "signed_on": "2026-01-01", "revoked_at": null, "locale": "en", "letter_was_uploaded": false, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/roe_sat_agreements/" } } } } } } } }, "/statutory_withholding_line_items/{statutory_withholding_line_item}": { "delete": { "summary": "Delete a statutory withholding line item", "operationId": "statutory-withholding-line-items-destroy", "tags": [ "Statutory Withholding Line Items" ], "parameters": [ { "name": "statutory_withholding_line_item", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a statutory withholding line item", "operationId": "statutory-withholding-line-items-show", "tags": [ "Statutory Withholding Line Items" ], "parameters": [ { "name": "statutory_withholding_line_item", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_preset", "custom_expense_accounting_code", "custom_liability_accounting_code", "expense_accounting_code", "liability_accounting_code", "managed_expense_accounting_code", "managed_liability_accounting_code", "managed_tag_assignment", "pay_stub", "remittance_account", "source_adjustment", "tag_assignment", "tag_assignment_amounts" ] } }, "required": false } ], "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 (`\"statutory_withholding_line_item\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/StatutoryWithholdingLineItem" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With pay_stub expanded", "properties": { "pay_stub": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PayStub" } } } } }, { "type": "object", "title": "With remittance_account expanded", "properties": { "remittance_account": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } }, { "type": "object", "title": "With source_adjustment expanded", "properties": { "source_adjustment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SourceAdjustment" } } } } }, { "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 managed_expense_accounting_code expanded", "properties": { "managed_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedExpenseAccountingCode" } } } } }, { "type": "object", "title": "With custom_expense_accounting_code expanded", "properties": { "custom_expense_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomExpenseAccountingCode" } } } } }, { "type": "object", "title": "With liability_accounting_code expanded", "properties": { "liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LiabilityAccountingCode" } } } } }, { "type": "object", "title": "With managed_liability_accounting_code expanded", "properties": { "managed_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedLiabilityAccountingCode" } } } } }, { "type": "object", "title": "With custom_liability_accounting_code expanded", "properties": { "custom_liability_accounting_code": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomLiabilityAccountingCode" } } } } }, { "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" } } } } }, { "type": "object", "title": "With managed_tag_assignment expanded", "properties": { "managed_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/ManagedTagAssignment" } } } } }, { "type": "object", "title": "With tag_assignment_amounts expanded", "properties": { "tag_assignment_amounts": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/TagAssignmentAmount" } } } } } } } } ] } } }, "example": { "id": "", "object": "statutory_withholding_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "statutory_withholding", "is_system": true, "is_managed": true, "amount": 500, "custom_amount": null, "managed_amount": 500, "statutory_withholding_type": { "id": "", "object": "statutory_withholding_type", "data": { "type": "federal_income_tax", "label": "Federal Income Tax" }, "links": { "self": "/statutory_withholding_types/federal_income_tax" } }, "title": "Federal Income Tax", "title_translations": { "en": "Federal Income Tax", "fr": "Imp\u00f4t f\u00e9d\u00e9ral" }, "title_translated": "Federal Income Tax", "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "source_adjustment": null, "business_preset": { "id": "", "object": "business_preset", "links": { "self": "/business_presets/" } }, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/statutory_withholding_line_items/" } } } } } } }, "put": { "summary": "Update a statutory withholding line item", "description": "Only available on correction and historical payrolls.", "operationId": "statutory-withholding-line-items-update", "tags": [ "Statutory Withholding Line Items" ], "parameters": [ { "name": "statutory_withholding_line_item", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"statutory_withholding_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/StatutoryWithholdingLineItem" } } }, "example": { "id": "", "object": "statutory_withholding_line_item", "data": { "pay_stub": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/" } }, "line_item_type": "statutory_withholding", "is_system": true, "is_managed": true, "amount": 500, "custom_amount": null, "managed_amount": 500, "statutory_withholding_type": { "id": "", "object": "statutory_withholding_type", "data": { "type": "federal_income_tax", "label": "Federal Income Tax" }, "links": { "self": "/statutory_withholding_types/federal_income_tax" } }, "title": "Federal Income Tax", "title_translations": { "en": "Federal Income Tax", "fr": "Imp\u00f4t f\u00e9d\u00e9ral" }, "title_translated": "Federal Income Tax", "remittance_account": { "id": "", "object": "remittance_account", "links": { "self": "/remittance_accounts/" } }, "source_adjustment": null, "business_preset": { "id": "", "object": "business_preset", "links": { "self": "/business_presets/" } }, "expense_accounting_code": null, "managed_expense_accounting_code": null, "custom_expense_accounting_code": null, "liability_accounting_code": null, "managed_liability_accounting_code": null, "custom_liability_accounting_code": null, "component_settings": { "attributes_locked": false }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/statutory_withholding_line_items/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_preset_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "statutory_withholding_type": { "type": "string", "description": "The type of statutory withholding for this line item.\n\nEditing is prevented when `is_editable` is false", "enum": [ "cpp", "cpp_2", "ei", "federal_income_tax", "provincial_income_tax", "qpip", "qpp", "qpp_2", "territorial_income_tax", "uk_paye_income_tax" ] }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.\n\nEditing is prevented when `is_editable` is false", "format": "decimal", "maximum": 999999 }, "title": { "type": "string", "description": "Editing is prevented when `is_editable` is false", "nullable": true, "maxLength": 255 }, "title_translations": { "type": "object", "description": "Optional translations for the `title` property.\n\nEditing is prevented when `is_editable` is false", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "remittance_account_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "expense_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "custom_expense_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "liability_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "custom_liability_accounting_code_id": { "type": "string", "description": "Editing is prevented when `is_editable` is false" }, "external_ref": { "type": "string", "maxLength": 255 } } }, "example": { "business_preset_id": "", "statutory_withholding_type": "federal_income_tax", "title": "Federal Income Tax", "title_translations": { "en": "Federal Income Tax", "fr": "Imp\u00f4t f\u00e9d\u00e9ral" }, "remittance_account_id": "" } } } } } }, "/statutory_withholding_types/{statutory_withholding_type}": { "get": { "summary": "Retrieve an employee statutory withholding type", "operationId": "statutory-withholding-types-show", "tags": [ "Statutory Withholding Types" ], "parameters": [ { "name": "statutory_withholding_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 (`\"statutory_withholding_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/StatutoryWithholdingType" } } }, "example": { "id": "", "object": "statutory_withholding_type", "data": { "type": "cpp", "label": "CPP" }, "links": { "self": "/statutory_withholding_types/cpp" } } } } } } } }, "/tags/{tag}": { "delete": { "summary": "Delete a tag", "operationId": "tags-destroy", "tags": [ "Tags" ], "parameters": [ { "name": "tag", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a tag", "operationId": "tags-show", "tags": [ "Tags" ], "parameters": [ { "name": "tag", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "counts", "tag_group" ] } }, "required": false } ], "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 (`\"tag\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Tag" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With tag_group expanded", "properties": { "tag_group": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TagGroup" } } } } }, { "type": "object", "title": "With counts expanded", "properties": { "counts": { "type": "object", "properties": { "work_assignments": { "type": "integer", "description": "Number of work assignments referencing this tag." }, "employees": { "type": "integer", "description": "Number of distinct employees behind the work assignments referencing this tag." }, "contractors": { "type": "integer", "description": "Number of distinct contractors behind the work assignments referencing this tag." } } } } } ] } } }, "example": { "id": "", "object": "tag", "data": { "label": "Engineering", "label_translations": null, "label_translated": "Engineering", "description": null, "description_translations": null, "description_translated": null, "archived_at": null, "is_deletable": true, "expense_segment": null, "liability_segment": null, "integrations": { "xero": { "id": null }, "quickbooks": { "id": null } }, "tag_group": { "id": "", "object": "tag_group", "links": { "self": "/tag_groups/" } }, "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/tags/" } } } } } } }, "put": { "summary": "Update a tag", "operationId": "tags-update", "tags": [ "Tags" ], "parameters": [ { "name": "tag", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"tag\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Tag" } } }, "example": { "id": "", "object": "tag", "data": { "label": "Product Engineering", "label_translations": null, "label_translated": "Product Engineering", "description": null, "description_translations": null, "description_translated": null, "archived_at": null, "is_deletable": true, "expense_segment": null, "liability_segment": null, "integrations": { "xero": { "id": null }, "quickbooks": { "id": null } }, "tag_group": { "id": "", "object": "tag_group", "links": { "self": "/tag_groups/" } }, "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/tags/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 255 }, "label_translations": { "type": "object", "description": "Optional translations for the `label` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "description": { "type": "string", "nullable": true }, "description_translations": { "type": "object", "description": "Optional translations for the `description` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "archived_at": { "type": "string", "format": "date" }, "expense_segment": { "type": "string", "nullable": true, "maxLength": 255 }, "liability_segment": { "type": "string", "nullable": true, "maxLength": 255 }, "integrations": { "type": "object", "properties": { "xero": { "type": "object", "properties": { "id": { "type": "string" } } }, "quickbooks": { "type": "object", "properties": { "id": { "type": "string" } } } } } } }, "example": { "label": "Product Engineering" } } } } } }, "/tag_groups/{tag_group}": { "delete": { "summary": "Delete a tag group", "operationId": "tag-groups-destroy", "tags": [ "Tag Groups" ], "parameters": [ { "name": "tag_group", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a tag group", "operationId": "tag-groups-show", "tags": [ "Tag Groups" ], "parameters": [ { "name": "tag_group", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "tags" ] } }, "required": false } ], "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 (`\"tag_group\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/TagGroup" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With tags expanded", "properties": { "tags": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/Tag" } } } } } } } } ] } } }, "example": { "id": "", "object": "tag_group", "data": { "label": "Department", "label_translations": null, "label_translated": "Department", "description": null, "description_translations": null, "description_translated": null, "color": null, "archived_at": null, "is_deletable": true, "is_component_locked": false, "is_journal_entry_dimension": false, "integrations": { "xero": { "id": null, "type": null }, "quickbooks": { "type": null } }, "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/tag_groups/" } } } } } } }, "put": { "summary": "Update a tag group", "operationId": "tag-groups-update", "tags": [ "Tag Groups" ], "parameters": [ { "name": "tag_group", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"tag_group\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/TagGroup" } } }, "example": { "id": "", "object": "tag_group", "data": { "label": "Cost Centre", "label_translations": null, "label_translated": "Cost Centre", "description": null, "description_translations": null, "description_translated": null, "color": null, "archived_at": null, "is_deletable": true, "is_component_locked": false, "is_journal_entry_dimension": false, "integrations": { "xero": { "id": null, "type": null }, "quickbooks": { "type": null } }, "business_entity": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/tag_groups/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 255 }, "label_translations": { "type": "object", "description": "Optional translations for the `label` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "description": { "type": "string", "nullable": true }, "description_translations": { "type": "object", "description": "Optional translations for the `description` property.", "allOf": [ { "$ref": "#/components/schemas/Translations" } ], "nullable": true }, "color": { "type": "string", "nullable": true }, "archived_at": { "type": "string", "format": "date" }, "is_component_locked": { "type": "boolean" }, "is_journal_entry_dimension": { "type": "boolean" }, "integrations": { "type": "object", "properties": { "xero": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "tracking_category" ] } } }, "quickbooks": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "class", "department", "project" ] } } } } } } }, "example": { "label": "Cost Centre" } } } } } }, "/tax_properties/{tax_property}": { "delete": { "summary": "Delete a tax property", "operationId": "tax-properties-destroy", "tags": [ "Tax Properties" ], "parameters": [ { "name": "tax_property", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a tax property", "operationId": "tax-properties-show", "tags": [ "Tax Properties" ], "parameters": [ { "name": "tax_property", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "owner" ] } }, "required": false } ], "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 (`\"tax_property\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/TaxProperty" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With owner expanded", "properties": { "owner": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TaxPropertyOwner" } } } } } ] } } }, "example": { "id": "", "object": "tax_property", "data": { "type": "ca::province_of_employment", "value": "ca_on", "effective_from": "2026-01-01", "effective_to": null, "earliest_valid_effective_to": "2026-01-01", "is_editable": true, "is_deletable": true, "label": "Province of Employment", "format": "string", "options": { "ca_ab": "Alberta", "ca_bc": "British Columbia", "ca_mb": "Manitoba", "ca_nb": "New Brunswick", "ca_nl": "Newfoundland and Labrador", "ca_ns": "Nova Scotia", "ca_nt": "Northwest Territories", "ca_nu": "Nunavut", "ca_on": "Ontario", "ca_pe": "Prince Edward Island", "ca_qc": "Quebec", "ca_sk": "Saskatchewan", "ca_yt": "Yukon", "ca_oc": "Outside Canada" }, "allow_concurrent": false, "feature": "onboarding", "owner": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "note": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/tax_properties/" } } } } } } }, "put": { "summary": "Update a tax property", "operationId": "tax-properties-update", "tags": [ "Tax Properties" ], "parameters": [ { "name": "tax_property", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"tax_property\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/TaxProperty" } } }, "example": { "id": "", "object": "tax_property", "data": { "type": "ca::province_of_employment", "value": "ca_on", "effective_from": "2026-01-01", "effective_to": "2026-12-31", "earliest_valid_effective_to": "2026-01-01", "is_editable": true, "is_deletable": true, "label": "Province of Employment", "format": "string", "options": { "ca_ab": "Alberta", "ca_bc": "British Columbia", "ca_mb": "Manitoba", "ca_nb": "New Brunswick", "ca_nl": "Newfoundland and Labrador", "ca_ns": "Nova Scotia", "ca_nt": "Northwest Territories", "ca_nu": "Nunavut", "ca_on": "Ontario", "ca_pe": "Prince Edward Island", "ca_qc": "Quebec", "ca_sk": "Saskatchewan", "ca_yt": "Yukon", "ca_oc": "Outside Canada" }, "allow_concurrent": false, "feature": "onboarding", "owner": { "id": "", "object": "business_entity", "links": { "self": "/business_entities/" } }, "note": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/tax_properties/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "effective_from": { "type": "string", "description": "The date from which this tax property takes effect.\n\nOnly updatable when `is_editable` is `true`.\n\nEditing is prevented when `is_editable` is false", "format": "date" }, "effective_to": { "type": "string", "description": "The date on which this tax property expires. `null` means no end date and the property remains in effect indefinitely.", "format": "date" }, "type": { "type": "string", "description": "The type of this tax property, determining its format, label, and validation rules.\n\nOnly updatable when `is_editable` is `true`.\n\nEditing is prevented when `is_editable` is false", "enum": [ "ca::ab::claim_amount", "ca::ab::total_income_less_than_total_claim_amount", "ca::ab::workers_compensation_class", "ca::bc::claim_amount", "ca::bc::eht", "ca::bc::total_income_less_than_total_claim_amount", "ca::bc::workers_compensation_class", "ca::cpp_exempt", "ca::ei_exempt", "ca::ei_premium_reduction", "ca::federal::additional_tax", "ca::federal::annual_deduction_at_source", "ca::federal::claim_amount", "ca::federal::commission_expenses", "ca::federal::commission_total_income", "ca::federal::income_tax_rate", "ca::federal::total_income_less_than_total_claim_amount", "ca::federal_oc_surtax_exempt", "ca::first_nation_exemptions", "ca::mb::claim_amount", "ca::mb::eht", "ca::mb::total_income_less_than_total_claim_amount", "ca::mb::workers_compensation_class", "ca::nb::claim_amount", "ca::nb::total_income_less_than_total_claim_amount", "ca::nb::workers_compensation_class", "ca::nl::claim_amount", "ca::nl::eht", "ca::nl::total_income_less_than_total_claim_amount", "ca::nl::workers_compensation_class", "ca::ns::claim_amount", "ca::ns::total_income_less_than_total_claim_amount", "ca::ns::workers_compensation_class", "ca::nt::claim_amount", "ca::nt::territorial_payroll_tax", "ca::nt::total_income_less_than_total_claim_amount", "ca::nt::workers_compensation_class", "ca::nu::claim_amount", "ca::nu::territorial_payroll_tax", "ca::nu::total_income_less_than_total_claim_amount", "ca::nu::workers_compensation_class", "ca::on::claim_amount", "ca::on::dependent_children_credit", "ca::on::eht", "ca::on::impaired_dependants_credit", "ca::on::total_income_less_than_total_claim_amount", "ca::on::workers_compensation_class", "ca::pe::claim_amount", "ca::pe::total_income_less_than_total_claim_amount", "ca::pe::workers_compensation_class", "ca::province_of_employment", "ca::province_of_work", "ca::provincial::income_tax_rate", "ca::qc::additional_tax", "ca::qc::claim_amount", "ca::qc::commission_percentage_taxed", "ca::qc::eht", "ca::qc::income_tax_rate", "ca::qc::qpip_exempt", "ca::qc::qpp_exempt", "ca::qc::tax_id", "ca::qc::total_income_less_than_total_claim_amount", "ca::qc::workers_compensation_class", "ca::sk::claim_amount", "ca::sk::total_income_less_than_total_claim_amount", "ca::sk::workers_compensation_class", "ca::statutory_holiday_pay", "ca::tax_id", "ca::yt::claim_amount", "ca::yt::total_income_less_than_total_claim_amount", "ca::yt::workers_compensation_class" ] }, "value": { "type": "string", "description": "The value of this tax property. Format depends on `format`: numeric types store a decimal string, boolean types store a boolean, select types store a string key, and object types store a structured value object.\n\nOnly updatable when `is_editable` is `true`.\n\nEditing is prevented when `is_editable` is false" }, "note": { "type": "string", "description": "An optional note for this tax property.", "nullable": true } } }, "example": { "effective_to": "2026-12-31" } } } } } }, "/tax_property_templates/{tax_property_template}": { "get": { "summary": "Retrieve a tax property template", "operationId": "tax-property-templates-show", "tags": [ "Tax Property Templates" ], "parameters": [ { "name": "tax_property_template", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"tax_property_template\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/TaxPropertyTemplate" } } }, "example": { "id": "", "object": "tax_property_template", "data": { "type": "ca::province_of_employment", "label": "Province of Employment", "format": "string", "options": { "ca_ab": "Alberta", "ca_bc": "British Columbia", "ca_mb": "Manitoba", "ca_nb": "New Brunswick", "ca_nl": "Newfoundland and Labrador", "ca_ns": "Nova Scotia", "ca_nt": "Northwest Territories", "ca_nu": "Nunavut", "ca_on": "Ontario", "ca_pe": "Prince Edward Island", "ca_qc": "Quebec", "ca_sk": "Saskatchewan", "ca_yt": "Yukon", "ca_oc": "Outside Canada" }, "allow_concurrent": false, "feature": "onboarding", "nullable": false, "structure": null, "validation": null }, "links": { "self": "/tax_property_templates/ca::province_of_employment" } } } } } } } }, "/usage_records/{usage_record}": { "get": { "summary": "Retrieve an usage record", "operationId": "usage-records-show", "tags": [ "Usage Records" ], "parameters": [ { "name": "usage_record", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"usage_record\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/UsageRecord" } } }, "example": { "id": "", "object": "usage_record", "data": { "company": { "id": "", "object": "company", "links": { "self": "/companies/" } }, "event": "employee_paid", "record": { "id": "", "object": "pay_stub", "links": { "self": "/pay_stubs/fake-id" } }, "recorded_at": "2026-01-01 00:00:00", "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/usage_records/" } } } } } } } }, "/usage_summaries/{usage_summary}": { "get": { "summary": "Retrieve an usage summary", "operationId": "usage-summaries-show", "tags": [ "Usage Summaries" ], "parameters": [ { "name": "usage_summary", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"usage_summary\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/UsageSummary" } } }, "example": { "id": "", "object": "usage_summary", "data": { "company": { "id": "", "object": "company", "links": { "self": "/companies/" } }, "event": "employee_paid", "count": 0, "period_start": "2026-01-01", "period_end": "2026-01-31", "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/usage_summaries/" } } } } } } } }, "/vacation_pay_settings/{vacation_pay_setting}": { "delete": { "summary": "Delete a vacation pay setting", "operationId": "vacation-pay-settings-destroy", "tags": [ "Vacation Pay Settings" ], "parameters": [ { "name": "vacation_pay_setting", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a vacation pay setting", "operationId": "vacation-pay-settings-show", "tags": [ "Vacation Pay Settings" ], "parameters": [ { "name": "vacation_pay_setting", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "work_assignment" ] } }, "required": false } ], "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 (`\"vacation_pay_setting\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/VacationPaySetting" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With work_assignment expanded", "properties": { "work_assignment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WorkAssignment" } } } } } ] } } }, "example": { "id": "", "object": "vacation_pay_setting", "data": { "percentage": 4, "vacation_pay_method": "manual", "effective_from": "2026-01-01", "effective_to": null, "earliest_valid_effective_to": "2026-01-01", "is_editable": true, "is_deletable": true, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "note": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/vacation_pay_settings/" } } } } } } }, "put": { "summary": "Update a vacation pay setting", "operationId": "vacation-pay-settings-update", "tags": [ "Vacation Pay Settings" ], "parameters": [ { "name": "vacation_pay_setting", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"vacation_pay_setting\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/VacationPaySetting" } } }, "example": { "id": "", "object": "vacation_pay_setting", "data": { "percentage": 4, "vacation_pay_method": "manual", "effective_from": "2026-01-01", "effective_to": "2026-12-31", "earliest_valid_effective_to": "2026-01-01", "is_editable": true, "is_deletable": true, "work_assignment": { "id": "", "object": "work_assignment", "links": { "self": "/work_assignments/" } }, "note": null, "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/vacation_pay_settings/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "effective_from": { "type": "string", "description": "Editing is prevented when `is_editable` is false", "format": "date" }, "effective_to": { "type": "string", "format": "date" }, "percentage": { "type": "number", "description": "Editing is prevented when `is_editable` is false", "format": "decimal", "minimum": 0, "maximum": 100 }, "vacation_pay_method": { "type": "string", "description": "Editing is prevented when `is_editable` is false", "enum": [ "manual", "per_period" ] }, "overrides": { "type": "array", "description": "Editing is prevented when `is_editable` is false", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "allowance", "earning", "reimbursement" ] }, "subtype": { "type": "string" }, "percentage": { "type": "number", "format": "decimal", "minimum": 0, "maximum": 100 }, "method": { "type": "string", "enum": [ "manual", "per_period" ] } } } }, "note": { "type": "string", "nullable": true } } }, "example": { "effective_to": "2026-12-31" } } } } } }, "/webhooks/{webhook}": { "delete": { "summary": "Delete a webhook", "operationId": "webhooks-destroy", "tags": [ "Webhooks" ], "parameters": [ { "name": "webhook", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a webhook", "operationId": "webhooks-show", "tags": [ "Webhooks" ], "parameters": [ { "name": "webhook", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"webhook\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Webhook" } } }, "example": { "id": "", "object": "webhook", "data": { "url": "https://partner.example.com/webhooks", "key": "", "is_enabled": true, "events": [ "resource_created", "resource_updated", "resource_deleted", "payroll_approved", "payroll_unapproved", "payroll_paid", "payroll_deadline_upcoming", "pay_stub_available", "async_task_completed", "form_completed", "form_batch_completed", "integration_authentication_success", "integration_authentication_failure", "integration_sync_account_codes_complete", "integration_sync_account_codes_failure", "integration_sync_journal_entries_complete", "integration_sync_journal_entries_failure", "integration_sync_tags_complete", "integration_sync_tags_failure" ], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/webhooks/" } } } } } } }, "put": { "summary": "Update a webhook", "operationId": "webhooks-update", "tags": [ "Webhooks" ], "parameters": [ { "name": "webhook", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"webhook\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/Webhook" } } }, "example": { "id": "", "object": "webhook", "data": { "url": "https://partner.example.com/webhooks", "key": "", "is_enabled": true, "events": [ "resource_created", "resource_updated", "resource_deleted", "payroll_approved", "payroll_unapproved", "payroll_paid", "payroll_deadline_upcoming", "pay_stub_available", "async_task_completed", "form_completed", "form_batch_completed", "integration_authentication_success", "integration_authentication_failure", "integration_sync_account_codes_complete", "integration_sync_account_codes_failure", "integration_sync_journal_entries_complete", "integration_sync_journal_entries_failure", "integration_sync_tags_complete", "integration_sync_tags_failure" ], "created_at": "2026-01-01T00:00:00.000000Z", "updated_at": "2026-01-01T00:00:00.000000Z" }, "links": { "self": "/webhooks/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "The HTTPS URL we deliver webhook calls to. Plain HTTP is not accepted.", "maxLength": 255 }, "is_enabled": { "type": "boolean" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "async_task_completed", "form_batch_completed", "form_completed", "integration_authentication_failure", "integration_authentication_success", "integration_sync_account_codes_complete", "integration_sync_account_codes_failure", "integration_sync_journal_entries_complete", "integration_sync_journal_entries_failure", "integration_sync_tags_complete", "integration_sync_tags_failure", "pay_stub_available", "payroll_approved", "payroll_deadline_upcoming", "payroll_paid", "payroll_unapproved", "ping", "resource_created", "resource_deleted", "resource_updated" ] } } } }, "example": { "url": "https://partner.example.com/webhooks", "is_enabled": true, "events": [ "resource_created", "resource_updated", "resource_deleted", "payroll_approved", "payroll_unapproved", "payroll_paid", "payroll_deadline_upcoming", "pay_stub_available", "async_task_completed", "form_completed", "form_batch_completed", "integration_authentication_success", "integration_authentication_failure", "integration_sync_account_codes_complete", "integration_sync_account_codes_failure", "integration_sync_journal_entries_complete", "integration_sync_journal_entries_failure", "integration_sync_tags_complete", "integration_sync_tags_failure" ] } } } } } }, "/work_assignments/{work_assignment}": { "delete": { "summary": "Delete a work assignment", "operationId": "work-assignments-destroy", "tags": [ "Work Assignments" ], "parameters": [ { "name": "work_assignment", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } } }, "get": { "summary": "Retrieve a work assignment", "operationId": "work-assignments-show", "tags": [ "Work Assignments" ], "parameters": [ { "name": "work_assignment", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "business_entity", "contractor", "effective_tax_properties", "employee", "pay_rates", "pay_schedule", "pay_split", "remittance_accounts", "tag_assignment", "tax_properties" ] } }, "required": false } ], "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 (`\"work_assignment\"`).", "readOnly": true }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/WorkAssignment" } ], "anyOf": [ { "type": "object", "title": "Default" }, { "type": "object", "title": "With employee expanded", "properties": { "employee": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Employee" } } } } }, { "type": "object", "title": "With contractor expanded", "properties": { "contractor": { "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/Contractor" } } } } }, { "type": "object", "title": "With pay_rates expanded", "properties": { "pay_rates": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/PayRate" } } } } } } } }, { "type": "object", "title": "With pay_schedule expanded", "properties": { "pay_schedule": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PaySchedule" } } } } }, { "type": "object", "title": "With pay_split expanded", "properties": { "pay_split": { "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/PaySplit" } } } } }, { "type": "object", "title": "With business_entity expanded", "properties": { "business_entity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BusinessEntity" } } } } }, { "type": "object", "title": "With tax_properties expanded", "properties": { "tax_properties": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/TaxProperty" } } } } } } } }, { "type": "object", "title": "With effective_tax_properties expanded", "properties": { "effective_tax_properties": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/EffectiveTaxProperty" } } } } } } } }, { "type": "object", "title": "With remittance_accounts expanded", "properties": { "remittance_accounts": { "type": "object", "nullable": true, "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.", "readOnly": true }, "data": { "$ref": "#/components/schemas/RemittanceAccount" } } } } } } } }, { "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": { "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/" } } } } } } }, "put": { "summary": "Update a work assignment", "operationId": "work-assignments-update", "tags": [ "Work Assignments" ], "parameters": [ { "name": "work_assignment", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"work_assignment\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/WorkAssignment" } } }, "example": { "id": "", "object": "work_assignment", "data": { "title": "New title", "title_translations": null, "title_translated": "New title", "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/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "pay_split_id": { "type": "string" }, "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." }, "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 }, "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.", "format": "date" }, "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 } } } } } }, "tag_assignment_patch": { "type": "object", "description": "Additive changes to the existing tag assignment, as an alternative to replacing it with `tag_assignment`. The two keys are mutually exclusive.\n\n`tag_assignment_patch.add_tags` \u2014 Tag IDs to add to every existing allocation. Adding a tag replaces any other tag from the same tag group on that allocation.\n\n`tag_assignment_patch.remove_tags` \u2014 Tag IDs to remove from every existing allocation. An allocation left with no tags is deleted; the distribution strategy decides what happens to its value.\n\n`tag_assignment_patch.distribution_strategy` (optional) \u2014 Governs the value of allocations deleted by `remove_tags`. Defaults to `reallocate` when omitted. Accepted values: `reallocate` (spread the deleted value proportionally across the remaining allocations), `unallocated` (drop the value; the assignment's allocations will sum to less than before), `error` (refuse the patch if any allocation would be deleted).", "properties": { "add_tags": { "type": "array", "items": { "type": "string" } }, "remove_tags": { "type": "array", "items": { "type": "string" } }, "distribution_strategy": { "type": "string", "enum": [ "error", "reallocate", "unallocated" ] } } } } }, "example": { "title": "New title" } } } } } }, "/work_assignment/{work_assignment}/terminate": { "post": { "summary": "Terminate a work assignment", "operationId": "work-assignments-terminate", "tags": [ "Work Assignments" ], "parameters": [ { "name": "work_assignment", "in": "path", "schema": { "type": "string" }, "required": true } ], "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 (`\"work_assignment\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/WorkAssignment" } } }, "example": { "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/" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "effective_date": { "type": "string", "description": "The date for all recurring items to be ended, e.g. Pay Rates, Earnings, Allowances, Benefits, Reimbursements, Deductions.", "format": "date" }, "archived_at": { "type": "string", "description": "The date to archive the work assignment. If not provided, the work assignment will remain active.", "format": "date" } } }, { "type": "object", "required": [ "effective_date" ] } ] }, "example": { "effective_date": "2026-06-01" } } } } } } }, "components": { "securitySchemes": { "PartnerSecret": { "type": "http", "scheme": "bearer" }, "CompanyToken": { "type": "http", "scheme": "bearer" } }, "schemas": { "SourceTaxProperty": { "$ref": "#/components/schemas/TaxProperty" }, "SupersededBy": { "$ref": "#/components/schemas/RemittanceAccount" }, "RemittanceAccountEnrollment": { "type": "object", "title": "Remittance Account Enrollment", "properties": { "remittance_account": { "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 (`\"remittance_account\"`).", "readOnly": true } } }, "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 } } }, "managing_enrollment": { "description": "The CRA enrollment this enrollment was generated from, present only when the enrollment is managed." }, "effective_from": { "type": "string", "format": "date" }, "effective_to": { "type": "string", "nullable": true, "format": "date" }, "is_editable": { "type": "boolean", "description": "When false, the enrollment's effective dates cannot be updated. A managed enrollment is never editable." }, "is_deletable": { "type": "boolean", "description": "When false, the enrollment cannot be deleted. A managed enrollment is never deletable." }, "is_managed": { "type": "boolean", "description": "When true, this enrollment was generated from a CRA enrollment on a linked account and follows that enrollment's effective dates. Managed enrollments cannot be manually created, edited, or deleted while the linking is configured." }, "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" } } }, "LinkedRemittanceAccount": { "$ref": "#/components/schemas/RemittanceAccount" }, "ManagingEnrollment": { "$ref": "#/components/schemas/RemittanceAccountEnrollment" }, "Benefit": { "type": "object" }, "BenefitLineItem": { "type": "object" }, "SourceAdjustment": { "$ref": "#/components/schemas/Adjustment" }, "LiabilityAccountingCode": { "$ref": "#/components/schemas/AccountingCode" }, "ExpenseAccountingCode": { "$ref": "#/components/schemas/AccountingCode" }, "ManagedExpenseAccountingCode": { "$ref": "#/components/schemas/AccountingCode" }, "CustomExpenseAccountingCode": { "$ref": "#/components/schemas/AccountingCode" }, "ManagedLiabilityAccountingCode": { "$ref": "#/components/schemas/AccountingCode" }, "CustomLiabilityAccountingCode": { "$ref": "#/components/schemas/AccountingCode" }, "DefaultPayrollPayableAccountingCode": { "$ref": "#/components/schemas/AccountingCode" }, "DefaultBankAccountingCode": { "$ref": "#/components/schemas/AccountingCode" }, "SegmentTemplate": { "type": "object", "description": "Assembles a formatted accounting code for the journal entry report: each segment resolves to a value, is wrapped and transformed, and the results are concatenated in order. Only valid on rules with no tag and no tag group; `null` when unset.", "nullable": true, "properties": { "segments": { "type": "array", "description": "Ordered segments concatenated into the generated code.", "items": { "type": "object", "anyOf": [ { "type": "object", "description": "Emits the referenced accounting code's `code`.", "title": "Fixed accounting code", "properties": { "type": { "type": "string", "enum": [ "accounting_code" ] }, "id": { "type": "string", "description": "Id of an accounting code in this business entity." }, "prefix": { "type": "string", "description": "Literal text prepended to the resolved value.", "nullable": true, "maxLength": 255 }, "suffix": { "type": "string", "description": "Literal text appended to the resolved value.", "nullable": true, "maxLength": 255 }, "transform": { "type": "array", "description": "Transforms applied to the resolved value in the order listed.", "nullable": true, "items": { "type": "string", "enum": [ "alphanumeric", "lowercase", "uppercase" ] } }, "max_length": { "type": "integer", "description": "Truncates the resolved value to this many characters.", "nullable": true, "minimum": 1 }, "fallback": { "type": "string", "description": "Substituted when the resolved value is empty. When absent or empty, an empty segment is dropped instead \u2014 prefix and suffix included.", "nullable": true, "maxLength": 255 } }, "required": [ "type", "id" ] }, { "type": "object", "description": "Emits the row's tag in this group \u2014 its expense template code in an expense template, its liability template code in a liability template.", "title": "Tag group code", "properties": { "type": { "type": "string", "enum": [ "tag_group" ] }, "tag_group_id": { "type": "string", "description": "Id of a tag group in this business entity." }, "prefix": { "type": "string", "description": "Literal text prepended to the resolved value.", "nullable": true, "maxLength": 255 }, "suffix": { "type": "string", "description": "Literal text appended to the resolved value.", "nullable": true, "maxLength": 255 }, "transform": { "type": "array", "description": "Transforms applied to the resolved value in the order listed.", "nullable": true, "items": { "type": "string", "enum": [ "alphanumeric", "lowercase", "uppercase" ] } }, "max_length": { "type": "integer", "description": "Truncates the resolved value to this many characters.", "nullable": true, "minimum": 1 }, "fallback": { "type": "string", "description": "Substituted when the resolved value is empty. When absent or empty, an empty segment is dropped instead \u2014 prefix and suffix included.", "nullable": true, "maxLength": 255 } }, "required": [ "type", "tag_group_id" ] }, { "type": "object", "description": "Emits a fixed piece of text. A text segment takes no formatting.", "title": "Literal text", "properties": { "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "description": "The literal text to emit.", "maxLength": 255 } }, "required": [ "type", "text" ] } ] }, "minItems": 1, "maxItems": 20 } }, "required": [ "segments" ] }, "PayrollOverview": { "type": "object" }, "LineItem": { "type": "object" }, "Recurrence": { "type": "object" }, "TaxPropertyOwner": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessEntity" }, { "$ref": "#/components/schemas/WorkAssignment" }, { "$ref": "#/components/schemas/RemittanceAccount" } ] }, "FormOwner": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/Employee" }, { "$ref": "#/components/schemas/Contractor" }, { "$ref": "#/components/schemas/WorkAssignment" } ] }, "FormBatchOwner": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessEntity" } ] }, "SourcePayroll": { "$ref": "#/components/schemas/Payroll" }, "Token": { "type": "object", "properties": { "access_token": { "type": "string" }, "expires_in": { "type": "number" }, "expires_at": { "type": "string", "format": "dateTime" } } }, "Hour": { "type": "object", "properties": { "work_assignment_id": { "type": "string" }, "wage": { "type": "array", "items": { "type": "object", "properties": { "hours": { "type": "number", "format": "decimal" } } } }, "salary": { "type": "array", "items": { "type": "object", "properties": { "hours": { "type": "number", "format": "decimal" } } } }, "vacation_pay": { "type": "array", "items": { "type": "object", "properties": { "hours": { "type": "number", "format": "decimal" } } } }, "overtime": { "type": "array", "items": { "type": "object", "properties": { "hours": { "type": "number", "format": "decimal" } } } } } }, "JournalEntryRow": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "credit", "debit" ] }, "amount": { "type": "number", "format": "decimal" }, "code": { "type": "string" }, "description": { "type": "string" } } }, "Translations": { "type": "object", "nullable": true, "properties": { "en": { "type": "string", "maxLength": 255 }, "fr": { "type": "string", "maxLength": 255 } } }, "InlineTaxProperty": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of tax property to create. Must be a supported type for the parent model.", "enum": [ "ca::ab::claim_amount", "ca::ab::total_income_less_than_total_claim_amount", "ca::ab::workers_compensation_class", "ca::bc::claim_amount", "ca::bc::eht", "ca::bc::total_income_less_than_total_claim_amount", "ca::bc::workers_compensation_class", "ca::cpp_exempt", "ca::ei_exempt", "ca::ei_premium_reduction", "ca::federal::additional_tax", "ca::federal::annual_deduction_at_source", "ca::federal::claim_amount", "ca::federal::commission_expenses", "ca::federal::commission_total_income", "ca::federal::income_tax_rate", "ca::federal::total_income_less_than_total_claim_amount", "ca::federal_oc_surtax_exempt", "ca::first_nation_exemptions", "ca::mb::claim_amount", "ca::mb::eht", "ca::mb::total_income_less_than_total_claim_amount", "ca::mb::workers_compensation_class", "ca::nb::claim_amount", "ca::nb::total_income_less_than_total_claim_amount", "ca::nb::workers_compensation_class", "ca::nl::claim_amount", "ca::nl::eht", "ca::nl::total_income_less_than_total_claim_amount", "ca::nl::workers_compensation_class", "ca::ns::claim_amount", "ca::ns::total_income_less_than_total_claim_amount", "ca::ns::workers_compensation_class", "ca::nt::claim_amount", "ca::nt::territorial_payroll_tax", "ca::nt::total_income_less_than_total_claim_amount", "ca::nt::workers_compensation_class", "ca::nu::claim_amount", "ca::nu::territorial_payroll_tax", "ca::nu::total_income_less_than_total_claim_amount", "ca::nu::workers_compensation_class", "ca::on::claim_amount", "ca::on::dependent_children_credit", "ca::on::eht", "ca::on::impaired_dependants_credit", "ca::on::total_income_less_than_total_claim_amount", "ca::on::workers_compensation_class", "ca::pe::claim_amount", "ca::pe::total_income_less_than_total_claim_amount", "ca::pe::workers_compensation_class", "ca::province_of_employment", "ca::province_of_work", "ca::provincial::income_tax_rate", "ca::qc::additional_tax", "ca::qc::claim_amount", "ca::qc::commission_percentage_taxed", "ca::qc::eht", "ca::qc::income_tax_rate", "ca::qc::qpip_exempt", "ca::qc::qpp_exempt", "ca::qc::tax_id", "ca::qc::total_income_less_than_total_claim_amount", "ca::qc::workers_compensation_class", "ca::sk::claim_amount", "ca::sk::total_income_less_than_total_claim_amount", "ca::sk::workers_compensation_class", "ca::statutory_holiday_pay", "ca::tax_id", "ca::yt::claim_amount", "ca::yt::total_income_less_than_total_claim_amount", "ca::yt::workers_compensation_class" ] }, "value": { "type": "string", "description": "The value of the tax property. Format depends on the type." }, "effective_from": { "type": "string", "description": "The date from which this tax property is effective.", "format": "date" }, "effective_to": { "type": "string", "description": "The date until which this tax property is effective. If null, the tax property is effective indefinitely.", "nullable": true, "format": "date" }, "note": { "type": "string", "description": "An optional note for this tax property.", "nullable": true } } }, "RemittanceAccountMetadata": { "type": "object", "description": "Additional data points for this account. The available fields depend on the account's `category`; `null` for categories that capture no metadata.", "anyOf": [ { "type": "object", "title": "Workers\u2019 compensation", "properties": { "last_payment_amount": { "type": "string", "description": "The last payment made to the board before Nmbr takes over remittance, in dollars (e.g. `\"1250.00\"`).", "nullable": true, "format": "decimal" } } }, { "type": "object", "description": "Categories with no category-specific metadata. Omit the field or send `null`.", "title": "Other categories", "nullable": true } ], "nullable": true }, "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" } } } } } }, "ManagedTagAssignment": { "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" } } } } } }, "CustomTagAssignment": { "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" } } } } } }, "TagAssignmentAmount": { "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" } } } } } }, "PrimaryTagGroup": { "$ref": "#/components/schemas/TagGroup" }, "Integrations": { "type": "object", "properties": { "xero": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "maxLength": 255 }, "type": { "type": "string", "nullable": true, "enum": [ "tracking_category" ] } } }, "quickbooks": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "maxLength": 255 }, "type": { "type": "string", "nullable": true, "enum": [ "class", "department", "project" ] } } } } }, "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.", "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 } } } } } } }, "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" } } }, "AccountingCodeRule": { "type": "object", "title": "Accounting Code Rule", "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 } } }, "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 } } }, "tag": { "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\"`).", "readOnly": true } } }, "type": { "type": "string", "description": "The line item type this rule applies to (e.g. `earning`, `deduction`). When combined with `subtypes`, narrows the rule to specific line item categories. Mutually exclusive with `business_preset`.", "nullable": true, "maxLength": 255 }, "subtype": { "type": "string", "description": "This attribute is deprecated and will be removed.\n\nUse `subtypes`. The first member of the set, or `null` when the set is empty.", "nullable": true, "deprecated": true, "maxLength": 255 }, "subtypes": { "type": "object", "description": "The line item subtypes this rule applies to (e.g. `wage`, `salary`). The rule matches a line item whose subtype is any member of the set. Every member belongs to `type`, which a non-empty set requires. Empty when the rule is not scoped to a subtype.", "nullable": true }, "business_preset": { "description": "A business preset this rule applies to. Provides the highest specificity match. Mutually exclusive with `type` and `subtypes`." }, "expense_accounting_code": { "type": "object", "description": "The expense accounting code assigned when this rule matches.", "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 (`\"accounting_code\"`).", "readOnly": true } } }, "liability_accounting_code": { "description": "The liability accounting code assigned when this rule matches." }, "expense_segment_template": { "$ref": "#/components/schemas/SegmentTemplate" }, "liability_segment_template": { "$ref": "#/components/schemas/SegmentTemplate" }, "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" } } }, "Adjustment": { "type": "object", "title": "Adjustment", "properties": { "source_line_item": { "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_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/LineItem" } } }, "correction_line_item": { "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_line_item\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/LineItem" } } }, "correction_pay_stub": { "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_stub\"`).", "readOnly": true } } }, "type": { "type": "string", "nullable": true, "maxLength": 255 }, "subtype": { "type": "string", "nullable": true, "maxLength": 255 }, "expected_amount": { "type": "number", "format": "decimal" }, "admin_note": { "type": "string", "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" } } }, "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" } } }, "AllowanceLineItem": { "type": "object", "title": "Allowance Line Item", "properties": { "pay_stub": { "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_stub\"`).", "readOnly": true } } }, "line_item_type": { "type": "string", "nullable": true }, "is_managed": { "type": "boolean", "description": "Whether this line item was generated by an Allowance recurrence and calculated automatically. When `true`, only `custom_amount` can be modified and the line item cannot be deleted." }, "amount": { "type": "number", "description": "The effective amount for this line item. Returns `custom_amount` if set, otherwise `managed_amount`. Read-only.", "nullable": true, "format": "decimal" }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.", "nullable": true, "format": "decimal" }, "managed_amount": { "type": "number", "description": "The amount calculated by the system or set by the linked Allowance recurrence. Read-only; set `custom_amount` to override.", "nullable": true, "format": "decimal" }, "accrued_vacation_pay": { "type": "number", "description": "The vacation pay accrued on this line item, calculated based on the Work Assignment's Vacation Pay Settings.", "nullable": true, "format": "decimal" }, "allowance_type": { "type": "object", "description": "The type of allowance for this line item.", "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" } } }, "recurrence": {}, "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 }, "business_preset": {}, "source_adjustment": {}, "expense_accounting_code": { "description": "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." }, "managed_expense_accounting_code": { "description": "The expense accounting code derived by the system from accounting code rules and presets. Read-only." }, "custom_expense_accounting_code": { "description": "User-set expense accounting code that overrides the system-derived value." }, "liability_accounting_code": { "description": "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." }, "managed_liability_accounting_code": { "description": "The liability accounting code derived by the system from accounting code rules and presets. Read-only." }, "custom_liability_accounting_code": { "description": "User-set liability accounting code that overrides the system-derived value." }, "component_settings": { "type": "object", "description": "Settings specific to the Nmbr component.", "nullable": true, "properties": { "attributes_locked": { "type": "boolean", "description": "Whether the line item is locked and cannot be edited in the component." } } }, "earned_on": { "description": "The effective earned-on date for this line item. Returns `custom_earned_on` if set, otherwise `managed_earned_on`. Read-only." }, "managed_earned_on": { "type": "string", "description": "The earned-on date set by the system. Read-only; set `custom_earned_on` to override.", "nullable": true, "format": "date" }, "custom_earned_on": { "type": "string", "description": "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.", "nullable": true, "format": "date" }, "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" } } } }, "AsyncTask": { "type": "object", "title": "Async Task", "properties": { "type": { "type": "string", "enum": [ "batch_delete", "batch_upsert", "bulk_create", "bulk_delete", "bulk_update", "form_generation", "integration_sync", "scenario_seed" ] }, "status": { "type": "string", "enum": [ "completed", "error", "processing" ] }, "completed_at": { "type": "string", "readOnly": true, "nullable": true, "format": "dateTime" }, "results": { "type": "object", "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" } } }, "BankAccount": { "type": "object", "title": "Bank Account", "properties": { "business_entity": { "type": "object", "description": "The Business Entity that owns this bank account. Present only for Business Entity bank accounts.", "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", "description": "An optional human-readable label for the bank account, such as \"Main chequing\". Useful for distinguishing accounts at the same institution.", "nullable": true, "maxLength": 255 }, "institution_number": { "type": "string", "description": "The 3-digit bank institution number. An institution Nmbr does not hold raises a `bank_account_unrecognized_institution` warning rather than failing the request." }, "institution_name": { "type": "string", "description": "The name of the banking institution matching the institution number, or `null` if the number is not recognized. Always the English name; see `institution_name_translated` for the value in the request's locale.", "nullable": true }, "institution_name_translations": { "type": "object", "nullable": true, "properties": { "en": { "type": "string", "nullable": true }, "fr": { "type": "string", "nullable": true } } }, "institution_name_translated": { "type": "string", "description": "The translation of the `institution_name` property for the request locale. Computed using the values in `institution_name` and `institution_name_translations` and the value of the request's `Accept-Language` header.", "readOnly": true }, "transit_number": { "type": "string", "description": "The 5-digit bank transit number. A transit that is not a known branch of the given institution raises a `bank_account_unrecognized_transit` warning rather than failing the request." }, "transit_address": { "type": "string", "description": "The address of the branch matching the institution and transit numbers, or `null` if the pair is not recognized.", "nullable": true }, "account_number_last_3": { "type": "string", "description": "The last 3 digits of the bank account number.", "nullable": true }, "is_primary": { "type": "boolean", "description": "Whether this is the primary bank account for its owner." }, "is_deletable": { "type": "boolean", "description": "Whether this bank account can be deleted." }, "warnings": { "type": "object", "description": "A collection of data validation warnings for this bank account. Warnings indicate incomplete or potentially incorrect data, such as an unrecognized institution or transit number.", "nullable": true, "properties": { "object": { "type": "string", "nullable": true }, "data": { "type": "object", "nullable": true } } }, "is_pad_signed": { "type": "boolean", "description": "Whether a PAD agreement has been signed. Only present for Business Entity bank accounts." }, "pad_signer_name": { "type": "string", "description": "The name of the person who signed the PAD agreement. Only applicable to Business Entity bank accounts.", "nullable": true, "maxLength": 255 }, "pad_signer_email": { "type": "string", "description": "The email address of the PAD agreement signer. Only applicable to Business Entity bank accounts.", "nullable": true, "maxLength": 255 }, "pad_signer_title": { "type": "string", "description": "The title or role of the PAD agreement signer. Only applicable to Business Entity bank accounts.", "nullable": true, "maxLength": 255 }, "pad_signed_at": { "type": "string", "description": "The date and time the PAD agreement was signed. Only applicable to Business Entity bank accounts.", "readOnly": true, "nullable": true, "format": "dateTime" }, "pad_file": { "description": "The signed PAD agreement file. Only present for Business Entity bank accounts." }, "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" } } }, "BankAccountLookup": { "type": "object", "title": "Bank Account Lookup", "properties": { "warnings": { "type": "object", "description": "A collection of advisory warnings for the submitted account, in the same shape as the warnings on a bank account.", "nullable": true, "properties": { "object": { "type": "string", "nullable": true }, "data": { "type": "object", "nullable": true } } }, "institution_name": { "type": "string", "description": "The name of the banking institution matching the submitted institution number, or `null` if it was not provided or not recognized. Always the English name; see `institution_name_translated` for the value in the request's locale.", "nullable": true }, "institution_name_translations": { "type": "object", "nullable": true, "properties": { "en": { "type": "string", "nullable": true }, "fr": { "type": "string", "nullable": true } } }, "institution_name_translated": { "type": "string", "description": "The translation of the `institution_name` property for the request locale. Computed using the values in `institution_name` and `institution_name_translations` and the value of the request's `Accept-Language` header.", "readOnly": true }, "transit_address": { "type": "string", "description": "The address of the branch matching the submitted institution and transit numbers, or `null` if either was not provided or the pair is not recognized.", "nullable": true } } }, "BusinessEntity": { "type": "object", "title": "Business Entity", "properties": { "business_number": { "type": "string", "description": "The Canada Revenue Agency (CRA) Business Number (BN) for this business entity, used to identify the business for payroll tax remittances. 15 characters (BN15): a 9-digit Business Number root, the 2-letter `RP` payroll program identifier, and a 4-digit reference number starting at 0001. The root begins with 1, 7, or 8 and carries a Luhn check digit.", "nullable": true, "maxLength": 255 }, "name": { "type": "string", "description": "The business entity's operating or trade name.", "maxLength": 255 }, "legal_name": { "type": "string", "description": "The business entity's registered legal name.", "nullable": true, "maxLength": 255 }, "legal_registration_number": { "type": "string", "description": "The provincial business registration number.", "nullable": true, "maxLength": 255 }, "address_line_1": { "type": "string", "description": "The first line of the business entity's mailing address. Canada Revenue Agency forms (T4, RL-1) truncate this to the length those forms allow.", "nullable": true, "maxLength": 255 }, "address_line_2": { "type": "string", "description": "The second line of the business entity's mailing address. Canada Revenue Agency forms (T4, RL-1) truncate this to the length those forms allow.", "nullable": true, "maxLength": 255 }, "city": { "type": "string", "description": "The city of the business entity's mailing address.", "nullable": true, "maxLength": 255 }, "in_preview": { "type": "boolean", "description": "When `true`, the business entity is in preview mode. In preview mode, Payrolls can be run and approved but no real money movement occurs." }, "administrative_area": { "type": "string", "description": "The region of the business entity's mailing address \u2014 the province, state, or county, depending on the country. For Canadian business entities this is the province.", "nullable": true, "maxLength": 255 }, "province_code": { "type": "string", "description": "This attribute is deprecated and will be removed.\n\nA deprecated alias of `administrative_area` that mirrors its value. Use `administrative_area` instead.", "nullable": true, "deprecated": true }, "country_code": { "type": "string", "description": "The country code for the business entity's mailing address.", "nullable": true, "maxLength": 2 }, "postal_code": { "type": "string", "description": "The postal code for the business entity's mailing address.", "nullable": true, "maxLength": 255 }, "contact_name": { "type": "string", "description": "The name of the primary contact at the business entity.", "nullable": true, "maxLength": 255 }, "contact_email": { "type": "string", "description": "The email address of the primary contact at the business entity.", "nullable": true, "maxLength": 255 }, "contact_area_code": { "type": "string", "description": "The area code for the primary contact's phone number.", "nullable": true, "maxLength": 255 }, "contact_phone_number": { "type": "string", "description": "The primary contact's phone number, excluding area code.", "nullable": true, "maxLength": 255 }, "contact_extension": { "type": "string", "description": "The extension for the primary contact's phone number.", "nullable": true, "maxLength": 255 }, "pay_day_movement_setting": { "type": "string", "description": "The business entity-level setting for how pay dates are adjusted when they fall on a weekend or bank holiday. If set to `inherit`, the Company's setting is used.", "enum": [ "inherit", "next_business_day", "previous_business_day" ] }, "vacation_pay_formula_setting": { "type": "string", "description": "The formula used to calculate vacation pay for Employees in this business entity.", "enum": [ "pay_date", "period_end", "period_start" ] }, "remitter_type": { "type": "string", "description": "The Canada Revenue Agency (CRA) remitter type, which determines the frequency of payroll tax remittances to the CRA.", "nullable": true, "enum": [ "accelerated_threshold_1", "accelerated_threshold_2", "quarterly", "regular" ] }, "status": { "type": "string", "description": "The business entity's current status. A business entity must reach `approved` status before live Payrolls can be processed.", "enum": [ "approved", "onboarding", "suspended" ] }, "company": { "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 (`\"company\"`).", "readOnly": true } } }, "warnings": { "type": "object", "description": "A collection of data validation warnings for this business entity. Warnings indicate incomplete or potentially incorrect data and could prevent payroll processing.", "nullable": true, "properties": { "object": { "type": "string", "nullable": true }, "data": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "object": { "type": "string", "nullable": true }, "data": { "type": "object", "nullable": true, "properties": { "namespace": { "type": "string", "nullable": true }, "type": { "type": "string", "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 }, "available_tax_properties": { "type": "array", "description": "A list of Tax Property template identifiers supported for this business entity, based on its jurisdiction.", "nullable": true, "items": { "type": "string" } }, "effective_processing_speed": { "type": "string", "description": "The resolved processing speed after applying inheritance from the Partner if `processing_speed` is `inherit`.", "nullable": true }, "processing_speed": { "type": "string", "description": "The business entity-level processing speed setting. If set to `inherit`, the Partner's processing speed is used.", "enum": [ "five_day", "four_day", "inherit", "one_day", "three_day", "two_day" ] }, "has_bank_accounts": { "type": "boolean", "description": "Whether this business entity has any Bank Accounts configured." }, "has_pay_schedules": { "type": "boolean", "description": "Whether this business entity has any Pay Schedules configured." }, "has_payrolls": { "type": "boolean", "description": "Whether this business entity has any Payrolls." }, "current_tax_jurisdiction": { "type": "string", "description": "The current tax jurisdiction for the business entity, derived from its `ca::province_of_employment` Tax Property.", "nullable": true }, "ca_settings": { "type": "object", "description": "Canada-specific settings for this business entity. Only present for business entities with a Canadian address.", "nullable": true, "properties": { "roe_submission_setting": { "type": "string", "description": "Indicates whether Record of Employment (ROE) submissions are managed by Nmbr (`managed`) or by the employer directly (`manual`).", "nullable": true } } }, "accounting_settings": { "type": "object", "description": "Accounting-related settings for this business entity. New clients should read and write these through this object; the top-level `default_bank_accounting_code`, `default_payroll_payable_accounting_code`, `resolve_journal_entry_stat_withholdings`, and `primary_tag_group` fields are retained as aliases for backwards compatibility.", "nullable": true, "properties": { "default_bank_accounting_code": { "description": "The Accounting Code used as the default bank account row when generating journal entries." }, "default_payroll_payable_accounting_code": { "description": "The Accounting Code used as the default payroll payable row when generating journal entries." }, "resolve_journal_entry_stat_withholdings": { "type": "boolean", "description": "When `true`, statutory withholding line items (employee and employer) are split across tracking dimensions derived from their applicable source earnings. When `false`, each statutory withholding appears as a single unsplit row in journal entries." }, "primary_tag_group": { "description": "The Tag Group that drives default accounting-code resolution for line items. Setting this also flags the group as a journal entry dimension." }, "journal_entry_dimensions": { "type": "array", "description": "The Tag Groups whose tags are broken out as tracking dimensions on journal entries, up to three. The primary tag group is always one of them. Archived groups keep their place until they are removed from the collection.", "nullable": true, "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the object in Nmbr.", "readOnly": true, "maxLength": 32 }, "object": { "type": "string", "nullable": true }, "links": { "type": "object", "nullable": true, "properties": { "self": { "type": "string", "nullable": true } } } } } }, "block_approval_on_incomplete_journal_entries": { "type": "boolean", "description": "When `true`, payroll approval is blocked if any exportable journal entry row has no Accounting Code." }, "block_approval_on_missing_export_identifiers": { "type": "boolean", "description": "When `true`, payroll approval is blocked if any exportable journal entry row has no Accounting Code OR has one that lacks the enabled integration's external identifier." } } }, "default_bank_accounting_code": { "description": "This attribute is deprecated and will be removed.\n\nUse `accounting_settings.default_bank_accounting_code`.", "deprecated": true }, "default_payroll_payable_accounting_code": { "description": "This attribute is deprecated and will be removed.\n\nUse `accounting_settings.default_payroll_payable_accounting_code`.", "deprecated": true }, "preferred_locale": { "type": "string", "description": "The locale used for payroll communications sent to Employees and Contractors within this business entity. If not set, the Company's locale is used.", "nullable": true, "enum": [ "en", "fr" ] }, "hold_funding_for_verification": { "type": "boolean", "description": "When `true`, funding payments will be automatically held after settlement for verification. Downstream payments (employee, CRA, RQ) will not be processed until the funding payment hold is released." }, "resolve_journal_entry_stat_withholdings": { "type": "boolean", "description": "This attribute is deprecated and will be removed.\n\nUse `accounting_settings.resolve_journal_entry_stat_withholdings`.", "deprecated": true }, "primary_tag_group": { "description": "This attribute is deprecated and will be removed.\n\nUse `accounting_settings.primary_tag_group`.", "deprecated": 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" } } }, "BusinessEntityVerification": { "type": "object", "title": "Business Entity Verification", "properties": { "status": { "type": "string", "enum": [ "approved", "failed", "incomplete", "requested" ] }, "link_status": { "type": "string", "description": "How far the business got through the verification link shared with it. Scoped to that link, not the provider's overall profile, and carrying no verdict (the decision is on `status`). `not_started` (link shared but not completed), `in_progress` (submitted, not yet picked up), or `complete` (submitted and picked up for review, covers in-review and any terminal decision). `null` until a status is available.", "nullable": true, "maxLength": 255, "enum": [ "complete", "in_progress", "not_started" ] }, "link": { "type": "string", "nullable": true, "maxLength": 255 }, "external_id": { "type": "string", "nullable": true, "maxLength": 255 }, "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" } } }, "BusinessEntityRoeAuthorization": { "type": "object", "title": "Business Entity Roe Authorization", "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 } } }, "status": { "type": "string", "enum": [ "authorized", "processing", "unauthorized" ] }, "note": { "type": "string", "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" } } }, "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" } } }, "StatutoryHolidayPayExplanation": { "type": "object", "title": "Statutory Holiday Pay Explanation", "properties": { "not_applicable_reason": { "description": "A machine-readable code describing why no entitlement was computed (one of `contractor_pay_stub`, `not_enabled`, `no_province_of_work`, `payroll_not_supported`). `null` when entitlement was calculated." }, "jurisdiction": { "type": "string", "description": "The effective Province of Work (work assignment's POW with any `override_rule_set` applied) used to look up holidays and provincial rules, in `ca_xx` format (one of `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`, or `ca_federal`). `null` when no Province of Work could be resolved.", "nullable": true }, "configuration": { "type": "object", "description": "The Statutory Holiday Pay tax property configuration on the work assignment as of the start of the pay period, or the configuration override supplied in the request body. `null` when neither is present.", "nullable": true, "properties": { "calculate_entitlement": { "type": "boolean" }, "calculation_strategy": { "type": "string", "nullable": true }, "override_rule_set": {}, "override_date_basis": {}, "hours": {}, "pay_rate": {} } }, "default_rules": { "type": "array", "description": "The rules defined by the work assignment's own Province of Work (ignoring any `override_rule_set`). Describes what would apply by default.", "nullable": true, "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The rule's stable identifier (e.g. `regular_earnings`, `commission`). Used to cross-reference per-holiday calculations under `holidays[].entitlement.provincial_rules_calculation[].id`.", "nullable": true }, "name": { "type": "string", "description": "The translated human-readable name of the rule for the request locale.", "nullable": true }, "explanation": { "type": "string", "description": "A prose sentence describing how this rule computes the entitlement (e.g. \"The last 4 weeks of eligible earnings, ending the day before the holiday week begins, divided by 20.\").", "nullable": true }, "earning_date_basis": { "type": "string", "description": "Which calendar boundary the rule's look-back window ends on. One of `before_holiday_day`, `before_holiday_week`, or `before_holiday_pay_period`.", "nullable": true }, "eligible_days_in_range": { "type": "number", "description": "The width of the look-back window in calendar days (e.g. 28 for Ontario's 4-week window).", "nullable": true, "format": "decimal" }, "eligible_work_days_in_range": { "type": "number", "description": "The divisor used to convert the window's effective earnings into a per-holiday entitlement (e.g. 20 for Ontario).", "nullable": true, "format": "decimal" }, "eligible_earning_types": { "type": "array", "description": "Earning types that count toward this rule's look-back sum. Earnings of types not listed here are excluded.", "nullable": true, "items": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "object": { "type": "string", "nullable": true }, "data": { "type": "object", "nullable": true, "properties": { "type": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "supported_payroll_types": { "type": "object", "nullable": true, "properties": { "regular": { "type": "boolean" }, "historical": { "type": "boolean" }, "off_cycle": { "type": "boolean" } } } } }, "links": { "type": "object", "nullable": true, "properties": { "self": { "type": "string", "nullable": true } } } } } }, "eligible_allowance_types": { "type": "object", "description": "Allowance types that count toward this rule's look-back sum. Usually empty.", "nullable": true }, "eligible_reimbursement_types": { "type": "object", "description": "Reimbursement types that count toward this rule's look-back sum. Usually empty.", "nullable": true } } } }, "overridden_rules": { "description": "Only present when the configuration actually overrides something (either `override_rule_set` or `override_date_basis`). Describes the rules that are used in place of the defaults: sourced from the effective POW and with the overridden earning date basis applied to each rule's prose and `earning_date_basis` field. Each entry has the same shape as `default_rules`." }, "holidays": { "type": "array", "description": "One entry per statutory holiday observed in the pay period (or per `holiday_dates` entry when an override was supplied in the request).", "nullable": true, "items": { "type": "object", "properties": { "holiday": { "type": "object", "description": "The Holiday record being calculated against. `id` and timestamps are `null` for hypothetical holidays supplied via `holiday_dates`.", "nullable": true, "properties": { "id": { "type": "string", "nullable": true }, "object": { "type": "string", "nullable": true }, "data": { "type": "object", "nullable": true, "properties": { "jurisdiction": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "name_translations": { "type": "object", "nullable": true, "properties": { "en": { "type": "string", "nullable": true }, "fr": { "type": "string", "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 }, "original_date": { "type": "string", "nullable": true }, "observed_date": { "type": "string", "nullable": true }, "created_at": { "type": "string", "nullable": true }, "updated_at": { "type": "string", "nullable": true } } }, "links": { "type": "object", "nullable": true, "properties": { "self": { "type": "string", "nullable": true } } } } }, "line_item_id": { "description": "The id of the managed Statutory Holiday Pay earning line item on this pay stub that corresponds to this holiday. `null` when no managed line item exists yet (e.g. statutory holiday pay isn't enabled on the work assignment, the holiday was supplied as a hypothetical via `holiday_dates`, or the pay stub belongs to a Contractor)." }, "amount": { "type": "number", "description": "The dollar amount this pay stub allocates for the holiday: `gross_amount` less `already_allocated.amount`, floored at `0`. `0` when entitlement isn't being calculated (see `not_applicable_reason`).", "nullable": true, "format": "decimal" }, "hours": { "type": "number", "description": "The hours that form the basis of `amount`, on the same basis as the amount. `0` when entitlement isn't being calculated.", "nullable": true, "format": "decimal" }, "gross_amount": { "type": "number", "description": "The full dollar entitlement the employee is owed for this holiday, after applying the configuration's strategy and before netting off any statutory holiday pay already allocated on another pay stub. Equal to `amount` unless `already_allocated` is present.", "nullable": true, "format": "decimal" }, "gross_hours": { "type": "number", "description": "The hours that form the basis of `gross_amount`.", "nullable": true, "format": "decimal" }, "already_allocated": { "description": "Statutory holiday pay this work assignment has already been allocated for this holiday on a different pay stub covering the same pay period - typically the regular payroll an off-cycle payroll was created against. Entitlement is per employee per holiday, so only the remainder is allocated here. Only line items with `is_managed` `true` count, so statutory holiday pay added by hand isn't netted off. `null` when no other pay stub has allocated anything for the holiday." }, "entitlement": { "type": "object", "description": "The breakdown of how `amount` and `hours` were computed. `null` when entitlement isn't being calculated for this pay stub.", "nullable": true, "properties": { "fixed_hours_calculation": { "description": "The fixed-hours calculation result. Always populated under `hours_only` and `provincial_rules_or_hours` strategies; `null` under `provincial_rules_only`." }, "provincial_rules_calculation": { "type": "array", "description": "Per-rule results from the provincial calculator. Always populated under `provincial_rules_only` and `provincial_rules_or_hours`; `null` under `hours_only`. Most provinces have a single `regular_earnings` rule; Quebec splits earnings and commissions into separate rules.", "nullable": true, "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The rule's identifier (e.g. `regular_earnings`). Matches an entry in `default_rules` / `overridden_rules`.", "nullable": true }, "amount": { "type": "number", "description": "The entitlement this rule contributes to the holiday, computed as `totals.effective_amount \u00f7 eligible_work_days_in_range`.", "nullable": true, "format": "decimal" }, "hours": { "type": "number", "description": "The hours basis for this rule's contribution, on the same basis as `amount`.", "nullable": true, "format": "decimal" }, "eligible_date_range": { "type": "object", "description": "The look-back window for this rule, derived from the rule's `earning_date_basis` and `eligible_days_in_range`. Inclusive on both ends.", "nullable": true, "properties": { "start": { "type": "string", "nullable": true }, "end": { "type": "string", "nullable": true } } }, "totals": { "type": "object", "description": "Aggregated totals across every pay period that overlapped the look-back window, before dividing by the rule's `eligible_work_days_in_range`. `dated_*` fields sum line items whose `earned_on` date falls inside the window (included at 100%); `undated_*` fields sum line items without an `earned_on` (prorated by each pay period's coverage ratio); `effective_*` is `dated_*` plus `undated_*_prorated`.", "nullable": true, "properties": { "dated_amount": { "type": "number", "nullable": true, "format": "decimal" }, "dated_hours": { "type": "number", "nullable": true, "format": "decimal" }, "undated_amount": { "type": "number", "nullable": true, "format": "decimal" }, "undated_hours": { "type": "number", "nullable": true, "format": "decimal" }, "undated_amount_prorated": { "type": "number", "description": "`undated_amount` after applying each pay period's `undated_coverage_ratio`. This is the value that contributes to `effective_amount`.", "nullable": true, "format": "decimal" }, "undated_hours_prorated": { "type": "number", "description": "`undated_hours` after applying each pay period's `undated_coverage_ratio`.", "nullable": true, "format": "decimal" }, "effective_amount": { "type": "number", "description": "The numerator divided by `eligible_work_days_in_range` to produce the per-holiday `amount`. Equal to `dated_amount + undated_amount_prorated`.", "nullable": true, "format": "decimal" }, "effective_hours": { "type": "number", "description": "The numerator divided by `eligible_work_days_in_range` to produce the per-holiday `hours`. Equal to `dated_hours + undated_hours_prorated`.", "nullable": true, "format": "decimal" } } }, "payroll_summaries": { "type": "array", "description": "The per-payroll breakdown that produced `totals`. Each entry covers one paid prior payroll (or the current draft payroll) whose pay period overlapped the look-back window.", "nullable": true, "items": { "type": "object", "properties": { "payroll": { "type": "object", "description": "The Payroll being summarized.", "nullable": true, "properties": { "id": { "type": "string", "nullable": true }, "object": { "type": "string", "nullable": true }, "links": { "type": "object", "nullable": true, "properties": { "self": { "type": "string", "nullable": true } } } } }, "pay_period": { "type": "object", "description": "The pay period start/end dates for this payroll. Both inclusive.", "nullable": true, "properties": { "start": { "type": "string", "nullable": true }, "end": { "type": "string", "nullable": true } } }, "dated_amount_total": { "type": "number", "nullable": true, "format": "decimal" }, "dated_hours_total": { "type": "number", "nullable": true, "format": "decimal" }, "undated_amount_total": { "type": "number", "nullable": true, "format": "decimal" }, "undated_hours_total": { "type": "number", "nullable": true, "format": "decimal" }, "eligible_days_in_pay_period": { "type": "number", "description": "The number of calendar days from this pay period that fall inside the rule's `eligible_date_range`. The numerator of `undated_coverage_ratio`.", "nullable": true, "format": "decimal" }, "days_in_pay_period": { "type": "number", "description": "The total number of calendar days in this pay period. The denominator of `undated_coverage_ratio`.", "nullable": true, "format": "decimal" }, "undated_coverage_ratio": { "type": "number", "description": "The fraction of this pay period that overlaps the rule's `eligible_date_range`. Used to prorate the period's undated line items into the look-back sum.", "nullable": true, "format": "decimal" }, "undated_amount_prorated": { "type": "number", "nullable": true, "format": "decimal" }, "undated_hours_prorated": { "type": "number", "nullable": true, "format": "decimal" }, "effective_amount": { "type": "number", "nullable": true, "format": "decimal" }, "effective_hours": { "type": "number", "nullable": true, "format": "decimal" }, "earlier_holidays_amount": { "type": "number", "description": "For cascading provincial rules (e.g. Ontario, where Statutory Holiday Pay itself counts as eligible earnings), the sum of entitlements computed for earlier holidays in the current pay period that fall inside this rule's eligible date range. Always `0` for prior payrolls' summaries. Treated as additional dated earnings.", "nullable": true, "format": "decimal" }, "earlier_holidays_hours": { "type": "number", "description": "The hours equivalent of `earlier_holidays_amount`.", "nullable": true, "format": "decimal" }, "dated_line_items": { "type": "object", "description": "The line items from this pay period's pay stub that have an `earned_on` date. Each entry's `in_range` flag indicates whether the `earned_on` falls inside the rule's `eligible_date_range` and therefore counted toward `dated_amount` / `dated_hours`.", "nullable": true }, "undated_line_items": { "type": "array", "description": "The line items from this pay period's pay stub that have no `earned_on` date \u2014 they're assumed to be spread evenly across the period and contribute to `undated_amount` / `undated_hours` after proration by `undated_coverage_ratio`.", "nullable": true, "items": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "object": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "amount": { "type": "number", "nullable": true, "format": "decimal" }, "hours": { "type": "number", "nullable": true, "format": "decimal" } } } } } } } } } }, "chosen_method": { "type": "string", "description": "Which calculator produced the chosen amount. Either `provincial_rules` or `fixed_hours`. Under `provincial_rules_or_hours` this can differ per holiday \u2014 the engine picks whichever yields the larger entitlement.", "nullable": true } } } } } } } }, "Company": { "type": "object", "title": "Company", "properties": { "name": { "type": "string", "description": "The company's name." }, "pay_day_movement_setting": { "type": "string", "description": "The company-level setting for how pay dates are adjusted when they fall on a weekend or bank holiday. Inherited by Business Entities and Pay Schedules whose own setting is `inherit`.", "enum": [ "inherit", "next_business_day", "previous_business_day" ] }, "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 }, "preferred_locale": { "type": "string", "description": "The locale used for payroll communications sent to Employees and Contractors within this company. If not set, the Partner's locale is used.", "nullable": true, "enum": [ "en", "fr" ] }, "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" } } }, "Contractor": { "type": "object", "title": "Contractor", "properties": { "business_name": { "type": "string", "description": "The contractor's business or corporation name. `null` for individual contractors.", "nullable": true, "maxLength": 255 }, "first_name": { "type": "string", "description": "The contractor's first name. `null` for corporation contractors.", "nullable": true, "maxLength": 50 }, "last_name": { "type": "string", "description": "The contractor's last name. `null` for corporation contractors.", "nullable": true, "maxLength": 50 }, "middle_initial": { "type": "string", "description": "The contractor's middle initial. `null` for corporation contractors.", "nullable": true, "maxLength": 1 }, "email": { "type": "string", "description": "The contractor's email address, used for payroll communications.", "nullable": true, "maxLength": 255 }, "business_number": { "type": "string", "description": "The contractor's 15-character (BN15) Canada Revenue Agency (CRA) program account number, consisting of a 9-digit Business Number (BN), a 2-letter program identifier, and a 4-digit reference number. `null` for individual contractors. The 9-digit root begins with 1, 7, or 8 and carries a Luhn check digit; the reference number starts at 0001.", "nullable": true, "maxLength": 15 }, "sin_last_3": { "description": "The last 3 digits of the contractor's Social Insurance Number (SIN). `null` if no SIN has been provided." }, "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 }, "preferred_locale": { "type": "string", "description": "The locale used for payroll communications sent to this contractor, such as Pay Stub emails. If not set, the Company's locale is used.", "nullable": true, "enum": [ "en", "fr" ] }, "archived_at": { "type": "string", "description": "The date the contractor was archived. Archiving a contractor also archives all Work Assignments that are not already archived. Archived contractors do not appear in active listings.", "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" } } }, "Deduction": { "type": "object", "title": "Deduction", "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 } } }, "frequency": { "type": "string", "description": "The frequency at which this deduction is applied to Pay Stubs. When `per_month`, the amount is distributed across selected Payrolls in the calendar month. `per_month` is only valid when `amount_type` is `fixed`; percent and per-hour deductions apply to every paycheque regardless of frequency.", "enum": [ "once", "per_month", "per_payroll" ] }, "date_basis": { "type": "string", "description": "Which payroll date determines the calendar month for the allocation. Applies only to fixed-amount `per_month` deductions.", "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 fixed-amount `per_month` deductions.", "nullable": true }, "deduction_type": { "type": "object", "description": "The type of deduction, which determines how it is categorized and remitted.", "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 (`\"deduction_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/DeductionType" } } }, "amount": { "type": "number", "description": "The deduction amount per occurrence. When `amount_type` is `percent`, this is interpreted as a percentage of the income basis. When `fixed_per_hour`, it is multiplied by the hours on the Pay Stub's earning line items. Otherwise it is a fixed dollar amount.", "format": "decimal" }, "amount_type": { "type": "string", "description": "Whether `amount` is a fixed dollar value (`fixed`), a dollar value per hour worked (`fixed_per_hour`), or a percentage of the income basis (`percent`).", "enum": [ "fixed", "fixed_per_hour", "percent" ] }, "income_basis": { "type": "string", "description": "Determines the income used as the base for percentage-based deductions. `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 }, "income_subtractions": { "type": "object", "description": "An optional list of deductions and employee benefits to subtract from the income before the deduction amount is calculated.", "nullable": true }, "income_statutory_withholdings": { "type": "string", "description": "Whether to subtract statutory withholdings (CPP, EI, income tax) from the income before the deduction amount is calculated.", "enum": [ "all", "none" ] }, "income_exemption_amount": { "type": "number", "description": "A fixed dollar amount to exempt from the income before calculating the deduction.", "nullable": true, "format": "decimal" }, "income_exemption_percent": { "type": "number", "description": "A percentage of the income to exempt before calculating the deduction amount.", "nullable": true, "format": "decimal" }, "effective_from": { "type": "string", "description": "The date from which this deduction is applied to Pay Stubs.", "format": "date" }, "effective_to": { "type": "string", "description": "The date after which this deduction is no longer applied. `null` if the deduction applies indefinitely.", "nullable": true, "format": "date" }, "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 }, "remittance_account": {}, "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" } } }, "DeductionLineItem": { "type": "object", "title": "Deduction Line Item", "properties": { "pay_stub": { "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_stub\"`).", "readOnly": true } } }, "line_item_type": { "type": "string", "nullable": true }, "is_managed": { "type": "boolean", "description": "Whether this line item was generated by a Deduction recurrence and calculated automatically. When `true`, only `custom_amount` can be modified and the line item cannot be deleted." }, "amount": { "type": "number", "description": "The effective amount for this line item. Returns `custom_amount` if set, otherwise `managed_amount`. Read-only.", "nullable": true, "format": "decimal" }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.", "nullable": true, "format": "decimal" }, "managed_amount": { "type": "number", "description": "The amount calculated by the system or set by the linked Deduction recurrence. Read-only; set `custom_amount` to override.", "nullable": true, "format": "decimal" }, "deduction_type": { "type": "object", "description": "The type of deduction for this line item.", "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 (`\"deduction_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/DeductionType" } } }, "recurrence": {}, "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 }, "remittance_account": {}, "business_preset": {}, "source_adjustment": {}, "expense_accounting_code": { "description": "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." }, "managed_expense_accounting_code": { "description": "The expense accounting code derived by the system from accounting code rules and presets. Read-only." }, "custom_expense_accounting_code": { "description": "User-set expense accounting code that overrides the system-derived value." }, "liability_accounting_code": { "description": "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." }, "managed_liability_accounting_code": { "description": "The liability accounting code derived by the system from accounting code rules and presets. Read-only." }, "custom_liability_accounting_code": { "description": "User-set liability accounting code that overrides the system-derived value." }, "component_settings": { "type": "object", "description": "Settings specific to the Nmbr component.", "nullable": true, "properties": { "attributes_locked": { "type": "boolean", "description": "Whether the line item is locked and cannot be edited in the component." } } }, "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" } } }, "DeductionType": { "type": "object", "title": "Deduction Type", "properties": { "type": { "type": "string", "description": "The string identifier for this deduction type.", "nullable": true }, "label": { "type": "string", "description": "The human-readable display name for this deduction type.", "nullable": true }, "locale": { "type": "string", "nullable": true }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/LineItemTypeFeature" } }, "form_mappings": { "type": "array", "items": { "$ref": "#/components/schemas/LineItemFormMapping" } } } }, "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" } } }, "EarningLineItem": { "type": "object", "title": "Earning Line Item", "properties": { "pay_stub": { "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_stub\"`).", "readOnly": true } } }, "amount": { "type": "number", "description": "The effective amount for this line item. Returns `custom_amount` if set, otherwise `managed_amount`. Read-only.", "nullable": true, "format": "decimal" }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.", "nullable": true, "format": "decimal" }, "managed_amount": { "type": "number", "description": "The amount calculated by the system or set by the linked Earning or Pay Rate. Read-only; set `custom_amount` to override.", "format": "decimal" }, "is_managed": { "type": "boolean", "description": "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." }, "line_item_type": { "type": "string", "nullable": true }, "earning_type": { "type": "object", "description": "The type of earning for this line item.", "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" } } }, "hours": { "type": "number", "description": "The effective hours for this line item. Returns `custom_hours` if set, otherwise `managed_hours`. `null` if neither is set. Read-only.", "nullable": true, "format": "decimal" }, "managed_hours": { "type": "number", "description": "The default hours from the linked Pay Rate. Read-only; set `custom_hours` to override.", "nullable": true, "format": "decimal" }, "custom_hours": { "type": "number", "description": "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.", "nullable": true, "format": "decimal" }, "accrued_vacation_pay": { "type": "number", "description": "The vacation pay accrued on this line item, calculated based on the Work Assignment's Vacation Pay Settings.", "nullable": true, "format": "decimal" }, "recurrence": {}, "pay_rate": {}, "overtime_rate": {}, "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 }, "expense_accounting_code": { "description": "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." }, "managed_expense_accounting_code": { "description": "The expense accounting code derived by the system from accounting code rules and presets. Read-only." }, "custom_expense_accounting_code": { "description": "User-set expense accounting code that overrides the system-derived value." }, "liability_accounting_code": { "description": "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." }, "managed_liability_accounting_code": { "description": "The liability accounting code derived by the system from accounting code rules and presets. Read-only." }, "custom_liability_accounting_code": { "description": "User-set liability accounting code that overrides the system-derived value." }, "business_preset": {}, "source_adjustment": {}, "component_settings": { "type": "object", "description": "Settings specific to the Nmbr component.", "nullable": true, "properties": { "attributes_locked": { "type": "boolean", "description": "Whether the line item is locked and cannot be edited in the component." } } }, "earned_on": { "description": "The effective earned-on date for this line item. Returns `custom_earned_on` if set, otherwise `managed_earned_on`. Read-only." }, "managed_earned_on": { "type": "string", "description": "The earned-on date set by the system. Read-only; set `custom_earned_on` to override.", "nullable": true, "format": "date" }, "custom_earned_on": { "type": "string", "description": "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.", "nullable": true, "format": "date" }, "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" } } }, "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" } } } }, "EffectiveTaxProperty": { "type": "object", "title": "Effective Tax Property", "properties": { "type": { "type": "string", "description": "The type of tax property being resolved (e.g. `ca::province_of_work`). Always reflects the requested type, even when the value was inherited from a different type on a parent owner (e.g. POW resolved via a POE Tax Property).", "nullable": true }, "value": { "type": "string", "description": "The resolved value for this type as of the requested date, after applying the inheritance chain. `null` if no value exists anywhere in the chain (only present when filtering to a specific type that has no value).", "nullable": true }, "source_tax_property": { "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 (`\"tax_property\"`).", "readOnly": true } } } } }, "Employee": { "type": "object", "title": "Employee", "properties": { "company": { "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 (`\"company\"`).", "readOnly": true } } }, "employee_number": { "type": "string", "description": "An optional identifier for the employee within the partner's system, such as a badge number or HR system ID. Distinct from `id` and `external_ref`.", "nullable": true, "maxLength": 40 }, "first_name": { "type": "string", "description": "The employee's first name.", "maxLength": 50 }, "last_name": { "type": "string", "description": "The employee's last name.", "maxLength": 50 }, "middle_initial": { "type": "string", "description": "The employee's middle initial.", "nullable": true, "maxLength": 1 }, "personal_email": { "type": "string", "description": "The employee's personal email address, used as the primary address for payroll communications such as Pay Stub emails.", "nullable": true, "maxLength": 255 }, "work_email": { "type": "string", "description": "The employee's work email address. Used for payroll communications if `personal_email` is not set.", "nullable": true, "maxLength": 255 }, "address_line_1": { "type": "string", "description": "The first line of the employee's mailing address. Canada Revenue Agency forms (T4, RL-1) truncate this to the length those forms allow.", "nullable": true, "maxLength": 255 }, "address_line_2": { "type": "string", "description": "The second line of the employee's mailing address. Canada Revenue Agency forms (T4, RL-1) truncate this to the length those forms allow.", "nullable": true, "maxLength": 255 }, "city": { "type": "string", "description": "The city of the employee's mailing address.", "nullable": true, "maxLength": 255 }, "administrative_area": { "type": "string", "description": "The region of the employee's mailing address \u2014 the province, state, or county, depending on the country. For Canadian employees this is the Province of Residence (POR), not the Province of Employment (POE) or Province of Work (POW). POE and POW are configured via the Work Assignment's Tax Properties.", "nullable": true, "maxLength": 255 }, "province_code": { "type": "string", "description": "This attribute is deprecated and will be removed.\n\nA deprecated alias of `administrative_area` that mirrors its value. Use `administrative_area` instead.", "nullable": true, "deprecated": true }, "country_code": { "type": "string", "description": "The country code for the employee's mailing address.", "nullable": true, "maxLength": 2, "enum": [ "CA", "GB" ] }, "postal_code": { "type": "string", "description": "The postal code for the employee's mailing address.", "nullable": true, "maxLength": 10 }, "sin": { "type": "string", "description": "This attribute is deprecated and will be removed.\n\nThe employee's Social Insurance Number (SIN), used for tax reporting. 9 digits, sent as a string. Spaces and dashes are stripped before validation. The first digit cannot be 0 or 8, and the number must pass the Luhn checksum. Required before year-end forms can be filed correctly, but not required to create the employee or run a payroll.\n\nIf you only need the last 3 digits for display purposes, use `sin_last_3` instead. If you need the complete SIN, use the `/employees/:id/reveal` endpoint instead. Note the `/reveal` endpoint can only reveal one employee at a time and is rate-limited for security reasons.", "nullable": true, "deprecated": true }, "sin_last_3": { "type": "string", "description": "The last 3 digits of the employee's Social Insurance Number (SIN). `null` if no SIN has been provided.", "nullable": true }, "date_of_birth": { "type": "string", "description": "The employee's date of birth.", "nullable": true, "format": "date" }, "warnings": { "type": "object", "description": "A collection of data validation warnings for this employee. Warnings indicate incomplete or potentially incorrect data and could prevent payroll processing.", "nullable": true, "properties": { "object": { "type": "string", "nullable": true }, "data": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "object": { "type": "string", "nullable": true }, "data": { "type": "object", "nullable": true, "properties": { "namespace": { "type": "string", "nullable": true }, "type": { "type": "string", "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 }, "preferred_locale": { "type": "string", "description": "The locale used for payroll communications sent to this employee, such as Pay Stub emails. If not set, the Company's locale is used.", "nullable": true, "enum": [ "en", "fr" ] }, "archived_at": { "type": "string", "description": "The date the employee was archived. Archiving an employee also archives all Work Assignments that are not already archived. Archived employees do not appear in active listings.", "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" } } }, "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": "Which earlier contributions count toward `max_annual_contribution`. `this_benefit` counts only the contributions on line items created by this benefit earlier in the year. `all_line_items_of_type` counts every contribution of the same type on the Work Assignment earlier in the year, including those created by other benefits and those added directly to a Pay Stub.", "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" } } }, "EmployeeBenefitLineItem": { "type": "object", "title": "Employee Benefit Line Item", "properties": { "pay_stub": { "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_stub\"`).", "readOnly": true } } }, "line_item_type": { "type": "string", "nullable": true }, "is_managed": { "type": "boolean", "description": "Whether this line item was generated by an Employee Benefit recurrence and calculated automatically. When `true`, only `custom_amount` can be modified and the line item cannot be deleted." }, "amount": { "type": "number", "description": "The effective amount for this line item. Returns `custom_amount` if set, otherwise `managed_amount`. Read-only.", "nullable": true, "format": "decimal" }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.", "nullable": true, "format": "decimal" }, "managed_amount": { "type": "number", "description": "The amount calculated by the system or set by the linked Employee Benefit recurrence. Read-only; set `custom_amount` to override.", "nullable": true, "format": "decimal" }, "employee_benefit_type": { "type": "object", "description": "The type of Employee Benefit for this line item.", "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" } } }, "recurrence": {}, "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 }, "remittance_account_id": { "type": "string", "nullable": true, "maxLength": 32 }, "remittance_account": {}, "business_preset": {}, "source_adjustment": {}, "expense_accounting_code": { "description": "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." }, "managed_expense_accounting_code": { "description": "The expense accounting code derived by the system from accounting code rules and presets. Read-only." }, "custom_expense_accounting_code": { "description": "User-set expense accounting code that overrides the system-derived value." }, "liability_accounting_code": { "description": "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." }, "managed_liability_accounting_code": { "description": "The liability accounting code derived by the system from accounting code rules and presets. Read-only." }, "custom_liability_accounting_code": { "description": "User-set liability accounting code that overrides the system-derived value." }, "component_settings": { "type": "object", "description": "Settings specific to the Nmbr component.", "nullable": true, "properties": { "attributes_locked": { "type": "boolean", "description": "Whether the line item is locked and cannot be edited in the component." } } }, "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" } } } }, "EmployerBenefit": { "type": "object", "title": "Employer 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": {}, "employer_benefit_type": { "type": "object", "description": "The type of employer benefit, which determines how it is categorized 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 (`\"employer_benefit_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerBenefitType" } } }, "employee_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 }, "apply_sales_tax": { "type": "boolean", "description": "Whether provincial sales tax is applied to the benefit amount." }, "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 }, "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" }, "max_annual_contribution_basis": { "type": "string", "description": "Which earlier contributions count toward `max_annual_contribution`. `this_benefit` counts only the contributions on line items created by this benefit earlier in the year. `all_line_items_of_type` counts every contribution of the same type on the Work Assignment earlier in the year, including those created by other benefits and those added directly to a Pay Stub.", "enum": [ "all_line_items_of_type", "this_benefit" ] }, "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" } } }, "EmployerBenefitLineItem": { "type": "object", "title": "Employer Benefit Line Item", "properties": { "pay_stub": { "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_stub\"`).", "readOnly": true } } }, "line_item_type": { "type": "string", "nullable": true }, "is_managed": { "type": "boolean", "description": "Whether this line item was generated by an Employer Benefit recurrence and calculated automatically. When `true`, only `custom_amount` can be modified and the line item cannot be deleted." }, "amount": { "type": "number", "description": "The effective amount for this line item. Returns `custom_amount` if set, otherwise `managed_amount`. Read-only.", "nullable": true, "format": "decimal" }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.", "nullable": true, "format": "decimal" }, "managed_amount": { "type": "number", "description": "The amount calculated by the system or set by the linked Employer Benefit recurrence. Read-only; set `custom_amount` to override.", "nullable": true, "format": "decimal" }, "employer_benefit_type": { "type": "object", "description": "The type of Employer Benefit for this line item.", "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 (`\"employer_benefit_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerBenefitType" } } }, "recurrence": {}, "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 }, "remittance_account_id": { "type": "string", "nullable": true, "maxLength": 32 }, "remittance_account": {}, "business_preset": {}, "source_adjustment": {}, "expense_accounting_code": { "description": "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." }, "managed_expense_accounting_code": { "description": "The expense accounting code derived by the system from accounting code rules and presets. Read-only." }, "custom_expense_accounting_code": { "description": "User-set expense accounting code that overrides the system-derived value." }, "liability_accounting_code": { "description": "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." }, "managed_liability_accounting_code": { "description": "The liability accounting code derived by the system from accounting code rules and presets. Read-only." }, "custom_liability_accounting_code": { "description": "User-set liability accounting code that overrides the system-derived value." }, "component_settings": { "type": "object", "description": "Settings specific to the Nmbr component.", "nullable": true, "properties": { "attributes_locked": { "type": "boolean", "description": "Whether the line item is locked and cannot be edited in the component." } } }, "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" } } }, "EmployerBenefitType": { "type": "object", "title": "Employer Benefit Type", "properties": { "type": { "type": "string", "description": "The string identifier for this employer benefit type.", "nullable": true }, "label": { "type": "string", "description": "The human-readable display name for this employer benefit type.", "nullable": true }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/LineItemTypeFeature" } }, "form_mappings": { "type": "array", "items": { "$ref": "#/components/schemas/LineItemFormMapping" } } } }, "EmployerStatutoryWithholdingLineItem": { "type": "object", "title": "Employer Statutory Withholding Line Item", "properties": { "pay_stub": { "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_stub\"`).", "readOnly": true } } }, "line_item_type": { "type": "string", "nullable": true }, "is_system": { "type": "boolean", "description": "Whether this line item was generated automatically by the payroll engine." }, "is_managed": { "type": "boolean", "description": "Always `true`. Employer statutory withholding line items are fully managed by the payroll engine and cannot be created, updated, or deleted." }, "amount": { "type": "number", "description": "The effective amount for this line item. Returns `custom_amount` if set, otherwise `managed_amount`. Read-only.", "nullable": true, "format": "decimal" }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.", "nullable": true, "format": "decimal" }, "managed_amount": { "type": "number", "description": "The withholding amount calculated by the payroll engine. Read-only; set `custom_amount` to override.", "format": "decimal" }, "employer_statutory_withholding_type": { "type": "object", "description": "The type of employer statutory withholding for this line item.", "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 (`\"employer_statutory_withholding_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/EmployerStatutoryWithholdingType" } } }, "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 }, "remittance_account": { "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 (`\"remittance_account\"`).", "readOnly": true } } }, "source_adjustment": {}, "business_preset": { "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_preset\"`).", "readOnly": true } } }, "expense_accounting_code": { "description": "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." }, "managed_expense_accounting_code": { "description": "The expense accounting code derived by the system from accounting code rules and presets. Read-only." }, "custom_expense_accounting_code": { "description": "User-set expense accounting code that overrides the system-derived value." }, "liability_accounting_code": { "description": "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." }, "managed_liability_accounting_code": { "description": "The liability accounting code derived by the system from accounting code rules and presets. Read-only." }, "custom_liability_accounting_code": { "description": "User-set liability accounting code that overrides the system-derived value." }, "component_settings": { "type": "object", "description": "Settings specific to the Nmbr component.", "nullable": true, "properties": { "attributes_locked": { "type": "boolean", "description": "Whether the line item is locked and cannot be edited in the component." } } }, "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" } } }, "EmployerStatutoryWithholdingType": { "type": "object", "title": "Employer Statutory Withholding Type", "properties": { "type": { "type": "string", "description": "The string identifier for this employer statutory withholding type.", "nullable": true }, "label": { "type": "string", "description": "The human-readable display name for this employer statutory withholding type.", "nullable": true } } }, "Form": { "type": "object", "title": "Form", "properties": { "owner": { "type": "object", "description": "The owner of this form. Can be a Work Assignment, Employee, or Contractor.", "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 } } }, "form_batch": { "description": "The Form Batch this form belongs to, if any." }, "stage": { "type": "string", "description": "The lifecycle stage of this form: original, amendment, or cancellation.", "enum": [ "amendment", "cancellation", "original" ] }, "note": { "type": "string", "description": "An optional note for this form.", "nullable": true }, "type": { "type": "string", "description": "The type of form (e.g. T4, ROE, RL-1).", "maxLength": 255, "enum": [ "rl1", "roe", "t4", "t4a", "td1", "td1ab", "td1bc", "td1mb", "td1nb", "td1nl", "td1ns", "td1nt", "td1nu", "td1on", "td1pe", "td1sk", "td1x", "td1yt", "tp_1015_3_v", "tp_1015_r_13_v" ] }, "effective_date": { "type": "string", "description": "The effective date used to determine the form variant (e.g. the T4 tax year).", "format": "date" }, "version_year": { "type": "string", "description": "The form variant's version year. New versions are typically released in January. Note: the version year may differ from the tax year. For example, income earned in the 2025 tax year is typically reported on a 2026 version of the T4.", "nullable": true }, "version_month": { "type": "string", "description": "The month component of the form variant, for forms with monthly variants. `null` for annual forms.", "nullable": true }, "validation_error_count": { "type": "number", "description": "The number of validation errors currently present in the form's fields.", "nullable": true, "format": "decimal" }, "is_editable": { "type": "boolean", "description": "Whether the form can be edited.\n\nWhether the form can currently be modified." }, "line_1_basic_personal_amount": {}, "line_2_infirm_children_caregiver_amount": {}, "line_3_age_amount": {}, "line_4_pension_income_amount": {}, "line_5_tuition": {}, "line_6_disability_amount": {}, "line_7_spouse_or_common_law_partner_amount": {}, "line_8_eligible_dependent_amount": {}, "line_9_infirm_dependent_caregiver_amount": {}, "line_10_dependent_caregiver_amount": {}, "line_11_spouse_or_common_law_transfer_amount": {}, "line_12_dependent_transfer_amount": {}, "line_13_total_claim_amount": {}, "more_than_one_employer_or_payer": {}, "total_income_less_than_total_claim_amount": {}, "ninety_percent_world_income_taxable_income": {}, "prescribed_zone_deduction": {}, "additional_tax_deduction": {}, "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" } } }, "FormBatch": { "type": "object", "title": "Form Batch", "properties": { "owner": { "type": "object", "description": "The owner of this form batch. Currently always a Business Entity.", "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 } } }, "form_type": { "type": "string", "description": "The type of Forms in this batch (e.g. T4, RL-1).", "maxLength": 255, "enum": [ "rl1", "roe", "t4", "t4a", "td1", "td1ab", "td1bc", "td1mb", "td1nb", "td1nl", "td1ns", "td1nt", "td1nu", "td1on", "td1pe", "td1sk", "td1x", "td1yt", "tp_1015_3_v", "tp_1015_r_13_v" ] }, "form_stage": { "type": "string", "description": "The lifecycle stage of the Forms in this batch: original, amendment, or cancellation.", "enum": [ "amendment", "cancellation", "original" ] }, "effective_date": { "type": "string", "description": "The effective date used to determine the form variant for all Forms in this batch.", "format": "date" }, "status": { "type": "string", "description": "The submission status of this batch.", "enum": [ "done", "draft", "processing", "submitted" ] }, "contact_name": { "type": "string", "description": "The name of the contact person responsible for this submission.", "maxLength": 255 }, "contact_email": { "type": "string", "description": "The email address of the contact person.", "maxLength": 255 }, "contact_area_code": { "type": "string", "description": "The 3-digit area code of the contact's phone number.", "maxLength": 255 }, "contact_phone_number": { "type": "string", "description": "The 7-digit phone number of the contact.", "maxLength": 255 }, "contact_extension": { "type": "string", "description": "The optional extension for the contact's phone number.", "nullable": true, "maxLength": 255 }, "note": { "type": "string", "description": "An optional note for this form batch.", "nullable": true }, "metadata": { "type": "object", "description": "Form-type-specific metadata for this batch. Structure varies by form type.", "nullable": true, "properties": { "counts": { "type": "object", "nullable": true, "properties": { "total": { "type": "number", "nullable": true, "format": "decimal" }, "valid": { "type": "number", "nullable": true, "format": "decimal" }, "invalid": { "type": "number", "nullable": true, "format": "decimal" }, "draft": { "type": "number", "nullable": true, "format": "decimal" }, "approved": { "type": "number", "nullable": true, "format": "decimal" }, "processing": { "type": "number", "nullable": true, "format": "decimal" }, "submitted": { "type": "number", "nullable": true, "format": "decimal" }, "done": { "type": "number", "nullable": true, "format": "decimal" }, "rejected": { "type": "number", "nullable": true, "format": "decimal" } } }, "flags": { "type": "object", "nullable": true, "properties": { "is_submittable": { "type": "boolean" } } }, "timestamps": { "type": "object", "nullable": true, "properties": { "submitted_at": { "type": "string", "readOnly": true, "nullable": true, "format": "dateTime" }, "completed_at": { "type": "string", "readOnly": true, "nullable": true, "format": "dateTime" } } }, "identifiers": { "type": "object", "nullable": true, "properties": { "confirmation_number": { "type": "string", "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" } } }, "FormType": { "type": "object", "title": "Form Type", "properties": { "type": { "type": "string", "description": "The string identifier for this form type.", "nullable": true, "enum": [ "rl1", "roe", "t4", "t4a", "td1", "td1ab", "td1bc", "td1mb", "td1nb", "td1nl", "td1ns", "td1nt", "td1nu", "td1on", "td1pe", "td1sk", "td1x", "td1yt", "tp_1015_3_v", "tp_1015_r_13_v" ] }, "label": { "type": "string", "description": "The human-readable display name for this form type.", "nullable": true }, "version_year": { "type": "number", "nullable": true, "format": "decimal" }, "version_month": { "type": "string", "nullable": true }, "owner_types": { "type": "array", "description": "The owner types that can have forms of this type.", "nullable": true, "items": { "type": "string" } }, "exportable_as": { "type": "object", "nullable": true }, "supports_population": { "type": "boolean" }, "supports_generation": { "type": "boolean" }, "fields": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true, "enum": [ "rl1", "roe", "t4", "t4a", "td1", "td1ab", "td1bc", "td1mb", "td1nb", "td1nl", "td1ns", "td1nt", "td1nu", "td1on", "td1pe", "td1sk", "td1x", "td1yt", "tp_1015_3_v", "tp_1015_r_13_v" ] }, "required": { "type": "boolean" }, "readonly": { "type": "boolean" } } } } } }, "Holiday": { "type": "object", "title": "Holiday", "properties": { "jurisdiction": { "type": "string", "nullable": true }, "type": { "type": "string", "enum": [ "bank", "statutory" ] }, "name": { "type": "string", "nullable": true }, "name_translations": { "type": "object", "nullable": true, "properties": { "en": { "type": "string", "nullable": true }, "fr": { "type": "string", "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 }, "original_date": { "type": "string", "format": "date" }, "observed_date": { "type": "string", "format": "date" }, "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" } } }, "Integration": { "type": "object", "title": "Integration", "properties": { "label": { "type": "string", "nullable": true }, "is_enabled": { "type": "boolean" }, "type": { "type": "string", "nullable": true } } }, "TrackingDimension": { "type": "object", "title": "Tracking Dimension", "properties": { "label": { "type": "string", "nullable": true }, "type": { "type": "string", "description": "Provider dimension family the row belongs to: `class`, `department` or `project` for QuickBooks, `tracking_category` for Xero.", "nullable": true } } }, "JournalEntry": { "type": "object", "title": "Journal Entry", "properties": { "type": { "type": "string", "description": "The type of journal entry (e.g. payroll recording, payroll payment).", "enum": [ "pay_stub_recording", "payroll_payment", "payroll_recording" ] }, "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 }, "payroll": { "type": "object", "description": "The Payroll this journal entry 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 (`\"payroll\"`).", "readOnly": true } } }, "pay_stub": { "description": "The Pay Stub this journal entry belongs to. Present only for Pay Stub-level journal entries." }, "is_balanced": { "type": "boolean", "description": "Whether the journal entry is balanced (total debits equal total credits)." }, "total": { "type": "number", "description": "The total amount for this journal entry.", "nullable": true, "format": "decimal" }, "is_missing_line_item_accounting_codes": { "type": "integer", "description": "Whether any rows in this journal entry are missing an Accounting Code assignment.", "maxLength": 1 }, "is_missing_default_account_payable": { "type": "integer", "description": "Whether the accounts payable row is missing an Accounting Code.", "maxLength": 1 }, "is_missing_default_bank_account": { "type": "integer", "description": "Whether the bank row is missing an Accounting Code.", "maxLength": 1 }, "posted_on": { "type": "string", "description": "The date this journal entry was posted to the accounting system.", "nullable": true, "format": "date" }, "invalid_expense_types": { "type": "object", "description": "Line Item type/subtype pairs that are missing an expense Accounting Code. Each entry contains `type` and `subtype`.", "nullable": true }, "invalid_liability_types": { "type": "object", "description": "Line Item type/subtype pairs that are missing a liability Accounting Code. Each entry contains `type` and `subtype`.", "nullable": true }, "integrations": { "type": "object", "description": "External integration references. Contains `xero` and `quickbooks` objects, each with a `reference` field holding the external ID if synced.", "nullable": true, "properties": { "quickbooks": { "type": "object", "nullable": true, "properties": { "reference": {} } }, "xero": { "type": "object", "nullable": true, "properties": { "reference": {} } } } }, "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" } } }, "OvertimeRate": { "type": "object", "title": "Overtime Rate", "properties": { "pay_rate": { "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_rate\"`).", "readOnly": true } } }, "title": { "type": "string", "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 }, "rate_multiplier": { "type": "number", "nullable": true, "format": "decimal" }, "hourly_rate": { "type": "number", "nullable": true, "format": "decimal" }, "hourly_rate_override": { "type": "number", "nullable": true, "format": "decimal" }, "business_preset": {}, "expense_accounting_code": {}, "liability_accounting_code": {}, "archived_at": { "type": "string", "description": "The date and time the object was archived in Nmbr.", "readOnly": true, "nullable": true, "format": "dateTime" }, "is_editable": { "type": "boolean", "description": "After a PayRate is on a non-draft payroll, its Type and Rate may not be updated." }, "is_deletable": { "type": "boolean", "description": "After a PayRate is on a non-draft payroll, it may not be deleted." }, "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" } } }, "Partner": { "type": "object", "title": "Partner", "properties": { "name": { "type": "string" }, "preferred_locale": { "type": "string", "enum": [ "en", "fr" ] }, "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" } } }, "PayRate": { "type": "object", "title": "Pay Rate", "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 } } }, "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 }, "type": { "type": "string", "description": "Whether this is a `salary` or `hourly` pay rate. Determines how `rate` is interpreted.", "enum": [ "hourly", "salary" ] }, "rate": { "type": "number", "description": "The annual salary when `type` is `salary`, or the hourly wage when `type` is `hourly`.", "format": "decimal" }, "expected_hours_per_week": { "type": "number", "description": "The expected number of working hours per week. Must be greater than `0` for `salary` pay rates. Used to calculate the equivalent hourly rate from salaries for overtime.", "format": "decimal" }, "is_editable": { "type": "boolean", "description": "Whether the pay rate's `type`, `rate`, and `effective_from` can be modified. Once the pay rate has been used on a non-draft Payroll, these fields are locked." }, "is_deletable": { "type": "boolean", "description": "Whether the pay rate can be deleted. A pay rate may not be deleted once it has been used on a non-draft Payroll." }, "effective_from": { "type": "string", "description": "The date from which this pay rate is applied to Pay Stubs.", "format": "date" }, "earliest_valid_effective_to": { "type": "string", "description": "The earliest date that `effective_to` may be set to, based on the most recent non-draft Payroll period in which this pay rate was active.", "format": "date" }, "effective_to": { "type": "string", "description": "The date after which this pay rate is no longer applied and can no longer be used to create Earning Line Items. `null` if the pay rate 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" } } }, "PaySchedule": { "type": "object", "title": "Pay Schedule", "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 } } }, "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 }, "pay_frequency": { "type": "string", "description": "The frequency at which Payrolls are processed. Use `custom` for non-standard schedules where the number of pay periods per year is specified manually.", "enum": [ "bi-weekly", "custom", "monthly", "semi-monthly", "weekly" ] }, "anchor_pay_date": { "type": "string", "description": "The pay date of the anchor pay period. Together with `anchor_end_of_pay_period`, this establishes the pattern from which all future pay dates are calculated.", "nullable": true, "format": "date" }, "anchor_start_of_pay_period": { "type": "string", "description": "The start date of the anchor pay period. Only required for semi-monthly pay schedules when `anchor_end_of_pay_period` is not the 15th or the last day of the month. For standard configurations it is derived automatically and does not need to be supplied.", "nullable": true, "format": "date" }, "anchor_end_of_pay_period": { "type": "string", "description": "The end date of the anchor pay period. Together with `anchor_pay_date`, this defines the length and pattern of all future pay periods.", "nullable": true, "format": "date" }, "generate_payrolls_from": { "type": "string", "description": "Only available in preview mode. When set, Payrolls are generated starting from this date rather than the default, allowing historical Payrolls to be created before the current date.", "nullable": true, "format": "date" }, "day_1": { "type": "integer", "description": "For monthly pay schedules, the day of the month on which pay is issued. For semi-monthly pay schedules, the first of two pay days per month.", "nullable": true }, "day_2": { "type": "integer", "description": "For semi-monthly pay schedules, the second of two pay days per month.", "nullable": true }, "pay_day_movement_setting": { "type": "string", "description": "The pay schedule-level setting for how pay dates are adjusted when they fall on a weekend or bank holiday. If set to `inherit`, the Business Entity's setting is used.", "enum": [ "inherit", "next_business_day", "previous_business_day" ] }, "send_empty_pay_stubs": { "type": "boolean", "description": "Whether Pay Stubs are generated for employees with no earnings in a given pay period." }, "pay_stub_settings": { "type": "object", "description": "Settings that control Pay Stub display. The `show_vacation_pay_balance` field, when `true`, causes the employee's current Vacation Pay balance to appear on Pay Stubs.", "nullable": true, "properties": { "show_vacation_pay_balance": { "type": "boolean" } } }, "custom_pay_periods_per_year": { "type": "integer", "description": "When `pay_frequency` is `custom`, the number of pay periods per year.", "nullable": true }, "is_editable": { "type": "boolean", "description": "Whether the pay schedule's configuration can be edited. A pay schedule becomes non-editable once any of its Payrolls have been approved or paid. When `false`, only the `title` field may be updated." }, "is_deletable": { "type": "boolean", "description": "Whether the pay schedule can be deleted. A pay schedule may not be deleted once any of its Payrolls have been approved or paid. In preview mode, any pay schedule may be deleted." }, "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" } } }, "PaySplit": { "type": "object", "title": "Pay Split", "properties": { "employee": { "type": "object", "description": "The Employee who owns this pay split. Present only for Employee pay splits.", "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 } } }, "type": { "type": "string", "description": "The split strategy. `amount` sends fixed dollar amounts in priority order with the last configured Bank Account receiving the remaining balance. `percentage` distributes by percentage; percentage must total 100% across all accounts.", "enum": [ "amount", "percentage" ] }, "title": { "type": "string", "description": "A label for this pay split configuration.", "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 }, "is_default": { "type": "boolean", "description": "Whether this is the default pay split for the Employee or Contractor." }, "priority_1_bank_account": { "type": "object", "description": "The first priority Bank Account.", "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 (`\"bank_account\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/BankAccount" } } }, "priority_1_amount": { "type": "number", "description": "The amount or percentage allocated to the first priority Bank Account.", "format": "decimal" }, "priority_2_bank_account": { "type": "object", "description": "The second priority Bank Account.", "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 (`\"bank_account\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/BankAccount" } } }, "priority_2_amount": { "type": "number", "description": "The amount or percentage for the second priority Bank Account. For `amount`-type splits, set to `null` if this is the last account (receives the remainder).", "nullable": true, "format": "decimal" }, "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" } } }, "PayStub": { "type": "object", "title": "Pay Stub", "properties": { "payroll": { "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 (`\"payroll\"`).", "readOnly": true } } }, "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 } } }, "payment_method": { "type": "string", "description": "The payment method for this pay stub.", "enum": [ "direct_deposit", "manual", "pad", "wire" ] }, "has_taxes_calculated": { "type": "boolean", "description": "Whether tax amounts have been calculated for this pay stub. When `false`, amounts in the `employee_summary` and `company_summary` may be incomplete." }, "is_pending_tax_rates": { "type": "boolean", "description": "This attribute is deprecated and will be removed.", "deprecated": true }, "employee_summary": { "type": "object", "description": "A summary of pay for the Employee associated with this pay stub. Both `employee_summary` and `contractor_summary` are always present. The summary that does not apply is empty rather than omitted, and its amounts may be `null` before summaries are calculated. For calculated summaries, the side with a non-null `net` is the populated summary. `*_ytd` fields contain year-to-date totals inclusive of this pay period.", "nullable": true, "properties": { "gross": { "type": "number", "description": "The sum of all earnings and allowances.", "nullable": true, "format": "decimal" }, "subtractions": { "type": "number", "description": "The total of all deductions, taxes, and benefit contributions.", "nullable": true, "format": "decimal" }, "reimbursements": { "type": "number", "description": "The total of non-taxable reimbursements.", "nullable": true, "format": "decimal" }, "net": { "type": "number", "description": "The Employee net pay; when negative, a warning is included.", "nullable": true, "format": "decimal" }, "gross_ytd": { "type": "number", "nullable": true, "format": "decimal" }, "subtractions_ytd": { "type": "number", "nullable": true, "format": "decimal" }, "reimbursements_ytd": { "type": "number", "nullable": true, "format": "decimal" }, "net_ytd": { "type": "number", "nullable": true, "format": "decimal" } } }, "contractor_summary": { "type": "object", "description": "A summary of pay for the Contractor associated with this pay stub. Always present. For calculated summaries, a non-null `contractor_summary.net` means the contractor summary is populated. `*_ytd` fields contain year-to-date totals inclusive of this pay period.", "nullable": true, "properties": { "gross": { "description": "The sum of all earnings." }, "reimbursements": { "description": "The total of non-taxable reimbursements." }, "net": { "description": "The Contractor net pay." }, "gross_ytd": { "type": "number", "nullable": true, "format": "decimal" }, "reimbursements_ytd": { "type": "number", "nullable": true, "format": "decimal" }, "net_ytd": { "type": "number", "nullable": true, "format": "decimal" } } }, "company_summary": { "type": "object", "description": "A summary of the company's obligations for this pay stub. `*_ytd` fields contain year-to-date totals inclusive of this pay period.", "nullable": true, "properties": { "taxes_and_contributions": { "type": "number", "description": "The employer share of statutory remittances (CPP and EI).", "nullable": true, "format": "decimal" }, "benefits": { "type": "number", "description": "The total of employer benefit contributions.", "nullable": true, "format": "decimal" }, "total": { "type": "number", "description": "The company's total obligations.", "nullable": true, "format": "decimal" }, "taxes_and_contributions_ytd": { "type": "number", "nullable": true, "format": "decimal" }, "benefits_ytd": { "type": "number", "nullable": true, "format": "decimal" }, "total_ytd": { "type": "number", "nullable": true, "format": "decimal" } } }, "vacation_pay_balance": { "type": "number", "description": "The Employee's Vacation Pay balance as of the end of this pay period. `null` for Contractor pay stubs.", "nullable": true, "format": "decimal" }, "liability": { "type": "number", "description": "The total amount owed by the company for this pay stub, including Employee or Contractor net pay, employer tax contributions, and employer benefit contributions.", "nullable": true, "format": "decimal" }, "cash_requirement": { "type": "number", "description": "The total amount that will be debited from the company's account for this pay stub when the Payroll is approved.", "nullable": true, "format": "decimal" }, "note": { "type": "string", "description": "An optional note on the pay stub, visible to the partner.", "nullable": true }, "line_item_summary": { "type": "object", "description": "Totals grouped by line item category for this pay stub. Each category includes a `period` total for the current pay period and a `ytd` total for the calendar year to date. Categories: `earnings`, `statutory_withholdings`, `reimbursements`, `allowances`, `employee_benefits`, `employer_benefits`, `deductions`.", "nullable": true, "properties": { "earnings": { "type": "object", "nullable": true, "properties": { "period": { "type": "number", "nullable": true, "format": "decimal" }, "period_managed": { "type": "number", "nullable": true, "format": "decimal" }, "period_unmanaged": { "type": "number", "nullable": true, "format": "decimal" }, "ytd": { "type": "number", "nullable": true, "format": "decimal" } } }, "statutory_withholdings": { "type": "object", "nullable": true, "properties": { "period": { "type": "number", "nullable": true, "format": "decimal" }, "ytd": { "type": "number", "nullable": true, "format": "decimal" } } }, "reimbursements": { "type": "object", "nullable": true, "properties": { "period": { "type": "number", "nullable": true, "format": "decimal" }, "ytd": { "type": "number", "nullable": true, "format": "decimal" } } }, "allowances": { "type": "object", "nullable": true, "properties": { "period": { "type": "number", "nullable": true, "format": "decimal" }, "ytd": { "type": "number", "nullable": true, "format": "decimal" } } }, "benefits": { "type": "object", "nullable": true, "properties": { "period": { "type": "number", "nullable": true, "format": "decimal" }, "ytd": { "type": "number", "nullable": true, "format": "decimal" } } }, "employee_benefits": { "type": "object", "nullable": true, "properties": { "period": { "type": "number", "nullable": true, "format": "decimal" }, "ytd": { "type": "number", "nullable": true, "format": "decimal" } } }, "employer_benefits": { "type": "object", "nullable": true, "properties": { "period": { "type": "number", "nullable": true, "format": "decimal" }, "ytd": { "type": "number", "nullable": true, "format": "decimal" } } }, "deductions": { "type": "object", "nullable": true, "properties": { "period": { "type": "number", "nullable": true, "format": "decimal" }, "ytd": { "type": "number", "nullable": true, "format": "decimal" } } } } }, "is_stale": { "type": "boolean", "description": "Whether the pay stub's tax calculations are out of date. When `true`, `stale_since` indicates when the pay stub became stale." }, "stale_since": { "type": "string", "description": "The timestamp at which the pay stub's tax calculations became stale and need to be recalculated. `null` if the pay stub is up to date.", "readOnly": true, "nullable": true, "format": "dateTime" }, "warnings": { "type": "object", "description": "A collection of data validation warnings for this pay stub. Warnings indicate incomplete or potentially incorrect data and could prevent payroll processing.", "nullable": true, "properties": { "object": { "type": "string", "nullable": true }, "data": { "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 }, "apply_standard_tax_reductions": { "type": "boolean", "description": "When `true`, the standard tax reductions are applied to this pay stub's withholdings even in cases where they would otherwise be skipped to avoid applying them twice across related runs in the same period. In Canada these reductions are the employee's federal and provincial personal tax credits (their TD1 claim amounts) and the CPP/QPP basic exemption. Defaults to `false`, and has no effect where those reductions already apply." }, "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" } } }, "Payment": { "type": "object", "title": "Payment", "properties": { "payroll": { "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 (`\"payroll\"`).", "readOnly": true } } }, "remittance_account": {}, "destination": { "type": "string", "description": "Where the payment is destined. `payroll_float` is the funding debit from the employer's bank account. `employee` is a credit to an employee or contractor. `cra` and `rq` are remittances to the Canada Revenue Agency (CRA) and Revenu Qu\u00e9bec (RQ), respectively.\n\nWhere the payment is destined. For example, `employee` for payments to employees, `cra` for remittances to CRA, `payroll_float` for business funding.", "enum": [ "bill_pay", "cra", "employee", "internal", "no_op", "payroll_float", "rq" ] }, "method": { "type": "string", "description": "How the payment will be processed. `pad` (Pre-Authorized Debit) is used for employer funding. `direct_deposit` is used for employee credits. `manual` indicates the payment is handled outside of Nmbr.\n\nHow the payment will be processed. For example, `direct_deposit` or `pad`.", "enum": [ "direct_deposit", "manual", "pad", "wire" ] }, "amount": { "type": "number", "description": "The dollar amount of the payment.", "format": "decimal" }, "status": { "type": "string", "description": "The current processing status of the payment. Payments begin as `pending`, move to `processing` when submitted to the banking network, and settle as `paid` or `failed`. Held payments that pass their processing date become `overdue`.", "enum": [ "canceled", "failed", "overdue", "paid", "pending", "processing" ] }, "process_at": { "type": "string", "description": "The date on which Nmbr will submit the payment to the banking network for processing.", "nullable": true, "format": "date" }, "expected_at": { "type": "string", "description": "The date on which the payment is expected to arrive at its destination.", "format": "date" }, "is_impacted_by_weekend_or_holiday": { "type": "boolean", "description": "Whether the payment dates have been adjusted due to a weekend or bank holiday.\n\nWhether the payment dates have been adjusted due to a weekend or bank holiday." }, "is_held": { "type": "boolean", "description": "Whether the payment is currently held. A held payment will not be submitted for processing until it is released." }, "held_at": { "type": "string", "description": "The timestamp when the payment was placed on hold. `null` if the payment is not held.\n\nThe timestamp when the payment was placed on hold. `null` if the payment is not held.", "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" } } }, "Payroll": { "type": "object", "title": "Payroll", "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 } } }, "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 } } }, "type": { "type": "string", "description": "The type of payroll. `regular` payrolls are generated automatically on the Pay Schedule. `off_cycle` Payrolls are created manually against a source regular payroll. `historical` and `correction` payrolls are used to record or correct prior periods.", "enum": [ "correction", "historical", "off_cycle", "regular" ] }, "period_number": { "type": "integer", "description": "The sequential number of this pay period within the calendar year of its `pay_date`, counting only regular payrolls. `null` for off-cycle, historical, and correction payrolls.", "nullable": true }, "period_label": { "type": "string", "description": "A human-readable label for this pay period.", "nullable": true }, "period_start": { "type": "string", "description": "The start date of the pay period.", "format": "date" }, "period_end": { "type": "string", "description": "The end date of the pay period.", "format": "date" }, "pay_date": { "type": "string", "description": "The date on which Employees and Contractors are paid.", "format": "date" }, "original_pay_date": { "type": "string", "description": "For payrolls on a custom-frequency Pay Schedule, the originally scheduled pay date before any movement for weekends or bank holidays. Used for year-to-date calculations and tax year assignment.", "nullable": true, "format": "date" }, "debit_date": { "type": "string", "description": "The expected date the company's account will be debited the `cash_requirement` amount.", "nullable": true }, "approval_due_at": { "type": "string", "description": "The date and time, in UTC, by which the payroll must be approved to be processed on time.", "readOnly": true, "nullable": true, "format": "dateTime" }, "regular_periods_count": { "type": "integer", "description": "The total number of regular pay periods in this Pay Schedule whose `pay_date` falls in the same calendar year as this payroll's `pay_date`. Used for year-to-date calculations.", "nullable": true }, "is_impacted_by_weekend_or_holiday": { "type": "boolean", "description": "Whether `pay_date` or `approval_due_at` has been moved to avoid falling on a weekend or bank holiday." }, "is_blocked_by_draft": { "type": "boolean", "description": "Whether this payroll is blocked from being approved because an earlier payroll on the same Pay Schedule is still in draft status." }, "note": { "type": "string", "description": "An optional note on the payroll, visible to the partner.", "nullable": true }, "employee_summary": { "type": "object", "description": "A summary of pay across all Employees in this payroll.", "nullable": true, "properties": { "gross": { "description": "The sum of all earnings and allowances." }, "subtractions": { "description": "The total of all deductions, taxes, and benefit contributions." }, "reimbursements": { "description": "The total of non-taxable reimbursements." }, "net": { "description": "The Employee net pay; when negative, a warning is included." } } }, "contractor_summary": { "type": "object", "description": "A summary of pay across all Contractors in this payroll.", "nullable": true, "properties": { "gross": { "description": "The sum of all earnings." }, "reimbursements": { "description": "The total of non-taxable reimbursements." }, "net": { "description": "The Contractor net pay." } } }, "company_summary": { "type": "object", "description": "A summary of the company's obligations in this payroll.", "nullable": true, "properties": { "taxes_and_contributions": { "description": "The employer share of statutory remittances (CPP and EI)." }, "benefits": { "description": "The total of employer benefit contributions." }, "total": { "description": "The company's total obligations." } } }, "liability": { "type": "number", "description": "The total amount owed by the company for this payroll, including Employee and Contractor net pay, employer tax contributions, and employer benefit contributions.", "nullable": true, "format": "decimal" }, "cash_requirement": { "type": "number", "description": "The total amount that will be debited from the company's account when this payroll is approved.", "nullable": true, "format": "decimal" }, "status": { "type": "string", "description": "The current status of the payroll.", "enum": [ "approved", "draft", "failed", "paid", "partially_paid", "processing" ] }, "approved_at": { "type": "string", "description": "The date on which the payroll was approved.", "nullable": true, "format": "date" }, "is_stale": { "type": "boolean", "description": "Whether the payroll's tax calculations are out of date. When `true`, `stale_since` indicates when the payroll became stale." }, "stale_since": { "type": "string", "description": "The timestamp at which the payroll's tax calculations became stale and need to be recalculated. `null` if the payroll is up to date.", "readOnly": true, "nullable": true, "format": "dateTime" }, "source_payroll": {}, "warnings": { "type": "object", "description": "A collection of data validation warnings for this payroll. Warnings indicate incomplete or potentially incorrect data and could prevent payroll processing.", "nullable": true, "properties": { "object": { "type": "string", "nullable": true }, "data": { "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" } } }, "Reimbursement": { "type": "object", "title": "Reimbursement", "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 } } }, "reimbursement_type": { "type": "object", "description": "The type of reimbursement, which determines how it is categorized 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 (`\"reimbursement_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/ReimbursementType" } } }, "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 }, "frequency": { "type": "string", "description": "The frequency at which this reimbursement 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 }, "amount": { "type": "number", "description": "The monetary amount applied each time this reimbursement is included on a Pay Stub.", "format": "decimal" }, "effective_from": { "type": "string", "description": "The date from which this reimbursement is applied to Pay Stubs.", "format": "date" }, "effective_to": { "type": "string", "description": "The date after which this reimbursement is no longer applied. `null` if the reimbursement 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" } } }, "ReimbursementLineItem": { "type": "object", "title": "Reimbursement Line Item", "properties": { "pay_stub": { "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_stub\"`).", "readOnly": true } } }, "line_item_type": { "type": "string", "nullable": true }, "is_managed": { "type": "boolean", "description": "Whether this line item was generated by a Reimbursement recurrence and calculated automatically. When `true`, only `custom_amount` can be modified and the line item cannot be deleted." }, "amount": { "type": "number", "description": "The effective amount for this line item. Returns `custom_amount` if set, otherwise `managed_amount`. Read-only.", "nullable": true, "format": "decimal" }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.", "nullable": true, "format": "decimal" }, "managed_amount": { "type": "number", "description": "The amount calculated by the system or set by the linked Reimbursement recurrence. Read-only; set `custom_amount` to override.", "nullable": true, "format": "decimal" }, "accrued_vacation_pay": { "type": "number", "description": "The vacation pay accrued on this line item, calculated based on the Work Assignment's Vacation Pay Settings.", "nullable": true, "format": "decimal" }, "reimbursement_type": { "type": "object", "description": "The type of reimbursement for this line item.", "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 (`\"reimbursement_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/ReimbursementType" } } }, "recurrence": {}, "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 }, "business_preset": {}, "source_adjustment": {}, "expense_accounting_code": { "description": "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." }, "managed_expense_accounting_code": { "description": "The expense accounting code derived by the system from accounting code rules and presets. Read-only." }, "custom_expense_accounting_code": { "description": "User-set expense accounting code that overrides the system-derived value." }, "liability_accounting_code": { "description": "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." }, "managed_liability_accounting_code": { "description": "The liability accounting code derived by the system from accounting code rules and presets. Read-only." }, "custom_liability_accounting_code": { "description": "User-set liability accounting code that overrides the system-derived value." }, "component_settings": { "type": "object", "description": "Settings specific to the Nmbr component.", "nullable": true, "properties": { "attributes_locked": { "type": "boolean", "description": "Whether the line item is locked and cannot be edited in the component." } } }, "earned_on": { "description": "The effective earned-on date for this line item. Returns `custom_earned_on` if set, otherwise `managed_earned_on`. Read-only." }, "managed_earned_on": { "type": "string", "description": "The earned-on date set by the system. Read-only; set `custom_earned_on` to override.", "nullable": true, "format": "date" }, "custom_earned_on": { "type": "string", "description": "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.", "nullable": true, "format": "date" }, "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" } } }, "ReimbursementType": { "type": "object", "title": "Reimbursement Type", "properties": { "type": { "type": "string", "description": "The string identifier for this reimbursement type.", "nullable": true }, "label": { "type": "string", "description": "The human-readable display name for this reimbursement type.", "nullable": true }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/LineItemTypeFeature" } }, "form_mappings": { "type": "array", "items": { "$ref": "#/components/schemas/LineItemFormMapping" } } } }, "RemittanceAccount": { "type": "object", "title": "Remittance Account", "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 } } }, "source_tax_property": { "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 (`\"tax_property\"`).", "readOnly": true } } }, "account_provider": { "type": "string", "description": "The authority to which remittances are made for this account. This is used to determine how to remit payments for this account. Employer Health Tax (EHT) and Workers' Compensation (WCB) authorities are limited to one account, per province, per business entity; creating a second for an authority that already has one is rejected.", "nullable": true, "enum": [ "ca_ab_workers_compensation", "ca_bc_eht", "ca_bc_workers_compensation", "ca_cra", "ca_mb_eht", "ca_mb_workers_compensation", "ca_nb_workers_compensation", "ca_nl_eht", "ca_nl_workers_compensation", "ca_ns_workers_compensation", "ca_nt_government", "ca_nt_workers_compensation", "ca_nu_government", "ca_nu_workers_compensation", "ca_on_eht", "ca_on_workers_compensation", "ca_pe_workers_compensation", "ca_rq", "ca_sk_workers_compensation", "ca_yt_workers_compensation" ] }, "is_default": { "type": "boolean", "description": "When true, this account is used for auto-enrollment of new work-assignments, and work-assignments without an existing enrollment for this authority. Only one account per authority per business may be the default at a time." }, "is_editable": { "type": "boolean", "description": "When false, the account's `account_identifier` cannot be updated. Becomes false once the account is used on a non-draft payroll and an `account_identifier` is set; returns to true when every referencing payroll is reverted to draft or deleted." }, "is_deletable": { "type": "boolean", "description": "When false, the account cannot be deleted. Becomes false once the account is referenced by any non-draft payroll; returns to true when every referencing payroll is reverted to draft or deleted." }, "linked_remittance_account": { "description": "The CRA remittance account whose enrollments this account follows, when it is a linked account; otherwise null." }, "category": { "type": "string", "nullable": true, "enum": [ "ca_benefit_provider", "ca_provincial_government", "ca_tax_agency", "ca_union", "ca_workers_compensation" ] }, "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 }, "account_identifier": { "type": "string", "nullable": true, "maxLength": 255 }, "superseded_by": { "description": "The account that has replaced this one, set when this account's business number was changed or corrected and a successor account took over. Null when no successor has been recorded." }, "superseded_on": { "type": "string", "description": "The date this account was replaced by its successor. Null when no successor has been recorded.", "nullable": true, "format": "date" }, "remitter_type": { "type": "string", "description": "The CRA remitter type for this account, which determines remittance due dates and reporting frequency. When null, falls back to the business entity's remitter type.", "nullable": true, "enum": [ "accelerated_threshold_1", "accelerated_threshold_2", "quarterly", "regular" ] }, "remittance_management": { "type": "string", "description": "Whether remittances for this account are filed manually by the employer (`manual`) or handled automatically by Nmbr (`automatic`). Only accounts Nmbr can remit on your behalf (CRA, RQ, and Employer Health Tax authorities) may be set to `automatic`; all others are always `manual`.", "enum": [ "automatic", "manual" ] }, "note": { "type": "string", "nullable": true }, "address_line_1": { "type": "string", "nullable": true, "maxLength": 255 }, "address_line_2": { "type": "string", "nullable": true, "maxLength": 255 }, "city": { "type": "string", "nullable": true, "maxLength": 255 }, "administrative_area": { "type": "string", "nullable": true, "maxLength": 255 }, "province_code": { "type": "string", "nullable": true }, "country_code": { "type": "string", "nullable": true, "maxLength": 2 }, "postal_code": { "type": "string", "nullable": true, "maxLength": 10 }, "has_payments": { "type": "boolean" }, "current_enrollments_count": { "type": "number", "nullable": true, "format": "decimal" }, "pending_enrollments_count": { "type": "number", "nullable": true, "format": "decimal" }, "metadata": { "$ref": "#/components/schemas/RemittanceAccountMetadata" }, "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" } } }, "RemittanceTotal": { "type": "object", "title": "Remittance Total", "properties": { "remittance_account": { "type": "object", "description": "The remittance account the money is owed to. Expand it for the account identifier, address, and remitter type.", "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 (`\"remittance_account\"`).", "readOnly": true } } }, "account_provider": { "type": "string", "description": "The authority this account remits to. `null` for accounts that are not a tax authority, such as a benefit provider or union.", "nullable": true, "enum": [ "ca_ab_workers_compensation", "ca_bc_eht", "ca_bc_workers_compensation", "ca_cra", "ca_mb_eht", "ca_mb_workers_compensation", "ca_nb_workers_compensation", "ca_nl_eht", "ca_nl_workers_compensation", "ca_ns_workers_compensation", "ca_nt_government", "ca_nt_workers_compensation", "ca_nu_government", "ca_nu_workers_compensation", "ca_on_eht", "ca_on_workers_compensation", "ca_pe_workers_compensation", "ca_rq", "ca_sk_workers_compensation", "ca_yt_workers_compensation" ] }, "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 }, "amount": { "type": "number", "description": "The sum of every line item on the payroll payable to this account. The sum is signed. Note that when it is negative, the CRA and Revenue Qu\u00e9bec payment records created when a payroll is approved report zero rather than a negative amount, so the two figures differ.", "nullable": true, "format": "decimal" }, "details": { "type": "object", "description": "The same total split by who the money came from. `employee_amount` covers amounts withheld from workers, `employer_amount` covers amounts the employer owes on top of wages. The two add up to `amount`.", "nullable": true, "properties": { "employee_amount": { "type": "number", "nullable": true, "format": "decimal" }, "employer_amount": { "type": "number", "nullable": true, "format": "decimal" } } } } }, "Report": { "type": "object", "title": "Report", "properties": { "type": { "type": "string", "enum": [ "cra-remittance", "ei-cpp-balance", "ei-qpp-qpip-balance", "employer-health-tax", "journal-entry", "journal-entry-line-item", "liability", "payroll-register", "rl1-preview", "rq-remittance", "t4-preview", "vacation-accrual", "workers-compensation", "year-end-forms", "year-to-date" ] }, "business_entity": {}, "pay_schedule": {}, "payroll": { "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 (`\"payroll\"`).", "readOnly": true } } }, "filters": { "type": "object", "nullable": true }, "has_results": { "type": "boolean" }, "format": { "type": "string", "description": "The output format set at creation for `/download`. One of `csv` or `xlsx`. `null` when no format was specified \u2014 required to use `/download`.", "nullable": true, "maxLength": 255, "enum": [ "csv", "pdf", "xlsx" ] }, "sheet": { "type": "string", "description": "The sheet selected at creation for multi-sheet reports (e.g. `summary` or `detail` for Payroll Register). `null` when the report has a single sheet or no sheet was specified.", "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" } } }, "RoeSatAgreement": { "type": "object", "title": "Roe Sat Agreement", "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 } } }, "business_number": { "type": "string", "description": "The CRA payroll account number (BN15) the agreement covers. ROEs issued under this number are filed with Service Canada automatically while the agreement is not revoked.", "maxLength": 15 }, "business_legal_name": { "type": "string", "description": "The client's legal name as written on the letter.", "maxLength": 255 }, "signer_name": { "type": "string", "description": "The person who signed the letter on the client's behalf.", "maxLength": 255 }, "signer_title": { "type": "string", "description": "The signer's job title.", "maxLength": 255 }, "signed_on": { "type": "string", "description": "The date written on the signed letter.", "format": "date" }, "revoked_at": { "type": "string", "description": "When the agreement was revoked. Null while the agreement is in effect.", "readOnly": true, "nullable": true, "format": "dateTime" }, "locale": { "type": "string", "description": "The language of the letter (en or fr).", "maxLength": 2, "enum": [ "en", "fr" ] }, "letter_was_uploaded": { "type": "boolean", "description": "Whether the attached letter is the client's uploaded signed copy (true) or a copy generated from the recorded details (false). Download it from `/roe_sat_agreements/{id}/letter`." }, "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" } } }, "StatutoryWithholdingLineItem": { "type": "object", "title": "Statutory Withholding Line Item", "properties": { "pay_stub": { "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_stub\"`).", "readOnly": true } } }, "line_item_type": { "type": "string", "nullable": true }, "is_system": { "type": "boolean", "description": "Whether this line item was generated automatically by the payroll engine. System line items cannot be deleted." }, "is_managed": { "type": "boolean", "description": "Always `true`. Statutory withholding line items are fully managed by the payroll engine and cannot be created, updated, or deleted." }, "amount": { "type": "number", "description": "The effective amount for this line item. Returns `custom_amount` if set, otherwise `managed_amount`. Read-only.", "nullable": true, "format": "decimal" }, "custom_amount": { "type": "number", "description": "An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.", "nullable": true, "format": "decimal" }, "managed_amount": { "type": "number", "description": "The withholding amount calculated by the payroll engine. Read-only; set `custom_amount` to override.", "format": "decimal" }, "statutory_withholding_type": { "type": "object", "description": "The type of statutory withholding for this line item.", "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 (`\"statutory_withholding_type\"`).", "readOnly": true }, "data": { "$ref": "#/components/schemas/StatutoryWithholdingType" } } }, "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 }, "remittance_account": { "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 (`\"remittance_account\"`).", "readOnly": true } } }, "source_adjustment": {}, "business_preset": { "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_preset\"`).", "readOnly": true } } }, "expense_accounting_code": { "description": "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." }, "managed_expense_accounting_code": { "description": "The expense accounting code derived by the system from accounting code rules and presets. Read-only." }, "custom_expense_accounting_code": { "description": "User-set expense accounting code that overrides the system-derived value." }, "liability_accounting_code": { "description": "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." }, "managed_liability_accounting_code": { "description": "The liability accounting code derived by the system from accounting code rules and presets. Read-only." }, "custom_liability_accounting_code": { "description": "User-set liability accounting code that overrides the system-derived value." }, "component_settings": { "type": "object", "description": "Settings specific to the Nmbr component.", "nullable": true, "properties": { "attributes_locked": { "type": "boolean", "description": "Whether the line item is locked and cannot be edited in the component." } } }, "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" } } }, "StatutoryWithholdingType": { "type": "object", "title": "Statutory Withholding Type", "properties": { "type": { "type": "string", "description": "The string identifier for this employee statutory withholding type.", "nullable": true }, "label": { "type": "string", "description": "The human-readable display name for this employee statutory withholding type.", "nullable": true } } }, "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." }, "expense_segment": { "type": "string", "description": "The expense code piece this tag contributes to a generated expense code, pulled in by a `tag_group` segment of an accounting code rule's expense template.", "nullable": true, "maxLength": 255 }, "liability_segment": { "type": "string", "description": "The liability code piece this tag contributes to a generated liability code, pulled in by a `tag_group` segment of an accounting code rule's liability template.", "nullable": true, "maxLength": 255 }, "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" } } }, "TagGroup": { "type": "object", "title": "Tag Group", "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 }, "color": { "type": "string", "description": "A hex colour code for the tag group (e.g. `#AABBCC` or `#ABC`). Used for display.", "nullable": true, "maxLength": 7 }, "archived_at": { "type": "string", "description": "When set, the tag group is archived and excluded from index listings by default.", "readOnly": true, "nullable": true, "format": "dateTime" }, "is_deletable": { "type": "boolean", "description": "A tag group may not be deleted while it is the primary tag group or any of its tags are assigned to active allocations." }, "is_component_locked": { "type": "boolean", "description": "When `true`, the tags within this group cannot be modified through the embedded portal. Tags can still be managed through the API." }, "is_journal_entry_dimension": { "type": "boolean", "description": "When `true`, this tag group is used as a dimension in journal entry reports. A business entity can have up to three journal entry dimensions." }, "integrations": { "type": "object", "description": "Identifiers and object types for this tag group in external accounting integrations, used to sync tag groups imported from those systems. QuickBooks does not expose a group-level identifier, so only the type is stored for QuickBooks.", "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 }, "type": {} } }, "quickbooks": { "type": "object", "nullable": true, "properties": { "type": {} } } } }, "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" } } }, "TaxProperty": { "type": "object", "title": "Tax Property", "properties": { "type": { "type": "string", "description": "The type of this tax property, determining its format, label, and validation rules.", "maxLength": 255, "enum": [ "ca::ab::claim_amount", "ca::ab::total_income_less_than_total_claim_amount", "ca::ab::workers_compensation_class", "ca::bc::claim_amount", "ca::bc::eht", "ca::bc::total_income_less_than_total_claim_amount", "ca::bc::workers_compensation_class", "ca::cpp_exempt", "ca::ei_exempt", "ca::ei_premium_reduction", "ca::federal::additional_tax", "ca::federal::annual_deduction_at_source", "ca::federal::claim_amount", "ca::federal::commission_expenses", "ca::federal::commission_total_income", "ca::federal::income_tax_rate", "ca::federal::total_income_less_than_total_claim_amount", "ca::federal_oc_surtax_exempt", "ca::first_nation_exemptions", "ca::mb::claim_amount", "ca::mb::eht", "ca::mb::total_income_less_than_total_claim_amount", "ca::mb::workers_compensation_class", "ca::nb::claim_amount", "ca::nb::total_income_less_than_total_claim_amount", "ca::nb::workers_compensation_class", "ca::nl::claim_amount", "ca::nl::eht", "ca::nl::total_income_less_than_total_claim_amount", "ca::nl::workers_compensation_class", "ca::ns::claim_amount", "ca::ns::total_income_less_than_total_claim_amount", "ca::ns::workers_compensation_class", "ca::nt::claim_amount", "ca::nt::territorial_payroll_tax", "ca::nt::total_income_less_than_total_claim_amount", "ca::nt::workers_compensation_class", "ca::nu::claim_amount", "ca::nu::territorial_payroll_tax", "ca::nu::total_income_less_than_total_claim_amount", "ca::nu::workers_compensation_class", "ca::on::claim_amount", "ca::on::dependent_children_credit", "ca::on::eht", "ca::on::impaired_dependants_credit", "ca::on::total_income_less_than_total_claim_amount", "ca::on::workers_compensation_class", "ca::pe::claim_amount", "ca::pe::total_income_less_than_total_claim_amount", "ca::pe::workers_compensation_class", "ca::province_of_employment", "ca::province_of_work", "ca::provincial::income_tax_rate", "ca::qc::additional_tax", "ca::qc::claim_amount", "ca::qc::commission_percentage_taxed", "ca::qc::eht", "ca::qc::income_tax_rate", "ca::qc::qpip_exempt", "ca::qc::qpp_exempt", "ca::qc::tax_id", "ca::qc::total_income_less_than_total_claim_amount", "ca::qc::workers_compensation_class", "ca::sk::claim_amount", "ca::sk::total_income_less_than_total_claim_amount", "ca::sk::workers_compensation_class", "ca::statutory_holiday_pay", "ca::tax_id", "ca::yt::claim_amount", "ca::yt::total_income_less_than_total_claim_amount", "ca::yt::workers_compensation_class" ] }, "value": { "type": "string", "description": "The value of this tax property. Format depends on `format`: numeric types store a decimal string, boolean types store a boolean, select types store a string key, and object types store a structured value object.", "nullable": true }, "effective_from": { "type": "string", "description": "The date from which this tax property takes effect.", "format": "date" }, "effective_to": { "type": "string", "description": "The date on which this tax property expires. `null` means no end date and the property remains in effect indefinitely.", "nullable": true, "format": "date" }, "earliest_valid_effective_to": { "type": "string", "description": "The earliest date that `effective_to` can be set to without triggering a validation error. Corresponds to the pay date of the most recent non-draft payroll that used this property.", "nullable": true, "format": "date" }, "is_editable": { "type": "boolean", "description": "Whether this tax property can be fully edited. When `false`, only `effective_to` and `note` may be updated.\n\nWhen false, only the `effective_to` and `note` attributes may be updated." }, "is_deletable": { "type": "boolean", "description": "Whether this tax property can be deleted." }, "label": { "type": "string", "description": "The human-readable display name for this tax property's type.", "nullable": true }, "format": { "type": "string", "description": "The value format for this tax property's type. Determines how `value` is interpreted.", "nullable": true }, "options": { "type": "object", "description": "The available options for this tax property's type if it is a select type. `null` if not applicable.", "nullable": true, "properties": { "ca_ab": { "type": "string", "nullable": true }, "ca_bc": { "type": "string", "nullable": true }, "ca_mb": { "type": "string", "nullable": true }, "ca_nb": { "type": "string", "nullable": true }, "ca_nl": { "type": "string", "nullable": true }, "ca_ns": { "type": "string", "nullable": true }, "ca_nt": { "type": "string", "nullable": true }, "ca_nu": { "type": "string", "nullable": true }, "ca_on": { "type": "string", "nullable": true }, "ca_pe": { "type": "string", "nullable": true }, "ca_qc": { "type": "string", "nullable": true }, "ca_sk": { "type": "string", "nullable": true }, "ca_yt": { "type": "string", "nullable": true }, "ca_oc": { "type": "string", "nullable": true } } }, "allow_concurrent": { "type": "boolean", "description": "Whether multiple tax properties of this tax property's type are allowed on the same owner with overlapping effective date ranges." }, "feature": { "type": "string", "description": "The feature this tax property's type is associated with. `null` if not feature-gated.", "nullable": true }, "owner": { "type": "object", "description": "The owner of this tax property. Can be a Business Entity, Work Assignment, or Remittance Account.", "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 } } }, "note": { "type": "string", "description": "An optional note for this tax property.", "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" } } }, "TaxPropertyTemplate": { "type": "object", "title": "Tax Property Template", "properties": { "type": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "format": { "type": "string", "nullable": true }, "options": { "type": "object", "nullable": true, "properties": { "ca_ab": { "type": "string", "nullable": true }, "ca_bc": { "type": "string", "nullable": true }, "ca_mb": { "type": "string", "nullable": true }, "ca_nb": { "type": "string", "nullable": true }, "ca_nl": { "type": "string", "nullable": true }, "ca_ns": { "type": "string", "nullable": true }, "ca_nt": { "type": "string", "nullable": true }, "ca_nu": { "type": "string", "nullable": true }, "ca_on": { "type": "string", "nullable": true }, "ca_pe": { "type": "string", "nullable": true }, "ca_qc": { "type": "string", "nullable": true }, "ca_sk": { "type": "string", "nullable": true }, "ca_yt": { "type": "string", "nullable": true }, "ca_oc": { "type": "string", "nullable": true } } }, "allow_concurrent": { "type": "boolean" }, "feature": { "type": "string", "nullable": true }, "nullable": { "type": "boolean" }, "structure": {}, "validation": {} } }, "UsageRecord": { "type": "object", "title": "Usage Record", "properties": { "company": { "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 (`\"company\"`).", "readOnly": true } } }, "event": { "type": "string", "enum": [ "business_launched", "contractor_paid", "contractor_paid_unique", "employee_paid", "employee_paid_unique", "funding_failure", "kyb_attempt", "payroll_expedited" ] }, "record": { "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_stub\"`).", "readOnly": true } } }, "recorded_at": { "type": "string", "readOnly": 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" } } }, "UsageSummary": { "type": "object", "title": "Usage Summary", "properties": { "company": { "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 (`\"company\"`).", "readOnly": true } } }, "event": { "type": "string", "enum": [ "business_launched", "contractor_paid", "contractor_paid_unique", "employee_paid", "employee_paid_unique", "funding_failure", "kyb_attempt", "payroll_expedited" ] }, "count": { "type": "integer" }, "period_start": { "type": "string", "format": "date" }, "period_end": { "type": "string", "format": "date" }, "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" } } }, "VacationPayBalance": { "type": "object", "title": "Vacation Pay Balance", "properties": { "vacation_pay_opening_balance": { "type": "number", "nullable": true, "format": "decimal" }, "vacation_pay_accrued_in_period": { "type": "number", "nullable": true, "format": "decimal" }, "vacation_pay_paid_in_period": { "type": "number", "nullable": true, "format": "decimal" }, "vacation_pay_closing_balance": { "type": "number", "nullable": true, "format": "decimal" } } }, "VacationPayHistory": { "type": "object", "title": "Vacation Pay History" }, "VacationPaySetting": { "type": "object", "title": "Vacation Pay Setting", "properties": { "percentage": { "type": "number", "format": "decimal" }, "vacation_pay_method": { "type": "string", "enum": [ "manual", "per_period" ] }, "effective_from": { "type": "string", "format": "date" }, "effective_to": { "type": "string", "nullable": true, "format": "date" }, "earliest_valid_effective_to": { "type": "string", "nullable": true, "format": "date" }, "is_editable": { "type": "boolean", "description": "When false, only the `effective_to` attribute may be updated." }, "is_deletable": { "type": "boolean" }, "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 } } }, "note": { "type": "string", "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" } } }, "Webhook": { "type": "object", "title": "Webhook", "properties": { "url": { "type": "string", "maxLength": 255 }, "key": { "type": "string", "maxLength": 255 }, "is_enabled": { "type": "boolean" }, "events": { "type": "object" }, "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" } } } } } }