# Lista informações tributárias dos produtos

Retorna uma lista de produtos com suas respectivas configurações fiscais.

Endpoint: GET /api/v3/products/tax-settings
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:

  - `search` (string)
    Termo de busca para filtrar produtos por nome, categoria ou SKU.
    Example: "produção"

  - `categories_id` (string)
    Filtra pelos IDs das categorias. Pode passar mais de um ID numérico separado por virgula.
    Example: "1,2,3"

  - `with_icms` (boolean)
    Filtro para produtos que possuem ou não configuração de ICMS.

  - `with_ipi` (boolean)
    Filtro para produtos que possuem ou não configuração de IPI.

  - `with_pis_cofins` (boolean)
    Filtro para produtos que possuem ou não configuração de PIS/COFINS.

  - `with_issqn` (boolean)
    Filtro para produtos que possuem ou não configuração de ISSQN.

  - `ncm_id` (integer)
    Filtro pelo ID do NCM.
    Example: 123

  - `cest_id` (integer)
    Filtro pelo ID do CEST.
    Example: 456

  - `origem_id` (integer)
    Filtro pelo ID da origem de mercadoria do ICMS.
    Example: 789

  - `cfop_id` (integer)
    Filtro pelo ID do CFOP.
    Example: 5102

  - `order_by_field` (string)
    Campo usado para ordenação dos resultados.
    Enum: "name", "created_at"

  - `order_by_type` (string)
    Direção da ordenação.
    Enum: "asc", "desc"

  - `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.products` (array)
    Lista de produtos com suas configurações fiscais.

  - `data.products.id` (integer, required)
    Identificador único do produto.
    Example: 8

  - `data.products.name` (string, required)
    Nome do produto.
    Example: "dolorem"

  - `data.products.type` (string, required)
    Tipo do produto.

- simple: Produto simples.
- combo: Produto combo.
    Enum: "simple", "combo"

  - `data.products.description` (null,string)
    Descrição do produto.

  - `data.products.sku` (string, required)
    Código SKU do produto.
    Example: "2423"

  - `data.products.category` (object, required)
    Categoria do produto.

  - `data.products.category.id` (integer)
    Identificador único da categoria.
    Example: 2

  - `data.products.category.name` (string)
    Nome da categoria.
    Example: "Produção Interna"

  - `data.products.image_url` (null,string)
    URL da imagem do produto.

  - `data.products.tax_settings` (object, required)
    Representa as configurações fiscais de um Produto.

  - `data.products.tax_settings.ncm` (object)
    Representa um NCM.

  - `data.products.tax_settings.ncm.id` (integer)
    ID do NCM.
    Example: 1

  - `data.products.tax_settings.ncm.code` (string)
    Código do NCM.
    Example: "01012100"

  - `data.products.tax_settings.ncm.description` (string)
    Descrição do NCM.
    Example: "01012100 - Cavalos reprodutores de raça pura"

  - `data.products.tax_settings.origin` (object)
    Representa um ICMS de Origem.

  - `data.products.tax_settings.origin.id` (integer)
    ID do ICMS de Origem.
    Example: 1

  - `data.products.tax_settings.origin.description` (string)
    Descrição do ICMS de Origem.
    Example: "0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8"

  - `data.products.tax_settings.cest` (object)
    Representa um CEST.

  - `data.products.tax_settings.cest.id` (integer)
    ID do CEST.
    Example: 6

  - `data.products.tax_settings.cest.code` (string)
    Código do CEST.
    Example: "0100500"

  - `data.products.tax_settings.cest.description` (string)
    Descrição do CEST.
    Example: "0100500 - Frisos, decalques, molduras e acabamentos"

  - `data.products.tax_settings.cfop` (object)
    Representa um CFOP.

  - `data.products.tax_settings.cfop.code` (string)
    Código do CFOP.
    Example: "1101"

  - `data.products.tax_settings.cfop.description` (string)
    Descrição do CFOP.
    Example: "1101 - Compra para industrialização"

  - `data.products.tax_settings.net_weight` (number)
    Peso líquido do produto.
    Example: 12.123

  - `data.products.tax_settings.gross_weight` (number)
    Peso bruto do produto.
    Example: 11.333

  - `data.products.tax_settings.percent_fcp` (number)
    Percentual do Fundo de Combate à Pobreza.
    Example: 10.12

  - `data.products.tax_settings.percent_fcp_st` (number)
    Percentual do Fundo de Combate à Pobreza para Substituição Tributária.
    Example: 9.12

  - `data.products.tax_settings.percent_fcp_st_ret` (number)
    Percentual do Fundo de Combate à Pobreza para Substituição Tributária Retida.
    Example: 1.12

  - `data.products.tax_settings.groups` (array)
    Grupos de configurações fiscais por empresa.

  - `data.products.tax_settings.groups.company` (object, required)
    Dados da empresa relacionado.

  - `data.products.tax_settings.groups.company.id` (integer)
    Identificador único da empresa
    Example: 1234

  - `data.products.tax_settings.groups.company.name` (string)
    Nome fantasia da empresa.
    Example: "CPlug"

  - `data.products.tax_settings.groups.company.company_name` (string,null)
    Razão social da empresa.
    Example: "CPlug Tecnologia da Informação"

  - `data.products.tax_settings.groups.ipi_group` (object)
    Identificador do grupo de IPI.

  - `data.products.tax_settings.groups.ipi_group.id` (integer)
    ID do grupo de IPI.
    Example: 6

  - `data.products.tax_settings.groups.ipi_group.name` (string)
    Nome do grupo de IPI.
    Example: "Grupo de IPI 1"

  - `data.products.tax_settings.groups.icms_group` (object)
    Identificador do grupo de ICMS.

  - `data.products.tax_settings.groups.icms_group.id` (integer)
    ID do grupo de ICMS.
    Example: 6

  - `data.products.tax_settings.groups.icms_group.name` (string)
    Nome do grupo de ICMS.
    Example: "Grupo de ICMS 1"

  - `data.products.tax_settings.groups.pis_cofins_group` (object)
    Identificador do grupo de PIS/COFINS.

  - `data.products.tax_settings.groups.pis_cofins_group.id` (integer)
    ID do grupo de PIS/COFINS.
    Example: 6

  - `data.products.tax_settings.groups.pis_cofins_group.name` (string)
    Nome do grupo de PIS/COFINS.
    Example: "Grupo de PIS/COFINS 1"

  - `data.products.tax_settings.groups.issqn_group` (object)
    Identificador do grupo de ISSQN.

  - `data.products.tax_settings.groups.issqn_group.id` (integer)
    ID do grupo de ISSQN.
    Example: 6

  - `data.products.tax_settings.groups.issqn_group.name` (string)
    Nome do grupo de ISSQN.
    Example: "Grupo de ISSQN 1"

  - `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