> ## Documentation Index > Fetch the complete documentation index at: https://docs.nmbr.co/llms.txt > Use this file to discover all available pages before exploring further. # List work assignments ## OpenAPI ````yaml /spec/openapi.json get /work_assignments openapi: 3.0.0 info: title: Nmbr API description: API to interact with Nmbr Payroll version: 1.0.0 servers: - url: https://sandbox.nmbr.co/services/payroll security: - CompanyToken: [] tags: - name: Accounting Codes - name: Accounting Code Rules - name: Adjustments - name: Allowances - name: Allowance Line Items - name: Allowance Types - name: Async Tasks - name: Bank Accounts - name: Business Entities - name: Business Entity Verifications - name: Business Entity ROE Authorizations - name: Business Presets - name: Calculations - name: Companies - name: Contractors - name: Deductions - name: Deduction Line Items - name: Deduction Types - name: Earnings - name: Earning Line Items - name: Earning Types - name: Effective Tax Properties - name: Employees - name: Employee Benefits - name: Employee Benefit Line Items - name: Employee Benefit Types - name: Employer Benefits - name: Employer Benefit Line Items - name: Employer Benefit Types - name: Employer Statutory Withholding Line Items - name: Employer Statutory Withholding Types - name: Forms - name: Form Batches - name: Form Types - name: Holidays - name: Integrations - name: Journal Entries - name: Overtime Rates - name: Partners - name: Pay Rates - name: Pay Schedules - name: Pay Splits - name: Pay Stubs - name: Payments - name: Payrolls - name: Reimbursements - name: Reimbursement Line Items - name: Reimbursement Types - name: Remittance Accounts - name: Remittance Account Enrollments - name: Reports - name: Statutory Withholding Line Items - name: Statutory Withholding Types - name: Tags - name: Tag Groups - name: Tax Properties - name: Tax Property Templates - name: Tokens - name: Usage Records - name: Usage Summaries - name: Vacation Pay - name: Vacation Pay Settings - name: Webhooks - name: Work Assignments paths: /work_assignments: get: tags: - Work Assignments summary: List work assignments operationId: work-assignments-index parameters: - name: business_entity_id in: query schema: type: string required: false - name: pay_schedule_id in: query schema: type: string required: false - name: 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: 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: Exact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `archived_at=2024-01-01` Use an array-like syntax to specify a range with one or more comparison operators: - `gt` (greater than) - `gte` (greater than or equal to) - `lte` (less than or equal to) - `lt` (less than) Example: `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 `sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by and `direction` is the optional sort direction (`asc` or `desc`). - name: 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 components: schemas: 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 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 — 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. A 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. The employee's Social Insurance Number (SIN), used for tax reporting. If 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 Business Entity'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 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. 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 Business Entity'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 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 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. 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 — 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. A 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. 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. Use `accounting_settings.default_bank_accounting_code`. deprecated: true default_payroll_payable_accounting_code: description: |- This attribute is deprecated and will be removed. Use `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. Use `accounting_settings.resolve_journal_entry_stat_withholdings`. deprecated: true primary_tag_group: description: |- This attribute is deprecated and will be removed. Use `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 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. When 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 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 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. 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 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 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' Translations: type: object nullable: true properties: en: type: string maxLength: 255 fr: type: string maxLength: 255 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 institution_number: type: string description: The 3-digit bank institution number. 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. 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 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’ 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 Tag: type: object title: Tag properties: label: type: string maxLength: 255 label_translations: type: object description: Optional translations for the `label` property. allOf: - $ref: '#/components/schemas/Translations' nullable: true label_translated: type: string description: >- The translation of the `label` property for the request locale. Computed using the values in `label` and `label_translations` and the value of the request's `Accept-Language` header. readOnly: true description: type: string nullable: true description_translations: type: object description: Optional translations for the `description` property. allOf: - $ref: '#/components/schemas/Translations' nullable: true description_translated: type: string description: >- The translation of the `description` property for the request locale. Computed using the values in `description` and `description_translations` and the value of the request's `Accept-Language` header. readOnly: true archived_at: type: string description: >- When set, the tag is archived and excluded from index listings by default. readOnly: true nullable: true format: dateTime is_deletable: type: boolean description: >- A tag may not be deleted while it is assigned to any active allocation. integrations: type: object description: >- Identifiers for this tag in external accounting integrations, used to sync tags imported from those systems. nullable: true properties: xero: type: object nullable: true properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true maxLength: 32 quickbooks: type: object nullable: true properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true maxLength: 32 tag_group: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"tag_group"`). readOnly: true business_entity: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"business_entity"`). readOnly: true created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime 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 securitySchemes: CompanyToken: type: http scheme: bearer ````