---
title: "ConsultaEmLoteViewModel"
url: "https://devcenter.stone.com.br/apis/stone-tax/versions/206fd1c1-6382-4ada-8612-c67fdc65e050/schemas/ConsultaEmLoteViewModel"
---

> Full API specification: https://devcenter.stone.com.br/apis/stone-tax/versions/206fd1c1-6382-4ada-8612-c67fdc65e050.md

# ConsultaEmLoteViewModel

Dados da solicitação de consulta de tributação de produtos em lote.

## OpenAPI definition

```yaml
openapi: 3.0.4
info:
  title: Stone Tax API
  version: 1.0.0
servers:
  - url: https://stone-tax-sdx.stone.com.br
    description: Ambiente de Desenvolvimento
  - url: https://stone-tax.stone.com.br
    description: Ambiente de Produção
components:
  schemas:
    StatusConsultaEmLoteModelEnum:
      enum:
        - Pendente
        - EmProcessamento
        - Concluido
      type: string
      description: Status da consulta de tributação de produtos em lote.
    ConsultaEmLotePerfilTributarioViewModel:
      type: object
      properties:
        codigoMunicipioDestino:
          type: string
          description: Código IBGE do município de destino da operação.
          nullable: true
        finalidade:
          $ref: "#/components/schemas/FinalidadeConsultaTributacaoModelEnum"
        situacaoEspecialDestinatario:
          $ref: "#/components/schemas/SituacaoEspecialDestinatarioConsultaTributacaoModel\
            Enum"
        origemProduto:
          $ref: "#/components/schemas/OrigemProdutoConsultaTributacaoModelEnum"
        produtoFabricacaoPropria:
          type: boolean
          description: Indica se o produto é de fabricação própria do emissor.
        destinatarioSimplesNacional:
          type: boolean
          description: Indica se o destinatário é optante pelo Simples Nacional.
        destinatarioSubstitutoTributario:
          type: boolean
          description: Indica se o destinatário é substituto tributário.
        mercadoriaProduzidaZFM:
          type: boolean
          description: Indica se a mercadoria foi produzida na Zona Franca de Manaus.
      additionalProperties: false
      description: Perfil tributário utilizado na consulta em lote.
    ConsultaEmLoteFiltroViewModel:
      type: object
      properties:
        tipoFiltro:
          $ref: "#/components/schemas/TipoFiltroConsultaProdutoModelEnum"
        filtro:
          type: string
          description: Valor do filtro utilizado na consulta.
          nullable: true
        status:
          $ref: "#/components/schemas/StatusConsultaLoteFiltroResultadoModelEnum"
        resultado:
          $ref: "#/components/schemas/ConsultarProdutoViewModel"
        mensagemFalha:
          type: string
          description: Mensagem de falha, quando o processamento deste filtro resultou em
            erro.
          nullable: true
      additionalProperties: false
      description: Resultado de um filtro individual da consulta de tributação de
        produtos em lote.
    StatusCallbackConsultaLoteModelEnum:
      enum:
        - NaoRealizado
        - Sucesso
        - Falha
      type: string
      description: Status do callback de notificação da consulta de tributação de
        produtos em lote.
    FinalidadeConsultaTributacaoModelEnum:
      enum:
        - VendaConsumidorFinalNaoContribuinte
        - VendaConsumidorFinalContribuinte
        - VendaParaRevenda
        - Bonificacao
        - Transferencia
      type: string
      description: Finalidade da operação fiscal.
    SituacaoEspecialDestinatarioConsultaTributacaoModelEnum:
      enum:
        - Industrial
        - Distribuidor
        - Atacadista
        - ProdutorRural
        - ArmazemGeral
        - OrgaoPublico
      type: string
      description: Situação especial do destinatário da operação fiscal.
    OrigemProdutoConsultaTributacaoModelEnum:
      enum:
        - Nacional
        - EstrangeiraImportacaoDireta
        - EstrangeiraAdquiridaMercadoInterno
        - NacionalConteudoImportacaoSuperior40A70
        - NacionalPPB
        - NacionalConteudoImportacaoInferior40
        - EstrangeiraImportacaoDiretaSemSimilar
        - EstrangeiraAdquiridaMercadoInternoSemSimilar
        - NacionalConteudoImportacaoSuperior70
      type: string
      description: Origem do produto para consulta.
    TipoFiltroConsultaProdutoModelEnum:
      enum:
        - Ean
        - DescricaoSimilar
        - Hash
      type: string
      description: Tipo de filtro do catálogo de produto.
    StatusConsultaLoteFiltroResultadoModelEnum:
      enum:
        - Pendente
        - Sucesso
        - Falha
      type: string
      description: Status do resultado de um filtro da consulta de tributação de
        produtos em lote.
    ConsultarProdutoViewModel:
      type: object
      properties:
        hash:
          type: string
          description: Hash da consulta - identificador do produto dentro da aplicação
            para lastro de consulta de atualização de tributos.
          nullable: true
        ncm:
          type: string
          description: NCM do produto.
          nullable: true
        descricaoNcm:
          type: string
          description: Descrição do NCM.
          nullable: true
        inicioVigenciaNcm:
          type: string
          description: Data de início da vigência do NCM.
          format: date
          example: 2025-03-31
        finalVigenciaNcm:
          type: string
          description: Data do fim da vigência do NCM.
          format: date
          nullable: true
        cest:
          type: string
          description: CEST do produto.
          nullable: true
        cfop:
          type: string
          description: CFOP da operação.
          nullable: true
        icms:
          $ref: "#/components/schemas/ConsultarProdutoIcmsViewModel"
        icmssn:
          $ref: "#/components/schemas/ConsultarProdutoIcmssnViewModel"
        ipi:
          $ref: "#/components/schemas/ConsultarProdutoIpiViewModel"
        pis:
          $ref: "#/components/schemas/ConsultarProdutoPisViewModel"
        cofins:
          $ref: "#/components/schemas/ConsultarProdutoCofinsViewModel"
        ibs:
          $ref: "#/components/schemas/ConsultarProdutoIbsViewModel"
        cbs:
          $ref: "#/components/schemas/ConsultarProdutoCbsViewModel"
        impostoSeletivo:
          $ref: "#/components/schemas/ConsultarProdutoIsViewModel"
      additionalProperties: false
      description: Dados de retorno da consulta da tributação do produto.
    ConsultarProdutoIcmsViewModel:
      type: object
      properties:
        cst:
          type: string
          description: CST.
          nullable: true
        aliquotaIcmsInternaDestino:
          type: number
          description: Alíquota interna de ICMS no estado de destino.
          format: double
        aliquotaFcpDestino:
          type: number
          description: Alíquota do Fundo de Combate à Pobreza (FCP) no destino.
          format: double
        percentualReducaoBaseIcmsDestino:
          type: number
          description: Percentual de redução da base de cálculo do ICMS no destino.
          format: double
        aliquotaIcmsInterestadual:
          type: number
          description: Alíquota de ICMS para operações interestaduais.
          format: double
        percentualReducaoBaseInterestadual:
          type: number
          description: Percentual de redução da base de cálculo do ICMS interestadual.
          format: double
        percentualReducaoBaseSt:
          type: number
          description: Percentual de redução da base de cálculo da Substituição Tributária
            (ST).
          format: double
        mva:
          type: number
          description: MVA - Margem de valor agregado, também chamado de IVA.
          format: double
        mvaAjustado:
          type: number
          description: MVA ajustado para cálculo do ST - Ajuste realizado após validação
            da alíquota interna do destino com alíquota interestadual.
          format: double
        aliquotaSt:
          type: number
          description: Alíquota ICMS ST.
          format: double
        aliquotaFcpSt:
          type: number
          description: Alíquota FCP ST.
          format: double
        percentualDiferimento:
          type: number
          description: Percentual de diferimento.
          format: double
        codigoBeneficio:
          type: string
          description: Código do benefício fiscal se houver.
          nullable: true
        percentualIcmsDesonerado:
          type: number
          description: Percentual de ICMS Desonerado.
          format: double
        desoneracaoDeduzValorItem:
          type: boolean
          description: Indica se a desoneração deve deduzir/descontar no valor do item na
            nota.
          nullable: true
        amparoLegal:
          type: string
          description: Amparo legal.
          nullable: true
      additionalProperties: false
      description: Dados do ICMS incidentes na operação - Regime "Normal".
    ConsultarProdutoIcmssnViewModel:
      type: object
      properties:
        csosn:
          type: string
          description: CSOSN do simples nacional.
          nullable: true
        aliquotaIcmsInternaDestino:
          type: number
          description: Alíquota interna de ICMS no estado de destino.
          format: double
        aliquotaFcpDestino:
          type: number
          description: Alíquota do Fundo de Combate à Pobreza (FCP) no destino.
          format: double
        percentualReducaoBaseIcmsDestino:
          type: number
          description: Percentual de redução da base de cálculo do ICMS no destino.
          format: double
        aliquotaIcmsInterestadual:
          type: number
          description: Alíquota de ICMS para operações interestaduais.
          format: double
        percentualReducaoBaseInterestadual:
          type: number
          description: Percentual de redução da base de cálculo do ICMS interestadual.
          format: double
        percentualReducaoBaseSt:
          type: number
          description: Percentual de redução da base de cálculo da Substituição Tributária
            (ST).
          format: double
        mva:
          type: number
          description: MVA - Margem de valor agregado, também chamado de IVA.
          format: double
        mvaAjustado:
          type: number
          description: MVA ajustado para cálculo do ST - Ajuste realizado após validação
            da alíquota interna do destino com alíquota interestadual.
          format: double
        aliquotaSt:
          type: number
          description: Alíquota ICMS ST.
          format: double
        aliquotaFcpSt:
          type: number
          description: Alíquota FCP ST.
          format: double
        amparoLegal:
          type: string
          description: Amparo legal.
          nullable: true
      additionalProperties: false
      description: Dados do ICMSST incidentes na operação - Simples Nacional.
    ConsultarProdutoIpiViewModel:
      type: object
      properties:
        cst:
          type: string
          description: CST do IPI.
          nullable: true
        aliquota:
          type: number
          description: Alíquota do IPI.
          format: double
        amparoLegal:
          type: string
          description: Amparo legal.
          nullable: true
        codigoEnquadramento:
          type: string
          description: Código do enquadramento legal do IPI.
          nullable: true
      additionalProperties: false
      description: Dados do IPI incidentes na operação.
    ConsultarProdutoPisViewModel:
      type: object
      properties:
        cstEntrada:
          type: string
          description: CST de entrada do PIS.
          nullable: true
        cstSaida:
          type: string
          description: CST de saída do PIS.
          nullable: true
        aliquota:
          type: number
          description: Alíquota do PIS.
          format: double
        naturezaReceitaIsenta:
          type: string
          description: Natureza da receita para produtos isentos e/ou não tributados.
          nullable: true
        amparoLegal:
          type: string
          description: Amparo legal.
          nullable: true
      additionalProperties: false
      description: Dados do PIS incidentes na operação.
    ConsultarProdutoCofinsViewModel:
      type: object
      properties:
        cstEntrada:
          type: string
          description: CST de entrada do COFINS.
          nullable: true
        cstSaida:
          type: string
          description: CST de saída do COFINS.
          nullable: true
        aliquota:
          type: number
          description: Alíquota do COFINS.
          format: double
        naturezaReceitaIsenta:
          type: string
          description: Natureza da receita para produtos isentos e/ou não tributados.
          nullable: true
        amparoLegal:
          type: string
          description: Amparo legal.
          nullable: true
      additionalProperties: false
      description: Dados do COFINS incidentes na operação.
    ConsultarProdutoIbsViewModel:
      type: object
      properties:
        classificacaoTributaria:
          type: string
          description: Classificação tributária do IBS (cClassTrib).
          nullable: true
        descricaoClassificacaoTributaria:
          type: string
          description: Descrição da classificação tributária do IBS.
          nullable: true
        cst:
          type: string
          description: CST do IBS.
          nullable: true
        aliquotaUf:
          type: number
          description: Alíquota do IBS de competência da UF de destino.
          format: double
        aliquotaMunicipio:
          type: number
          description: Alíquota do IBS de competência do município de destino.
          format: double
        percentualReducao:
          type: number
          description: Percentual de redução de alíquota do IBS.
          format: double
        aliquotaEfetivaUf:
          type: number
          description: Alíquota efetiva do IBS de competência da UF de destino.
          format: double
        aliquotaEfetivaMunicipio:
          type: number
          description: Alíquota efetiva do IBS de competência do município de destino.
          format: double
        amparoLegal:
          type: string
          description: Amparo legal.
          nullable: true
      additionalProperties: false
      description: Dados do IBS incidentes na operação.
    ConsultarProdutoCbsViewModel:
      type: object
      properties:
        classificacaoTributaria:
          type: string
          description: Classificação tributária do CBS (cClassTrib).
          nullable: true
        descricaoClassificacaoTributaria:
          type: string
          description: Descrição da classificação tributária do CBS.
          nullable: true
        cst:
          type: string
          description: CST do CBS.
          nullable: true
        aliquota:
          type: number
          description: Alíquota do CBS.
          format: double
        percentualReducao:
          type: number
          description: Percentual de redução de alíquota do CBS.
          format: double
        aliquotaEfetiva:
          type: number
          description: Alíquota efetiva do CBS.
          format: double
        amparoLegal:
          type: string
          description: Amparo legal.
          nullable: true
      additionalProperties: false
      description: Dados do CBS incidentes na operação.
    ConsultarProdutoIsViewModel:
      type: object
      properties:
        classificacaoTributaria:
          type: string
          description: Classificação tributária do IS (cClassTrib).
          nullable: true
        descricaoClassificacaoTributaria:
          type: string
          description: Descrição da classificação tributária do IS.
          nullable: true
        cst:
          type: string
          description: CST do IS.
          nullable: true
        aliquota:
          type: number
          description: Alíquota do IS.
          format: double
        amparoLegal:
          type: string
          description: Amparo legal.
          nullable: true
      additionalProperties: false
      description: Dados do Imposto Seletivo (IS) incidentes na operação.
    ConsultaEmLoteViewModel:
      type: object
      properties:
        id:
          type: string
          description: Identificador da solicitação.
          format: uuid
        status:
          $ref: "#/components/schemas/StatusConsultaEmLoteModelEnum"
        dataSolicitacao:
          type: string
          description: Data de criação da solicitação.
          format: date-time
        dataHoraProcessamento:
          type: string
          description: Data e hora de início do processamento.
          format: date-time
          nullable: true
        perfilTributario:
          $ref: "#/components/schemas/ConsultaEmLotePerfilTributarioViewModel"
        filtros:
          type: array
          items:
            $ref: "#/components/schemas/ConsultaEmLoteFiltroViewModel"
          description: Lista de filtros com os respectivos resultados da consulta.
          nullable: true
        urlCallback:
          type: string
          description: URL de callback para notificação de conclusão.
          nullable: true
        statusCallback:
          $ref: "#/components/schemas/StatusCallbackConsultaLoteModelEnum"
        mensagemFalhaCallback:
          type: string
          description: Mensagem de falha do callback, quando aplicável.
          nullable: true
      additionalProperties: false
      description: Dados da solicitação de consulta de tributação de produtos em lote.
```
