---
title: "remittance/tax-categories"
method: GET
path: "/remittance/tax-categories"
tags: ["Remittance Endpoints"]
---

# remittance/tax-categories

`GET /remittance/tax-categories`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/remittance/tax-categories`
- Auth: none declared

Publishes the tax remittance category matrix: the display name, jurisdiction and exact Details fields required for each TaxRemittanceType accepted by /remittance/create. The response is identical for every caller.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `TaxRemittanceType` string
- `Jurisdiction` string

## Response `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `TaxCategories` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items.
    - `0` object
      - `TaxRemittanceType` string: The category code, as passed to /remittance/create.
      - `Name` string: Display name matching the CRA/Revenu Québec remittance voucher this category files against.
      - `Jurisdiction` string: Federal, ON, QC, or NS.
      - `TaxPeriodEndDateRequired` boolean: Whether /remittance/create requires TaxPeriodEndDate for this category. Currently true for every category.
      - `RequiredFields` object: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. The exact set of Details keys /remittance/create requires for this category - not a minimum: extra keys are rejected, missing keys are rejected.
        - `0` object
          - `FieldName` string: The key to use inside the Details JSON object.
          - `DataType` string: The kind of value expected: amount, date, integer, or string.
          - `IsProfileField` boolean: Whether this Details field may be saved as a DefaultDetails value on a remittance profile (see POST /remittance/account/profiles/add). No field is currently flagged true for any category.

---

[API](https://skmtc.dev/vopay/apis/remittance-api.md) - [All operations](https://skmtc.dev/vopay/apis/remittance-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/remittance-api/revisions/d8a4c4720960?raw)