---
title: "🔒 List Tax Account Mapping Entries"
method: GET
path: "/api/v1/taxAccountMapping"
tags: ["Tax Account Mapping"]
---

# 🔒 List Tax Account Mapping Entries

`GET /api/v1/taxAccountMapping`

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

Retrieves a list of tax account mapping entries.

## Query parameters

- `filter` object[]
  - `key` 'id' | 'accountId' | 'countryCode' | 'region' | 'zipCode' | 'isActive' | 'createdAt' | 'updatedAt'
  - `op` 'equals' | 'notEquals' | 'in' | 'notIn' | 'exactlyIn' | 'allIn' | 'allNotIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'greaterThan' | 'lessThan' | 'is' | 'lessThanOrEquals' | 'greaterThanOrEquals'
  - `value` union
    - string — Used for the operations 'equals', 'notEquals', 'contains', 'notContains', 'startsWith', 'endsWith' and 'is'.
    - string[] — Used for the operations 'in', 'notIn', 'exactlyIn', 'allIn' and 'allNotIn'.
- `page` object
  - `number` string, required — Page number should be an integer greater than or equal to 1
  - `size` string, required — Page size should usually be an integer between 10 and 50.
- `order` object[]
  - `field` 'id' | 'accountId' | 'countryCode' | 'region' | 'zipCode' | 'isActive' | 'createdAt' | 'updatedAt'
  - `dir` 'asc' | 'desc'

## Response `200`

Successful operation

- object
  - `data` object[]
    - `id` string — Tax account mapping ID
    - `name` string — Name of the mapping
    - `account` object — Account entry
      - `id` string — Account ID
      - `accountNumber` string — Account number
      - `accountType` string — Account type
      - `name` string — Account name
      - `description` string — Account description
      - `isStandard` boolean — Is standard account
      - `deletedAt` string, date-time, nullable — Deleted at timestamp
      - `createdAt` string, date-time — Created at timestamp
      - `updatedAt` string, date-time — Updated at timestamp
    - `taxType` object — Tax type entry
      - `id` string — Tax type ID
      - `name` string — Tax type name
      - `description` string, nullable — Tax type description
      - `isStandard` boolean — Is standard tax type
      - `createdAt` string, date-time — Created at timestamp
      - `updatedAt` string, date-time — Updated at timestamp
    - `countryCode` string — Country code in ISO 3166-1 alpha-2 format
    - `region` string, nullable — Region
    - `zipCode` string, nullable — ZIP code
    - `isActive` boolean — Is active
    - `createdAt` string, date-time — Created at timestamp
    - `updatedAt` string, date-time — Updated at timestamp

## Other responses

- `400` — XGL Problem
- `401` — Unable to authenticate the client
- `403` — Unable to authorize the client
- `404` — XGL Problem
- `429` — Too many API calls made.
- `500` — XGL Problem

---

[API](https://skmtc.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/revisions/8a27ba392442/schema)