# Lista os grupos de ICMS

Retorna uma lista de grupos de ICMS da Empresa.

Endpoint: GET /api/v3/tax-settings/icms
Version: 3.0.0
Security: OAuth2

## Header parameters:

  - `CPlug-Company-Id` (number, required)
    Id da Empresa (Company).

Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas.
    Example: 12

## Query parameters:

  - `name` (string)
    Filtra pelo nome do grupo de ICMS.
    Example: "Grupo ..."

  - `page` (number)
    Indica a página da paginação.

  - `per_page` (number)
    Indica a quantidade de itens por página.

## Response 200 fields (application/json):

  - `data` (object)

  - `data.icms` (array)
    Representa uma lista grupos de ICMS

  - `data.icms.id` (integer)
    Identificador único do Grupo de ICMS.
    Example: 211

  - `data.icms.name` (string)
    Nome do grupo de ICMS.
    Example: "ICMS Outras - Campos Opcionais"

  - `data.icms.tributary_group` (object)
    Grupo tributário associado ao ICMS.

  - `data.icms.tributary_group.id` (integer)
    Identificador único do grupo tributário.
    Example: 900

  - `data.icms.tributary_group.code` (string)
    Código do grupo tributário.
    Example: "900"

  - `data.icms.tributary_group.description` (string)
    Descrição do grupo tributário.
    Example: "900 - Outros"

  - `data.icms.icms_percentage` (number)
    Percentual do ICMS.
    Example: 18

  - `data.icms.is_default` (boolean)
    Indica se este é o grupo de ICMS padrão.

  - `data.icms.is_shared_with_all_companies` (boolean)
    Indica se este grupo de ICMS é compartilhado com todas as empresas.
    Example: true

  - `data.icms.created_at` (string)
    Data e hora de criação do registro.
    Example: "2025-07-18T23:37:49.000000Z"

  - `data.icms.updated_at` (string)
    Data e hora da última atualização do registro.
    Example: "2025-07-18T23:37:49.000000Z"

  - `meta` (object)
    Representa as informações de Metadado da paginação da listagem.

  - `meta.current_page` (integer, required)
    Página atual na paginação.
    Example: 1

  - `meta.last_page` (integer, required)
    Quantidade total de páginas.
    Example: 10

  - `meta.per_page` (integer, required)
    Quantidade de resultados por página.
    Example: 20

  - `meta.total` (integer, required)
    Quantidade total de itens.
    Example: 200

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields