> ## 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 remittance totals

> Totals every statutory withholding, deduction and benefit on the payroll that names a remittance destination, and returns one figure per destination — what the payroll owes the CRA, Revenue Québec, each benefit provider, union, workers' compensation board and employer health tax authority.

Totals 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 — there are no pages.

Line 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.



## OpenAPI

````yaml /spec/openapi.json get /payrolls/{payroll}/remittances
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:
  /payrolls/{payroll}/remittances:
    get:
      tags:
        - Remittance Totals
      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 — what the payroll owes the CRA, Revenue Québec, each
        benefit provider, union, workers' compensation board and employer health
        tax authority.


        Totals 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 — there are no pages.


        Line 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
      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: <id>
                        object: remittance_account
                        links:
                          self: /remittance_accounts/<id>
                      account_provider: null
                      label_translated: IBEW Local 353 — Dues
                      amount: 245
                      details:
                        employee_amount: 245
                        employer_amount: 0
                  - object: remittance_total
                    data:
                      remittance_account:
                        id: <id>
                        object: remittance_account
                        links:
                          self: /remittance_accounts/<id>
                      account_provider: ca_cra
                      label_translated: Canada Revenue Agency (CRA)
                      amount: 918.73
                      details:
                        employee_amount: 611.42
                        employer_amount: 307.31
components:
  schemas:
    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ébec 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
    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
        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
    Translations:
      type: object
      nullable: true
      properties:
        en:
          type: string
          maxLength: 255
        fr:
          type: string
          maxLength: 255
    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
  securitySchemes:
    CompanyToken:
      type: http
      scheme: bearer

````