---
title: "Stone Tax API"
url: "https://devcenter.stone.com.br/apis/stone-tax/versions/206fd1c1-6382-4ada-8612-c67fdc65e050"
---
# Stone Tax API
OpenAPI specification document.
```json
{"openapi":"3.0.4","info":{"title":"Stone Tax API","description":"\n\nA Stone Tax API é a solução fiscal da Stone responsável por atuar como middleware entre o portfólio de produtos da companhia e os serviços de documentos fiscais (SEFAZ e prefeituras), oferecendo uma integração simples, segura, performática e padronizada.\n
\n\n\nSeu objetivo é permitir que os produtos cumpram as obrigações acessórias do fisco brasileiro de forma mais eficiente e desacoplada, centralizando regras, reduzindo complexidade e promovendo reutilização de soluções fiscais dentro do ecossistema Stone.\n
\n\n\nAlém de recursos de credenciamento, autenticação e emissão/gestão de documentos fiscais (como NF-e, NFC-e e NFS-e), a API disponibiliza capacidades como Catálogo Fiscal e suporte inteligente ao preenchimento tributário, auxiliando no cálculo e composição de tributos da venda de forma automática e consistente.\n
\n\n\nA API é construída em .NET 8 e projetada com base nos princípios de DDD, EDA e CQRS, com execução de tarefas agendadas via Hangfire.\n
\n\n\nA documentação completa do projeto encontra-se em\nDocumentação Completa.\n
\n\n\nA documentação destinada às aplicações encontra-se em\nDocumentação da aplicação.\n
\n\nContextos de Negócio
\n\n - Autenticação: provê recursos para autenticar usuários do Console e Aplicativos, incluindo emissão e gestão de credenciais e tokens.
\n - Console: provê recursos para criação e gerenciamento de Parceiros e Aplicativos, além de configurações operacionais e administrativas.
\n - Emissor: provê recursos para habilitação e gestão cadastral de emissores, permitindo o controle de regimes tributários e configurações operacionais vinculadas a parceiros e aplicativos.
\n - Catálogo Fiscal: provê recursos para consulta e listagem de produtos por EAN e descrição, incluindo consulta fiscal detalhada por EAN.
\n - NF-e: provê recursos para emissão e gestão de NF-e, incluindo listagem, detalhamento, consultas e obtenção de documentos como DANFE.
\n - NFC-e: provê recursos para emissão e gestão de NFC-e, incluindo listagem, detalhamento, consultas e obtenção de documentos como DANFE.
\n - NFS-e: provê recursos para emissão e gestão de NFS-e, incluindo listagem, detalhamento, consultas e retorno de documentos conforme o padrão de cada município.
\n
\n","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"}],"paths":{"/api/v1/Autenticacao/ObterToken":{"post":{"tags":["Autenticacao"],"summary":"Obter token.","description":"Permite obter o token de acesso a api com base nas credenciais fornecidas pelo operador do serviço. \n\n⚠️ **ATENÇÃO**: O token tem validade de 1 hora. É sugerido armazenar o token em cache para evitar geração de tokens em excesso sobrecarregando o serviço.","requestBody":{"description":"Credenciais de acesso.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/GerarTokenInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/GerarTokenInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/GerarTokenInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/GerarTokenInputModel"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GerarTokenViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/GerarTokenViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/GerarTokenViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}}}},"/api/v1/Autenticacao/AtualizarToken":{"post":{"tags":["Autenticacao"],"summary":"Refresh token.","description":"Permite gerar um novo token com base no token expirado. (Útil para casos onde o token expirou e o operador do serviço deseja obter um novo token sem precisar realizar uma nova autenticação completa). \n\n⚠️ **ATENÇÃO**: O token expirado não pode ter um prazo de expiração superior a 2 horas.","requestBody":{"description":"Dados do token expirado.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/AtualizarTokenInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/AtualizarTokenInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AtualizarTokenInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/AtualizarTokenInputModel"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GerarTokenViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/GerarTokenViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/GerarTokenViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}}}},"/api/v1/CatalogoProduto/Tributacao":{"post":{"tags":["CatalogoProduto"],"summary":"Obter tributação do produto.","description":"Busca informações detalhadas referentes a tributação de um produto. Poderá ser utilizado código de barras, descrição ou hash para realizar as buscas. \n\n⚠️ **ATENÇÃO**: É indicado vincular e salvar o HASH do resultado ao cadastro do produto do sistema consumidor do serviço. O HASH será utilizado para acompanhamento de atualizações futuras da tributação do mesmo.\n\n🧪 **TESTE**: Em ambiente de desenvolvimento/sandbox, os dados dos tributos retornados são fictícios e gerados automaticamente para testes. Não utilize como fonte da verdade em produção. Já em relação ao EAN, o sistema irá validar normalmente, de maneira que para teste de EANs inválidos ou NÃO ENCONTRADOS, poderá aplicar EANs reais.\n\n🔍 **BUSCA POR DESCRIÇÃO**: O ideal é utilizar a busca por descrição quando o produto NÃO POSSUI EAN. A busca por EAN apresenda dados assertivos enquanto pela descrição será aplicado um algorítmo para identificar a tributação do produto.","parameters":[{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados de input para a consulta.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ConsultarProdutoInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConsultarProdutoInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ConsultarProdutoInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/ConsultarProdutoInputModel"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ConsultarProdutoViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConsultarProdutoViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ConsultarProdutoViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/CatalogoProduto/BuscarHash":{"get":{"tags":["CatalogoProduto"],"summary":"Hash de produtos - Buscar.","description":"Permite localizar o identificador único (**HASH**) de tributação de mercadorias através de sua descrição comercial. \n\n🔗 **UTILIZAÇÃO**: Este endpoint é fundamental para identificar o vínculo correto de um produto quando o **EAN (GTIN)** não está disponível, permitindo que o sistema consumidor armazene o HASH para futuras consultas de atualização tributária.\n\n🔍 **CRITÉRIO DE BUSCA**: A busca é processada por algoritmos de similaridade. Recomenda-se o envio de descrições claras e sem abreviações excessivas para garantir que a listagem de hashes retornada seja condizente com o item desejado.","parameters":[{"name":"descricao","in":"query","description":"Descrição comercial ou termo de busca para localizar o produto.","schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BuscarHashDescricaoViewModel"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BuscarHashDescricaoViewModel"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BuscarHashDescricaoViewModel"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/CatalogoProduto/ListarTributacaoAlterada":{"get":{"tags":["CatalogoProduto"],"summary":"Tributos atualizados - Listar.","description":"Fornece uma lista de produtos cuja tributação sofreu atualização no intervalo de tempo fornecido em filtro. Com base no retorno, o sistema consumidor do serviço deverá utilizar o HASH salvo para atualizar os tributos consultados anteriormente.","parameters":[{"name":"hash","in":"query","description":"Filtrar pelo hash de identificação.","schema":{"type":"string"}},{"name":"ultimaAtualizacaoFiscalInicial","in":"query","description":"Filtrar pela data de atualização fiscal \"a partir de\".","schema":{"type":"string","format":"date-time"}},{"name":"ultimaAtualizacaoFiscalFinal","in":"query","description":"Filtrar pela data de atualização fiscal \"até\".","schema":{"type":"string","format":"date-time"}},{"name":"offset","in":"query","description":"Registro inicial para paginação.","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Quantidade de registros por página.","schema":{"type":"integer","format":"int32","default":10}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ListarTributacaoAlteradaViewModelListPaginationResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ListarTributacaoAlteradaViewModelListPaginationResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ListarTributacaoAlteradaViewModelListPaginationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/CatalogoProduto/Historico/Resumo":{"get":{"tags":["CatalogoProduto"],"summary":"Histórico de consultas - Resumo.","description":"Fornece dados totalizados do histórico de consultas na api. Permite ao usuário fazer o acompanhamento da bilhetagem de consumo dos serviços filtrando por intervalo de datas ou texto de busca genérica.","parameters":[{"name":"modoConsulta","in":"query","description":"Filtrar pelo modo da consulta realizada.","schema":{"$ref":"#/components/schemas/ModoConsultaProdutoModelEnum"}},{"name":"tipoFiltro","in":"query","description":"Filtrar pelo tipo de filtro aplicado na consulta.","schema":{"$ref":"#/components/schemas/TipoFiltroConsultaProdutoModelEnum"}},{"name":"busca","in":"query","description":"Busca genérica - Filtro ou Hash.","schema":{"type":"string"}},{"name":"statusConsulta","in":"query","description":"Filtrar pelo status de retorno da consulta.","schema":{"$ref":"#/components/schemas/StatusConsultaProdutoModelEnum"}},{"name":"dataConsultaInicial","in":"query","description":"Filtrar pela data de consulta \"a partir de\".","schema":{"type":"string","format":"date-time"}},{"name":"dataConsultaFinal","in":"query","description":"Filtrar pela data de consulta \"até\".","schema":{"type":"string","format":"date-time"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ResumoConsultasProdutoVisaoAplicacaoViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ResumoConsultasProdutoVisaoAplicacaoViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ResumoConsultasProdutoVisaoAplicacaoViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/CatalogoProduto/Historico/Listar":{"get":{"tags":["CatalogoProduto"],"summary":"Histórico de consultas - Listar.","description":"Permite listar o histórico de consultas realizadas na api. Fornece filtros não obrigatórios por intervalo de datas ou texto de busca genérica.","parameters":[{"name":"modoConsulta","in":"query","description":"Filtrar pelo modo da consulta realizada.","schema":{"$ref":"#/components/schemas/ModoConsultaProdutoModelEnum"}},{"name":"tipoFiltro","in":"query","description":"Filtrar pelo tipo de filtro aplicado na consulta.","schema":{"$ref":"#/components/schemas/TipoFiltroConsultaProdutoModelEnum"}},{"name":"busca","in":"query","description":"Busca genérica - Filtro ou Hash.","schema":{"type":"string"}},{"name":"statusConsulta","in":"query","description":"Filtrar pelo status de retorno da consulta.","schema":{"$ref":"#/components/schemas/StatusConsultaProdutoModelEnum"}},{"name":"dataConsultaInicial","in":"query","description":"Filtrar pela data de consulta \"a partir de\".","schema":{"type":"string","format":"date-time"}},{"name":"dataConsultaFinal","in":"query","description":"Filtrar pela data de consulta \"até\".","schema":{"type":"string","format":"date-time"}},{"name":"offset","in":"query","description":"Paginação da listagem - página atual.","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Paginação da listagem - itens por página.","schema":{"type":"integer","format":"int32","default":10}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ListarConsultasProdutoVisaoAplicacaoViewModelListPaginationResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ListarConsultasProdutoVisaoAplicacaoViewModelListPaginationResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ListarConsultasProdutoVisaoAplicacaoViewModelListPaginationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/CatalogoProduto/Historico/{historicoConsultaEmissorId}/ObterDetalhe":{"get":{"tags":["CatalogoProduto"],"summary":"Histórico de consultas - Detalhe.","description":"Permite obter o detalhe da consulta realizada com base no ID da listagem do histórico.","parameters":[{"name":"historicoConsultaEmissorId","in":"path","description":"Identificador do histórico de consulta do emissor.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/DetalheConsultasProdutoVisaoAplicacaoViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/DetalheConsultasProdutoVisaoAplicacaoViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/DetalheConsultasProdutoVisaoAplicacaoViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/CatalogoProduto/ConsultaEmLote/Solicitar":{"post":{"tags":["CatalogoProduto"],"summary":"Consulta em lote - Solicitar.","description":"Solicita o processamento assíncrono da consulta de tributação de uma lista de produtos em lote.\n \n🔄 **PROCESSAMENTO**: A consulta é processada de forma assíncrona. Utilize o identificador retornado para acompanhar o andamento através do endpoint de consulta.\n \n📋 **FILTROS**: Cada item da lista pode ser identificado por **EAN**, **descrição similar** ou **hash**. Todos os filtros são processados individualmente e o resultado de cada um fica disponível na consulta do lote.\n \n🔔 **CALLBACK**: Informe uma URL de callback para receber uma notificação automática assim que o processamento for concluído. O payload enviado seguirá o mesmo contrato do endpoint de consulta.\n \n⚠️ **ATENÇÃO**: Só é permitida uma consulta em lote em andamento por emissor. Aguarde a conclusão antes de solicitar uma nova.","parameters":[{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados da solicitação de consulta em lote.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/SolicitarConsultaEmLoteInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/SolicitarConsultaEmLoteInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/SolicitarConsultaEmLoteInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/SolicitarConsultaEmLoteInputModel"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string","format":"uuid"}},"application/json":{"schema":{"type":"string","format":"uuid"}},"text/json":{"schema":{"type":"string","format":"uuid"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/CatalogoProduto/ConsultaEmLote/{consultaLoteId}":{"get":{"tags":["CatalogoProduto"],"summary":"Consulta em lote - Consultar solicitação.","description":"Permite o acompanhamento do processamento de uma solicitação de consulta em lote previamente realizada.\n \n🔄 **ESTADOS**: A solicitação pode transitar entre os estados *Pendente*, *EmProcessamento* e *Concluido*. Os resultados individuais de cada filtro só estarão disponíveis quando o status for **Concluido**.\n \n📋 **RESULTADOS**: Cada filtro possui seu próprio status de processamento (*Pendente*, *Sucesso* ou *Falha*). Em caso de falha em um filtro específico, os demais não são impactados.","parameters":[{"name":"consultaLoteId","in":"path","description":"Identificador único da solicitação de consulta em lote.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ConsultaEmLoteViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConsultaEmLoteViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ConsultaEmLoteViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/CatalogoProduto/Produto/Listar":{"get":{"tags":["CatalogoProduto"],"summary":"Produtos consultados - Listar.","description":"Permite a listagem e gestão dos produtos que já foram objeto de consulta pelo Emissor. \nEsta funcionalidade facilita a sincronização de portfólios, permitindo filtrar registros por identificadores \ntécnicos ou períodos específicos de atualização.\n\n🔍 **CRITÉRIOS DE BUSCA**: O campo de busca permite localizar registros de forma flexível, aceitando tanto \no **HASH** de identificação fiscal quanto os termos originais (EAN ou descrição) utilizados no momento da consulta.\n\n📅 **ATUALIZAÇÃO FISCAL**: Utilize os filtros de data para identificar quais itens do seu catálogo local \npodem necessitar de revisão com base na última análise fiscal realizada pela plataforma.","parameters":[{"name":"busca","in":"query","description":"Filtrar pelo hash de identificação ou pelo filtro utilizado na consulta.","schema":{"type":"string"}},{"name":"ultimaAtualizacaoFiscalInicial","in":"query","description":"Filtrar pela data de atualização fiscal \"a partir de\".","schema":{"type":"string","format":"date-time"}},{"name":"ultimaAtualizacaoFiscalFinal","in":"query","description":"Filtrar pela data de atualização fiscal \"até\".","schema":{"type":"string","format":"date-time"}},{"name":"offset","in":"query","description":"Paginação da listagem - página atual.","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Paginação da listagem - itens por página.","schema":{"type":"integer","format":"int32","default":10}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ListarProdutosEmissorViewModelListPaginationResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ListarProdutosEmissorViewModelListPaginationResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ListarProdutosEmissorViewModelListPaginationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/CatalogoProduto/Produto/{produtoEmissorId}/ObterDetalhe":{"get":{"tags":["CatalogoProduto"],"summary":"Produtos consultados - Detalhe.","description":"Permite obter a visão detalhada de um produto específico presente no catálogo do Emissor, \nutilizando seu identificador único gerado pela plataforma.\n\n📋 **INFORMAÇÕES RETORNADAS**: O retorno abrange desde os dados cadastrais básicos (EAN, Descrição, NCM) \naté o histórico de bilhetagem aplicada sobre o produto.\n\n💡 **UTILIZAÇÃO**: Este endpoint é ideal para obter o histórico de bilhetagem do produto.","parameters":[{"name":"produtoEmissorId","in":"path","description":"Identificador interno do produto do emissor.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProdutoEmissorViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProdutoEmissorViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProdutoEmissorViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/DocumentoFiscal/DownloadXml/Solicitar":{"post":{"tags":["DocumentoFiscal"],"summary":"Download de XMLs - Solicitar.","description":"Inicia o processo de geração e recuperação de arquivos XML das notas fiscais de forma assíncrona. \nDevido ao volume de dados, a requisição não retorna os arquivos imediatamente, mas sim um identificador de solicitação.\n\n⚠️ **ATENÇÃO**: O ticket (ID) retornado deve ser utilizado posteriormente no endpoint de consulta de status para verificar se o pacote de arquivos já está disponível para download.\n\n⚙️ **PROCESSAMENTO**: O tempo de geração pode variar conforme o intervalo de datas e a quantidade de documentos filtrados. Recomenda-se evitar solicitações com intervalos superiores a 30 dias para otimizar a performance.\n\n📅 **RESTRIÇÃO DE PERÍODO**: O sistema processa solicitações com um intervalo máximo de 90 dias entre a data inicial e final. Solicitações que excedam este limite retornarão erro de validação.\n\n📂 **CONTEÚDO**: O arquivo final será disponibilizado em formato compactado (.zip) contendo os XMLs autorizados que atendam aos critérios informados.","parameters":[{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Filtros e critérios para a extração dos arquivos XML.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/SolicitarDownloadXmlInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/SolicitarDownloadXmlInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/SolicitarDownloadXmlInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/SolicitarDownloadXmlInputModel"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string","format":"uuid"}},"application/json":{"schema":{"type":"string","format":"uuid"}},"text/json":{"schema":{"type":"string","format":"uuid"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/DocumentoFiscal/DownloadXml/{downloadXmlId}":{"get":{"tags":["DocumentoFiscal"],"summary":"Download de XMLs - Consultar.","description":"Permite o acompanhamento do processamento de uma solicitação de download de arquivos XML previamente realizada. \nAtravés deste endpoint, o sistema consumidor pode verificar se os arquivos já foram compactados e estão prontos para baixar.\n\n🔄 **ESTADOS**: A solicitação pode transitar entre os estados de *Pendente*, *EmProcessamento*, *Concluido*, *Expirado* ou *Falha*. O link de download só será preenchido quando o status for **Concluido**.\n\n🔗 **DISPONIBILIDADE**: Uma vez gerado, o link para o arquivo .zip possui uma validade temporária. Certifique-se de realizar o download assim que o processamento for finalizado.\n\n⚠️ **DICA**: Caso o status retorne como *Falha*, verifique os detalhes da mensagem para identificar se o intervalo de busca foi muito extenso ou se não foram encontrados documentos para os filtros informados.","parameters":[{"name":"downloadXmlId","in":"path","description":"Identificador único (Ticket) da solicitação de download.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/DownloadXmlViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/DownloadXmlViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/DownloadXmlViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/DocumentoFiscal/HistoricoEventos/Listar":{"get":{"tags":["DocumentoFiscal"],"summary":"Histórico de eventos - Listar.","description":"Permite a listagem e rastreabilidade de eventos processados pela API de Notas Fiscais. \nFornece uma visão detalhada do ciclo de vida das requisições, permitindo auditoria técnica e funcional.\n\n🔍 **BUSCA ABRANGENTE**: O campo de busca genérica atua sobre a rota acessada e o conteúdo (body) das requisições, facilitando a localização de transações específicas.\n\n⏱️ **PERFORMANCE**: É possível filtrar eventos por tempo de execução (milissegundos), ideal para identificar gargalos operacionais ou latências atípicas no processamento.\n\n🛡️ **AUDITORIA**: O filtro por sucesso ou erro permite isolar rapidamente falhas de integração ou validações de negócio impeditivas.","parameters":[{"name":"tipoEvento","in":"query","description":"Filtrar pelo tipo do evento da nota fiscal.","schema":{"$ref":"#/components/schemas/TipoEventoNotaFiscalModelEnum"}},{"name":"sucesso","in":"query","description":"Filtrar por eventos com sucesso ou erro.","schema":{"type":"boolean"}},{"name":"busca","in":"query","description":"Termo de busca genérico (rota ou conteúdo).","schema":{"type":"string"}},{"name":"dataInicial","in":"query","description":"Filtrar pela data de início do evento \"a partir de\".","schema":{"type":"string","format":"date-time"}},{"name":"dataFinal","in":"query","description":"Filtrar pela data de início do evento \"até\".","schema":{"type":"string","format":"date-time"}},{"name":"duracaoInicialMilissegundos","in":"query","description":"Filtrar pela duração mínima em milissegundos.","schema":{"type":"number","format":"double"}},{"name":"duracaoFinalMilissegundos","in":"query","description":"Filtrar pela duração máxima em milissegundos.","schema":{"type":"number","format":"double"}},{"name":"offset","in":"query","description":"Registro inicial para paginação.","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Quantidade de registros por página.","schema":{"type":"integer","format":"int32","default":10}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ListarHistoricoEventosNotaFiscalViewModelListPaginationResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ListarHistoricoEventosNotaFiscalViewModelListPaginationResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ListarHistoricoEventosNotaFiscalViewModelListPaginationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/DocumentoFiscal/HistoricoEventos/{historicoEventoId}/ObterDetalhe":{"get":{"tags":["DocumentoFiscal"],"summary":"Histórico de eventos - Detalhe.","description":"Permite obter o detalhamento completo de um evento específico vinculado a uma Nota Fiscal, utilizando o identificador único do histórico. \n\nEsta operação é fundamental para a rastreabilidade de ocorrências e conferência de logs de processamento ou eventos fiscais (como cancelamentos, cartas de correção, etc.) registrados na plataforma.","parameters":[{"name":"historicoEventoId","in":"path","description":"Identificador único do histórico do evento.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ObterDetalheHistoricoEventosNotaFiscalViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ObterDetalheHistoricoEventosNotaFiscalViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ObterDetalheHistoricoEventosNotaFiscalViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/DocumentoFiscal/HistoricoEventos/Resumo":{"get":{"tags":["DocumentoFiscal"],"summary":"Histórico de eventos - Resumo.","description":"Fornece uma visão consolidada e simplificada dos eventos vinculados ao processamento de Notas Fiscais. \nPermite o monitoramento operacional através de filtros por tipo de evento, performance (duração) e status da execução.","parameters":[{"name":"tipoEvento","in":"query","description":"Filtrar pelo tipo do evento da nota fiscal.","schema":{"$ref":"#/components/schemas/TipoEventoNotaFiscalModelEnum"}},{"name":"sucesso","in":"query","description":"Filtrar por eventos com sucesso ou erro.","schema":{"type":"boolean"}},{"name":"busca","in":"query","description":"Filtrar pela busca genérica por texto.","schema":{"type":"string"}},{"name":"dataInicial","in":"query","description":"Filtrar pela data de início do evento \"a partir de\".","schema":{"type":"string","format":"date-time"}},{"name":"dataFinal","in":"query","description":"Filtrar pela data de início do evento \"até\".","schema":{"type":"string","format":"date-time"}},{"name":"duracaoInicialMilissegundos","in":"query","description":"Filtrar pela duração mínima em milissegundos.","schema":{"type":"number","format":"double"}},{"name":"duracaoFinalMilissegundos","in":"query","description":"Filtrar pela duração máxima em milissegundos.","schema":{"type":"number","format":"double"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ObterResumoHistoricoEventosNotaFiscalViewModel"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ObterResumoHistoricoEventosNotaFiscalViewModel"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ObterResumoHistoricoEventosNotaFiscalViewModel"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Emissor/Habilitar":{"post":{"tags":["Emissor"],"summary":"Habilitar emissor.","description":"Permite habilitar um novo emissor para uso na aplicação. Para realização de consultas da tributação dos produtos e emissão de notas fiscais é fundamental o credenciamento do emissor.\n\n⚠️ **ATENÇÃO**: É necessário que os dados cadastrais do emissor estejam corretos e atualizados para retorno assertivo da tributação dos produtos nas consultas e emissão de notas fiscais.","requestBody":{"description":"Dados necessários para habilitar o emissor.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/HabilitarEmissorInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/HabilitarEmissorInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/HabilitarEmissorInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/HabilitarEmissorInputModel"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Emissor/{documentoEmissor}/Atualizar":{"put":{"tags":["Emissor"],"summary":"Atualização de dados cadastrais.","description":"Permite atualizar os dados cadastrais do emissor.\n\n⚠️ **ATENÇÃO**: É necessário que os dados cadastrais do emissor estejam corretos e atualizados para retorno assertivo da tributação dos produtos nas consultas e emissão de notas fiscais.","parameters":[{"name":"documentoEmissor","in":"path","description":"Documento do emissor a ser atualizado.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados atualizados do emissor.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/AtualizarDadosEmissorInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/AtualizarDadosEmissorInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AtualizarDadosEmissorInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/AtualizarDadosEmissorInputModel"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Emissor/{documentoEmissor}/Desabilitar":{"delete":{"tags":["Emissor"],"summary":"Desabilitar emissor.","description":"Permite desabilitar o emissor da aplicação, impedindo o uso dos recursos pelo mesmo.\n\n⚠️ **ATENÇÃO**: Após desabilitar o emissor, o mesmo ficará inativo no sistema, não permitindo mais realizar operações para o mesmo.","parameters":[{"name":"documentoEmissor","in":"path","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Emissor/{documentoEmissor}/CertificadoDigital/Adicionar":{"post":{"tags":["Emissor"],"summary":"Adicionar certificado digital.","description":"Permite adicionar o certificado digital para o emissor. O certificado digital é fundamental para emissão de documentos fiscais.\n\n⚠️ **ATENÇÃO**: O sistema só permite o uso de certificado digital modelo A1 com extensão de arquivo .PFX ou .P12.\n\n🚨 **IMPORTANTE**: Após o vencimento do certificado digital atual, o mesmo deve ser removido para adição de um novo.","parameters":[{"name":"documentoEmissor","in":"path","description":"Documento do emissor associado ao certificado.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["CertificadoDigital","Senha"],"type":"object","properties":{"CertificadoDigital":{"minLength":1,"type":"string","description":"Arquivo PFX contendo o certificado digital do emissor.","format":"binary"},"Senha":{"minLength":1,"type":"string","description":"Senha do certificado digital."}}},"encoding":{"CertificadoDigital":{"style":"form"},"Senha":{"style":"form"}}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CertificadoDigitalViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/CertificadoDigitalViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/CertificadoDigitalViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Emissor/{documentoEmissor}/CertificadoDigital/Remover":{"delete":{"tags":["Emissor"],"summary":"Remover certificado digital.","description":"Permite remover o certificado digital do emissor.\n\n🚨 **IMPORTANTE**: Após o vencimento do certificado digital atual, o mesmo deve ser removido para adição de um novo.","parameters":[{"name":"documentoEmissor","in":"path","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Emissor/{documentoEmissor}/Parametros/Nfce/Definir":{"post":{"tags":["Emissor"],"summary":"Parâmetros da NFC-e.","description":"Permite definir os parâmetros de emissão da NFC-e.\n\n⚠️ **ATENÇÃO**: É necessário observar se o emissor já realizou emissão de NFC-e antes em outro sistema e definir a série e numeração única adequada para evitar rejeição por duplicidade.","parameters":[{"name":"documentoEmissor","in":"path","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados dos parâmetros da NFC-e.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/DefinirParametrosNfceInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/DefinirParametrosNfceInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/DefinirParametrosNfceInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/DefinirParametrosNfceInputModel"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Emissor/{documentoEmissor}/Parametros/Nfe/Definir":{"post":{"tags":["Emissor"],"summary":"Parâmetros da NF-e.","description":"Permite definir os parâmetros de emissão da NF-e.\n\n⚠️ **ATENÇÃO**: É necessário observar se o emissor já realizou emissão de NF-e antes em outro sistema e definir a série e numeração única adequada para evitar rejeição por duplicidade.","parameters":[{"name":"documentoEmissor","in":"path","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados dos parâmetros da NF-e.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/DefinirParametrosNfeInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/DefinirParametrosNfeInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/DefinirParametrosNfeInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/DefinirParametrosNfeInputModel"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Emissor/{documentoEmissor}/Parametros/Nfse/Definir":{"post":{"tags":["Emissor"],"summary":"Parâmetros da NFS-e.","description":"Permite definir os parâmetros de emissão da NFS-e.\n \n⚠️ **ATENÇÃO**: É necessário observar se o emissor já realizou emissão de NFS-e antes em outro sistema e definir a série e numeração única adequada para evitar rejeição por duplicidade.","parameters":[{"name":"documentoEmissor","in":"path","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados dos parâmetros da NFS-e.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/DefinirParametrosNfseInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/DefinirParametrosNfseInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/DefinirParametrosNfseInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/DefinirParametrosNfseInputModel"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Emissor/Listar":{"get":{"tags":["Emissor"],"summary":"Listar emissores.","description":"Permite listar todos os emissores so aplicativo. O recurso possui filtros não obrigatórios e mecanismo de paginação.","parameters":[{"name":"busca","in":"query","description":"Filtrar por nome, documento ou identificador por texto.","schema":{"type":"string"}},{"name":"documentoEmissor","in":"query","description":"Filtrar pelo documento do emissor.","schema":{"type":"string"}},{"name":"dataCriacaoInicial","in":"query","description":"Filtrar pela data de criação inicial.","schema":{"type":"string","format":"date-time"}},{"name":"dataCriacaoFinal","in":"query","description":"Filtrar pela data de criação final.","schema":{"type":"string","format":"date-time"}},{"name":"status","in":"query","description":"Filtrar pelo status atual do emissor.","schema":{"$ref":"#/components/schemas/StatusEmissorModelEnum"}},{"name":"tipoDocumento","in":"query","description":"Filtrar pelo tipo de documento.","schema":{"$ref":"#/components/schemas/TipoDocumentoEmissorModelEnum"}},{"name":"regimeTributario","in":"query","description":"Filtrar pela lista de regimes tributários.","schema":{"type":"array","items":{"$ref":"#/components/schemas/RegimeTributarioModelEnum"}}},{"name":"estabelecimento","in":"query","description":"Filtrar pelo tipo de estabelecimento.","schema":{"$ref":"#/components/schemas/TipoEstabelecimentoEmissorModelEnum"}},{"name":"offset","in":"query","description":"Paginação da listagem - offset.","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Paginação da listagem - limit.","schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EmissorListagemViewModelListPaginationResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmissorListagemViewModelListPaginationResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmissorListagemViewModelListPaginationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Emissor/{documento}/ObterDetalhe":{"get":{"tags":["Emissor"],"summary":"Obter detalhe.","description":"Permite obter os dados cadastrais completos do emissor selecionado.","parameters":[{"name":"documento","in":"path","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EmissorDetalheViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmissorDetalheViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmissorDetalheViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfce/Sefaz/Status":{"post":{"tags":["Nfce"],"summary":"Status SEFAZ.","description":"Realiza a verificação em tempo real da disponibilidade dos serviços da SEFAZ (Secretaria da Fazenda) para a autorização de documentos fiscais. \n\nEste recurso é essencial para diagnosticar instabilidades no webservice de destino, permitindo que o sistema emissor decida pela ativação de regimes de contingência ou aguarde a normalização do serviço.\n\n⚠️ **ATENÇÃO**: O tempo de resposta deste endpoint depende diretamente da latência do servidor governamental consultado. Recomenda-se implementar um timeout adequado no lado do cliente para evitar retenção de threads.\n\n🧪 **TESTE**: Em ambiente de sandbox, o retorno pode simular um status de \"Operação Normal\" de forma estática ou refletir o ambiente de homologação da SEFAZ, dependendo da configuração da aplicação.","parameters":[{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ConsultarStatusSefazViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConsultarStatusSefazViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ConsultarStatusSefazViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfce/Emitir/ModoAutomatico":{"post":{"tags":["Nfce"],"summary":"Emitir NFCe - Modo Automático.","description":"Realiza o processamento e a transmissão de uma Nota Fiscal de Consumidor Eletrônica (modelo 65) no modo automático, otimizando o preenchimento de campos tributários complexos por meio de automações internas da API.\n\n⚠️ **ATENÇÃO**: Esta operação possui validade jurídica perante a SEFAZ. Certifique-se de que os dados do destinatário e dos itens estão corretos antes de processar a emissão, pois a autorização consome recursos do ambiente de produção.\n\n🧪 **TESTE**: Em ambiente de sandbox, as notas emitidas NÃO possuem valor fiscal e são enviadas para os servidores de homologação da SEFAZ. Utilize este ambiente para validar a estrutura do JSON e o fluxo de resposta antes do go-live.\n\n⚙️ **PROCESSAMENTO**: O retorno bem-sucedido confirma o recebimento pela mensageria. \n\nErro 422: A nota foi salva no sistema, mas não autorizada pela SEFAZ. \n\nAção necessária: Analisar o motivo da rejeição para reenviar o documento ou realizar o cancelamento para inutilizar a numeração junto ao fisco.","parameters":[{"name":"inscricaoEstadualEmissor","in":"header","description":"Inscrição estadual do emissor (Opcional).","schema":{"type":"string"}},{"name":"danfe","in":"header","description":"Escolha o formato do DANFE gerado na emissão da nota (Default: Nenhum).","schema":{"$ref":"#/components/schemas/DanfeEmissaoNotasModelEnum"}},{"name":"tipoDanfeNfce","in":"header","description":"Tipo de DANFE gerado (Opcional).","schema":{"$ref":"#/components/schemas/TipoDanfeNfceModelEnum"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados para emissão da NFCe Automática.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/NfceAutomaticaInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/NfceAutomaticaInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/NfceAutomaticaInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/NfceAutomaticaInputModel"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"422":{"description":"Unprocessable Content","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfce/Emitir/ModoSimplificado":{"post":{"tags":["Nfce"],"summary":"Emitir NFCe - Modo Simplificado.","description":"Realiza o processamento e a transmissão de uma Nota Fiscal de Consumidor Eletrônica (modelo 65) no modo simplificado, ocultando campos de base e valor de tributos calculados pelo sistema.\n\n⚠️ **ATENÇÃO**: Esta operação possui validade jurídica perante a SEFAZ. Certifique-se de que os dados do destinatário e dos itens estão corretos antes de processar a emissão, pois a autorização consome recursos do ambiente de produção.\n\n🧪 **TESTE**: Em ambiente de sandbox, as notas emitidas NÃO possuem valor fiscal e são enviadas para os servidores de homologação da SEFAZ. Utilize este ambiente para validar a estrutura do JSON e o fluxo de resposta antes do go-live.\n\n⚙️ **PROCESSAMENTO**: O retorno bem-sucedido confirma o recebimento pela mensageria. \n\nErro 422: A nota foi salva no sistema, mas não autorizada pela SEFAZ. \n\nAção necessária: Analisar o motivo da rejeição para reenviar o documento ou realizar o cancelamento para inutilizar a numeração junto ao fisco.","parameters":[{"name":"inscricaoEstadualEmissor","in":"header","description":"Inscrição estadual do emissor (Opcional).","schema":{"type":"string"}},{"name":"danfe","in":"header","description":"Escolha o formato do DANFE gerado na emissão da nota (Default: Nenhum).","schema":{"$ref":"#/components/schemas/DanfeEmissaoNotasModelEnum"}},{"name":"tipoDanfeNfce","in":"header","description":"Tipo de DANFE gerado (Opcional).","schema":{"$ref":"#/components/schemas/TipoDanfeNfceModelEnum"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados para emissão da NFCe simplificada.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/NfceSimplificadaInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/NfceSimplificadaInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/NfceSimplificadaInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/NfceSimplificadaInputModel"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"422":{"description":"Unprocessable Content","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfce/Emitir":{"post":{"tags":["Nfce"],"summary":"Emitir NFCe.","description":"Realiza o processamento e a transmissão de uma **Nota Fiscal de Consumidor Eletrônica (Modelo 65)** para a SEFAZ no modo completo, preenchendo todos os campos tributários. \nO endpoint abrange desde a validação do schema XML até a assinatura digital e autorização em tempo real.\n\n⚠️ **ATENÇÃO**: Certifique-se de que os dados de impostos (ICMS, PIS, COFINS) e as informações do destinatário estejam em conformidade com as regras fiscais vigentes para evitar rejeições de validação da SEFAZ.\n\n🧪 **TESTE**: Em ambiente de homologação, as notas emitidas possuem **sem valor fiscal**. Utilize o CNPJ de teste apropriado e verifique se o prefixo da série está configurado para o ambiente de testes para evitar conflitos de numeração.\n\n⚙️ **PROCESSAMENTO**: O retorno bem-sucedido confirma o recebimento pela mensageria. \n\nErro 422: A nota foi salva no sistema, mas não autorizada pela SEFAZ. \n\nAção necessária: Analisar o motivo da rejeição para reenviar o documento ou realizar o cancelamento para inutilizar a numeração junto ao fisco.","parameters":[{"name":"inscricaoEstadualEmissor","in":"header","description":"Inscrição estadual do emissor (Opcional).","schema":{"type":"string"}},{"name":"danfe","in":"header","description":"Escolha o formato do DANFE gerado na emissão da nota (Default: Nenhum).","schema":{"$ref":"#/components/schemas/DanfeEmissaoNotasModelEnum"}},{"name":"tipoDanfeNfce","in":"header","description":"Tipo de DANFE gerado (Opcional).","schema":{"$ref":"#/components/schemas/TipoDanfeNfceModelEnum"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados para a emissão da nota fiscal de consumidor eletrônica.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/NfceInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/NfceInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/NfceInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/NfceInputModel"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"422":{"description":"Unprocessable Content","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfce/{filtro}/ContingenciaOffline/Transmitir":{"post":{"tags":["Nfce"],"summary":"Transmitir Contingência.","description":"Realiza a transmissão de uma NFCe que foi emitida previamente sob o regime de contingência offline. \nEste recurso é essencial para regularizar a situação fiscal de documentos gerados sem comunicação prévia com a SEFAZ devido a problemas técnicos.\n\n⚠️ **ATENÇÃO**: A transmissão deve ser realizada respeitando os prazos legais estabelecidos pelo ajuste SINIEF para evitar penalidades. Certifique-se de que os dados do XML transmitido são idênticos aos do documento entregue ao consumidor.\n\n⚙️ **PROCESSAMENTO**: O sistema validará a assinatura digital e o status do documento antes de submeter o lote para autorização. Caso o documento já tenha sido autorizado anteriormente, o serviço retornará o protocolo existente.","parameters":[{"name":"filtro","in":"path","description":"Chave de acesso da nota fiscal (44 dígitos) ou Código ERP.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfce/Listar":{"get":{"tags":["Nfce"],"summary":"Listar NFCe´s.","description":"Fornece uma listagem detalhada das Notas Fiscais de Consumidor Eletrônicas (NFCe) emitidas ou processadas pelo Emissor. \n\n🔍 **CAPACIDADE DE BUSCA**: O recurso suporta filtros complexos que permitem a extração de relatórios e a reconciliação fiscal. O campo `busca` realiza uma varredura genérica em múltiplos campos (número, série, chave e participantes).\n\n📑 **PAGINAÇÃO**: A API utiliza o modelo de offset e limit. Recomendamos o uso de limites baixos (ex: 50 registros) para garantir a performance da resposta e economia de banda.\n\n⚖️ **CONTEXTO FISCAL**: Os resultados refletem o estado atual dos documentos na base da Stone Tax, permitindo filtrar por status específicos (Autorizada, Cancelada, Rejeitada, etc.) e intervalos de valores ou datas.","parameters":[{"name":"notaFiscalId","in":"query","description":"Filtrar pelo identificador único da nota fiscal no sistema.","schema":{"type":"string","format":"uuid"}},{"name":"codigoErp","in":"query","description":"Filtrar pelo código ERP.","schema":{"type":"string"}},{"name":"busca","in":"query","description":"Filtrar pelo termo de busca genérica.","schema":{"type":"string"}},{"name":"inscricaoEstadualEmissor","in":"query","description":"Filtrar pela inscrição estadual do emissor do documento.","schema":{"type":"string"}},{"name":"numeroDocumento","in":"query","description":"Filtrar pelo número sequencial do documento fiscal.","schema":{"type":"string"}},{"name":"serie","in":"query","description":"Filtrar pela série do documento fiscal.","schema":{"type":"string"}},{"name":"chaveAcesso","in":"query","description":"Filtrar pel lista de chaves de acesso (44 dígitos).","schema":{"type":"array","items":{"type":"string"}}},{"name":"documentoParticipante","in":"query","description":"Filtrar pelo documento (CPF/CNPJ) do participante.","schema":{"type":"string"}},{"name":"nomeParticipante","in":"query","description":"Filtrar pel nome ou razão social do participante.","schema":{"type":"string"}},{"name":"dataEmissaoInicial","in":"query","description":"Filtrar documentos emitidos a partir desta data.","schema":{"type":"string","format":"date-time"}},{"name":"dataEmissaoFinal","in":"query","description":"Filtrar documentos emitidos até esta data.","schema":{"type":"string","format":"date-time"}},{"name":"dataCancelamentoInicial","in":"query","description":"Filtrar documentos cancelados a partir desta data.","schema":{"type":"string","format":"date-time"}},{"name":"dataCancelamentoFinal","in":"query","description":"Filtrar documentos cancelados até esta data.","schema":{"type":"string","format":"date-time"}},{"name":"valorDocumentoInicial","in":"query","description":"Filtrar pelo valor mínimo do documento.","schema":{"type":"number","format":"double"}},{"name":"valorDocumentoFinal","in":"query","description":"Filtrar pel valor máximo do documento.","schema":{"type":"number","format":"double"}},{"name":"status","in":"query","description":"Filtrar pelo status atual da nota fiscal.","schema":{"$ref":"#/components/schemas/StatusNotaFiscalModelEnum"}},{"name":"consumidorFinal","in":"query","description":"Filtrar pelo indicador do documento emitido para consumidor final.","schema":{"type":"boolean"}},{"name":"documentoTransportador","in":"query","description":"Filtrar pelo documento (CPF/CNPJ) da transportadora.","schema":{"type":"string"}},{"name":"nomeTransportador","in":"query","description":"Filtrar pelo nome ou razão Social da transportadora.","schema":{"type":"string"}},{"name":"modalidadeFrete","in":"query","description":"Filtrar pela modalidade do frete.","schema":{"$ref":"#/components/schemas/ModalidadeFreteNotaFiscalModelEnum"}},{"name":"documentoIntermediador","in":"query","description":"Filtrar pelo documento (CPF/CNPJ) do intermediador.","schema":{"type":"string"}},{"name":"identificadorIntermediador","in":"query","description":"Filtrar pelo identificador do intermediador na plataforma.","schema":{"type":"string"}},{"name":"modoContingenciaOffline","in":"query","description":"Filtrar por notas que foram geradas em modo de contingência offline, ou seja, sem comunicação com a SEFAZ no momento da emissão.","schema":{"type":"boolean"}},{"name":"ordenarPor","in":"query","description":"Campo pelo qual a listagem será ordenada. Padrão: DataEmissao.","schema":{"$ref":"#/components/schemas/OrdenacaoListarNotasFiscaisModelEnum"}},{"name":"ordemDecrescente","in":"query","description":"Define se a ordenação é decrescente. Padrão: true.","schema":{"type":"boolean","default":true}},{"name":"offset","in":"query","description":"Paginação da listagem - offset.","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Paginação da listagem - limit.","schema":{"type":"integer","format":"int32","default":10}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ListarNotasFiscaisViewModelListPaginationResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ListarNotasFiscaisViewModelListPaginationResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ListarNotasFiscaisViewModelListPaginationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfce/Resumo":{"get":{"tags":["Nfce"],"summary":"Resumo de NFCe´s.","description":"Fornece dados totalizados e consolidados de notas fiscais de consumidor eletrônicas (NFCe) com base nos filtros aplicados. \nEste recurso é ideal para alimentar dashboards, painéis de conferência ou indicadores financeiros (KPIs), \npermitindo uma visão macro do volume de documentos e valores sem a necessidade de processar a listagem completa.\n\n\nA consulta suporta múltiplos critérios de filtragem, abrangendo desde dados básicos do documento (número, série, chave) \naté informações de atores envolvidos (participante, transportador e intermediador).\n\n🔍 **DICA DE PERFORMANCE**: Para consultas em grandes volumes de dados, priorize o uso da Chave de Acesso \nou o intervalo de Data de Emissão para garantir maior agilidade no retorno.","parameters":[{"name":"notaFiscalId","in":"query","description":"Filtrar pelo identificador único da nota fiscal no sistema.","schema":{"type":"string","format":"uuid"}},{"name":"codigoErp","in":"query","description":"Filtrar pelo código ERP.","schema":{"type":"string"}},{"name":"busca","in":"query","description":"Filtrar pelo termo de busca genérica.","schema":{"type":"string"}},{"name":"inscricaoEstadualEmissor","in":"query","description":"Filtrar pela inscrição estadual do emissor do documento.","schema":{"type":"string"}},{"name":"numeroDocumento","in":"query","description":"Filtrar pelo número sequencial do documento fiscal.","schema":{"type":"string"}},{"name":"serie","in":"query","description":"Filtrar pela série do documento fiscal.","schema":{"type":"string"}},{"name":"chaveAcesso","in":"query","description":"Filtrar pel lista de chaves de acesso (44 dígitos).","schema":{"type":"array","items":{"type":"string"}}},{"name":"documentoParticipante","in":"query","description":"Filtrar pelo documento (CPF/CNPJ) do participante.","schema":{"type":"string"}},{"name":"nomeParticipante","in":"query","description":"Filtrar pel nome ou razão social do participante.","schema":{"type":"string"}},{"name":"dataEmissaoInicial","in":"query","description":"Filtrar documentos emitidos a partir desta data.","schema":{"type":"string","format":"date-time"}},{"name":"dataEmissaoFinal","in":"query","description":"Filtrar documentos emitidos até esta data.","schema":{"type":"string","format":"date-time"}},{"name":"dataCancelamentoInicial","in":"query","description":"Filtrar documentos cancelados a partir desta data.","schema":{"type":"string","format":"date-time"}},{"name":"dataCancelamentoFinal","in":"query","description":"Filtrar documentos cancelados até esta data.","schema":{"type":"string","format":"date-time"}},{"name":"valorDocumentoInicial","in":"query","description":"Filtrar pelo valor mínimo do documento.","schema":{"type":"number","format":"double"}},{"name":"valorDocumentoFinal","in":"query","description":"Filtrar pel valor máximo do documento.","schema":{"type":"number","format":"double"}},{"name":"status","in":"query","description":"Filtrar pelo status atual da nota fiscal.","schema":{"$ref":"#/components/schemas/StatusNotaFiscalModelEnum"}},{"name":"consumidorFinal","in":"query","description":"Filtrar pelo indicador do documento emitido para consumidor final.","schema":{"type":"boolean"}},{"name":"documentoTransportador","in":"query","description":"Filtrar pelo documento (CPF/CNPJ) da transportadora.","schema":{"type":"string"}},{"name":"nomeTransportador","in":"query","description":"Filtrar pelo nome ou razão Social da transportadora.","schema":{"type":"string"}},{"name":"modalidadeFrete","in":"query","description":"Filtrar pela modalidade do frete.","schema":{"$ref":"#/components/schemas/ModalidadeFreteNotaFiscalModelEnum"}},{"name":"documentoIntermediador","in":"query","description":"Filtrar pelo documento (CPF/CNPJ) do intermediador.","schema":{"type":"string"}},{"name":"identificadorIntermediador","in":"query","description":"Filtrar pelo identificador do intermediador na plataforma.","schema":{"type":"string"}},{"name":"modoContingenciaOffline","in":"query","description":"Filtrar por notas que foram geradas em modo de contingência offline, ou seja, sem comunicação com a SEFAZ no momento da emissão.","schema":{"type":"boolean"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ObterTotalizacaoListagemViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ObterTotalizacaoListagemViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ObterTotalizacaoListagemViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfce/{filtro}/StatusFiscal":{"get":{"tags":["Nfce"],"summary":"Status da NFCe.","description":"Retorna o status de uma nota fiscal de consumidor eletrônica (NFCe) identificada pelo código ERP ou chave de acesso.\n \n🔍 **IDENTIFICAÇÃO**: O filtro aceita a chave de acesso da nota fiscal (44 dígitos numéricos) ou o código ERP informado pelo integrador no momento da emissão.\n \n📋 **RETORNO**: Inclui modelo, série, número, chave de acesso, status, protocolos de autorização/cancelamento e mensagem da SEFAZ.","parameters":[{"name":"filtro","in":"path","description":"Chave de acesso da nota fiscal (44 dígitos) ou Código ERP.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ObterStatusFiscalViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ObterStatusFiscalViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ObterStatusFiscalViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfce/{filtro}/ObterDanfe/{tipoDanfe}/{formato}":{"get":{"tags":["Nfce"],"summary":"DANFE NFCe (PDF).","description":"Recupera a representação gráfica da NFCe, conhecida como DANFE (Documento Auxiliar da Nota Fiscal Eletrônica). \n\n📄 **FORMATO DE SAÍDA**: O recurso retorna o arquivo em formato PDF, codificado em Base64. Para a visualização, o sistema consumidor deve realizar o decode da string e salvar o binário com a extensão `.pdf`.\n\n⚖️ **VALIDADE JURÍDICA**: O DANFE é apenas um documento auxiliar para facilitar a consulta e o transporte das mercadorias. Ele não substitui o arquivo XML, que é o documento fiscal eletrônico de existência apenas digital e valor jurídico real.\n\n🧪 **TESTE**: Em ambiente de sandbox, o DANFE gerado conterá a marca d'água \"SEM VALOR FISCAL - AMBIENTE DE HOMOLOGAÇÃO\", conforme exigência da SEFAZ para testes.\n\n🔍 **DISPONIBILIDADE**: O documento só poderá ser gerado para chaves de acesso que possuam o status de Autorizada ou Cancelada na base de dados.","parameters":[{"name":"tipoDanfe","in":"path","description":"Tipo de danfe para NFCe.","required":true,"schema":{"$ref":"#/components/schemas/TipoDanfeNfceModelEnum"}},{"name":"formato","in":"path","description":"Formato do danfe.","required":true,"schema":{"$ref":"#/components/schemas/FormatoDanfeModelEnum"}},{"name":"filtro","in":"path","description":"Chave de acesso da nota fiscal (44 dígitos) ou Código ERP.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfce/{filtro}/ObterXml":{"get":{"tags":["Nfce"],"summary":"Obter XML (procNFCe).","description":"Recupera o arquivo XML de distribuição da nota fiscal de consumidor eletrônica. Este é o documento oficial com validade jurídica, contendo o protocolo de autorização da SEFAZ.\n\n⚖️ **GUARDA FISCAL**: Conforme a legislação vigente, o emitente e o destinatário devem manter os arquivos digitais das NF-e/NFCe pelo prazo decadencial estabelecido na lei tributária (geralmente 5 anos), sendo este endpoint a ferramenta ideal para o download e arquivamento.\n\n🛠️ **ESTRUTURA**: O retorno consiste no XML completo, incluindo as tags de assinatura digital e o nó `protNFe` (Protocolo de Autorização), caracterizando o documento como processado e apto para a escrituração contábil.\n\n🧪 **TESTE**: Em ambiente de homologação, o XML retornado possui as tags de ambiente identificadas como `tpAmb = 2`, indicando que o documento não possui validade comercial ou fiscal.","parameters":[{"name":"filtro","in":"path","description":"Chave de acesso da nota fiscal (44 dígitos) ou Código ERP.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfce/{filtro}/Cancelar":{"post":{"tags":["Nfce"],"summary":"Cancelamento de NFCe.","description":"Registra um Evento de Cancelamento para uma nota fiscal de consumidor eletrônica (NFCe). Esta operação invalida a existência jurídica do documento perante a SEFAZ.\n\n⚠️ **NOTAS REJEITADAS**: Caso o documento fiscal esteja com status de Rejeitado, o processo de cancelamento nesta API acionará automaticamente a Inutilização de Numeração. Isso garante que a sequência numérica do emissor permaneça íntegra e em conformidade com as normas da SEFAZ, evitando \"buracos\" na numeração fiscal.\n\n⏳ **PRAZO LEGAL**: O cancelamento deve respeitar o prazo regulamentar definido pela legislação estadual vigente (geralmente 24h para NF-e). Após este período, a operação poderá exigir procedimentos administrativos ou estar sujeita a penalidades por cancelamento extemporâneo.\n\n📄 **CONDIÇÃO DE USO**: Só é possível cancelar uma nota que tenha sido Autorizada ou Rejeitada (via inutilização), e cujo Fato Gerador (saída da mercadoria) ainda não tenha ocorrido.\n\n🧪 **TESTE**: Em ambiente de homologação, o cancelamento é processado junto aos servidores de teste, permitindo validar a estrutura da justificativa (mínimo 15 caracteres) e o comportamento da inutilização para números rejeitados.","parameters":[{"name":"filtro","in":"path","description":"Chave de acesso da nota fiscal (44 dígitos) ou Código ERP.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados para o cancelamento da nota fiscal.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CancelarNotaFiscalInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/CancelarNotaFiscalInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/CancelarNotaFiscalInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CancelarNotaFiscalInputModel"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfe/Sefaz/Status":{"post":{"tags":["Nfe"],"summary":"Status SEFAZ.","description":"Realiza a verificação em tempo real da disponibilidade dos serviços da SEFAZ (Secretaria da Fazenda) para a autorização de documentos fiscais. \n\nEste recurso é essencial para diagnosticar instabilidades no webservice de destino, permitindo que o sistema emissor decida pela ativação de regimes de contingência ou aguarde a normalização do serviço.\n\n⚠️ **ATENÇÃO**: O tempo de resposta deste endpoint depende diretamente da latência do servidor governamental consultado. Recomenda-se implementar um timeout adequado no lado do cliente para evitar retenção de threads.\n\n🧪 **TESTE**: Em ambiente de sandbox, o retorno pode simular um status de \"Operação Normal\" de forma estática ou refletir o ambiente de homologação da SEFAZ, dependendo da configuração da aplicação.","parameters":[{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ConsultarStatusSefazViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConsultarStatusSefazViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ConsultarStatusSefazViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfe/PreNota/ModoAutomatico":{"post":{"tags":["Nfe"],"summary":"Pré-Nota - Modo Automático.","description":"Realiza o processamento inteligente e retorna a estrutura de dados (payload) para a emissão da Nota Fiscal Eletrônica (modelo 55), otimizando o preenchimento de campos tributários complexos por meio de automações internas no modo automático, ocultando qualquer informação tributária.\n\n⚠️ **ATENÇÃO**: Esta operação possui caráter estritamente consultivo e preparatório. O retorno consiste no objeto JSON necessário para a emissão, não realizando o registro fiscal ou o envio da nota à SEFAZ neste momento.\n\n⚙️ **PROCESSAMENTO**: O resultado obtido deve ser validado pelo sistema consumidor e, estando em conformidade, utilizado como entrada (input) no endpoint de emissão definitiva: `../Espelho/ModoSimplificado`.\n\n🛡️ **AUTOMAÇÃO**: Este modo reduz a carga de integração ao calcular automaticamente alíquotas e enquadramentos com base no perfil do emissor e destinatário informados.","parameters":[{"name":"inscricaoEstadualEmissor","in":"header","description":"Inscrição estadual do emissor (Opcional - Utilizado para múltiplos estabelecimentos).","schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados de entrada para a geração automática da estrutura da NFe.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/NfeAutomaticaInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/NfeAutomaticaInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/NfeAutomaticaInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/NfeAutomaticaInputModel"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/NfeInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/NfeInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/NfeInputModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfe/PreNota/ModoSimplificado":{"post":{"tags":["Nfe"],"summary":"Pré-Nota - Modo Simplificado.","description":"Realiza o processamento inteligente e retorna a estrutura de dados (payload) para a emissão da Nota Fiscal Eletrônica (modelo 55), otimizando o preenchimento de campos tributários complexos por meio de automações internas no modo simplificado, exigindo apenas o preenchimento das alíquotas.\n\n⚠️ **ATENÇÃO**: Esta operação possui caráter estritamente consultivo e preparatório. O retorno consiste no objeto JSON necessário para a emissão, não realizando o registro fiscal ou o envio da nota à SEFAZ neste momento.\n\n⚙️ **PROCESSAMENTO**: O resultado obtido deve ser validado pelo sistema consumidor e, estando em conformidade, utilizado como entrada (input) no endpoint de emissão definitiva: `../Espelho/ModoSimplificado`.\n\n🛡️ **AUTOMAÇÃO**: Este modo reduz a carga de integração ao calcular automaticamente alíquotas e enquadramentos com base no perfil do emissor e destinatário informados.","parameters":[{"name":"inscricaoEstadualEmissor","in":"header","description":"Inscrição estadual do emissor (Opcional - Utilizado para múltiplos estabelecimentos).","schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados de entrada para a geração automática da estrutura da NFe.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/NfeSimplificadaInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/NfeSimplificadaInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/NfeSimplificadaInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/NfeSimplificadaInputModel"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/NfeInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/NfeInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/NfeInputModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfe/Emitir":{"post":{"tags":["Nfe"],"summary":"Emitir NFe.","description":"Realiza o processamento e a transmissão de uma **Nota Fiscal Eletrônica (Modelo 55)** para a SEFAZ no modo completo, necessitando o preenchimento de todos os campos tributários. \nO endpoint abrange desde a validação do schema XML até a assinatura digital e autorização em tempo real.\n\n⚠️ **ATENÇÃO**: Certifique-se de que os dados de impostos (ICMS, PIS, COFINS, IPI) e as informações do destinatário estejam em conformidade com as regras fiscais vigentes para evitar rejeições de validação da SEFAZ.\n\n🧪 **TESTE**: Em ambiente de homologação, as notas emitidas possuem **sem valor fiscal**. Utilize o CNPJ de teste apropriado e verifique se o prefixo da série está configurado para o ambiente de testes para evitar conflitos de numeração.\n\n⚙️ **PROCESSAMENTO**: O retorno bem-sucedido confirma o recebimento pela mensageria. \n\nErro 422: A nota foi salva no sistema, mas não autorizada pela SEFAZ. \n\nAção necessária: Analisar o motivo da rejeição para reenviar o documento ou realizar o cancelamento para inutilizar a numeração junto ao fisco.","parameters":[{"name":"inscricaoEstadualEmissor","in":"header","description":"Inscrição estadual do emissor (Opcional).","schema":{"type":"string"}},{"name":"danfe","in":"header","description":"Escolha o formato do DANFE gerado na emissão da nota (Default: Nenhum).","schema":{"$ref":"#/components/schemas/DanfeEmissaoNotasModelEnum"}},{"name":"tipoDanfeNfe","in":"header","description":"Tipo de DANFE gerado (Opcional).","schema":{"$ref":"#/components/schemas/TipoDanfeNfeModelEnum"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados para a emissão da nota fiscal.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/NfeInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/NfeInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/NfeInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/NfeInputModel"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"422":{"description":"Unprocessable Content","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfe/Estorno/Emitir":{"post":{"tags":["Nfe"],"summary":"Emitir NFe - Estorno (extemporâneo).","description":"Permite a emissão de uma NFe de estorno para documentos fiscais cujo prazo legal de cancelamento já tenha sido expirado perante a SEFAZ.\n\nEste recurso automatiza a geração do documento de anulação, garantindo que as cláusulas fiscais de estorno (finalidade de emissão 3) sejam aplicadas \ncorretamente em relação à nota de origem referenciada.\n\nRealiza a emissão de um novo documento fiscal com o objetivo de reverter os efeitos financeiros e de estoque de uma nota anteriormente autorizada.\n\n⚠️ **ATENÇÃO**: O estorno deve ser utilizado apenas quando o cancelamento não for mais possível. A nota de estorno referenciará a chave de acesso da nota original e deve conter os mesmos dados de itens e valores, porém com CFOPs inversos, conforme a legislação vigente.\n\n⚙️ **CONFIGURAÇÃO**: Certifique-se de que o certificado digital do Emissor esteja válido e configurado no contexto da Stone Tax API para a assinatura do XML.","parameters":[{"name":"danfe","in":"header","description":"Escolha o formato do DANFE gerado na emissão da nota (Default: Nenhum).","schema":{"$ref":"#/components/schemas/DanfeEmissaoNotasModelEnum"}},{"name":"tipoDanfeNfe","in":"header","description":"Tipo de DANFE gerado (Opcional).","schema":{"$ref":"#/components/schemas/TipoDanfeNfeModelEnum"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Objeto contendo os dados complementares para a emissão do estorno.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/EmitirNfeEstornoInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmitirNfeEstornoInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmitirNfeEstornoInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/EmitirNfeEstornoInputModel"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"422":{"description":"Unprocessable Content","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfe/Devolucao/Emitir":{"post":{"tags":["Nfe"],"summary":"Emitir NFe - Devolução.","description":"Realiza a emissão de uma Nota Fiscal Eletrônica (NFe) de Devolução com base em um documento de origem. \nEste endpoint automatiza o estorno de tributos e a movimentação de estoque reversa, garantindo o vínculo legal com a nota referenciada.\n\n⚠️ **ATENÇÃO**: A operação de devolução exige que a Chave de Acesso da nota de origem seja válida e que o emissor possua permissão para referenciar o documento informado.\n\n🧪 **TESTE**: Em ambiente de homologação/sandbox, as notas emitidas não possuem valor jurídico e são enviadas para os servidores de teste da SEFAZ. Utilize o prefixo de homologação configurado para evitar rejeições de duplicidade.\n\n🔗 **VÍNCULO FISCAL**: É obrigatório que os itens informados em dadosDevolucao correspondam, total ou parcialmente, aos itens constantes no documento identificado para ser devolvido.","parameters":[{"name":"danfe","in":"header","description":"Escolha o formato do DANFE gerado na emissão da nota (Default: Nenhum).","schema":{"$ref":"#/components/schemas/DanfeEmissaoNotasModelEnum"}},{"name":"tipoDanfeNfe","in":"header","description":"Tipo de DANFE gerado (Opcional).","schema":{"$ref":"#/components/schemas/TipoDanfeNfeModelEnum"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Objeto contendo a relação de itens, quantidades e justificativas para a devolução.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/EmitirNfeDevolucaoInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmitirNfeDevolucaoInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmitirNfeDevolucaoInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/EmitirNfeDevolucaoInputModel"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"422":{"description":"Unprocessable Content","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfe/Xml/Devolucao/Emitir":{"post":{"tags":["Nfe"],"summary":"Emitir NFe - Devolução via XML.","description":"Permite a emissão de uma Nota Fiscal Eletrônica (NFe) de devolução utilizando como base o arquivo XML da nota de origem.\n\nO recurso realiza a leitura do arquivo fornecido, correlaciona os itens para estorno e aplica as regras fiscais de devolução \nconforme o regime tributário do emissor e a natureza da operação.\n\nEste endpoint simplifica o processo de devolução ao extrair dados diretamente do XML original, exigindo apenas a relação de itens e quantidades a serem devolvidas.\n\n⚠️ **ATENÇÃO**: O arquivo XML deve ser enviado em formato **Base64**. Certifique-se de que a nota de origem esteja autorizada na SEFAZ, pois chaves de acesso inexistentes ou canceladas impedirão a emissão.\n\n⚙️ **REGRA DE NEGÓCIO**: Caso a devolução seja parcial, informe apenas os itens e quantidades correspondentes no objeto de itens. Para devolução total, a lista deve refletir exatamente o conteúdo da nota de origem.\n\n🧪 **TESTE**: Em ambiente de homologação, as notas emitidas possuem **sem valor jurídico** e não afetam o estoque real ou limites fiscais junto à SEFAZ.","parameters":[{"name":"danfe","in":"header","description":"Escolha o formato do DANFE gerado na emissão da nota (Default: Nenhum).","schema":{"$ref":"#/components/schemas/DanfeEmissaoNotasModelEnum"}},{"name":"tipoDanfeNfe","in":"header","description":"Tipo de DANFE gerado (Opcional).","schema":{"$ref":"#/components/schemas/TipoDanfeNfeModelEnum"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["ArquivoXml","CodigoErp"],"type":"object","properties":{"CodigoErp":{"minLength":1,"type":"string","description":"Identificador da operação fiscal no ERP."},"Serie":{"type":"string","description":"Série do documento fiscal (Informar somente se estiver configurado para geração numérica manual)."},"NumeroDocumento":{"type":"integer","description":"Numero do documento fiscal (Informar somente se estiver configurado para geração numérica manual).","format":"int64"},"ModeloDocumentoFiscalDevolvido":{"$ref":"#/components/schemas/ModeloNotaFiscalModelEnum"},"ArquivoXml":{"type":"string","description":"Arquivo XML da nota fiscal.","format":"binary"},"TipoEmissao":{"$ref":"#/components/schemas/TipoEmissaoNfeModelEnum"},"Destinatario.TipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"Destinatario.Documento":{"type":"string","description":"Documento do destinatário."},"Destinatario.Nome":{"type":"string","description":"Nome do destinatário."},"Destinatario.Endereco.Logradouro":{"type":"string","description":"Logradouro."},"Destinatario.Endereco.Numero":{"type":"string","description":"Número."},"Destinatario.Endereco.Complemento":{"type":"string","description":"Complemento."},"Destinatario.Endereco.Bairro":{"type":"string","description":"Bairro."},"Destinatario.Endereco.CodigoMunicipio":{"type":"string","description":"Código do município."},"Destinatario.Endereco.NomeMunicipio":{"type":"string","description":"Nome do município."},"Destinatario.Endereco.Uf":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"Destinatario.Endereco.Cep":{"type":"string","description":"CEP."},"Destinatario.Endereco.CodigoPais":{"type":"string","description":"Código do país."},"Destinatario.Endereco.Pais":{"type":"string","description":"Nome do país."},"Destinatario.Telefone":{"type":"string","description":"Telefone do destinatário."},"Destinatario.InscricaoEstadual":{"type":"string","description":"Inscrição estadual do destinatário."},"Destinatario.InscricaoSuframa":{"type":"string","description":"Inscrição SUFRAMA."},"Destinatario.InscricaoMunicipal":{"type":"string","description":"Inscrição municipal."},"Destinatario.Email":{"type":"string","description":"Email do destinatário."},"AutXml":{"type":"array","items":{"$ref":"#/components/schemas/NfeAuxXmlInputModel"},"description":"Documentos autorizados a visualizar a NFe."},"ItensDevolvidos":{"type":"array","items":{"$ref":"#/components/schemas/EmitirNfeDevolucaoDetalheItemInputModel"},"description":"Lista de itens devolvidos (Informar nulo para devolução completa da nota)."}}},"encoding":{"CodigoErp":{"style":"form"},"Serie":{"style":"form"},"NumeroDocumento":{"style":"form"},"ModeloDocumentoFiscalDevolvido":{"style":"form"},"ArquivoXml":{"style":"form"},"TipoEmissao":{"style":"form"},"Destinatario.TipoDocumento":{"style":"form"},"Destinatario.Documento":{"style":"form"},"Destinatario.Nome":{"style":"form"},"Destinatario.Endereco.Logradouro":{"style":"form"},"Destinatario.Endereco.Numero":{"style":"form"},"Destinatario.Endereco.Complemento":{"style":"form"},"Destinatario.Endereco.Bairro":{"style":"form"},"Destinatario.Endereco.CodigoMunicipio":{"style":"form"},"Destinatario.Endereco.NomeMunicipio":{"style":"form"},"Destinatario.Endereco.Uf":{"style":"form"},"Destinatario.Endereco.Cep":{"style":"form"},"Destinatario.Endereco.CodigoPais":{"style":"form"},"Destinatario.Endereco.Pais":{"style":"form"},"Destinatario.Telefone":{"style":"form"},"Destinatario.InscricaoEstadual":{"style":"form"},"Destinatario.InscricaoSuframa":{"style":"form"},"Destinatario.InscricaoMunicipal":{"style":"form"},"Destinatario.Email":{"style":"form"},"AutXml":{"style":"form"},"ItensDevolvidos":{"style":"form"}}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"422":{"description":"Unprocessable Content","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfe/{filtro}/ContingenciaOffline/Transmitir":{"post":{"tags":["Nfe"],"summary":"Transmitir Contingência.","description":"Realiza a transmissão de uma NFe que foi emitida previamente sob o regime de contingência offline. \nEste recurso é essencial para regularizar a situação fiscal de documentos gerados sem comunicação prévia com a SEFAZ devido a problemas técnicos.\n\n⚠️ **ATENÇÃO**: A transmissão deve ser realizada respeitando os prazos legais estabelecidos pelo ajuste SINIEF para evitar penalidades. Certifique-se de que os dados do XML transmitido são idênticos aos do documento entregue ao consumidor.\n\n⚙️ **PROCESSAMENTO**: O sistema validará a assinatura digital e o status do documento antes de submeter o lote para autorização. Caso o documento já tenha sido autorizado anteriormente, o serviço retornará o protocolo existente.","parameters":[{"name":"filtro","in":"path","description":"Chave de acesso da nota fiscal (44 dígitos) ou Código ERP.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfe/Listar":{"get":{"tags":["Nfe"],"summary":"Listar NFe´s.","description":"Fornece uma listagem detalhada das Notas Fiscais Eletrônicas (NFe) emitidas ou processadas pelo Emissor. \n\n🔍 **CAPACIDADE DE BUSCA**: O recurso suporta filtros complexos que permitem a extração de relatórios e a reconciliação fiscal. O campo `busca` realiza uma varredura genérica em múltiplos campos (número, série, chave e participantes).\n\n📑 **PAGINAÇÃO**: A API utiliza o modelo de offset e limit. Recomendamos o uso de limites baixos (ex: 50 registros) para garantir a performance da resposta e economia de banda.\n\n⚖️ **CONTEXTO FISCAL**: Os resultados refletem o estado atual dos documentos na base da Stone Tax, permitindo filtrar por status específicos (Autorizada, Cancelada, Rejeitada, etc.) e intervalos de valores ou datas.","parameters":[{"name":"notaFiscalId","in":"query","description":"Filtrar pelo identificador único da nota fiscal no sistema.","schema":{"type":"string","format":"uuid"}},{"name":"codigoErp","in":"query","description":"Filtrar pelo código ERP.","schema":{"type":"string"}},{"name":"busca","in":"query","description":"Filtrar pelo termo de busca genérica.","schema":{"type":"string"}},{"name":"inscricaoEstadualEmissor","in":"query","description":"Filtrar pela inscrição estadual do emissor do documento.","schema":{"type":"string"}},{"name":"numeroDocumento","in":"query","description":"Filtrar pelo número sequencial do documento fiscal.","schema":{"type":"string"}},{"name":"serie","in":"query","description":"Filtrar pela série do documento fiscal.","schema":{"type":"string"}},{"name":"chaveAcesso","in":"query","description":"Filtrar pel lista de chaves de acesso (44 dígitos).","schema":{"type":"array","items":{"type":"string"}}},{"name":"documentoParticipante","in":"query","description":"Filtrar pelo documento (CPF/CNPJ) do participante.","schema":{"type":"string"}},{"name":"nomeParticipante","in":"query","description":"Filtrar pel nome ou razão social do participante.","schema":{"type":"string"}},{"name":"dataEmissaoInicial","in":"query","description":"Filtrar documentos emitidos a partir desta data.","schema":{"type":"string","format":"date-time"}},{"name":"dataEmissaoFinal","in":"query","description":"Filtrar documentos emitidos até esta data.","schema":{"type":"string","format":"date-time"}},{"name":"dataCancelamentoInicial","in":"query","description":"Filtrar documentos cancelados a partir desta data.","schema":{"type":"string","format":"date-time"}},{"name":"dataCancelamentoFinal","in":"query","description":"Filtrar documentos cancelados até esta data.","schema":{"type":"string","format":"date-time"}},{"name":"valorDocumentoInicial","in":"query","description":"Filtrar pelo valor mínimo do documento.","schema":{"type":"number","format":"double"}},{"name":"valorDocumentoFinal","in":"query","description":"Filtrar pel valor máximo do documento.","schema":{"type":"number","format":"double"}},{"name":"status","in":"query","description":"Filtrar pelo status atual da nota fiscal.","schema":{"$ref":"#/components/schemas/StatusNotaFiscalModelEnum"}},{"name":"consumidorFinal","in":"query","description":"Filtrar pelo indicador do documento emitido para consumidor final.","schema":{"type":"boolean"}},{"name":"documentoTransportador","in":"query","description":"Filtrar pelo documento (CPF/CNPJ) da transportadora.","schema":{"type":"string"}},{"name":"nomeTransportador","in":"query","description":"Filtrar pelo nome ou razão Social da transportadora.","schema":{"type":"string"}},{"name":"modalidadeFrete","in":"query","description":"Filtrar pela modalidade do frete.","schema":{"$ref":"#/components/schemas/ModalidadeFreteNotaFiscalModelEnum"}},{"name":"documentoIntermediador","in":"query","description":"Filtrar pelo documento (CPF/CNPJ) do intermediador.","schema":{"type":"string"}},{"name":"identificadorIntermediador","in":"query","description":"Filtrar pelo identificador do intermediador na plataforma.","schema":{"type":"string"}},{"name":"modoContingenciaOffline","in":"query","description":"Filtrar por notas que foram geradas em modo de contingência offline, ou seja, sem comunicação com a SEFAZ no momento da emissão.","schema":{"type":"boolean"}},{"name":"ordenarPor","in":"query","description":"Campo pelo qual a listagem será ordenada. Padrão: DataEmissao.","schema":{"$ref":"#/components/schemas/OrdenacaoListarNotasFiscaisModelEnum"}},{"name":"ordemDecrescente","in":"query","description":"Define se a ordenação é decrescente. Padrão: true.","schema":{"type":"boolean","default":true}},{"name":"offset","in":"query","description":"Paginação da listagem - offset.","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Paginação da listagem - limit.","schema":{"type":"integer","format":"int32","default":10}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ListarNotasFiscaisViewModelListPaginationResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ListarNotasFiscaisViewModelListPaginationResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ListarNotasFiscaisViewModelListPaginationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfe/Resumo":{"get":{"tags":["Nfe"],"summary":"Resumo de NFe´s.","description":"Fornece dados totalizados e consolidados de notas fiscais com base nos filtros aplicados. \nEste recurso é ideal para alimentar dashboards, painéis de conferência ou indicadores financeiros (KPIs), \npermitindo uma visão macro do volume de documentos e valores sem a necessidade de processar a listagem completa.\n\nA consulta suporta múltiplos critérios de filtragem, abrangendo desde dados básicos do documento (número, série, chave) \naté informações de atores envolvidos (participante, transportador e intermediador).\n\n🔍 **DICA DE PERFORMANCE**: Para consultas em grandes volumes de dados, priorize o uso da Chave de Acesso \nou o intervalo de Data de Emissão para garantir maior agilidade no retorno.","parameters":[{"name":"notaFiscalId","in":"query","description":"Filtrar pelo identificador único da nota fiscal no sistema.","schema":{"type":"string","format":"uuid"}},{"name":"codigoErp","in":"query","description":"Filtrar pelo código ERP.","schema":{"type":"string"}},{"name":"busca","in":"query","description":"Filtrar pelo termo de busca genérica.","schema":{"type":"string"}},{"name":"inscricaoEstadualEmissor","in":"query","description":"Filtrar pela inscrição estadual do emissor do documento.","schema":{"type":"string"}},{"name":"numeroDocumento","in":"query","description":"Filtrar pelo número sequencial do documento fiscal.","schema":{"type":"string"}},{"name":"serie","in":"query","description":"Filtrar pela série do documento fiscal.","schema":{"type":"string"}},{"name":"chaveAcesso","in":"query","description":"Filtrar pel lista de chaves de acesso (44 dígitos).","schema":{"type":"array","items":{"type":"string"}}},{"name":"documentoParticipante","in":"query","description":"Filtrar pelo documento (CPF/CNPJ) do participante.","schema":{"type":"string"}},{"name":"nomeParticipante","in":"query","description":"Filtrar pel nome ou razão social do participante.","schema":{"type":"string"}},{"name":"dataEmissaoInicial","in":"query","description":"Filtrar documentos emitidos a partir desta data.","schema":{"type":"string","format":"date-time"}},{"name":"dataEmissaoFinal","in":"query","description":"Filtrar documentos emitidos até esta data.","schema":{"type":"string","format":"date-time"}},{"name":"dataCancelamentoInicial","in":"query","description":"Filtrar documentos cancelados a partir desta data.","schema":{"type":"string","format":"date-time"}},{"name":"dataCancelamentoFinal","in":"query","description":"Filtrar documentos cancelados até esta data.","schema":{"type":"string","format":"date-time"}},{"name":"valorDocumentoInicial","in":"query","description":"Filtrar pelo valor mínimo do documento.","schema":{"type":"number","format":"double"}},{"name":"valorDocumentoFinal","in":"query","description":"Filtrar pel valor máximo do documento.","schema":{"type":"number","format":"double"}},{"name":"status","in":"query","description":"Filtrar pelo status atual da nota fiscal.","schema":{"$ref":"#/components/schemas/StatusNotaFiscalModelEnum"}},{"name":"consumidorFinal","in":"query","description":"Filtrar pelo indicador do documento emitido para consumidor final.","schema":{"type":"boolean"}},{"name":"documentoTransportador","in":"query","description":"Filtrar pelo documento (CPF/CNPJ) da transportadora.","schema":{"type":"string"}},{"name":"nomeTransportador","in":"query","description":"Filtrar pelo nome ou razão Social da transportadora.","schema":{"type":"string"}},{"name":"modalidadeFrete","in":"query","description":"Filtrar pela modalidade do frete.","schema":{"$ref":"#/components/schemas/ModalidadeFreteNotaFiscalModelEnum"}},{"name":"documentoIntermediador","in":"query","description":"Filtrar pelo documento (CPF/CNPJ) do intermediador.","schema":{"type":"string"}},{"name":"identificadorIntermediador","in":"query","description":"Filtrar pelo identificador do intermediador na plataforma.","schema":{"type":"string"}},{"name":"modoContingenciaOffline","in":"query","description":"Filtrar por notas que foram geradas em modo de contingência offline, ou seja, sem comunicação com a SEFAZ no momento da emissão.","schema":{"type":"boolean"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ObterTotalizacaoListagemViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ObterTotalizacaoListagemViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ObterTotalizacaoListagemViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfe/{filtro}/StatusFiscal":{"get":{"tags":["Nfe"],"summary":"Status da NFe.","description":"Retorna o status de uma nota fiscal identificada pelo código ERP ou chave de acesso.\n \n🔍 **IDENTIFICAÇÃO**: O filtro aceita a chave de acesso da nota fiscal (44 dígitos numéricos) ou o código ERP informado pelo integrador no momento da emissão.\n \n📋 **RETORNO**: Inclui modelo, série, número, chave de acesso, status, protocolos de autorização/cancelamento e mensagem da SEFAZ.","parameters":[{"name":"filtro","in":"path","description":"Chave de acesso da nota fiscal (44 dígitos) ou Código ERP.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ObterStatusFiscalViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ObterStatusFiscalViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ObterStatusFiscalViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfe/{filtro}/ObterDanfe/{tipoDanfe}/{formato}":{"get":{"tags":["Nfe"],"summary":"DANFE NFe (PDF).","description":"Recupera a representação gráfica da NFe, conhecida como DANFE (Documento Auxiliar da Nota Fiscal Eletrônica). \n\n📄 **FORMATO DE SAÍDA**: O recurso retorna o arquivo em formato PDF, codificado em Base64. Para a visualização, o sistema consumidor deve realizar o decode da string e salvar o binário com a extensão `.pdf`.\n\n⚖️ **VALIDADE JURÍDICA**: O DANFE é apenas um documento auxiliar para facilitar a consulta e o transporte das mercadorias. Ele não substitui o arquivo XML, que é o documento fiscal eletrônico de existência apenas digital e valor jurídico real.\n\n🧪 **TESTE**: Em ambiente de sandbox, o DANFE gerado conterá a marca d'água \"SEM VALOR FISCAL - AMBIENTE DE HOMOLOGAÇÃO\", conforme exigência da SEFAZ para testes.\n\n🔍 **DISPONIBILIDADE**: O documento só poderá ser gerado para chaves de acesso que possuam o status de Autorizada ou Cancelada na base de dados.","parameters":[{"name":"tipoDanfe","in":"path","description":"Tipo de danfe para NFe.","required":true,"schema":{"$ref":"#/components/schemas/TipoDanfeNfeModelEnum"}},{"name":"formato","in":"path","description":"Formato do danfe.","required":true,"schema":{"$ref":"#/components/schemas/FormatoDanfeModelEnum"}},{"name":"filtro","in":"path","description":"Chave de acesso da nota fiscal (44 dígitos) ou Código ERP.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfe/{filtro}/ObterXml":{"get":{"tags":["Nfe"],"summary":"Notas Fiscais - Obter XML (procNFe).","description":"Recupera o arquivo XML de distribuição da nota fiscal eletrônica. Este é o documento oficial com validade jurídica, contendo o protocolo de autorização da SEFAZ.\n\n⚖️ **GUARDA FISCAL**: Conforme a legislação vigente, o emitente e o destinatário devem manter os arquivos digitais das NFe pelo prazo decadencial estabelecido na lei tributária (geralmente 5 anos), sendo este endpoint a ferramenta ideal para o download e arquivamento.\n\n🛠️ **ESTRUTURA**: O retorno consiste no XML completo, incluindo as tags de assinatura digital e o nó `protNFe` (Protocolo de Autorização), caracterizando o documento como processado e apto para a escrituração contábil.\n\n🧪 **TESTE**: Em ambiente de homologação, o XML retornado possui as tags de ambiente identificadas como `tpAmb = 2`, indicando que o documento não possui validade comercial ou fiscal.","parameters":[{"name":"filtro","in":"path","description":"Chave de acesso da nota fiscal (44 dígitos) ou Código ERP.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfe/{filtro}/Cancelar":{"post":{"tags":["Nfe"],"summary":"Cancelamento de NFe.","description":"Registra um Evento de Cancelamento para uma nota fiscal eletrônico (NFe). Esta operação invalida a existência jurídica do documento perante a SEFAZ.\n\n⚠️ **NOTAS REJEITADAS**: Caso o documento fiscal esteja com status de Rejeitado, o processo de cancelamento nesta API acionará automaticamente a Inutilização de Numeração. Isso garante que a sequência numérica do emissor permaneça íntegra e em conformidade com as normas da SEFAZ, evitando \"buracos\" na numeração fiscal.\n\n⏳ **PRAZO LEGAL**: O cancelamento deve respeitar o prazo regulamentar definido pela legislação estadual vigente (geralmente 24h para NFe). Após este período, a operação poderá exigir procedimentos administrativos ou estar sujeita a penalidades por cancelamento extemporâneo.\n\n📄 **CONDIÇÃO DE USO**: Só é possível cancelar uma nota que tenha sido Autorizada ou Rejeitada (via inutilização), e cujo Fato Gerador (saída da mercadoria) ainda não tenha ocorrido.\n\n🧪 **TESTE**: Em ambiente de homologação, o cancelamento é processado junto aos servidores de teste, permitindo validar a estrutura da justificativa (mínimo 15 caracteres) e o comportamento da inutilização para números rejeitados.","parameters":[{"name":"filtro","in":"path","description":"Chave de acesso da nota fiscal (44 dígitos) ou Código ERP.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados para o cancelamento da nota fiscal.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CancelarNotaFiscalInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/CancelarNotaFiscalInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/CancelarNotaFiscalInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CancelarNotaFiscalInputModel"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfe/{filtro}/CartaCorrecao/Enviar":{"post":{"tags":["Nfe"],"summary":"NFe - Carta de Correção Eletrônica (CCe).","description":"Registra um Evento de Carta de Correção Eletrônica (CCe) para uma NFe autorizada. Permite corrigir informações acessórias do documento fiscal perante a SEFAZ.\n \n⚠️ **RESTRIÇÃO**: A CCe é suportada exclusivamente para NFe (modelo 55). Não é aplicável para NFC-e.\n \n❌ **VEDAÇÕES LEGAIS**: Não é permitido utilizar a CCe para corrigir: dados que impliquem mudança no remetente ou destinatário, data de emissão, data de saída, valor total da NFe, base de cálculo, alíquotas e quantidades de mercadorias.\n \n🔢 **SEQUÊNCIA**: Cada CCe possui um número de sequência gerado automaticamente. Podem ser emitidas múltiplas CCes para a mesma NFe, sendo que a mais recente prevalece sobre as anteriores para os campos corrigidos.\n \n🧪 **TESTE**: Em ambiente de homologação, a CCe é transmitida para os servidores de teste da SEFAZ, permitindo validar a estrutura e o conteúdo da correção.","parameters":[{"name":"filtro","in":"path","description":"Chave de acesso da NFe (44 dígitos) ou Código ERP.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados para emissão da carta de correção.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/EmitirCartaDeCorrecaoInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmitirCartaDeCorrecaoInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmitirCartaDeCorrecaoInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/EmitirCartaDeCorrecaoInputModel"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfe/CartaCorrecao/Listar":{"get":{"tags":["Nfe"],"summary":"CCe - Listagem de cartas de correção eletrônicas.","description":"Retorna uma lista paginada de cartas de correção eletrônicas (CCe) associadas às NFes do emissor autenticado.\n \nÉ possível filtrar por busca genérica (CNPJ, nome do destinatário, chave de acesso ou código ERP), por status da CCe e por intervalo de data do evento.\n \nOs registros são ordenados por data de emissão em ordem decrescente (mais recente primeiro).","parameters":[{"name":"busca","in":"query","description":"Campo de busca genérico: CNPJ e Nome do destinatário, Chave de acesso da NFe (44 dígitos) ou Código ERP.","schema":{"type":"string"}},{"name":"status","in":"query","description":"Status da carta de correção (Pendente, Autorizada ou Rejeitada).","schema":{"$ref":"#/components/schemas/StatusCartaCorrecaoModelEnum"}},{"name":"dataEventoCartaCorrecaoInicial","in":"query","description":"Data inicial do intervalo do evento da CCe.","schema":{"type":"string","format":"date-time"}},{"name":"dataEventoCartaCorrecaoFinal","in":"query","description":"Data final do intervalo do evento da CCe.","schema":{"type":"string","format":"date-time"}},{"name":"offset","in":"query","description":"Paginação da listagem - offset (padrão 1).","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Paginação da listagem - limit (padrão 10, máximo 100).","schema":{"type":"integer","format":"int32","default":10}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ListarCartasCorrecaoViewModelListPaginationResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ListarCartasCorrecaoViewModelListPaginationResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ListarCartasCorrecaoViewModelListPaginationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfe/{filtro}/CartaCorrecao/{sequencia}/ObterXml":{"get":{"tags":["Nfe"],"summary":"CCe - Obter XML.","description":"Obter o XML de uma Carta de Correção Eletrônica (CCe) previamente emitida.","parameters":[{"name":"filtro","in":"path","description":"Chave de acesso da NFe (44 dígitos) ou Código ERP.","required":true,"schema":{"type":"string"}},{"name":"sequencia","in":"path","description":"Número de sequência da carta de correção.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfse/Prestador/Emitir":{"post":{"tags":["Nfse"],"summary":"Emitir NFS-e - Modo Prestador.","description":"Realiza a emissão completa de uma Nota Fiscal de Serviços Eletrônica (NFS-e) junto ao ADN (Ambiente de Desenvolvimento Nacional), atuando o emissor como o prestador do serviço.\n \nO recurso assegura que o contexto tributário do prestador seja validado e que as regras fiscais do município correspondente sejam aplicadas durante a emissão do documento.\n\nO processo segue o fluxo:\n \n1. Geração e assinatura digital do XML da DPS (Declaração de Prestação de Serviços).\n\n2. Persistência com status Pendente.\n\n3. Transmissão ao ADN e atualização do status para Autorizada ou Rejeitada.\n \n\n🔁 **IDEMPOTÊNCIA**: O campo `codigoErp` identifica a nota unicamente por emissor. Em caso de reenvio (nota Pendente ou Rejeitada), os dados são atualizados e a DPS é retransmitida sem duplicar registros.\n\n⚙️ **SEQUÊNCIA**: A série e o número da DPS são gerenciados automaticamente com base nos parâmetros de NFS-e configurados para o emissor. Para sequência manual, informe `serie` e `numeroDps`.\n\n⚠️ **ATENÇÃO**: Certifique-se de que o documento do emissor configurado no cabeçalho corresponda ao perfil tributário do prestador do serviço antes de efetuar a chamada.","parameters":[{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados para emissão da NFS-e.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/EmitirNfseModoPrestadorInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmitirNfseModoPrestadorInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmitirNfseModoPrestadorInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/EmitirNfseModoPrestadorInputModel"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalServicoViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalServicoViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalServicoViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfse/Tomador/Emitir":{"post":{"tags":["Nfse"],"summary":"Emitir NFS-e - Modo Tomador.","description":"Realiza a emissão completa de uma Nota Fiscal de Serviços Eletrônica (NFS-e) junto ao ADN (Ambiente de Desenvolvimento Nacional), atuando o emissor como o tomador do serviço.\n \nNeste modo, os dados do prestador externo devem ser informados no corpo da requisição, enquanto os dados do tomador são obtidos automaticamente do cadastro do emissor.\n \nO processo segue o fluxo:\n \n1. Geração e assinatura digital do XML da DPS (Declaração de Prestação de Serviços).\n\n2. Persistência com status Pendente.\n\n3. Transmissão ao ADN e atualização do status para Autorizada ou Rejeitada.\n \n \n🔁 **IDEMPOTÊNCIA**: O campo `codigoErp` identifica a nota unicamente por emissor. Em caso de reenvio (nota Pendente ou Rejeitada), os dados são atualizados e a DPS é retransmitida sem duplicar registros.\n \n⚙️ **SEQUÊNCIA**: A série e o número da DPS são gerenciados automaticamente com base nos parâmetros de NFS-e configurados para o emissor. Para sequência manual, informe `serie` e `numeroDps`.\n \n⚠️ **ATENÇÃO**: Certifique-se de que o documento do emissor configurado no cabeçalho corresponda ao tomador do serviço antes de efetuar a chamada.","parameters":[{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados para emissão da NFS-e.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/EmitirNfseModoTomadorInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmitirNfseModoTomadorInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmitirNfseModoTomadorInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/EmitirNfseModoTomadorInputModel"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalServicoViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalServicoViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/EmissaoNotaFiscalServicoViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfse/{filtro}/Cancelar":{"post":{"tags":["Nfse"],"summary":"Cancelar NFS-e.","description":"Inicia o processo de cancelamento de uma Nota Fiscal de Serviços Eletrônica (NFS-e) junto ao ADN.\n \n⚠️ **RESTRIÇÕES**: Somente NFS-e com status Autorizada podem ser canceladas.\n \nO campo `filtro` aceita **ChaveNfse** ou **Código ERP**.","parameters":[{"name":"filtro","in":"path","description":"ChaveNfse ou Código ERP.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados para o cancelamento da nota fiscal de serviço.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CancelarNotaFiscalInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/CancelarNotaFiscalInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/CancelarNotaFiscalInputModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CancelarNotaFiscalInputModel"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfse/Listar":{"get":{"tags":["Nfse"],"summary":"Listar NFSe´s.","description":"Fornece uma listagem detalhada das Notas Fiscais de Serviços Eletrônicas (NFSe Nacional) emitidas ou processadas pelo Emissor.\n \n🔍 **CAPACIDADE DE BUSCA**: O recurso suporta filtros complexos que permitem a extração de relatórios e a reconciliação fiscal. O campo `busca` realiza uma varredura genérica em múltiplos campos (número da DPS, chave, nome e documento do tomador e prestador, descrição do serviço).\n \n📑 **PAGINAÇÃO**: A API utiliza o modelo de offset e limit. Recomendamos o uso de limites baixos (ex: 50 registros) para garantir a performance da resposta e economia de banda.\n \n⚖️ **CONTEXTO FISCAL**: Os resultados refletem o estado atual dos documentos na base da Stone Tax, permitindo filtrar por status específicos (Autorizada, Cancelada, Rejeitada, etc.) e intervalos de valores ou datas.","parameters":[{"name":"notaFiscalServicoId","in":"query","description":"Filtrar pelo identificador único da nota fiscal de serviço no sistema.","schema":{"type":"string","format":"uuid"}},{"name":"codigoErp","in":"query","description":"Filtrar pelo código ERP.","schema":{"type":"string"}},{"name":"busca","in":"query","description":"Filtrar pelo termo de busca genérica.","schema":{"type":"string"}},{"name":"numeroDps","in":"query","description":"Filtrar pelo número sequencial da DPS.","schema":{"type":"string"}},{"name":"serie","in":"query","description":"Filtrar pela série da DPS.","schema":{"type":"string"}},{"name":"chaves","in":"query","description":"Filtrar pela lista de chaves (ChaveDps — 45 chars, ou ChaveNfse — 53 chars).","schema":{"type":"array","items":{"type":"string"}}},{"name":"documentoTomador","in":"query","description":"Filtrar pelo documento (CPF/CNPJ) do tomador do serviço.","schema":{"type":"string"}},{"name":"nomeTomador","in":"query","description":"Filtrar pelo nome ou razão social do tomador do serviço.","schema":{"type":"string"}},{"name":"documentoPrestador","in":"query","description":"Filtrar pelo documento (CPF/CNPJ) do prestador do serviço.","schema":{"type":"string"}},{"name":"nomePrestador","in":"query","description":"Filtrar pelo nome ou razão social do prestador do serviço.","schema":{"type":"string"}},{"name":"dataEmissaoInicial","in":"query","description":"Filtrar documentos emitidos a partir desta data.","schema":{"type":"string","format":"date-time"}},{"name":"dataEmissaoFinal","in":"query","description":"Filtrar documentos emitidos até esta data.","schema":{"type":"string","format":"date-time"}},{"name":"dataCancelamentoInicial","in":"query","description":"Filtrar documentos cancelados a partir desta data.","schema":{"type":"string","format":"date-time"}},{"name":"dataCancelamentoFinal","in":"query","description":"Filtrar documentos cancelados até esta data.","schema":{"type":"string","format":"date-time"}},{"name":"valorServicoInicial","in":"query","description":"Filtrar pelo valor mínimo do serviço.","schema":{"type":"number","format":"double"}},{"name":"valorServicoFinal","in":"query","description":"Filtrar pelo valor máximo do serviço.","schema":{"type":"number","format":"double"}},{"name":"status","in":"query","description":"Filtrar pelo status atual da nota fiscal de serviço.","schema":{"$ref":"#/components/schemas/StatusNotaFiscalServicoModelEnum"}},{"name":"ordenarPor","in":"query","description":"Campo pelo qual a listagem será ordenada. Padrão: DataEmissao.","schema":{"$ref":"#/components/schemas/OrdenacaoListarNotasFiscaisServicoModelEnum"}},{"name":"ordemDecrescente","in":"query","description":"Define se a ordenação é decrescente. Padrão: true.","schema":{"type":"boolean","default":true}},{"name":"offset","in":"query","description":"Paginação da listagem - offset.","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Paginação da listagem - limit.","schema":{"type":"integer","format":"int32","default":10}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ListarNotasFiscaisServicoViewModelListPaginationResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ListarNotasFiscaisServicoViewModelListPaginationResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ListarNotasFiscaisServicoViewModelListPaginationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfse/Resumo":{"get":{"tags":["Nfse"],"summary":"Resumo de NFSe´s.","description":"Fornece dados totalizados e consolidados de notas fiscais de serviço com base nos filtros aplicados.\nEste recurso é ideal para alimentar dashboards, painéis de conferência ou indicadores financeiros (KPIs),\npermitindo uma visão macro do volume de documentos e valores sem a necessidade de processar a listagem completa.\n \nOs totais são agrupados por status: Aprovadas, Canceladas, Rejeitadas, Pendentes e Substituídas.","parameters":[{"name":"notaFiscalServicoId","in":"query","description":"Filtrar pelo identificador único da nota fiscal de serviço no sistema.","schema":{"type":"string","format":"uuid"}},{"name":"codigoErp","in":"query","description":"Filtrar pelo código ERP.","schema":{"type":"string"}},{"name":"busca","in":"query","description":"Filtrar pelo termo de busca genérica.","schema":{"type":"string"}},{"name":"numeroDps","in":"query","description":"Filtrar pelo número sequencial da DPS.","schema":{"type":"string"}},{"name":"serie","in":"query","description":"Filtrar pela série da DPS.","schema":{"type":"string"}},{"name":"chaves","in":"query","description":"Filtrar pela lista de chaves (ChaveDps — 45 chars, ou ChaveNfse — 53 chars).","schema":{"type":"array","items":{"type":"string"}}},{"name":"documentoTomador","in":"query","description":"Filtrar pelo documento (CPF/CNPJ) do tomador do serviço.","schema":{"type":"string"}},{"name":"nomeTomador","in":"query","description":"Filtrar pelo nome ou razão social do tomador do serviço.","schema":{"type":"string"}},{"name":"documentoPrestador","in":"query","description":"Filtrar pelo documento (CPF/CNPJ) do prestador do serviço.","schema":{"type":"string"}},{"name":"nomePrestador","in":"query","description":"Filtrar pelo nome ou razão social do prestador do serviço.","schema":{"type":"string"}},{"name":"dataEmissaoInicial","in":"query","description":"Filtrar documentos emitidos a partir desta data.","schema":{"type":"string","format":"date-time"}},{"name":"dataEmissaoFinal","in":"query","description":"Filtrar documentos emitidos até esta data.","schema":{"type":"string","format":"date-time"}},{"name":"dataCancelamentoInicial","in":"query","description":"Filtrar documentos cancelados a partir desta data.","schema":{"type":"string","format":"date-time"}},{"name":"dataCancelamentoFinal","in":"query","description":"Filtrar documentos cancelados até esta data.","schema":{"type":"string","format":"date-time"}},{"name":"valorServicoInicial","in":"query","description":"Filtrar pelo valor mínimo do serviço.","schema":{"type":"number","format":"double"}},{"name":"valorServicoFinal","in":"query","description":"Filtrar pelo valor máximo do serviço.","schema":{"type":"number","format":"double"}},{"name":"status","in":"query","description":"Filtrar pelo status atual da nota fiscal de serviço.","schema":{"$ref":"#/components/schemas/StatusNotaFiscalServicoModelEnum"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ObterTotalizacaoListagemNfseViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ObterTotalizacaoListagemNfseViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ObterTotalizacaoListagemNfseViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfse/{filtro}/StatusFiscal":{"get":{"tags":["Nfse"],"summary":"Status da NFS-e.","description":"Retorna o status de uma nota fiscal de serviço identificada pelo filtro.\n \n🔍 **IDENTIFICAÇÃO**: O filtro aceita a ChaveNfse ou o Código ERP informado pelo integrador no momento da emissão.\n \n📋 **RETORNO**: Inclui série, número da DPS, número da NFS-e, chaves, status, protocolo de autorização e mensagem do ADN.","parameters":[{"name":"filtro","in":"path","description":"ChaveNfse ou Código ERP.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ObterStatusFiscalNfseViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ObterStatusFiscalNfseViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ObterStatusFiscalNfseViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfse/{filtro}/ObterDanfe":{"get":{"tags":["Nfse"],"summary":"DANFE NFS-e (PDF).","description":"Recupera a representação gráfica da NFS-e, conhecida como DANFE (Documento Auxiliar da Nota Fiscal de Serviços Eletrônica).\n \n📄 **FORMATO DE SAÍDA**: O recurso retorna o arquivo em formato PDF, codificado em Base64. Para a visualização, o sistema consumidor deve realizar o decode da string e salvar o binário com a extensão `.pdf`.\n \n🔍 **DISPONIBILIDADE**: O documento só poderá ser obtido para notas com status Autorizada, Em Cancelamento ou Substituída.\n \nO campo `filtro` aceita **ChaveNfse** ou **Código ERP**.","parameters":[{"name":"filtro","in":"path","description":"ChaveNfse ou Código ERP.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/Nfse/{filtro}/ObterXml":{"get":{"tags":["Nfse"],"summary":"Obter XML da NFS-e.","description":"Retorna o XML mais relevante para o status atual da nota fiscal de serviço:\n \n- **Pendente / Rejeitada**: XML da DPS assinada.\n- **Autorizada / Em Cancelamento / Substituída**: XML da NFS-e retornado pelo ADN.\n- **Cancelada**: XML do evento de cancelamento.\n \nO campo `filtro` aceita **ChaveNfse** ou **Código ERP**.","parameters":[{"name":"filtro","in":"path","description":"ChaveNfse ou Código ERP.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/RecursosAdicionais/Cep/{cep}/Consultar":{"get":{"tags":["RecursosAdicionais"],"summary":"Localização e Logradouro - Consultar por CEP.","description":"Realiza a busca detalhada de informações do logradouro com base no Código de Endereçamento Postal (CEP). \nEste recurso é essencial para a padronização de cadastros de clientes, fornecedores e emissores, garantindo a integridade dos dados de localização.\n\n⚠️ **ATENÇÃO**: O CEP informado deve conter apenas números (8 dígitos).\n\n🔍 **DICA DE INTEGRAÇÃO**: Utilize este endpoint para o preenchimento automático de campos de endereço em interfaces de usuário, minimizando erros de digitação e facilitando o cálculo de alíquotas baseadas na localidade (ISS/ICMS).","parameters":[{"name":"cep","in":"path","description":"CEP - Código de Endereçamento Postal.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ConsultaCepViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConsultaCepViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ConsultaCepViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/RecursosAdicionais/Cnpj/{cnpj}/Consultar":{"get":{"tags":["RecursosAdicionais"],"summary":"Consultar dados do CNPJ.","description":"Realiza a busca de informações cadastrais detalhadas de uma pessoa jurídica junto às bases de dados oficiais. \nEste recurso é fundamental para a validação de emissores e garantia de que os dados cadastrais \nestão atualizados para a correta aplicação das regras fiscais.\n\n⚠️ **ATENÇÃO**: A consulta retorna dados públicos do registro da empresa. Certifique-se de que o CNPJ informado \nesteje em formato válido para evitar erros de validação de máscara.\n\n🧪 **TESTE**: Em ambiente de sandbox, a consulta pode retornar dados simplificados ou simulados para garantir \na agilidade do desenvolvimento sem onerar bureaus de crédito ou bases governamentais reais.","parameters":[{"name":"cnpj","in":"path","description":"CNPJ a ser consultado.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ConsultaCnpjViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConsultaCnpjViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ConsultaCnpjViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/RecursosAdicionais/Cnpj/HistoricoConsulta/Resumo":{"get":{"tags":["RecursosAdicionais"],"summary":"Histórico de consultas CNPJ - Resumo.","description":"Fornece uma visão consolidada e totalizada do histórico de consultas de CNPJ realizadas pela aplicação. \nEste recurso é estratégico para a gestão e bilhetagem do consumo, permitindo auditar o volume de requisições \nprocessadas dentro de um período específico ou através de termos de busca.\n\n📊 **INDICADORES**: O retorno contempla somatórios que auxiliam no controle operacional e financeiro do uso da API de consulta cadastral.","parameters":[{"name":"filtro","in":"query","description":"Filtrar pelo filtro utilizado na consulta.","schema":{"type":"string"}},{"name":"dataConsultaInicial","in":"query","description":"Filtrar pela data de consulta \"a partir de\".","schema":{"type":"string","format":"date-time"}},{"name":"dataConsultaFinal","in":"query","description":"Filtrar pela data de consulta \"até\".","schema":{"type":"string","format":"date-time"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ObterResumoConsultaCnpjAplicacaoViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ObterResumoConsultaCnpjAplicacaoViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ObterResumoConsultaCnpjAplicacaoViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/RecursosAdicionais/Cnpj/HistoricoConsulta/Listar":{"get":{"tags":["RecursosAdicionais"],"summary":"Histórico de consultas CNPJ - Listar.","description":"Permite listar consultas de CNPJ realizadas. O recurso retorna uma relação resumida das consultas, possibilitando a identificação de quais CNPJs foram consultados em um determinado período.\n\n📋 **PAGINAÇÃO**: A listagem utiliza o padrão de offset e limit. É recomendável parametrizar o tamanho da página para otimizar o tempo de resposta e o tráfego de dados.\n\n🔍 **FILTROS**: É possível refinar os resultados utilizando intervalos de datas ou filtro para localizar registros específicos no histórico.","parameters":[{"name":"filtro","in":"query","description":"Filtrar pelo filtro utilizado na consulta.","schema":{"type":"string"}},{"name":"dataConsultaInicial","in":"query","description":"Filtrar pela data de consulta \"a partir de\".","schema":{"type":"string","format":"date-time"}},{"name":"dataConsultaFinal","in":"query","description":"Filtrar pela data de consulta \"até\".","schema":{"type":"string","format":"date-time"}},{"name":"offset","in":"query","description":"Quantidade de registros a serem pulados.","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Limite máximo de registros por página.","schema":{"type":"integer","format":"int32","default":10}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ListarConsultasCnpjAplicacaoViewModelListPaginationResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ListarConsultasCnpjAplicacaoViewModelListPaginationResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ListarConsultasCnpjAplicacaoViewModelListPaginationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/RecursosAdicionais/Cnpj/HistoricoConsulta/{historicoConsultaCnpjId}/ObterDetalhe":{"get":{"tags":["RecursosAdicionais"],"summary":"Histórico de consultas CNPJ - Detalhe.","description":"Permite obter o detalhamento completo de uma consulta de CNPJ realizada anteriormente. \nO recurso recupera os dados cadastrais e fiscais da entidade consultada conforme registrado no momento da transação original, \nutilizando o identificador único gerado pelo histórico.\n\n🔍 **RASTRO**: Este endpoint é essencial para auditoria e recuperação de dados de consultas anteriores sem a necessidade de realizar um novo consumo tarifado, desde que o ID do histórico esteja disponível.","parameters":[{"name":"historicoConsultaCnpjId","in":"path","description":"Identificador do histórico de consulta do cnpj.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ObterDetalheConsultaCnpjAplicacaoViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ObterDetalheConsultaCnpjAplicacaoViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ObterDetalheConsultaCnpjAplicacaoViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/RecursosAdicionais/Cfop/Listar":{"get":{"tags":["RecursosAdicionais"],"summary":"CFOPs - Listar.","description":"Fornece uma listagem completa dos Códigos Fiscais de Operações e Prestações (CFOP). Este recurso é fundamental para determinar a natureza da circulação de mercadorias ou a prestação de serviços.\n\n⚠️ **ATENÇÃO**: A escolha incorreta do CFOP pode impactar diretamente na apuração de impostos e na validação da nota fiscal pela SEFAZ. Utilize os filtros para restringir a busca ao cenário de negócio desejado.\n\n🔍 **DICA DE INTEGRAÇÃO**: Recomenda-se o cache dessas informações no sistema local, realizando consultas periódicas para capturar novos códigos ou alterações em indicadores de faturamento e devolução.","parameters":[{"name":"codigoCfop","in":"query","description":"Filtrar pelo código numérico do CFOP.","schema":{"type":"string"}},{"name":"busca","in":"query","description":"Filtrar por campo de busca genérico.","schema":{"type":"string"}},{"name":"tipoOperacao","in":"query","description":"Filtrar pelo tipo de operação (Entrada/Saída).","schema":{"$ref":"#/components/schemas/TipoOperacaoCfopModelEnum"}},{"name":"tipoDestino","in":"query","description":"Filtrar pelo tipo de destino.","schema":{"$ref":"#/components/schemas/TipoDestinoCfopModelEnum"}},{"name":"tipoIcms","in":"query","description":"Filtrar pelo tipo de incidência do ICMS.","schema":{"$ref":"#/components/schemas/TipoIcmsCfopModelEnum"}},{"name":"tipoDestinatario","in":"query","description":"Filtrar pelo tipo de destinatário.","schema":{"$ref":"#/components/schemas/TipoDestinatarioCfopModelEnum"}},{"name":"permiteNfe","in":"query","description":"Filtrar se permite emissão de NFe.","schema":{"type":"boolean"}},{"name":"indicaComunicacao","in":"query","description":"Filtrar se indica serviços de comunicação.","schema":{"type":"boolean"}},{"name":"indicaTransporte","in":"query","description":"Filtrar se indica serviços de transporte.","schema":{"type":"boolean"}},{"name":"indicaDevolucao","in":"query","description":"Filtrar se caracteriza devolução.","schema":{"type":"boolean"}},{"name":"indicaCombustivel","in":"query","description":"Filtrar se envolve combustíveis.","schema":{"type":"boolean"}},{"name":"compoeFaturamento","in":"query","description":"Filtrar se compõe faturamento.","schema":{"type":"boolean"}},{"name":"offset","in":"query","description":"Quantidade de registros a serem pulados.","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Limite máximo de registros por página.","schema":{"type":"integer","format":"int32","default":10}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ListarCfopsViewModelListPaginationResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ListarCfopsViewModelListPaginationResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ListarCfopsViewModelListPaginationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/RecursosAdicionais/Ncm/Listar":{"get":{"tags":["RecursosAdicionais"],"summary":"NCMs - Listar.","description":"Consulta a tabela de Nomenclatura Comum do Mercosul (NCM), utilizada para a classificação fiscal de mercadorias no comércio internacional e doméstico.\n\n⚠️ **VIGÊNCIA**: Atente-se aos campos de data de vigência. Consultar NCMs expiradas pode ocasionar rejeições no momento da emissão do documento fiscal eletrônico.\n\n🧪 **TESTE**: Em ambiente de sandbox, a tabela reflete a estrutura oficial, permitindo validar se a lógica de busca por descrição ou código atende aos requisitos do PDV ou ERP.\n\n🔍 **BUSCA SEMÂNTICA**: O parâmetro 'busca' realiza uma varredura tanto na descrição do item quanto no segmento relacionado, facilitando a identificação correta da mercadoria.","parameters":[{"name":"codigoNcm","in":"query","description":"Filtrar pelo código NCM exato.","schema":{"type":"string"}},{"name":"extensaoTipi","in":"query","description":"Filtrar pela extensão TIPI (EX).","schema":{"type":"integer","format":"int32"}},{"name":"busca","in":"query","description":"Filtrar por campo de busca genérico.","schema":{"type":"string"}},{"name":"dataInicioVigenciaInicial","in":"query","description":"Data de início de vigência \"a partir de\".","schema":{"type":"string","format":"date"}},{"name":"dataInicioVigenciaFinal","in":"query","description":"Data de início de vigência \"até\".","schema":{"type":"string","format":"date"}},{"name":"dataFimVigenciaInicial","in":"query","description":"Data de fim de vigência \"a partir de\".","schema":{"type":"string","format":"date"}},{"name":"dataFimVigenciaFinal","in":"query","description":"Data de fim de vigência \"até\".","schema":{"type":"string","format":"date"}},{"name":"offset","in":"query","description":"Quantidade de registros a serem pulados (deslocamento).","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Limite máximo de registros por página.","schema":{"type":"integer","format":"int32","default":10}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ListarNcmsViewModelListPaginationResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ListarNcmsViewModelListPaginationResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ListarNcmsViewModelListPaginationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/RecursosAdicionais/Ncm/{codigoNcm}/ObterDetalhe":{"get":{"tags":["RecursosAdicionais"],"summary":"NCM - Obter detalhe.","description":"Realiza uma consulta detalhada à tabela de Nomenclatura Comum do Mercosul (NCM), fornecendo informações sobre a classificação fiscal e tributos aproximados por UF.\n\n🔍 **CLASSIFICAÇÃO**: O código NCM deve ser informado com 8 dígitos numéricos. O tributo aproximado deve ser informado em operações de vendas a consumidor final.\n\nℹ️ **EXTENSÃO TIPI**: Caso o produto possua uma exceção tarifária específica, utilize o parâmetro Extensão TIPI (Ex) para obter o detalhamento diferenciado aplicável ao código.\n\n⚠️ **ATENÇÃO**: A utilização de NCMs inválidos ou extintos pode ocasionar a rejeição de documentos fiscais eletrônicos (NF-e/NFC-e) pelas Secretarias da Fazenda.","parameters":[{"name":"codigoNcm","in":"path","description":"Código do NCM.","required":true,"schema":{"type":"string"}},{"name":"extensaoTipi","in":"query","description":"Extensão TIPI do NCM. (Opcional)","schema":{"type":"integer","format":"int32"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/NcmViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/NcmViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/NcmViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/RecursosAdicionais/Cest/Listar":{"get":{"tags":["RecursosAdicionais"],"summary":"CEST - Listar","description":"Fornece uma listagem completa e atualizada dos códigos CEST, utilizados para identificar mercadorias e bens passíveis de Substituição Tributária (ST) e antecipação de ICMS. \n\nO recurso permite a consulta técnica para auxiliar na correta classificação fiscal de produtos, garantindo que o vínculo entre o NCM e o CEST esteja em conformidade com o Convênio ICMS vigente.\n\n🔍 **DICA DE BUSCA**: Utilize o filtro por busca para encontrar códigos baseados no agrupamento de mercadorias ou o filtro por código para validações diretas de conformidade.","parameters":[{"name":"codigoCest","in":"query","description":"Filtrar pelo código CEST.","schema":{"type":"string"}},{"name":"busca","in":"query","description":"Filtrar por campo de busca genérico.","schema":{"type":"string"}},{"name":"offset","in":"query","description":"Paginação da listagem - offset.","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Paginação da listagem - limit.","schema":{"type":"integer","format":"int32","default":10}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ListarCestsViewModelListPaginationResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ListarCestsViewModelListPaginationResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ListarCestsViewModelListPaginationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/RecursosAdicionais/Cest/{codigoCest}/ObterDetalhe":{"get":{"tags":["RecursosAdicionais"],"summary":"CEST - Obter detalhe.","description":"Permite obter informações detalhadas sobre o CEST com base no seu código identificador. \nO recurso é fundamental para a correta identificação de mercadorias sujeitas aos regimes de \nsubstituição tributária e antecipação do ICMS.\n\n🔍 **VINCULAÇÃO**: O detalhamento auxilia na correlação entre o CEST e o NCM (Nomenclatura Comum do Mercosul), \ngarantindo que a classificação fiscal do produto esteja em conformidade com as exigências do CONFAZ.","parameters":[{"name":"codigoCest","in":"path","description":"Código CEST.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ObterDetalheCestViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ObterDetalheCestViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ObterDetalheCestViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/RecursosAdicionais/CodigoBeneficio/Listar":{"get":{"tags":["RecursosAdicionais"],"summary":"Códigos de benefício - Listar.","description":"Permite a consulta e listagem dos códigos de benefício fiscal parametrizados na plataforma. \nEste recurso é essencial para a correta identificação de incentivos fiscais vinculados a determinados produtos ou operações, \ngarantindo a conformidade na emissão de documentos fiscais eletrônicos.\n\n🔍 **FILTROS**: A busca pode ser refinada combinando o código técnico do benefício, termos contidos em sua descrição \nou restringindo os resultados a uma Unidade Federativa (UF) específica.\n\n📑 **PAGINAÇÃO**: O retorno é paginado, permitindo o controle de fluxo de dados através dos parâmetros de offset e limit.","parameters":[{"name":"codigoBeneficio","in":"query","description":"Filtrar pelo código do benefício.","schema":{"type":"string"}},{"name":"busca","in":"query","description":"Filtrar por campo de busca genérico.","schema":{"type":"string"}},{"name":"uf","in":"query","description":"Filtrar pela Unidade Federativa (UF).","schema":{"$ref":"#/components/schemas/UfCodigoBeneficioModelEnum"}},{"name":"offset","in":"query","description":"Paginação da listagem - offset.","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Paginação da listagem - limit.","schema":{"type":"integer","format":"int32","default":10}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ListarCodigosBeneficioViewModelListPaginationResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ListarCodigosBeneficioViewModelListPaginationResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ListarCodigosBeneficioViewModelListPaginationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/RecursosAdicionais/EnquadramentoLegalIpi/Listar":{"get":{"tags":["RecursosAdicionais"],"summary":"Enquadramento Legal do IPI - Listar.","description":"Fornece a listagem dos códigos de enquadramento legal do IPI utilizados na emissão de documentos fiscais eletrônicos.\n \nO enquadramento legal do IPI é obrigatório para determinadas situações tributárias e identifica a fundamentação legal\naplicável à operação, como imunidade, isenção, suspensão, redução ou outras hipóteses previstas na legislação.\n \n🔍 **FILTROS**: A busca pode ser refinada por termos contidos no código ou na descrição do enquadramento,\nou restringindo os resultados a um grupo de CST específico.\n \n📑 **PAGINAÇÃO**: O retorno é paginado, permitindo o controle de fluxo de dados através dos parâmetros de offset e limit.","parameters":[{"name":"busca","in":"query","description":"Filtrar por campo de busca genérico (código ou descrição).","schema":{"type":"string"}},{"name":"grupoCst","in":"query","description":"Filtrar pelo grupo de CST do IPI.","schema":{"$ref":"#/components/schemas/GrupoCstIpiModelEnum"}},{"name":"offset","in":"query","description":"Paginação da listagem - offset.","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Paginação da listagem - limit.","schema":{"type":"integer","format":"int32","default":10}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ListarEnquadramentosLegalIpiViewModelListPaginationResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ListarEnquadramentosLegalIpiViewModelListPaginationResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ListarEnquadramentosLegalIpiViewModelListPaginationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/RecursosAdicionais/ServicoCtn/Listar":{"get":{"tags":["RecursosAdicionais"],"summary":"NFS-e - Listar serviços.","description":"Fornece uma listagem dos serviços da Lista de Serviços do CTN (Código Tributário Nacional),\ncom informações sobre o tipo de incidência do ISS para cada serviço.\n \n🔍 **FILTROS**: A busca pode ser refinada por código ou descrição do serviço, e pelo tipo de incidência do ISS.\n \n📑 **PAGINAÇÃO**: O retorno é paginado via parâmetros de offset e limit.","parameters":[{"name":"busca","in":"query","description":"Filtrar por campo de busca genérico (código ou descrição).","schema":{"type":"string"}},{"name":"incidenciaIss","in":"query","description":"Filtrar pelo tipo de incidência do ISS.","schema":{"$ref":"#/components/schemas/IncidenciaIssCtnModelEnum"}},{"name":"offset","in":"query","description":"Quantidade de registros a serem pulados.","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Limite máximo de registros por página.","schema":{"type":"integer","format":"int32","default":10}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ListarServicoCtnViewModelListPaginationResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ListarServicoCtnViewModelListPaginationResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ListarServicoCtnViewModelListPaginationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/RecursosAdicionais/ServicoCtn/{codigoCtn}/ObterDetalhe":{"get":{"tags":["RecursosAdicionais"],"summary":"NFS-e - Obter detalhe do serviço CTN.","description":"Retorna os dados completos de um serviço da Lista de Serviços do CTN (Código Tributário Nacional),\nincluindo os códigos NBS associados, os indicadores de operação de NFS-e e as classificações tributárias vinculadas.","parameters":[{"name":"codigoCtn","in":"path","description":"Código do serviço conforme a Lista de Serviços do CTN.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ObterDetalheServicoCtnViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ObterDetalheServicoCtnViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ObterDetalheServicoCtnViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/RecursosAdicionais/IndicadorOperacaoNfse/Listar":{"get":{"tags":["RecursosAdicionais"],"summary":"NFS-e - Listar indicadores de operação.","description":"Fornece uma listagem dos Indicadores de Operação de NFS-e (cIndOp),\nutilizados no bloco IBS/CBS da Declaração de Prestação de Serviços (DPS) da reforma tributária.\n \n🔍 **FILTROS**: A busca pode ser refinada por código, tipo de operação, característica ou local de fornecimento.\n \n📑 **PAGINAÇÃO**: O retorno é paginado via parâmetros de offset e limit.","parameters":[{"name":"busca","in":"query","description":"Filtrar por campo de busca genérico (código, tipo de operação, característica ou local de fornecimento).","schema":{"type":"string"}},{"name":"offset","in":"query","description":"Quantidade de registros a serem pulados.","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Limite máximo de registros por página.","schema":{"type":"integer","format":"int32","default":10}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ListarIndicadoresOperacaoNfseViewModelListPaginationResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ListarIndicadoresOperacaoNfseViewModelListPaginationResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ListarIndicadoresOperacaoNfseViewModelListPaginationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/RecursosAdicionais/Nbs/Listar":{"get":{"tags":["RecursosAdicionais"],"summary":"NFS-e - Listar códigos NBS.","description":"Fornece uma listagem dos códigos da Nomenclatura Brasileira de Serviços (NBS),\nutilizados para a classificação fiscal de serviços na emissão de NFS-e.\n \n🔍 **FILTROS**: A busca pode ser refinada por código ou descrição do serviço.\n \n📑 **PAGINAÇÃO**: O retorno é paginado via parâmetros de offset e limit.","parameters":[{"name":"busca","in":"query","description":"Filtrar por campo de busca genérico (código ou descrição).","schema":{"type":"string"}},{"name":"offset","in":"query","description":"Quantidade de registros a serem pulados.","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Limite máximo de registros por página.","schema":{"type":"integer","format":"int32","default":10}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ListarNbsViewModelListPaginationResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ListarNbsViewModelListPaginationResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ListarNbsViewModelListPaginationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/RecursosAdicionais/Nfse/Municipio/{codigoMunicipio}/Parametros":{"get":{"tags":["RecursosAdicionais"],"summary":"NFS-e - Obter parâmetros do município.","description":"Retorna os parâmetros do município para emissão de NFS-e no Ambiente Nacional, incluindo dados do convênio\n(aderência ao Ambiente Nacional, Emissor Nacional e MAN) e as retenções configuradas no município.\n \n⚠️ **ATENÇÃO**: O código do município deve ser o código IBGE de 7 dígitos.","parameters":[{"name":"codigoMunicipio","in":"path","description":"Código IBGE do município.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ObterParametrosMunicipioNfseViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ObterParametrosMunicipioNfseViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ObterParametrosMunicipioNfseViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/RecursosAdicionais/Nfse/Municipio/{codigoMunicipio}/Cnpj/{cnpj}/CadastroCnc":{"get":{"tags":["RecursosAdicionais"],"summary":"NFS-e - Consultar cadastro do CNPJ no CNC.","description":"Consulta o cadastro do CNPJ no Cadastro Nacional de Contribuintes (CNC) do Ambiente Nacional NFS-e,\nretornando a lista de registros municipais encontrados com as informações cadastrais, situação de emissão\ne dados de endereço do contribuinte.\n \n⚠️ **ATENÇÃO**: O código do município deve ser o código IBGE de 7 dígitos.","parameters":[{"name":"codigoMunicipio","in":"path","description":"Código IBGE do município.","required":true,"schema":{"type":"string"}},{"name":"cnpj","in":"path","description":"CNPJ a ser consultado no CNC.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CadastroMunicipalCncNfseViewModel"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CadastroMunicipalCncNfseViewModel"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CadastroMunicipalCncNfseViewModel"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/RecursosAdicionais/Nfse/Municipio/{codigoMunicipio}/Servico/{codigoServico}/AliquotaIss":{"get":{"tags":["RecursosAdicionais"],"summary":"NFS-e - Obter alíquota de ISS do município.","description":"Retorna as alíquotas de ISS vigentes para o serviço informado no município, conforme parametrização do Ambiente Nacional NFS-e.\nAs alíquotas são agrupadas por tipo de incidência e contêm o período de vigência de cada faixa.\n \n⚠️ **ATENÇÃO**: O código do município deve ser o código IBGE de 7 dígitos. O código do serviço deve seguir a classificação da LC 116/2003.","parameters":[{"name":"codigoMunicipio","in":"path","description":"Código IBGE do município.","required":true,"schema":{"type":"string"}},{"name":"codigoServico","in":"path","description":"Código do serviço (LC 116/2003).","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ObterAliquotaIssDoMunicipioNfseViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ObterAliquotaIssDoMunicipioNfseViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ObterAliquotaIssDoMunicipioNfseViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/RecursosAdicionais/Nfse/Municipio/{codigoMunicipio}/Beneficio/{codigoBeneficio}/Consultar":{"get":{"tags":["RecursosAdicionais"],"summary":"NFS-e - Consultar benefício fiscal do município.","description":"Consulta os detalhes de um benefício fiscal parametrizado no Ambiente Nacional NFS-e para o município informado,\nincluindo tipo, percentuais de redução de base de cálculo ou alíquota diferenciada, serviços contemplados e período de vigência.\n \n⚠️ **ATENÇÃO**: O código do município deve ser o código IBGE de 7 dígitos.","parameters":[{"name":"codigoMunicipio","in":"path","description":"Código IBGE do município.","required":true,"schema":{"type":"string"}},{"name":"codigoBeneficio","in":"path","description":"Código do benefício fiscal.","required":true,"schema":{"type":"string"}},{"name":"DocumentoEmissor","in":"header","description":"Documento do emissor.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ConsultarBeneficioNfseViewModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConsultarBeneficioNfseViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ConsultarBeneficioNfseViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseErrorResult"}}}}},"security":[{"BearerAuth":[]}]}}},"components":{"schemas":{"AnaliseAplicativoDetalheViewModel":{"type":"object","properties":{"quantidadeTotalEmissoresAtivos":{"type":"integer","description":"Quantidade total de emissores ativos.","format":"int32"},"quantidadeEmissoresHabilitadosNoPeriodo":{"type":"integer","description":"Quantidade de emissores habilitados no período selecionado.","format":"int32"},"quantidadeEmissoresAtivosComCertificadoDigital":{"type":"integer","description":"Quantidade total de emissores ativos com certificado digital.","format":"int32"},"quantidadeEmissoresAtivosComCertificadoDigitalValido":{"type":"integer","description":"Quantidade total de emissores ativos com certificado digital válido e em dia.","format":"int32"},"quantidadeEmissoresAtivosComCertificadoDigitalProximoDoVencimento":{"type":"integer","description":"Quantidade total de emissores ativos com certificado digital próximo do vencimento.","format":"int32"},"quantidadeEmissoresAtivosComCertificadoDigitalVencido":{"type":"integer","description":"Quantidade total de emissores ativos com certificado digital vencido.","format":"int32"},"quantidadeEmissoresAtivosSemCertificadoDigital":{"type":"integer","description":"Quantidade total de emissores sem certificado digital.","format":"int32"},"quantidadeTotalNotas":{"type":"integer","description":"Quantidade total de notas processadas.","format":"int32"},"quantidadeTotalNotasAprovadas":{"type":"integer","description":"Quantidade total de notas com status aprovado.","format":"int32"},"quantidadeTotalNotasCanceladas":{"type":"integer","description":"Quantidade total de notas canceladas.","format":"int32"},"quantidadeTotalNotasRejeitadas":{"type":"integer","description":"Quantidade total de notas rejeitadas pela SEFAZ.","format":"int32"},"quantidadeTotalNotasPendentes":{"type":"integer","description":"Quantidade total de notas em processamento ou pendentes.","format":"int32"},"quantidadeTotalNotasEmContingencia":{"type":"integer","description":"Quantidade total de notas emitidas em regime de contingência.","format":"int32"},"quantidadeTotalNotasSubstituidas":{"type":"integer","description":"Quantidade total de notas que foram substituídas.","format":"int32"},"valorTotalNotas":{"type":"number","description":"Valor bruto total de todas as notas.","format":"double"},"valorTotalNotasAprovadas":{"type":"number","description":"Valor total acumulado das notas aprovadas.","format":"double"},"valorTotalNotasCanceladas":{"type":"number","description":"Valor total acumulado das notas canceladas.","format":"double"},"valorTotalNotasRejeitadas":{"type":"number","description":"Valor total acumulado das notas rejeitadas.","format":"double"},"valorTotalNotasPendentes":{"type":"number","description":"Valor total acumulado das notas pendentes.","format":"double"},"valorTotalNotasEmContingencia":{"type":"number","description":"Valor total acumulado das notas em contingência.","format":"double"},"valorTotalNotasSubstituidas":{"type":"number","description":"Valor total acumulado das notas substituídas.","format":"double"},"tempoMedioEmissaoNotasMilissegundos":{"type":"number","description":"Tempo médio de emissão das notas em milissegundos.","format":"double"},"tempoMedioEmissaoNotas":{"type":"string","description":"Representação textual do tempo médio de emissão.","nullable":true},"quantidadeConsultasCatalogoFiscal":{"type":"integer","description":"Quantidade de consultas realizadas ao catálogo fiscal.","format":"int32"},"quantidadeProdutosTributacaoAlterada":{"type":"integer","description":"Quantidade de produtos que tiveram a tributação alterada no período.","format":"int32"},"quantidadeConsultasCnpjAplicacao":{"type":"integer","description":"Quantidade de consultas de CNPJ realizadas via aplicação.","format":"int32"},"quantidadeConsultasCnpjEmissores":{"type":"integer","description":"Quantidade de consultas de CNPJ realizadas pelos emissores.","format":"int32"}},"additionalProperties":false,"description":"Detalhe da análise do aplicativo."},"AnaliseAplicativoViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador interno do aplicativo.","format":"uuid"},"nome":{"type":"string","description":"Nome do aplicativo.","nullable":true},"status":{"$ref":"#/components/schemas/StatusAplicativoModelEnum"},"consoleId":{"type":"string","description":"Identificador do aplicativo no console.","nullable":true},"dataCriacao":{"type":"string","description":"Data de criação do aplicação no sistema.","format":"date-time"},"ultimaAlteracao":{"type":"string","description":"Data de última alteração dos dados da aplicação no sistema.","format":"date-time"},"contrato":{"$ref":"#/components/schemas/AplicativoContratoViewModel"},"bilhetagem":{"$ref":"#/components/schemas/AplicativoBilhetagemViewModel"},"analise":{"$ref":"#/components/schemas/AnaliseAplicativoDetalheViewModel"}},"additionalProperties":false,"description":"Dados de análise detalhada do aplicativo."},"AnaliseEmissorDetalheViewModel":{"type":"object","properties":{"quantidadeTotalNotas":{"type":"integer","description":"Quantidade total de notas processadas.","format":"int32"},"quantidadeTotalNotasAprovadas":{"type":"integer","description":"Quantidade total de notas com status aprovado.","format":"int32"},"quantidadeTotalNotasCanceladas":{"type":"integer","description":"Quantidade total de notas canceladas.","format":"int32"},"quantidadeTotalNotasRejeitadas":{"type":"integer","description":"Quantidade total de notas rejeitadas pela SEFAZ.","format":"int32"},"quantidadeTotalNotasPendentes":{"type":"integer","description":"Quantidade total de notas em processamento ou pendentes.","format":"int32"},"quantidadeTotalNotasEmContingencia":{"type":"integer","description":"Quantidade total de notas emitidas em regime de contingência.","format":"int32"},"quantidadeTotalNotasSubstituidas":{"type":"integer","description":"Quantidade total de notas que foram substituídas.","format":"int32"},"valorTotalNotas":{"type":"number","description":"Valor bruto total de todas as notas.","format":"double"},"valorTotalNotasAprovadas":{"type":"number","description":"Valor total acumulado das notas aprovadas.","format":"double"},"valorTotalNotasCanceladas":{"type":"number","description":"Valor total acumulado das notas canceladas.","format":"double"},"valorTotalNotasRejeitadas":{"type":"number","description":"Valor total acumulado das notas rejeitadas.","format":"double"},"valorTotalNotasPendentes":{"type":"number","description":"Valor total acumulado das notas pendentes.","format":"double"},"valorTotalNotasEmContingencia":{"type":"number","description":"Valor total acumulado das notas em contingência.","format":"double"},"valorTotalNotasSubstituidas":{"type":"number","description":"Valor total acumulado das notas substituídas.","format":"double"},"tempoMedioEmissaoNotasMilissegundos":{"type":"number","description":"Tempo médio de emissão das notas em milissegundos.","format":"double"},"tempoMedioEmissaoNotas":{"type":"string","description":"Representação textual do tempo médio de emissão.","nullable":true},"quantidadeConsultasCatalogoFiscal":{"type":"integer","description":"Quantidade de consultas realizadas ao catálogo fiscal.","format":"int32"},"quantidadeProdutosTributacaoAlterada":{"type":"integer","description":"Quantidade de produtos que tiveram a tributação alterada no período.","format":"int32"},"quantidadeConsultasCnpj":{"type":"integer","description":"Quantidade de consultas de CNPJ realizadas pelo emissor.","format":"int32"}},"additionalProperties":false,"description":"Detalhe da análise do emissor."},"AnaliseEmissorViewModel":{"type":"object","properties":{"documento":{"type":"string","description":"Documento (CPF/CNPJ) do emissor.","nullable":true},"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoEmissorModelEnum"},"nome":{"type":"string","description":"Nome ou Razão Social do emissor.","nullable":true},"nomeFantasia":{"type":"string","description":"Nome fantasia do emissor.","nullable":true},"dataCriacao":{"type":"string","description":"Data de criação do emissor no sistema.","format":"date-time"},"ultimaAlteracao":{"type":"string","description":"Data de última alteração dos dados do emissor no sistema.","format":"date-time"},"status":{"$ref":"#/components/schemas/StatusEmissorModelEnum"},"certificadoDigital":{"$ref":"#/components/schemas/CertificadoDigitalViewModel"},"bilhetagem":{"$ref":"#/components/schemas/EmissorBilhetagemViewModel"},"analise":{"$ref":"#/components/schemas/AnaliseEmissorDetalheViewModel"}},"additionalProperties":false,"description":"Dados da análise do emissor."},"AnaliseGeralViewModel":{"type":"object","properties":{"quantidadeTotalParceirosAtivos":{"type":"integer","description":"Quantidade total de parceiros ativos.","format":"int32"},"quantidadeParceirosHabilitadosNoPeriodo":{"type":"integer","description":"Quantidade de parceiros no período selecionado.","format":"int32"},"quantidadeTotalAplicativosAtivos":{"type":"integer","description":"Quantidade total de aplicativos ativos.","format":"int32"},"quantidadeAplicativosHabilitadosNoPeriodo":{"type":"integer","description":"Quantidade de aplicativos no período selecionado.","format":"int32"},"quantidadeTotalEmissoresAtivos":{"type":"integer","description":"Quantidade total de emissores ativos.","format":"int32"},"quantidadeEmissoresHabilitadosNoPeriodo":{"type":"integer","description":"Quantidade de emissores habilitados no período selecionado.","format":"int32"},"quantidadeEmissoresAtivosComCertificadoDigital":{"type":"integer","description":"Quantidade total de emissores ativos com certificado digital.","format":"int32"},"quantidadeEmissoresAtivosComCertificadoDigitalValido":{"type":"integer","description":"Quantidade total de emissores ativos com certificado digital válido e em dia.","format":"int32"},"quantidadeEmissoresAtivosComCertificadoDigitalProximoDoVencimento":{"type":"integer","description":"Quantidade total de emissores ativos com certificado digital próximo do vencimento.","format":"int32"},"quantidadeEmissoresAtivosComCertificadoDigitalVencido":{"type":"integer","description":"Quantidade total de emissores ativos com certificado digital vencido.","format":"int32"},"quantidadeEmissoresAtivosSemCertificadoDigital":{"type":"integer","description":"Quantidade total de emissores sem certificado digital.","format":"int32"},"quantidadeTotalNotas":{"type":"integer","description":"Quantidade total de notas processadas.","format":"int32"},"quantidadeTotalNotasAprovadas":{"type":"integer","description":"Quantidade total de notas com status aprovado.","format":"int32"},"quantidadeTotalNotasCanceladas":{"type":"integer","description":"Quantidade total de notas canceladas.","format":"int32"},"quantidadeTotalNotasRejeitadas":{"type":"integer","description":"Quantidade total de notas rejeitadas pela SEFAZ.","format":"int32"},"quantidadeTotalNotasPendentes":{"type":"integer","description":"Quantidade total de notas em processamento ou pendentes.","format":"int32"},"quantidadeTotalNotasEmContingencia":{"type":"integer","description":"Quantidade total de notas emitidas em regime de contingência.","format":"int32"},"quantidadeTotalNotasSubstituidas":{"type":"integer","description":"Quantidade total de notas que foram substituídas.","format":"int32"},"valorTotalNotas":{"type":"number","description":"Valor bruto total de todas as notas.","format":"double"},"valorTotalNotasAprovadas":{"type":"number","description":"Valor total acumulado das notas aprovadas.","format":"double"},"valorTotalNotasCanceladas":{"type":"number","description":"Valor total acumulado das notas canceladas.","format":"double"},"valorTotalNotasRejeitadas":{"type":"number","description":"Valor total acumulado das notas rejeitadas.","format":"double"},"valorTotalNotasPendentes":{"type":"number","description":"Valor total acumulado das notas pendentes.","format":"double"},"valorTotalNotasEmContingencia":{"type":"number","description":"Valor total acumulado das notas em contingência.","format":"double"},"valorTotalNotasSubstituidas":{"type":"number","description":"Valor total acumulado das notas substituídas.","format":"double"},"tempoMedioEmissaoNotasMilissegundos":{"type":"number","description":"Tempo médio de emissão das notas em milissegundos.","format":"double"},"tempoMedioEmissaoNotas":{"type":"string","description":"Representação textual do tempo médio de emissão.","nullable":true},"quantidadeConsultasCatalogoFiscal":{"type":"integer","description":"Quantidade de consultas realizadas ao catálogo fiscal.","format":"int32"},"quantidadeProdutosTributacaoAlterada":{"type":"integer","description":"Quantidade de produtos que tiveram a tributação alterada no período.","format":"int32"},"quantidadeConsultasCnpjAplicacao":{"type":"integer","description":"Quantidade de consultas de CNPJ realizadas via aplicação.","format":"int32"},"quantidadeConsultasCnpjEmissores":{"type":"integer","description":"Quantidade de consultas de CNPJ realizadas pelos emissores.","format":"int32"}},"additionalProperties":false,"description":"Dados da análise geral."},"AnaliseParceiroViewModel":{"type":"object","properties":{"cnpj":{"type":"string","description":"CNPJ do parceiro.","nullable":true},"razaoSocial":{"type":"string","description":"Nome ou razão social do parceiro.","nullable":true},"status":{"type":"string","description":"Status atual do parceiro no sistema.","nullable":true},"consoleId":{"type":"string","description":"Identificador do parceiro no console.","nullable":true},"quantidadeTotalAplicativosAtivos":{"type":"integer","description":"Quantidade total de aplicativos ativos.","format":"int32"},"quantidadeAplicativosHabilitadosNoPeriodo":{"type":"integer","description":"Quantidade de aplicativos no período selecionado.","format":"int32"},"quantidadeTotalEmissoresAtivos":{"type":"integer","description":"Quantidade total de emissores ativos.","format":"int32"},"quantidadeEmissoresHabilitadosNoPeriodo":{"type":"integer","description":"Quantidade de emissores habilitados no período selecionado.","format":"int32"},"quantidadeEmissoresAtivosComCertificadoDigital":{"type":"integer","description":"Quantidade total de emissores ativos com certificado digital.","format":"int32"},"quantidadeEmissoresAtivosComCertificadoDigitalValido":{"type":"integer","description":"Quantidade total de emissores ativos com certificado digital válido e em dia.","format":"int32"},"quantidadeEmissoresAtivosComCertificadoDigitalProximoDoVencimento":{"type":"integer","description":"Quantidade total de emissores ativos com certificado digital próximo do vencimento.","format":"int32"},"quantidadeEmissoresAtivosComCertificadoDigitalVencido":{"type":"integer","description":"Quantidade total de emissores ativos com certificado digital vencido.","format":"int32"},"quantidadeEmissoresAtivosSemCertificadoDigital":{"type":"integer","description":"Quantidade total de emissores sem certificado digital.","format":"int32"},"quantidadeTotalNotas":{"type":"integer","description":"Quantidade total de notas processadas.","format":"int32"},"quantidadeTotalNotasAprovadas":{"type":"integer","description":"Quantidade total de notas com status aprovado.","format":"int32"},"quantidadeTotalNotasCanceladas":{"type":"integer","description":"Quantidade total de notas canceladas.","format":"int32"},"quantidadeTotalNotasRejeitadas":{"type":"integer","description":"Quantidade total de notas rejeitadas pela SEFAZ.","format":"int32"},"quantidadeTotalNotasPendentes":{"type":"integer","description":"Quantidade total de notas em processamento ou pendentes.","format":"int32"},"quantidadeTotalNotasEmContingencia":{"type":"integer","description":"Quantidade total de notas emitidas em regime de contingência.","format":"int32"},"quantidadeTotalNotasSubstituidas":{"type":"integer","description":"Quantidade total de notas que foram substituídas.","format":"int32"},"valorTotalNotas":{"type":"number","description":"Valor bruto total de todas as notas.","format":"double"},"valorTotalNotasAprovadas":{"type":"number","description":"Valor total acumulado das notas aprovadas.","format":"double"},"valorTotalNotasCanceladas":{"type":"number","description":"Valor total acumulado das notas canceladas.","format":"double"},"valorTotalNotasRejeitadas":{"type":"number","description":"Valor total acumulado das notas rejeitadas.","format":"double"},"valorTotalNotasPendentes":{"type":"number","description":"Valor total acumulado das notas pendentes.","format":"double"},"valorTotalNotasEmContingencia":{"type":"number","description":"Valor total acumulado das notas em contingência.","format":"double"},"valorTotalNotasSubstituidas":{"type":"number","description":"Valor total acumulado das notas substituídas.","format":"double"},"tempoMedioEmissaoNotasMilissegundos":{"type":"number","description":"Tempo médio de emissão das notas em milissegundos.","format":"double"},"tempoMedioEmissaoNotas":{"type":"string","description":"Representação textual do tempo médio de emissão.","nullable":true},"quantidadeConsultasCatalogoFiscal":{"type":"integer","description":"Quantidade de consultas realizadas ao catálogo fiscal.","format":"int32"},"quantidadeProdutosTributacaoAlterada":{"type":"integer","description":"Quantidade de produtos que tiveram a tributação alterada no período.","format":"int32"},"quantidadeConsultasCnpjAplicacao":{"type":"integer","description":"Quantidade de consultas de CNPJ realizadas via aplicação.","format":"int32"},"quantidadeConsultasCnpjEmissores":{"type":"integer","description":"Quantidade de consultas de CNPJ realizadas pelos emissores.","format":"int32"}},"additionalProperties":false,"description":"Dados de análise detalhada do parceiro."},"AplicativoBilhetagemViewModel":{"type":"object","properties":{"emissoresCredenciados":{"type":"integer","description":"Quantidade de emissores credenciados no aplicativo.","format":"int64"},"consultasCnpjRealizadas":{"type":"integer","description":"Quantidade de consultas de CNPJ realizadas pelo aplicativo.","format":"int64"}},"additionalProperties":false,"description":"Dados de bilhetagem do aplicativo."},"AplicativoContratoViewModel":{"type":"object","properties":{"recorrenciaAutomatica":{"type":"boolean","description":"Indica se a bilhetagem dos emissores será reiniciada de forma automática mensalmente."},"quantidadeEmissores":{"type":"integer","description":"Quantidade de emissores permitidos para o aplicativo.","format":"int64","nullable":true},"quantidadeConsultasCatalogo":{"type":"integer","description":"Quantidade de consultas no catálogo permitidas para cada emissor.","format":"int64","nullable":true},"quantidadeConsultasCnpj":{"type":"integer","description":"Quantidade de consultas de CNPJ´s permitidas para o aplicativo. (Deixar nulo para quantidade ilimitada)","format":"int64","nullable":true},"quantidadeConsultasCnpjEmissor":{"type":"integer","description":"Quantidade de consultas de CNPJ´s permitidas para cada emissor. (Deixar nulo para quantidade ilimitada)","format":"int64","nullable":true},"quantidadeNotasFiscais":{"type":"integer","description":"Quantidade de notas fiscais permitidas para emissão por emissor.","format":"int64","nullable":true}},"additionalProperties":false,"description":"Dados do contrato adquirido pelo aplicativo."},"AplicativoDetalheViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador interno do aplicativo.","format":"uuid"},"nome":{"type":"string","description":"Nome do aplicativo.","nullable":true},"responsavelTecnicoCnpj":{"type":"string","description":"CNPJ do responsável técnico.","nullable":true},"responsavelTecnicoNome":{"type":"string","description":"Nome do responsável técnico.","nullable":true},"responsavelTecnicoEmail":{"type":"string","description":"Email do responsável técnico.","nullable":true},"responsavelTecnicoFone":{"type":"string","description":"Telefone do responsável técnico.","nullable":true},"responsavelTecnicoCrtId":{"type":"string","description":"ID do responsável técnico exigido no estado do Paraná para emissão de NFe´s.","nullable":true},"responsavelTecnicoCrtHash":{"type":"string","description":"Hash do responsável técnico exigido no estado do Paraná para emissão de NFe´s.","nullable":true},"status":{"$ref":"#/components/schemas/StatusAplicativoModelEnum"},"clientId":{"type":"string","description":"ClientId usado na autenticação do aplicativo no sistema.","nullable":true},"secretId":{"type":"string","description":"Chave secreta usada na autenticação do aplicativo no sistema.","nullable":true},"apiGatewayAtivo":{"type":"boolean","description":"Indica se as credenciais de acesso estão ativas no API Gateway. (Se não tiver é necessário recriar as credenciais para ativar o acesso do aplicativo no API Gateway)"},"consoleId":{"type":"string","description":"Identificador do aplicativo no console.","nullable":true},"dataCriacao":{"type":"string","description":"Data de criação do aplicação no sistema.","format":"date-time"},"ultimaAlteracao":{"type":"string","description":"Data de última alteração dos dados da aplicação no sistema.","format":"date-time"},"contrato":{"$ref":"#/components/schemas/AplicativoContratoViewModel"},"bilhetagem":{"$ref":"#/components/schemas/AplicativoBilhetagemViewModel"}},"additionalProperties":false,"description":"Dados detalhados do aplicativo."},"AplicativoListagemViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador interno do aplicativo.","format":"uuid"},"nome":{"type":"string","description":"Nome do aplicativo.","nullable":true},"status":{"$ref":"#/components/schemas/StatusAplicativoModelEnum"}},"additionalProperties":false,"description":"Dados de listagem do aplicativo."},"AplicativoListagemViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AplicativoListagemViewModel"},"nullable":true}},"additionalProperties":false},"ArtigoSextoMunicipioNfseViewModel":{"type":"object","properties":{"habilitado":{"type":"boolean","description":"Indica se o Artigo Sexto está habilitado no município."},"historico":{"type":"array","items":{"$ref":"#/components/schemas/HistoricoVigenciaMunicipioNfseViewModel"},"description":"Histórico de vigências do Artigo Sexto.","nullable":true}},"additionalProperties":false,"description":"Configuração de retenção via Artigo Sexto no município."},"AtualizarContratoAplicativoInputModel":{"required":["recorrenciaAutomatica"],"type":"object","properties":{"recorrenciaAutomatica":{"type":"boolean","description":"Indica se a bilhetagem dos emissores será reiniciada de forma automática mensalmente."},"quantidadeEmissores":{"type":"integer","description":"Quantidade de emissores permitidos para o aplicativo. (Deixar nulo para quantidade ilimitada)","format":"int64","nullable":true},"quantidadeConsultasCatalogo":{"type":"integer","description":"Quantidade de consultas no catálogo permitidas para cada emissor. (Deixar nulo para quantidade ilimitada)","format":"int64","nullable":true},"quantidadeConsultasCnpj":{"type":"integer","description":"Quantidade de consultas de CNPJ´s permitidas para o aplicativo. (Deixar nulo para quantidade ilimitada)","format":"int64","nullable":true},"quantidadeConsultasCnpjEmissor":{"type":"integer","description":"Quantidade de consultas de CNPJ´s permitidas para cada emissor. (Deixar nulo para quantidade ilimitada)","format":"int64","nullable":true},"quantidadeNotasFiscais":{"type":"integer","description":"Quantidade de notas fiscais permitidas para emissão por emissor. (Deixar nulo para quantidade ilimitada)","format":"int64","nullable":true}},"additionalProperties":false,"description":"Dados para atualização do contrato do aplicativo."},"AtualizarDadosAplicativoInputModel":{"required":["consoleId","nome"],"type":"object","properties":{"nome":{"maxLength":60,"minLength":1,"type":"string","description":"Nome do aplicativo."},"consoleId":{"maxLength":255,"minLength":1,"type":"string","description":"Identificador do aplicativo no console."},"responsavelTecnicoCnpj":{"type":"string","description":"CNPJ do responsável técnico.","nullable":true},"responsavelTecnicoNome":{"type":"string","description":"Nome do responsável técnico.","nullable":true},"responsavelTecnicoEmail":{"type":"string","description":"Email do responsável técnico.","nullable":true},"responsavelTecnicoFone":{"type":"string","description":"Telefone do responsável técnico.","nullable":true},"responsavelTecnicoCrtId":{"type":"string","description":"ID do responsável técnico exigido no estado do Paraná para emissão de NFe´s.","nullable":true},"responsavelTecnicoCrtHash":{"type":"string","description":"Hash do responsável técnico exigido no estado do Paraná para emissão de NFe´s.","nullable":true}},"additionalProperties":false,"description":"Informações necessárias para atualizar os dados do aplicativo."},"AtualizarDadosEmissorInputModel":{"required":["endereco","nome","regimeTributario","tipoEstabelecimento","tipoIcmsSt"],"type":"object","properties":{"nome":{"maxLength":60,"minLength":3,"type":"string","description":"Nome ou Razão Social do emissor."},"nomeFantasia":{"type":"string","description":"Nome fantasia do emissor.","nullable":true},"regimeTributario":{"$ref":"#/components/schemas/RegimeTributarioModelEnum"},"aliquotaCreditoSimples":{"type":"number","description":"Alíquota do crédito de icms do simples nacional consedido em operações de revenda do regime Simples Nacional.","format":"double","nullable":true},"tipoIcmsSt":{"$ref":"#/components/schemas/TipoIcmsStEmissorModelEnum"},"tipoEstabelecimento":{"$ref":"#/components/schemas/TipoEstabelecimentoEmissorModelEnum"},"telefone":{"maxLength":14,"minLength":6,"type":"string","description":"Telefone de contato.","nullable":true},"inscricaoMunicipal":{"maxLength":15,"type":"string","description":"Inscrição municipal do emissor.","nullable":true},"cnae":{"maxLength":7,"type":"string","description":"Código CNAE principal.","nullable":true},"cnaeSecundario":{"maxLength":7,"type":"string","description":"Código CNAE secundário.","nullable":true},"endereco":{"$ref":"#/components/schemas/EnderecoEmissorInputModel"},"inscricoesEstaduais":{"type":"array","items":{"$ref":"#/components/schemas/InscricaoEstadualEmissorInputModel"},"description":"Lista de inscrições estaduais do emissor.","nullable":true}},"additionalProperties":false,"description":"Informações para atualizar os dados do emissor."},"AtualizarDadosParceiroInputModel":{"required":["consoleId","razaoSocial"],"type":"object","properties":{"razaoSocial":{"maxLength":60,"minLength":1,"type":"string","description":"Nome ou razão social do parceiro."},"consoleId":{"maxLength":255,"minLength":1,"type":"string","description":"Identificador do parceiro no console."}},"additionalProperties":false,"description":"Informações para atualizar dados do parceiro."},"AtualizarTokenInputModel":{"required":["token"],"type":"object","properties":{"token":{"minLength":1,"type":"string","description":"Token expirado."}},"additionalProperties":false,"description":"Dados para atualização do token expirado."},"BandeiraCartaoNotaFiscalModelEnum":{"enum":["Visa","Mastercard","AmericanExpress","Sorocred","DinersClub","Elo","Hipercard","Aura","Cabal","Outros"],"type":"string","description":"Informações de bandeiras de pagamento."},"BeneficioMunicipalNfseInputModel":{"type":"object","properties":{"numeroBeneficio":{"type":"string","description":"Identificador único do benefício municipal (nBM — 14 dígitos).\nFormação: 7 dígitos (código IBGE do município) + 2 dígitos (tipo de parametrização:\n01=legislação, 02=regimes especiais, 03=retenções, 04=outros benefícios) +\n5 dígitos (número sequencial do parâmetro no sistema).","nullable":true},"valorReducaoBaseCalculo":{"type":"number","description":"Valor monetário de redução da base de cálculo do ISSQN (vRedBCBM) em R$. Opcional. Mutuamente exclusivo com PercentualReducaoBaseCalculo.","format":"double","nullable":true},"percentualReducaoBaseCalculo":{"type":"number","description":"Percentual de redução da base de cálculo do ISSQN (pRedBCBM) em %. Opcional. Mutuamente exclusivo com ValorReducaoBaseCalculo.","format":"double","nullable":true}},"additionalProperties":false,"description":"Benefício Municipal parametrizado pelo município de incidência do ISSQN (BM)."},"BuscarHashDescricaoViewModel":{"type":"object","properties":{"hash":{"type":"string","description":"Hash do produto.","nullable":true},"descricao":{"type":"string","description":"Descrição do produto.","nullable":true},"ncm":{"type":"string","description":"Ncm do produto.","nullable":true},"cest":{"type":"string","description":"Cest do produto.","nullable":true},"grupo":{"type":"string","description":"Descrição do grupo do produto.","nullable":true}},"additionalProperties":false,"description":"Dados exibidos na listagem da busca de hash de produtos no catálogo fiscal."},"CadastroMunicipalCncNfseViewModel":{"type":"object","properties":{"origemDados":{"type":"string","description":"Origem dos dados do cadastro.","nullable":true},"codigoMunicipio":{"type":"integer","description":"Código IBGE do município.","format":"int32"},"tipoAmbiente":{"type":"integer","description":"Tipo de ambiente do cadastro.","format":"int32"},"id":{"type":"integer","description":"Identificador do cadastro.","format":"int32"},"codigoUF":{"type":"integer","description":"Código da UF.","format":"int32"},"infCad":{"$ref":"#/components/schemas/InfCadCncNfseViewModel"},"dataHoraCadastro":{"type":"string","description":"Data e hora do cadastro.","format":"date-time"},"dataHoraAtualizacao":{"type":"string","description":"Data e hora da última atualização do cadastro.","format":"date-time"},"opcaoSimplesNacional":{"type":"string","description":"Opção pelo Simples Nacional do contribuinte.","nullable":true}},"additionalProperties":false,"description":"Cadastro municipal do contribuinte no CNC."},"CancelarNotaFiscalInputModel":{"required":["justificativa"],"type":"object","properties":{"justificativa":{"maxLength":255,"minLength":15,"type":"string","description":"Justificativa do cancelamento. (Mínimo de 15 caracteres)"}},"additionalProperties":false,"description":"Dados para cancelamento de nota fiscal (NFe ou NFCe)."},"CertificadoDigitalViewModel":{"type":"object","properties":{"numeroSerie":{"type":"string","description":"Número de série do certificado.","nullable":true},"dataValidade":{"type":"string","description":"Data de validade do certificado.","format":"date","example":"2025-03-31"}},"additionalProperties":false,"description":"Informações do certificado digital."},"CobrancaNfceAutomaticaInputModel":{"type":"object","properties":{"numeroFatura":{"type":"string","description":"Número da fatura.","nullable":true},"valorBrutoFatura":{"type":"number","description":"Valor bruto da fatura.","format":"double","nullable":true},"valorDescontoFatura":{"type":"number","description":"Valor de desconto da fatura.","format":"double","nullable":true},"valorLiquidoFatura":{"type":"number","description":"Valor líquido da fatura.","format":"double","nullable":true},"duplicatas":{"type":"array","items":{"$ref":"#/components/schemas/DuplicataNfceAutomaticaInputModel"},"description":"Lista de duplicatas da nota fiscal.","nullable":true}},"additionalProperties":false,"description":"Dados da cobrança da NFe Automática."},"CobrancaNfeInputModel":{"required":["numeroFatura","valorBrutoFatura","valorDescontoFatura","valorLiquidoFatura"],"type":"object","properties":{"numeroFatura":{"maxLength":60,"minLength":1,"type":"string","description":"Número da fatura."},"valorBrutoFatura":{"minimum":0,"type":"number","description":"Valor bruto da fatura.","format":"double"},"valorDescontoFatura":{"minimum":0,"type":"number","description":"Valor de desconto da fatura.","format":"double"},"valorLiquidoFatura":{"minimum":0,"type":"number","description":"Valor líquido da fatura.","format":"double"},"duplicatas":{"type":"array","items":{"$ref":"#/components/schemas/DuplicataNfeInputModel"},"description":"Lista de duplicatas da nota fiscal.","nullable":true}},"additionalProperties":false,"description":"Dados da cobrança da NFe."},"ConsultaCepViewModel":{"type":"object","properties":{"cep":{"type":"string","description":"Código de Endereçamento Postal.","nullable":true},"logradouro":{"type":"string","description":"Nome da rua, avenida ou logradouro.","nullable":true},"complemento":{"type":"string","description":"Informações adicionais do endereço.","nullable":true},"bairro":{"type":"string","description":"Bairro onde se localiza o logradouro.","nullable":true},"localidade":{"type":"string","description":"Nome da cidade ou localidade.","nullable":true},"uf":{"type":"string","description":"Unidade Federativa (Estado).","nullable":true},"ibge":{"type":"string","description":"Código do município no IBGE.","nullable":true}},"additionalProperties":false,"description":"Dados detalhados da consulta de endereço via CEP."},"ConsultaCnpjCnaeViewModel":{"type":"object","properties":{"cnae":{"type":"string","description":"Código numérico identificador do CNAE.","nullable":true},"descricao":{"type":"string","description":"Descrição textual da atividade econômica.","nullable":true}},"additionalProperties":false,"description":"Representa uma Classificação Nacional de Atividade Econômica (CNAE)."},"ConsultaCnpjEnderecoViewModel":{"type":"object","properties":{"logradouro":{"type":"string","description":"Nome do logradouro (rua, avenida, praça, etc.).","nullable":true},"numero":{"type":"string","description":"Número do estabelecimento no logradouro.","nullable":true},"complemento":{"type":"string","description":"Informações adicionais para localização (Andar, Sala, Loja).","nullable":true},"bairro":{"type":"string","description":"Bairro ou distrito de localização.","nullable":true},"codigoMunicipio":{"type":"string","description":"Código IBGE identificador do município.","nullable":true},"municipio":{"type":"string","description":"Nome da cidade ou município.","nullable":true},"uf":{"type":"string","description":"Sigla da Unidade Federativa (Estado).","nullable":true},"cep":{"type":"string","description":"Código de Endereçamento Postal.","nullable":true}},"additionalProperties":false,"description":"Representa o endereço completo de uma entidade."},"ConsultaCnpjInscricaoViewModel":{"type":"object","properties":{"ie":{"type":"string","description":"Número identificador da Inscrição Estadual.","nullable":true},"uf":{"type":"string","description":"Unidade Federativa onde a inscrição está registrada.","nullable":true},"ativa":{"type":"boolean","description":"Indica se a inscrição está em situação regular/ativa."},"possuiRestricao":{"type":"boolean","description":"Indica se existe alguma pendência ou restrição fiscal."},"dataAtualizacaoStatus":{"type":"string","description":"Data do último processamento de status da inscrição.","format":"date","example":"2025-03-31"}},"additionalProperties":false,"description":"Representa os detalhes de uma inscrição estadual."},"ConsultaCnpjRegimeEnum":{"enum":["Mei","SimplesNacional","Normal"],"type":"string","description":"Regime do CNPJ na consulta."},"ConsultaCnpjSocioViewModel":{"type":"object","properties":{"qualificacao":{"type":"string","description":"Descrição do cargo ou qualificação do sócio na empresa.","nullable":true},"nome":{"type":"string","description":"Nome completo ou razão social do sócio.","nullable":true},"faixaEtaria":{"type":"string","description":"Faixa etária estimada do sócio.","nullable":true}},"additionalProperties":false,"description":"Representa um membro do quadro societário ou administrativo."},"ConsultaCnpjViewModel":{"type":"object","properties":{"cnpj":{"type":"string","description":"Número de inscrição no Cadastro Nacional da Pessoa Jurídica.","nullable":true},"razaoSocial":{"type":"string","description":"Nome empresarial ou razão social completa da entidade.","nullable":true},"nomeFantasia":{"type":"string","description":"Nome fantasia ou título do estabelecimento, se houver.","nullable":true},"naturezaJuridica":{"type":"string","description":"Descrição da natureza jurídica da organização.","nullable":true},"regime":{"$ref":"#/components/schemas/ConsultaCnpjRegimeEnum"},"dataAbertura":{"type":"string","description":"Data oficial de abertura da empresa.","format":"date","example":"2025-03-31"},"status":{"type":"string","description":"Situação cadastral atual (Ex: Ativa, Baixada, Suspensa).","nullable":true},"ultimaAlteracaoStatus":{"type":"string","description":"Data da última atualização da situação cadastral.","format":"date","nullable":true},"telefones":{"type":"array","items":{"type":"string"},"description":"Lista de números de telefone para contato.","nullable":true},"emails":{"type":"array","items":{"type":"string"},"description":"Lista de endereços de e-mail para contato.","nullable":true},"atividadePrincipal":{"$ref":"#/components/schemas/ConsultaCnpjCnaeViewModel"},"atividadesSecundarias":{"type":"array","items":{"$ref":"#/components/schemas/ConsultaCnpjCnaeViewModel"},"description":"Lista de atividades econômicas secundárias exercidas.","nullable":true},"endereco":{"$ref":"#/components/schemas/ConsultaCnpjEnderecoViewModel"},"socios":{"type":"array","items":{"$ref":"#/components/schemas/ConsultaCnpjSocioViewModel"},"description":"Quadro de sócios e administradores da empresa.","nullable":true},"inscricoesEstaduais":{"type":"array","items":{"$ref":"#/components/schemas/ConsultaCnpjInscricaoViewModel"},"description":"Lista de inscrições estaduais vinculadas ao CNPJ por UF.","nullable":true}},"additionalProperties":false,"description":"Representa os dados detalhados resultantes de uma consulta de CNPJ."},"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."},"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/SituacaoEspecialDestinatarioConsultaTributacaoModelEnum"},"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."},"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."},"ConsultaLoteFiltroInputModel":{"required":["filtro"],"type":"object","properties":{"tipoFiltro":{"$ref":"#/components/schemas/TipoFiltroConsultaProdutoModelEnum"},"filtro":{"maxLength":255,"minLength":1,"type":"string","description":"Dado de filtragem para consulta do produto (EAN ou descrição similar)."}},"additionalProperties":false,"description":"Filtro individual para consulta de tributação de produto em lote."},"ConsultaLotePerfilTributarioInputModel":{"type":"object","properties":{"codigoMunicipioDestino":{"type":"string","description":"Código do município do destino. (Necessário somente se o destinatário for de outro município)","nullable":true},"finalidade":{"$ref":"#/components/schemas/FinalidadeConsultaTributacaoModelEnum"},"situacaoEspecialDestinatario":{"$ref":"#/components/schemas/SituacaoEspecialDestinatarioConsultaTributacaoModelEnum"},"origemProduto":{"$ref":"#/components/schemas/OrigemProdutoConsultaTributacaoModelEnum"},"produtoFabricacaoPropria":{"type":"boolean","description":"Indica se o produto consultado é de fabricação própria. (Default: false)","nullable":true},"destinatarioSimplesNacional":{"type":"boolean","description":"Indica se o destinatário é optante pelo Simples Nacional. (Default: false)","nullable":true},"destinatarioSubstitutoTributario":{"type":"boolean","description":"Indica se o destinatário é substituto tributário. (Default: false)","nullable":true},"mercadoriaProduzidaZFM":{"type":"boolean","description":"Indica se a mercadoria é produzida na Zona Franca de Manaus. (Default: false)","nullable":true}},"additionalProperties":false,"description":"Perfil tributário opcional para a consulta de tributação em lote.\nSe não informado, serão utilizados os valores padrão (venda para consumidor final presencial)."},"ConsultarBeneficioNfseViewModel":{"type":"object","properties":{"codigoBeneficio":{"type":"string","description":"Código do benefício fiscal.","nullable":true},"descricao":{"type":"string","description":"Descrição do benefício fiscal.","nullable":true},"dataInicioVigencia":{"type":"string","description":"Data de início da vigência do benefício.","format":"date-time"},"dataFimVigencia":{"type":"string","description":"Data de fim da vigência do benefício, se houver.","format":"date-time","nullable":true},"tipoBeneficio":{"type":"integer","description":"Tipo do benefício fiscal.","format":"int32"},"tipoReducaoBC":{"type":"integer","description":"Tipo de redução da base de cálculo, se aplicável.","format":"int32","nullable":true},"reducaoPercentualBC":{"type":"number","description":"Percentual de redução da base de cálculo, se aplicável.","format":"double","nullable":true},"aliquotaDiferenciada":{"type":"number","description":"Alíquota diferenciada aplicada pelo benefício, se houver.","format":"double","nullable":true},"restritoAoMunicipio":{"type":"boolean","description":"Indica se o benefício é restrito ao município.","nullable":true},"servicos":{"type":"array","items":{"$ref":"#/components/schemas/ServicoVigenciaBeneficioNfseViewModel"},"description":"Lista de serviços contemplados pelo benefício e seus períodos de vigência.","nullable":true},"contribuintes":{"type":"array","items":{"type":"string"},"description":"Lista de contribuintes contemplados pelo benefício, se houver restrição.","nullable":true}},"additionalProperties":false,"description":"Benefício fiscal vigente no município para o código informado."},"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."},"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."},"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."},"ConsultarProdutoInputModel":{"required":["filtro","tipoFiltro"],"type":"object","properties":{"tipoFiltro":{"$ref":"#/components/schemas/TipoFiltroConsultaProdutoModelEnum"},"filtro":{"minLength":1,"type":"string","description":"Dado de filtragem para consulta do produto (EAN ou descrição similar)."},"codigoMunicipioDestino":{"type":"string","description":"Código do município do destino. (Necessário somente se o destinatário for de outro município)","nullable":true},"finalidade":{"$ref":"#/components/schemas/FinalidadeConsultaTributacaoModelEnum"},"situacaoEspecialDestinatario":{"$ref":"#/components/schemas/SituacaoEspecialDestinatarioConsultaTributacaoModelEnum"},"origemProduto":{"$ref":"#/components/schemas/OrigemProdutoConsultaTributacaoModelEnum"},"produtoFabricacaoPropria":{"type":"boolean","description":"Indica se o produto consultado é de fabricação própria ou não. (Default false)","nullable":true},"destinatarioSimplesNacional":{"type":"boolean","description":"Indica se o destinatário é optante pelo Simples Nacional. (Default false)","nullable":true},"destinatarioSubstitutoTributario":{"type":"boolean","description":"Indica se o destinatário é substituto tributário. (Default false)","nullable":true},"mercadoriaProduzidaZFM":{"type":"boolean","description":"Indica se a mercadoria é produzida na Zona Franca de Manaus. (Default false)","nullable":true}},"additionalProperties":false,"description":"Dados para consultar a tributação do produto."},"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."},"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."},"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."},"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."},"ConsultarStatusSefazViewModel":{"type":"object","properties":{"sucesso":{"type":"boolean","description":"Indica se a consulta foi bem sucedida."},"tipoAmbiente":{"$ref":"#/components/schemas/TipoAmbienteSefazModelEnum"},"uf":{"$ref":"#/components/schemas/UfNotaFiscalModelEnum"},"cStat":{"type":"integer","description":"Código de status da SEFAZ.","format":"int32"},"xMotivo":{"type":"string","description":"Motivo do status da SEFAZ.","nullable":true}},"additionalProperties":false,"description":"Retorno da consulta de status da SEFAZ."},"CsosnNfceModelEnum":{"enum":["102","103","300","400","500"],"type":"string","description":"Lista de CSOSN da NFCe."},"CsosnNfeModelEnum":{"enum":["101","102","103","201","202","203","300","400","500","900"],"type":"string","description":"Lista de CSOSN da NFe."},"CstIbsCbsNfceModelEnum":{"enum":["000","200","400","410","620"],"type":"string","description":"Enumerador para o Código de Situação Tributária (CST) do IBS e CBS para NFCe."},"CstIbsCbsNfeModelEnum":{"enum":["000","200","400","410","510","515","550","620","800","810","811","820"],"type":"string","description":"Enumerador para o Código de Situação Tributária (CST) do IBS e CBS para NFe."},"CstIbsCbsNfseModelEnum":{"enum":["Cst000","Cst200","Cst400","Cst410","Cst510","Cst515","Cst550","Cst620","Cst800","Cst810","Cst811","Cst820"],"type":"string","description":"Código de Situação Tributária (CST) do IBS/CBS na NFS-e."},"CstIcmsNfceModelEnum":{"enum":["00","20","40","41","60"],"type":"string","description":"CST de ICMS para NFCe."},"CstIcmsNfeModelEnum":{"enum":["00","02","10","15","20","30","40","41","50","51","53","60","61","70","90"],"type":"string","description":"CST de ICMS para NFe."},"CstIpiNfeModelEnum":{"enum":["00","01","02","03","04","05","49","50","51","52","53","54","55","99"],"type":"string","description":"CST de IPI."},"CstPisCofinsNfceModelEnum":{"enum":["01","02","03","04","05","06","07",8,9,"49","99"],"type":"string","description":"CST de PIS/COFINS para NFCe."},"CstPisCofinsNfeModelEnum":{"enum":["01","02","03","04","05","06","07",8,9,"49","50","51","52","53","54","55","56","60","61","62","63","64","65","66","67","70","71","72","73","74","75","98","99"],"type":"string","description":"CST de PIS/COFINS para NFe."},"CstPisCofinsNfseModoPrestadorModelEnum":{"enum":["00","01","02","03","04","05","06","07",8,9,"49","99"],"type":"string","description":"CST de PIS/COFINS para NFS-e no modo prestador — CSTs de saída."},"CstPisCofinsNfseModoTomadorModelEnum":{"enum":["00","50","51","52","53","54","55","56","60","61","62","63","64","65","66","67","70","71","72","73","74","75","98","99"],"type":"string","description":"CST de PIS/COFINS para NFS-e no modo tomador — CSTs de entrada/crédito."},"DanfeEmissaoNotasModelEnum":{"enum":["Html","Pdf","Nenhum"],"type":"string","description":"Tipo de arquivo DANFE gerado na emissão."},"DefinirParametrosNfceInputModel":{"required":["enviarEmailNfe"],"type":"object","properties":{"sequenciaAutomatica":{"type":"boolean","description":"Indica se a sequência da numeração será automática ou manual."},"serie":{"type":"string","description":"Série da NFC-e. (Apenas se a sequência for automática)","nullable":true},"numeroUltimaNfce":{"type":"integer","description":"Número da última NFC-e emitida. (Apenas se a sequência for automática)","format":"int64","nullable":true},"enviarEmailNfe":{"type":"boolean","description":"Enviar email com a NFC-e para o cliente de forma automatica."},"tipoDanfe":{"$ref":"#/components/schemas/ParametroNfceTipoDanfeModelEnum"},"diasInutilizacaoAutomatica":{"maximum":30,"minimum":1,"type":"integer","description":"Dias \"A partir de\" para inutilização automática de notas rejeitadas ou pendentes de emissão.","format":"int32"},"contingenciaTimeOut":{"type":"boolean","description":"Indica se o timeout de comunicação com a SEFAZ deve acionar o modo de contingência automaticamente. Quando não informado, assume true.","nullable":true}},"additionalProperties":false,"description":"Dados para definição dos parâmetros de NFC-e."},"DefinirParametrosNfeInputModel":{"required":["enviarEmailNfe"],"type":"object","properties":{"sequenciaAutomatica":{"type":"boolean","description":"Indica se a sequência da numeração será automática ou manual."},"serie":{"type":"string","description":"Série da NF-e. (Apenas se a sequência for automática)","nullable":true},"numeroUltimaNfe":{"type":"integer","description":"Número da última NF-e emitida. (Apenas se a sequência for automática)","format":"int64","nullable":true},"enviarEmailNfe":{"type":"boolean","description":"Enviar email com a NF-e para o cliente de forma automatica."},"tipoDanfe":{"$ref":"#/components/schemas/ParametroNfeTipoDanfeModelEnum"},"diasInutilizacaoAutomatica":{"maximum":30,"minimum":1,"type":"integer","description":"Dias \"A partir de\" para inutilização automática de notas rejeitadas ou pendentes de emissão.","format":"int32"},"contingenciaTimeOut":{"type":"boolean","description":"Indica se o timeout de comunicação com a SEFAZ deve acionar o modo de contingência automaticamente. Quando não informado, assume true.","nullable":true}},"additionalProperties":false,"description":"Dados para definição dos parâmetros de NF-e."},"DefinirParametrosNfseInputModel":{"required":["enviarEmailNfse"],"type":"object","properties":{"sequenciaAutomatica":{"type":"boolean","description":"Indica se a sequência da numeração do DPS será automática ou manual."},"serie":{"type":"string","description":"Série do DPS. (Apenas se a sequência for automática)","nullable":true},"numeroUltimoDps":{"type":"integer","description":"Número do último DPS emitido. (Apenas se a sequência for automática)","format":"int64","nullable":true},"enviarEmailNfse":{"type":"boolean","description":"Enviar e-mail com a NFS-e para o cliente de forma automática."},"opcaoSimpleNacional":{"$ref":"#/components/schemas/OpcaoSimpleNacionalNfseModelEnum"},"regimeEspecialTributacao":{"$ref":"#/components/schemas/RegimeEspecialTributacaoNfseModelEnum"},"regimeApuracaoSimplesNacional":{"$ref":"#/components/schemas/RegimeApuracaoSimplesNacionalNfseModelEnum"},"diasInutilizacaoAutomatica":{"maximum":30,"minimum":1,"type":"integer","description":"Quantidade de dias para inutilização automática de numerações não utilizadas.","format":"int32"},"aliquotaEfetivaSn":{"type":"number","description":"Alíquota efetiva do Simples Nacional (pTotTribSN) em %.\nObrigatório (aceitando 0) para emissores do Simples Nacional e MEI.\nNão deve ser informado para emissores de Lucro Real e Lucro Presumido.","format":"double","nullable":true}},"additionalProperties":false,"description":"Dados para definição dos parâmetros de NFS-e."},"DestinatarioIbsCbsNfseInputModel":{"type":"object","properties":{"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoDestinatarioIbsCbsNfseModelEnum"},"documento":{"type":"string","description":"Documento de identificação do destinatário (CNPJ, CPF, NIF ou código cNaoNIF como string).","nullable":true},"nome":{"type":"string","description":"Nome / razão social do destinatário. Opcional.","nullable":true},"telefone":{"type":"string","description":"Telefone do destinatário. Opcional.","nullable":true},"email":{"type":"string","description":"E-mail do destinatário. Opcional.","nullable":true},"endereco":{"$ref":"#/components/schemas/EnderecoDestinatarioIbsCbsNfseInputModel"}},"additionalProperties":false,"description":"Destinatário para fins do IBS/CBS na NFS-e (dest). Obrigatório quando IndDest for Outro."},"DestinatarioNfceAutomaticaInputModel":{"required":["documento"],"type":"object","properties":{"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documento":{"minLength":1,"type":"string","description":"Documento do destinatário."},"nome":{"type":"string","description":"Nome do destinatário.","nullable":true},"endereco":{"$ref":"#/components/schemas/EnderecoDestinatarioNfceAutomaticaInputModel"},"telefone":{"type":"string","description":"Telefone do destinatário.","nullable":true},"email":{"type":"string","description":"Email do destinatário.","nullable":true}},"additionalProperties":false,"description":"Dados do destinatário da NFe Automática."},"DestinatarioNfceInputModel":{"required":["documento"],"type":"object","properties":{"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documento":{"minLength":1,"type":"string","description":"Documento do destinatário."},"nome":{"type":"string","description":"Nome do destinatário.","nullable":true},"endereco":{"$ref":"#/components/schemas/EnderecoDestinatarioNfceInputModel"},"telefone":{"type":"string","description":"Telefone do destinatário.","nullable":true},"email":{"type":"string","description":"Email do destinatário.","nullable":true}},"additionalProperties":false,"description":"Dados do destinatário da NFe ."},"DestinatarioNfceSimplificadaInputModel":{"required":["documento"],"type":"object","properties":{"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documento":{"minLength":1,"type":"string","description":"Documento do destinatário."},"nome":{"type":"string","description":"Nome do destinatário.","nullable":true},"endereco":{"$ref":"#/components/schemas/EnderecoDestNfceSimplificadaInputModel"},"telefone":{"type":"string","description":"Telefone do destinatário.","nullable":true},"email":{"type":"string","description":"Email do destinatário.","nullable":true}},"additionalProperties":false,"description":"Dados do destinatário da NFe ."},"DestinatarioNfeAutomaticaInputModel":{"required":["documento","endereco","nome"],"type":"object","properties":{"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documento":{"minLength":1,"type":"string","description":"Documento do destinatário."},"nome":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do destinatário."},"endereco":{"$ref":"#/components/schemas/EnderecoDestinatarioNfeAutomaticaInputModel"},"telefone":{"type":"string","description":"Telefone do destinatário.","nullable":true},"indicadorInscricao":{"$ref":"#/components/schemas/IndicadorInscricaoDestinatarioNotaFiscalModelEnum"},"inscricaoEstadual":{"type":"string","description":"Inscrição estadual do destinatário.","nullable":true},"inscricaoSuframa":{"type":"string","description":"Inscrição SUFRAMA.","nullable":true},"inscricaoMunicipal":{"type":"string","description":"Inscrição municipal.","nullable":true},"email":{"type":"string","description":"Email do destinatário.","nullable":true},"situacaoEspecial":{"$ref":"#/components/schemas/SituacaoEspecialDestinatarioModelEnum"}},"additionalProperties":false,"description":"Dados do destinatário da NFe Automática."},"DestinatarioNfeInputModel":{"required":["documento","endereco","nome"],"type":"object","properties":{"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documento":{"minLength":1,"type":"string","description":"Documento do destinatário."},"nome":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do destinatário."},"endereco":{"$ref":"#/components/schemas/EnderecoDestinatarioNfeInputModel"},"telefone":{"type":"string","description":"Telefone do destinatário.","nullable":true},"indicadorInscricao":{"$ref":"#/components/schemas/IndicadorInscricaoDestinatarioNotaFiscalModelEnum"},"inscricaoEstadual":{"type":"string","description":"Inscrição estadual do destinatário.","nullable":true},"inscricaoSuframa":{"type":"string","description":"Inscrição SUFRAMA.","nullable":true},"inscricaoMunicipal":{"type":"string","description":"Inscrição municipal.","nullable":true},"email":{"type":"string","description":"Email do destinatário.","nullable":true}},"additionalProperties":false,"description":"Dados do destinatário da NFe."},"DestinatarioNfeSimplificadaInputModel":{"required":["documento","endereco","nome"],"type":"object","properties":{"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documento":{"minLength":1,"type":"string","description":"Documento do destinatário."},"nome":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do destinatário."},"endereco":{"$ref":"#/components/schemas/EnderecoDestNfeSimplificadaInputModel"},"telefone":{"type":"string","description":"Telefone do destinatário.","nullable":true},"indicadorInscricao":{"$ref":"#/components/schemas/IndicadorInscricaoDestinatarioNotaFiscalModelEnum"},"inscricaoEstadual":{"type":"string","description":"Inscrição estadual do destinatário.","nullable":true},"inscricaoSuframa":{"type":"string","description":"Inscrição SUFRAMA.","nullable":true},"inscricaoMunicipal":{"type":"string","description":"Inscrição municipal.","nullable":true},"email":{"type":"string","description":"Email do destinatário.","nullable":true}},"additionalProperties":false,"description":"Dados do destinatário da NFe."},"DetalheConsultaCatalogoFiscalViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador interno da consulta no histórico.","format":"uuid"},"fonte":{"type":"string","description":"Fonte do dado consultado.","nullable":true},"tipoConsulta":{"$ref":"#/components/schemas/TipoConsultaCatalogoFiscalModelEnum"},"filtro":{"type":"string","description":"Valor do filtro utilizado.","nullable":true},"dataConsulta":{"type":"string","description":"Data da consulta.","format":"date-time"},"statusConsulta":{"$ref":"#/components/schemas/StatusHistoricoConsultaCatalogoFiscalModelEnum"},"jsonEnvio":{"type":"string","description":"JSON de envio para o Catálogo Fiscal.","nullable":true},"jsonRetorno":{"type":"string","description":"JSON de retorno recebido do Catálogo Fiscal.","nullable":true},"mensagemFalha":{"type":"string","description":"Mensagem detalhada em caso de falha na consulta.","nullable":true}},"additionalProperties":false,"description":"Dados do detalhe das consultas realizadas internamente no catálogo fiscal."},"DetalheConsultasProdutoVisaoAplicacaoViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador interno da consulta no histórico.","format":"uuid"},"modoConsulta":{"$ref":"#/components/schemas/ModoConsultaProdutoModelEnum"},"tipoFiltro":{"$ref":"#/components/schemas/TipoFiltroConsultaProdutoModelEnum"},"filtro":{"type":"string","description":"Valor do filtro utilizado.","nullable":true},"dataConsulta":{"type":"string","description":"Data da consulta.","format":"date-time"},"parametrosConsulta":{"type":"string","description":"Parâmetros detalhados da consulta.","nullable":true},"statusConsulta":{"$ref":"#/components/schemas/StatusConsultaProdutoModelEnum"},"hash":{"type":"string","description":"Hash do resultado da consulta.","nullable":true},"jsonResultadoInformado":{"type":"string","description":"JSON contendo o resultado informado.","nullable":true},"bilhetado":{"type":"boolean","description":"Indica se a consulta foi bilhetada."}},"additionalProperties":false,"description":"Dados detalhados da consulta realizada pelo emissor exibidos pela aplicação."},"DetalheConsultasProdutoVisaoCrmViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador interno da consulta no histórico.","format":"uuid"},"modoConsulta":{"$ref":"#/components/schemas/ModoConsultaProdutoModelEnum"},"tipoFiltro":{"$ref":"#/components/schemas/TipoFiltroConsultaProdutoModelEnum"},"filtro":{"type":"string","description":"Valor do filtro utilizado.","nullable":true},"dataConsulta":{"type":"string","description":"Data da consulta.","format":"date-time"},"parametrosConsulta":{"type":"string","description":"Parâmetros detalhados da consulta.","nullable":true},"statusConsulta":{"$ref":"#/components/schemas/StatusConsultaProdutoModelEnum"},"fonteInformacao":{"$ref":"#/components/schemas/FonteInformacaoConsultaProdutoModelEnum"},"jsonCatalogoFiscalEnvio":{"type":"string","description":"JSON de envio para o Catálogo Fiscal.","nullable":true},"jsonCatalogoFiscalRetorno":{"type":"string","description":"JSON de retorno recebido do Catálogo Fiscal.","nullable":true},"hash":{"type":"string","description":"Hash do resultado da consulta.","nullable":true},"jsonResultadoInformado":{"type":"string","description":"JSON contendo o resultado informado.","nullable":true},"mensagemFalha":{"type":"string","description":"Mensagem detalhada em caso de falha na consulta.","nullable":true},"bilhetado":{"type":"boolean","description":"Indica se a consulta foi bilhetada."}},"additionalProperties":false,"description":"Dados detalhados da consulta realizada pelo emissor exibidos pela console CRM."},"DownloadXmlViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador da solicitação do download.","format":"uuid"},"status":{"$ref":"#/components/schemas/StatusDownloadXmlModelEnum"},"dataSolicitacao":{"type":"string","description":"Data de solicitação do download.","format":"date-time"},"inscricaoEstadual":{"type":"string","description":"Filtrar pela inscrição estadual do emissor da nota fiscal.","nullable":true},"busca":{"type":"string","description":"Filtro de busca genérica (dados do destinatário, transportador, chave de acesso, intermediador ou número do documento).","nullable":true},"dataInicio":{"type":"string","description":"Filtrar pela data de emissão da nota \"a partir de\".","format":"date","nullable":true},"dataFim":{"type":"string","description":"Filtrar pela data de emissão da nota \"até\".","format":"date","nullable":true},"modelosDocumento":{"type":"array","items":{"$ref":"#/components/schemas/ModeloDocumentoDownloadXmlModelEnum"},"description":"Filtrar pelo modelo do arquivo XML.","nullable":true},"mensagemFalha":{"type":"string","description":"Mensagem em caso de falha.","nullable":true},"dataHoraProcessamento":{"type":"string","description":"Data e hora do processamento.","format":"date-time","nullable":true},"statusCallback":{"$ref":"#/components/schemas/StatusCallbackDownloadXmlModelEnum"},"urlCallback":{"type":"string","description":"URL de callback do solicitante.","nullable":true},"urlDownload":{"type":"string","description":"Url com link de download dos arquivos XMLs.","nullable":true}},"additionalProperties":false,"description":"Dados da solicitação de download do XML."},"DuplicataNfceAutomaticaInputModel":{"required":["dataVencimento","numeroParcela"],"type":"object","properties":{"numeroParcela":{"maxLength":60,"minLength":1,"type":"string","description":"Número da parcela."},"dataVencimento":{"minLength":1,"type":"string","description":"Data de vencimento.","format":"date-time"},"valorParcela":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Valor da parcela.","format":"double"}},"additionalProperties":false,"description":"Dados da duplicata da NFe Automática."},"DuplicataNfeInputModel":{"required":["dataVencimento","numeroParcela","valorParcela"],"type":"object","properties":{"numeroParcela":{"maxLength":60,"minLength":1,"type":"string","description":"Número da parcela."},"dataVencimento":{"minLength":1,"type":"string","description":"Data de vencimento.","format":"date-time"},"valorParcela":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Valor da parcela.","format":"double"}},"additionalProperties":false,"description":"Dados da duplicata da NFe."},"EmissaoNotaFiscalServicoViewModel":{"type":"object","properties":{"sucesso":{"type":"boolean","description":"Indica se a NFS-e foi autorizada pelo ADN."},"codigoStatus":{"type":"integer","description":"Código de status retornado pelo ADN.","format":"int32"},"mensagemSefaz":{"type":"string","description":"Mensagem de retorno do ADN.","nullable":true},"serie":{"type":"string","description":"Série da DPS emitida.","nullable":true},"numeroDps":{"type":"integer","description":"Número sequencial da DPS.","format":"int64"},"numeroNfse":{"type":"integer","description":"Número sequencial da NFS-e gerado pelo ADN. Disponível após autorização.","format":"int64","nullable":true},"chaveNfse":{"type":"string","description":"Chave da NFS-e. Disponível após autorização.","nullable":true},"alertas":{"type":"array","items":{"$ref":"#/components/schemas/MensagemNfseViewModel"},"description":"Alertas retornados pelo ADN.","nullable":true},"erros":{"type":"array","items":{"$ref":"#/components/schemas/MensagemNfseViewModel"},"description":"Erros retornados pelo ADN.","nullable":true}},"additionalProperties":false,"description":"Dados de retorno da emissão de Nota Fiscal de Serviço Eletrônica (NFS-e)."},"EmissaoNotaFiscalViewModel":{"type":"object","properties":{"sucesso":{"type":"boolean","description":"Indica se a nota foi autorizada pela sefaz ou não."},"codigoStatus":{"type":"integer","description":"Código de status de envio para a sefaz.","format":"int32"},"mensagemSefaz":{"type":"string","description":"Mensagem de retorno da sefaz.","nullable":true},"serie":{"type":"string","description":"Série da nota fiscal.","nullable":true},"numeroDocumento":{"type":"integer","description":"Número do documento.","format":"int64"},"chaveAcesso":{"type":"string","description":"Chave de acesso da nota fiscal.","nullable":true},"numeroProtocolo":{"type":"string","description":"Número do protocolo de autorização da nota fiscal.","nullable":true},"linkQrcode":{"type":"string","description":"Link de acesso a nota fiscal (Apenas para NFC-e).","nullable":true},"danfe":{"type":"string","description":"Arquivo DANFE solicitado (HTML ou PDF Base64).","nullable":true},"emitidaEmContingencia":{"type":"boolean","description":"Indica se a nota foi emitida em modo contingência."}},"additionalProperties":false,"description":"Dados de retorno da emissão de nota fiscal."},"EmissorBilhetagemContratoViewModel":{"type":"object","properties":{"quantidadeConsultasCatalogoProduto":{"type":"integer","description":"Quantidade de consultas contratadas para catálogo de produtos.","format":"int64","nullable":true},"quantidadeConsultasCnpjEmissor":{"type":"integer","description":"Quantidade de consultas contratadas para de CNPJ.","format":"int64","nullable":true},"quantidadeNotasFiscais":{"type":"integer","description":"Quantidade de emissões de notas fiscais contratada.","format":"int64","nullable":true}},"additionalProperties":false,"description":"Dados da bilhetagem contratados."},"EmissorBilhetagemViewModel":{"type":"object","properties":{"contrato":{"$ref":"#/components/schemas/EmissorBilhetagemContratoViewModel"},"dataInicioContagem":{"type":"string","description":"Data de início da contagem.","format":"date","example":"2025-03-31"},"consultasProdutoBilhetadas":{"type":"integer","description":"Quantidade de consultas de produtos bilhetadas após início da contagem.","format":"int64"},"consultasCnpjBilhetadas":{"type":"integer","description":"Quantidade de consultas de CNPJ´s bilhetadas após início da contagem.","format":"int64"},"notasFiscaisBilhetadas":{"type":"integer","description":"Quantidade de notas fiscais bilhetadas após início da contagem.","format":"int64"}},"additionalProperties":false,"description":"Dados da bilhetagem do emissor."},"EmissorDetalheViewModel":{"type":"object","properties":{"documento":{"type":"string","description":"Documento (CPF/CNPJ) do emissor.","nullable":true},"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoEmissorModelEnum"},"nome":{"type":"string","description":"Nome ou Razão Social do emissor.","nullable":true},"nomeFantasia":{"type":"string","description":"Nome fantasia do emissor.","nullable":true},"regimeTributario":{"$ref":"#/components/schemas/RegimeTributarioModelEnum"},"aliquotaCreditoSimples":{"type":"number","description":"Alíquota do crédito de icms do simples nacional consedido em operações de revenda do regime Simples Nacional.","format":"double","nullable":true},"tipoIcmsSt":{"$ref":"#/components/schemas/TipoIcmsStEmissorModelEnum"},"tipoEstabelecimento":{"$ref":"#/components/schemas/TipoEstabelecimentoEmissorModelEnum"},"telefone":{"type":"string","description":"Telefone de contato.","nullable":true},"inscricaoMunicipal":{"type":"string","description":"Inscrição municipal do emissor.","nullable":true},"cnae":{"type":"string","description":"Código CNAE principal.","nullable":true},"cnaeSecundario":{"type":"string","description":"Código CNAE secundário.","nullable":true},"endereco":{"$ref":"#/components/schemas/EnderecoEmissorViewModel"},"inscricoesEstaduais":{"type":"array","items":{"$ref":"#/components/schemas/InscricaoEstadualEmissorViewModel"},"description":"Lista de inscrições estaduais do emissor.","nullable":true},"certificadoDigital":{"$ref":"#/components/schemas/CertificadoDigitalViewModel"},"parametrosNfe":{"$ref":"#/components/schemas/ParametrosNfeViewModel"},"parametrosNfce":{"$ref":"#/components/schemas/ParametrosNfceViewModel"},"parametrosNfse":{"$ref":"#/components/schemas/ParametrosNfseViewModel"},"dataCriacao":{"type":"string","description":"Data de criação do emissor no sistema.","format":"date-time"},"ultimaAlteracao":{"type":"string","description":"Data de última alteração dos dados do emissor no sistema.","format":"date-time"},"status":{"$ref":"#/components/schemas/StatusEmissorModelEnum"},"bilhetagem":{"$ref":"#/components/schemas/EmissorBilhetagemViewModel"}},"additionalProperties":false,"description":"Dados detalhados do emissor."},"EmissorListagemViewModel":{"type":"object","properties":{"documento":{"type":"string","description":"Documento (CPF/CNPJ) do emissor.","nullable":true},"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoEmissorModelEnum"},"nome":{"type":"string","description":"Nome ou Razão Social do emissor.","nullable":true},"nomeFantasia":{"type":"string","description":"Nome fantasia do emissor.","nullable":true},"regimeTributario":{"$ref":"#/components/schemas/RegimeTributarioModelEnum"},"dataCriacao":{"type":"string","description":"Data de criação do emissor no sistema.","format":"date-time"},"ultimaAlteracao":{"type":"string","description":"Data de última alteração dos dados do emissor no sistema.","format":"date-time"},"status":{"$ref":"#/components/schemas/StatusEmissorModelEnum"}},"additionalProperties":false,"description":"Dados do emissor exibidos na listagem."},"EmissorListagemViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/EmissorListagemViewModel"},"nullable":true}},"additionalProperties":false},"EmitirCartaDeCorrecaoInputModel":{"required":["descricaoCorrecao"],"type":"object","properties":{"descricaoCorrecao":{"maxLength":1000,"minLength":15,"type":"string","description":"Descrição da correção. (Mínimo de 15 e máximo de 1000 caracteres)"}},"additionalProperties":false,"description":"Dados para emissão de carta de correção de nota fiscal (NF-e)."},"EmitirNfeDevolucaoDestinatarioInputModel":{"required":["documento","endereco","nome"],"type":"object","properties":{"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documento":{"minLength":1,"type":"string","description":"Documento do destinatário."},"nome":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do destinatário."},"endereco":{"$ref":"#/components/schemas/EmitirNfeDevolucaoEnderecoInputModel"},"telefone":{"type":"string","description":"Telefone do destinatário.","nullable":true},"inscricaoEstadual":{"type":"string","description":"Inscrição estadual do destinatário.","nullable":true},"inscricaoSuframa":{"type":"string","description":"Inscrição SUFRAMA.","nullable":true},"inscricaoMunicipal":{"type":"string","description":"Inscrição municipal.","nullable":true},"email":{"type":"string","description":"Email do destinatário.","nullable":true}},"additionalProperties":false,"description":"Dados do destinatário em nota fiscal de devolução."},"EmitirNfeDevolucaoDetalheItemInputModel":{"required":["item","quantidadeDevolvida"],"type":"object","properties":{"item":{"minimum":0,"exclusiveMinimum":true,"type":"integer","description":"Número da sequência do item na nota.","format":"int32"},"quantidadeDevolvida":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Quantidade de itens a serem devolvidos.","format":"double"},"rastros":{"type":"array","items":{"$ref":"#/components/schemas/EmitirNfeDevolucaoDetalheItemRastroInputModel"},"description":"Informações de rastro do item.","nullable":true}},"additionalProperties":false,"description":"Dados de devolução do item da nota."},"EmitirNfeDevolucaoDetalheItemRastroInputModel":{"required":["dataFabricacao","dataValidade","numeroLote"],"type":"object","properties":{"numeroLote":{"maxLength":20,"minLength":1,"type":"string","description":"Número do lote do produto."},"quantidadeLote":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Quantidade do lote.","format":"double"},"dataFabricacao":{"minLength":1,"type":"string","description":"Data de fabricação do lote.","format":"date-time"},"dataValidade":{"minLength":1,"type":"string","description":"Data de validade do lote.","format":"date-time"}},"additionalProperties":false,"description":"Dados de rastreabilidade do item da NFe ."},"EmitirNfeDevolucaoEnderecoInputModel":{"required":["bairro","cep","codigoMunicipio","logradouro","nomeMunicipio","numero"],"type":"object","properties":{"logradouro":{"maxLength":60,"minLength":2,"type":"string","description":"Logradouro."},"numero":{"maxLength":60,"minLength":1,"type":"string","description":"Número."},"complemento":{"type":"string","description":"Complemento.","nullable":true},"bairro":{"maxLength":60,"minLength":1,"type":"string","description":"Bairro."},"codigoMunicipio":{"maxLength":7,"minLength":7,"type":"string","description":"Código do município."},"nomeMunicipio":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do município."},"uf":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"cep":{"minLength":1,"type":"string","description":"CEP."},"codigoPais":{"type":"string","description":"Código do país.","nullable":true},"pais":{"type":"string","description":"Nome do país.","nullable":true}},"additionalProperties":false,"description":"Dados do endereço do destinatário nas notas de devolução."},"EmitirNfeDevolucaoInputModel":{"required":["identificadorDocumentoFiscalDevolvido"],"type":"object","properties":{"codigoErp":{"type":"string","description":"Identificador da operação fiscal no ERP.","nullable":true},"serie":{"type":"string","description":"Série do documento fiscal (Informar somente se estiver configurado para geração numérica manual).","nullable":true},"numeroDocumento":{"type":"integer","description":"Numero do documento fiscal (Informar somente se estiver configurado para geração numérica manual).","format":"int64","nullable":true},"modeloDocumentoFiscalDevolvido":{"$ref":"#/components/schemas/ModeloNotaFiscalModelEnum"},"identificadorDocumentoFiscalDevolvido":{"minLength":1,"type":"string","description":"Identificador da nota fiscal a ser devolvida - Chave de acesso ou Código ERP."},"tipoEmissao":{"$ref":"#/components/schemas/TipoEmissaoNfeModelEnum"},"destinatario":{"$ref":"#/components/schemas/EmitirNfeDevolucaoDestinatarioInputModel"},"autXml":{"type":"array","items":{"$ref":"#/components/schemas/NfeAuxXmlInputModel"},"description":"Documentos autorizados a visualizar a NFe.","nullable":true},"itensDevolvidos":{"type":"array","items":{"$ref":"#/components/schemas/EmitirNfeDevolucaoDetalheItemInputModel"},"description":"Lista de itens devolvidos (Informar nulo para devolução completa da nota).","nullable":true}},"additionalProperties":false,"description":"Dados da nota fiscal de devolução."},"EmitirNfeEstornoInputModel":{"required":["codigoErp","identificadorDocumentoFiscalEstornado"],"type":"object","properties":{"codigoErp":{"minLength":1,"type":"string","description":"Identificador da operação fiscal no ERP."},"serie":{"type":"string","description":"Série do documento fiscal (Informar somente se estiver configurado para geração numérica manual).","nullable":true},"numeroDocumento":{"type":"integer","description":"Numero do documento fiscal (Informar somente se estiver configurado para geração numérica manual).","format":"int64","nullable":true},"modeloDocumentoFiscalEstornado":{"$ref":"#/components/schemas/ModeloNotaFiscalModelEnum"},"identificadorDocumentoFiscalEstornado":{"minLength":1,"type":"string","description":"Identificador da nota fiscal a ser estornada - Chave de acesso ou Código ERP."},"tipoEmissao":{"$ref":"#/components/schemas/TipoEmissaoNfeModelEnum"},"autXml":{"type":"array","items":{"$ref":"#/components/schemas/NfeAuxXmlInputModel"},"description":"Documentos autorizados a visualizar a NFe.","nullable":true}},"additionalProperties":false,"description":"Dados necessários para criar uma nota de estorno."},"EmitirNfseModoPrestadorInputModel":{"required":["codigoErp","servico","tomador","valores"],"type":"object","properties":{"codigoErp":{"maxLength":60,"minLength":1,"type":"string","description":"Código de identificação interno do ERP do cliente. Utilizado para idempotência e reemissão."},"serie":{"type":"string","description":"Série da DPS (até 5 dígitos numéricos). Informar somente quando a sequência for manual.","nullable":true},"numeroDps":{"type":"integer","description":"Número sequencial da DPS (nDPS). Informar somente quando a sequência for manual.","format":"int64","nullable":true},"dataCompetencia":{"type":"string","description":"Mês de competência da prestação do serviço no formato \"AAAA-MM\".\nDeve ser igual ou anterior ao mês de emissão.\nQuando não informado, assume o mês/ano atual.","nullable":true},"substituicao":{"$ref":"#/components/schemas/SubstituicaoNfseInputModel"},"tomador":{"$ref":"#/components/schemas/TomadorNfseInputModel"},"servico":{"$ref":"#/components/schemas/ServicoNfseInputModel"},"valores":{"$ref":"#/components/schemas/ValoresNfseModoPrestadorInputModel"},"ibsCbs":{"$ref":"#/components/schemas/IbsCbsNfseInputModel"}},"additionalProperties":false,"description":"Dados para emissão de uma Nota Fiscal de Serviço Eletrônica (NFS-e) no modo prestador."},"EmitirNfseModoTomadorInputModel":{"required":["codigoErp","prestador","servico","valores"],"type":"object","properties":{"codigoErp":{"maxLength":60,"minLength":1,"type":"string","description":"Código de identificação interno do ERP do cliente. Utilizado para idempotência e reemissão."},"serie":{"type":"string","description":"Série da DPS (até 5 dígitos numéricos). Informar somente quando a sequência for manual.","nullable":true},"numeroDps":{"type":"integer","description":"Número sequencial da DPS (nDPS). Informar somente quando a sequência for manual.","format":"int64","nullable":true},"dataCompetencia":{"type":"string","description":"Mês de competência da prestação do serviço no formato \"AAAA-MM\".\nDeve ser igual ou anterior ao mês de emissão.\nQuando não informado, assume o mês/ano atual.","nullable":true},"substituicao":{"$ref":"#/components/schemas/SubstituicaoNfseInputModel"},"prestador":{"$ref":"#/components/schemas/PrestadorNfseInputModel"},"servico":{"$ref":"#/components/schemas/ServicoNfseInputModel"},"valores":{"$ref":"#/components/schemas/ValoresNfseModoTomadorInputModel"},"ibsCbs":{"$ref":"#/components/schemas/IbsCbsNfseInputModel"}},"additionalProperties":false,"description":"Dados para emissão de uma Nota Fiscal de Serviço Eletrônica (NFS-e) no modo tomador."},"EnderecoContribuinteCncNfseViewModel":{"type":"object","properties":{"cep":{"type":"string","description":"CEP do endereço.","nullable":true},"logradouro":{"type":"string","description":"Logradouro do endereço.","nullable":true},"numero":{"type":"string","description":"Número do endereço.","nullable":true},"bairro":{"type":"string","description":"Bairro do endereço.","nullable":true}},"additionalProperties":false,"description":"Endereço do contribuinte no CNC."},"EnderecoDestNfceSimplificadaInputModel":{"required":["bairro","cep","codigoMunicipio","logradouro","nomeMunicipio","numero"],"type":"object","properties":{"logradouro":{"maxLength":60,"minLength":2,"type":"string","description":"Logradouro."},"numero":{"maxLength":60,"minLength":1,"type":"string","description":"Número."},"complemento":{"type":"string","description":"Complemento.","nullable":true},"bairro":{"maxLength":60,"minLength":1,"type":"string","description":"Bairro."},"codigoMunicipio":{"maxLength":7,"minLength":7,"type":"string","description":"Código do município."},"nomeMunicipio":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do município."},"uf":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"cep":{"minLength":1,"type":"string","description":"CEP."},"codigoPais":{"type":"string","description":"Código do país.","nullable":true},"pais":{"type":"string","description":"Nome do país.","nullable":true}},"additionalProperties":false,"description":"Endereço do destinatário da NFe simplificada."},"EnderecoDestNfeSimplificadaInputModel":{"required":["bairro","cep","codigoMunicipio","logradouro","nomeMunicipio","numero"],"type":"object","properties":{"logradouro":{"maxLength":60,"minLength":2,"type":"string","description":"Logradouro."},"numero":{"maxLength":60,"minLength":1,"type":"string","description":"Número."},"complemento":{"type":"string","description":"Complemento.","nullable":true},"bairro":{"maxLength":60,"minLength":1,"type":"string","description":"Bairro."},"codigoMunicipio":{"maxLength":7,"minLength":7,"type":"string","description":"Código do município."},"nomeMunicipio":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do município."},"uf":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"cep":{"minLength":1,"type":"string","description":"CEP."},"codigoPais":{"type":"string","description":"Código do país.","nullable":true},"pais":{"type":"string","description":"Nome do país.","nullable":true}},"additionalProperties":false,"description":"Endereço do destinatário da NFe."},"EnderecoDestinatarioIbsCbsNfseInputModel":{"type":"object","properties":{"codigoMunicipio":{"type":"string","description":"Código do município (7 dígitos IBGE). Informar para destinatário brasileiro.","nullable":true},"cep":{"type":"string","description":"CEP (8 dígitos). Informar para destinatário brasileiro.","nullable":true},"logradouro":{"type":"string","description":"Logradouro (rua, avenida etc.).","nullable":true},"numero":{"type":"string","description":"Número do endereço.","nullable":true},"complemento":{"type":"string","description":"Complemento do endereço.","nullable":true},"bairro":{"type":"string","description":"Bairro.","nullable":true},"codigoPais":{"type":"string","description":"Código do país (tabela BACEN). Ex.: \"1058\" para o Brasil.","nullable":true},"codigoPostalExterior":{"type":"string","description":"Código postal de destinatário no exterior.","nullable":true},"cidadeExterior":{"type":"string","description":"Nome da cidade no exterior.","nullable":true},"estadoExterior":{"type":"string","description":"Nome do estado/província no exterior.","nullable":true}},"additionalProperties":false,"description":"Endereço do destinatário para fins do IBS/CBS na NFS-e. Todos os campos são opcionais."},"EnderecoDestinatarioNfceAutomaticaInputModel":{"required":["bairro","cep","codigoMunicipio","logradouro","nomeMunicipio","numero"],"type":"object","properties":{"logradouro":{"maxLength":60,"minLength":2,"type":"string","description":"Logradouro."},"numero":{"maxLength":60,"minLength":1,"type":"string","description":"Número."},"complemento":{"type":"string","description":"Complemento.","nullable":true},"bairro":{"maxLength":60,"minLength":1,"type":"string","description":"Bairro."},"codigoMunicipio":{"maxLength":7,"minLength":7,"type":"string","description":"Código do município."},"nomeMunicipio":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do município."},"uf":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"cep":{"minLength":1,"type":"string","description":"CEP."},"codigoPais":{"type":"string","description":"Código do país.","nullable":true},"pais":{"type":"string","description":"Nome do país.","nullable":true}},"additionalProperties":false,"description":"Endereço do destinatário da NFe Automática."},"EnderecoDestinatarioNfceInputModel":{"required":["bairro","cep","codigoMunicipio","logradouro","nomeMunicipio","numero"],"type":"object","properties":{"logradouro":{"maxLength":60,"minLength":2,"type":"string","description":"Logradouro."},"numero":{"maxLength":60,"minLength":1,"type":"string","description":"Número."},"complemento":{"type":"string","description":"Complemento.","nullable":true},"bairro":{"maxLength":60,"minLength":1,"type":"string","description":"Bairro."},"codigoMunicipio":{"maxLength":7,"minLength":7,"type":"string","description":"Código do município."},"nomeMunicipio":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do município."},"uf":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"cep":{"minLength":1,"type":"string","description":"CEP."},"codigoPais":{"type":"string","description":"Código do país.","nullable":true},"pais":{"type":"string","description":"Nome do país.","nullable":true}},"additionalProperties":false,"description":"Endereço do destinatário da NFe simplificada."},"EnderecoDestinatarioNfeAutomaticaInputModel":{"required":["bairro","cep","codigoMunicipio","logradouro","nomeMunicipio","numero"],"type":"object","properties":{"logradouro":{"maxLength":60,"minLength":2,"type":"string","description":"Logradouro."},"numero":{"maxLength":60,"minLength":1,"type":"string","description":"Número."},"complemento":{"type":"string","description":"Complemento.","nullable":true},"bairro":{"maxLength":60,"minLength":1,"type":"string","description":"Bairro."},"codigoMunicipio":{"maxLength":7,"minLength":7,"type":"string","description":"Código do município."},"nomeMunicipio":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do município."},"uf":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"cep":{"minLength":1,"type":"string","description":"CEP."},"codigoPais":{"type":"string","description":"Código do país.","nullable":true},"pais":{"type":"string","description":"Nome do país.","nullable":true}},"additionalProperties":false,"description":"Endereço do destinatário da NFe Automática."},"EnderecoDestinatarioNfeInputModel":{"required":["bairro","cep","codigoMunicipio","logradouro","nomeMunicipio","numero"],"type":"object","properties":{"logradouro":{"maxLength":60,"minLength":2,"type":"string","description":"Logradouro."},"numero":{"maxLength":60,"minLength":1,"type":"string","description":"Número."},"complemento":{"type":"string","description":"Complemento.","nullable":true},"bairro":{"maxLength":60,"minLength":1,"type":"string","description":"Bairro."},"codigoMunicipio":{"maxLength":7,"minLength":7,"type":"string","description":"Código do município."},"nomeMunicipio":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do município."},"uf":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"cep":{"minLength":1,"type":"string","description":"CEP."},"codigoPais":{"type":"string","description":"Código do país.","nullable":true},"pais":{"type":"string","description":"Nome do país.","nullable":true}},"additionalProperties":false,"description":"Endereço do destinatário da NFe."},"EnderecoEmissorInputModel":{"required":["bairro","cep","codigoMunicipio","logradouro","municipio","numero"],"type":"object","properties":{"logradouro":{"maxLength":60,"minLength":3,"type":"string","description":"Logradouro."},"numero":{"maxLength":60,"minLength":1,"type":"string","description":"Número."},"complemento":{"maxLength":255,"type":"string","description":"Complemento.","nullable":true},"bairro":{"maxLength":60,"minLength":3,"type":"string","description":"Bairro."},"codigoMunicipio":{"maxLength":7,"minLength":7,"type":"string","description":"Código IBGE do município."},"municipio":{"maxLength":60,"minLength":3,"type":"string","description":"Nome do município."},"uf":{"$ref":"#/components/schemas/UfModelEnum"},"cep":{"minLength":1,"type":"string","description":"CEP."}},"additionalProperties":false,"description":"Dados do emissor."},"EnderecoEmissorViewModel":{"type":"object","properties":{"logradouro":{"type":"string","description":"Logradouro.","nullable":true},"numero":{"type":"string","description":"Número.","nullable":true},"complemento":{"type":"string","description":"Complemento.","nullable":true},"bairro":{"type":"string","description":"Bairro.","nullable":true},"codigoMunicipio":{"type":"string","description":"Código IBGE do município.","nullable":true},"municipio":{"type":"string","description":"Nome do município.","nullable":true},"uf":{"$ref":"#/components/schemas/UfModelEnum"},"cep":{"type":"string","description":"CEP.","nullable":true}},"additionalProperties":false,"description":"Dados do emissor."},"EnderecoEntregaNfceAutomaticaInputModel":{"required":["bairro","codigoMunicipio","documentoRecebedor","logradouro","nomeMunicipio","numero"],"type":"object","properties":{"tipoDocumentoRecebedor":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documentoRecebedor":{"minLength":1,"type":"string","description":"Documento do recebedor."},"nomeRecebedor":{"type":"string","description":"Nome do recebedor.","nullable":true},"telefoneRecebedor":{"type":"string","description":"Telefone do recebedor.","nullable":true},"emailRecebedor":{"type":"string","description":"Email do recebedor.","nullable":true},"logradouro":{"maxLength":60,"minLength":2,"type":"string","description":"Logradouro."},"numero":{"maxLength":60,"minLength":1,"type":"string","description":"Número."},"complemento":{"type":"string","description":"Complemento.","nullable":true},"bairro":{"maxLength":60,"minLength":2,"type":"string","description":"Bairro."},"codigoMunicipio":{"maxLength":7,"minLength":7,"type":"string","description":"Código do município."},"nomeMunicipio":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do município."},"uf":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"cep":{"type":"string","description":"CEP.","nullable":true},"codigoPais":{"type":"string","description":"Código do país.","nullable":true},"pais":{"type":"string","description":"Nome do país.","nullable":true}},"additionalProperties":false,"description":"Dados de Endereço de Entrega para Nota Fiscal Eletrônica Automática."},"EnderecoEntregaNfceInputModel":{"required":["bairro","codigoMunicipio","documentoRecebedor","logradouro","nomeMunicipio","numero"],"type":"object","properties":{"tipoDocumentoRecebedor":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documentoRecebedor":{"minLength":1,"type":"string","description":"Documento do recebedor."},"nomeRecebedor":{"type":"string","description":"Nome do recebedor.","nullable":true},"telefoneRecebedor":{"type":"string","description":"Telefone do recebedor.","nullable":true},"emailRecebedor":{"type":"string","description":"Email do recebedor.","nullable":true},"logradouro":{"maxLength":60,"minLength":2,"type":"string","description":"Logradouro."},"numero":{"maxLength":60,"minLength":1,"type":"string","description":"Número."},"complemento":{"type":"string","description":"Complemento.","nullable":true},"bairro":{"maxLength":60,"minLength":2,"type":"string","description":"Bairro."},"codigoMunicipio":{"maxLength":7,"minLength":7,"type":"string","description":"Código do município."},"nomeMunicipio":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do município."},"uf":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"cep":{"type":"string","description":"CEP.","nullable":true},"codigoPais":{"type":"string","description":"Código do país.","nullable":true},"pais":{"type":"string","description":"Nome do país.","nullable":true}},"additionalProperties":false,"description":"Dados de Endereço de Entrega para Nota Fiscal Eletrônica"},"EnderecoEntregaNfceSimplificadaInputModel":{"required":["bairro","codigoMunicipio","documentoRecebedor","logradouro","nomeMunicipio","numero"],"type":"object","properties":{"tipoDocumentoRecebedor":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documentoRecebedor":{"minLength":1,"type":"string","description":"Documento do recebedor."},"nomeRecebedor":{"type":"string","description":"Nome do recebedor.","nullable":true},"telefoneRecebedor":{"type":"string","description":"Telefone do recebedor.","nullable":true},"emailRecebedor":{"type":"string","description":"Email do recebedor.","nullable":true},"logradouro":{"maxLength":60,"minLength":2,"type":"string","description":"Logradouro."},"numero":{"maxLength":60,"minLength":1,"type":"string","description":"Número."},"complemento":{"type":"string","description":"Complemento.","nullable":true},"bairro":{"maxLength":60,"minLength":2,"type":"string","description":"Bairro."},"codigoMunicipio":{"maxLength":7,"minLength":7,"type":"string","description":"Código do município."},"nomeMunicipio":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do município."},"uf":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"cep":{"type":"string","description":"CEP.","nullable":true},"codigoPais":{"type":"string","description":"Código do país.","nullable":true},"pais":{"type":"string","description":"Nome do país.","nullable":true}},"additionalProperties":false,"description":"Dados de Endereço de Entrega para Nota Fiscal Eletrônica"},"EnderecoEntregaNfeAutomaticaInputModel":{"required":["bairro","codigoMunicipio","documentoRecebedor","logradouro","nomeMunicipio","numero"],"type":"object","properties":{"tipoDocumentoRecebedor":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documentoRecebedor":{"minLength":1,"type":"string","description":"Documento do recebedor."},"nomeRecebedor":{"type":"string","description":"Nome do recebedor.","nullable":true},"telefoneRecebedor":{"type":"string","description":"Telefone do recebedor.","nullable":true},"emailRecebedor":{"type":"string","description":"Email do recebedor.","nullable":true},"logradouro":{"maxLength":60,"minLength":2,"type":"string","description":"Logradouro."},"numero":{"maxLength":60,"minLength":1,"type":"string","description":"Número."},"complemento":{"type":"string","description":"Complemento.","nullable":true},"bairro":{"maxLength":60,"minLength":2,"type":"string","description":"Bairro."},"codigoMunicipio":{"maxLength":7,"minLength":7,"type":"string","description":"Código do município."},"nomeMunicipio":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do município."},"uf":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"cep":{"type":"string","description":"CEP.","nullable":true},"codigoPais":{"type":"string","description":"Código do país.","nullable":true},"pais":{"type":"string","description":"Nome do país.","nullable":true}},"additionalProperties":false,"description":"Dados de Endereço de Entrega para Nota Fiscal Eletrônica Automática."},"EnderecoEntregaNfeInputModel":{"required":["bairro","codigoMunicipio","documentoRecebedor","logradouro","nomeMunicipio","numero"],"type":"object","properties":{"tipoDocumentoRecebedor":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documentoRecebedor":{"minLength":1,"type":"string","description":"Documento do recebedor."},"nomeRecebedor":{"type":"string","description":"Nome do recebedor.","nullable":true},"telefoneRecebedor":{"type":"string","description":"Telefone do recebedor.","nullable":true},"emailRecebedor":{"type":"string","description":"Email do recebedor.","nullable":true},"logradouro":{"maxLength":60,"minLength":2,"type":"string","description":"Logradouro."},"numero":{"maxLength":60,"minLength":1,"type":"string","description":"Número."},"complemento":{"type":"string","description":"Complemento.","nullable":true},"bairro":{"maxLength":60,"minLength":2,"type":"string","description":"Bairro."},"codigoMunicipio":{"maxLength":7,"minLength":7,"type":"string","description":"Código do município."},"nomeMunicipio":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do município."},"uf":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"cep":{"type":"string","description":"CEP.","nullable":true},"codigoPais":{"type":"string","description":"Código do país.","nullable":true},"pais":{"type":"string","description":"Nome do país.","nullable":true}},"additionalProperties":false,"description":"Dados de Endereço de Entrega para Nota Fiscal Eletrônica."},"EnderecoEntregaNfeSimplificadaInputModel":{"required":["bairro","codigoMunicipio","documentoRecebedor","logradouro","nomeMunicipio","numero"],"type":"object","properties":{"tipoDocumentoRecebedor":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documentoRecebedor":{"minLength":1,"type":"string","description":"Documento do recebedor."},"nomeRecebedor":{"type":"string","description":"Nome do recebedor.","nullable":true},"telefoneRecebedor":{"type":"string","description":"Telefone do recebedor.","nullable":true},"emailRecebedor":{"type":"string","description":"Email do recebedor.","nullable":true},"logradouro":{"maxLength":60,"minLength":2,"type":"string","description":"Logradouro."},"numero":{"maxLength":60,"minLength":1,"type":"string","description":"Número."},"complemento":{"type":"string","description":"Complemento.","nullable":true},"bairro":{"maxLength":60,"minLength":2,"type":"string","description":"Bairro."},"codigoMunicipio":{"maxLength":7,"minLength":7,"type":"string","description":"Código do município."},"nomeMunicipio":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do município."},"uf":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"cep":{"type":"string","description":"CEP.","nullable":true},"codigoPais":{"type":"string","description":"Código do país.","nullable":true},"pais":{"type":"string","description":"Nome do país.","nullable":true}},"additionalProperties":false,"description":"Dados de Endereço de Entrega para Nota Fiscal Eletrônica."},"EnderecoPrestadorNfseInputModel":{"type":"object","properties":{"logradouro":{"type":"string","description":"Tipo e nome do logradouro do endereço do prestador. Opcional.","nullable":true},"numero":{"type":"string","description":"Número no logradouro do endereço do prestador. Opcional.","nullable":true},"complemento":{"type":"string","description":"Complemento do endereço do prestador. Opcional.","nullable":true},"bairro":{"type":"string","description":"Bairro do endereço do prestador. Opcional.","nullable":true},"codigoMunicipio":{"type":"string","description":"Código do município do endereço do prestador (7 dígitos IBGE). Usar para endereço nacional.","nullable":true},"cep":{"type":"string","description":"CEP do endereço do prestador (8 dígitos, sem hífen). Usar para endereço nacional.","nullable":true},"codigoPais":{"type":"string","description":"Código do país do endereço do prestador (Tabela ISO — até 4 chars). Usar para endereço no exterior.","nullable":true},"codigoPostalExterior":{"type":"string","description":"Código postal alfanumérico no exterior. Opcional.","nullable":true},"cidadeExterior":{"type":"string","description":"Nome da cidade no exterior. Opcional.","nullable":true},"estadoExterior":{"type":"string","description":"Estado, província ou região no exterior. Opcional.","nullable":true}},"additionalProperties":false,"description":"Endereço do prestador de serviços.\nPreencher os campos nacionais (CodigoMunicipio + Cep) OU os campos do exterior (CodigoPais + demais), nunca ambos."},"EnderecoRetiradaNfceAutomaticaInputModel":{"required":["bairro","codigoMunicipio","documentoExpeditor","logradouro","nomeMunicipio","numero"],"type":"object","properties":{"tipoDocumentoExpeditor":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documentoExpeditor":{"minLength":1,"type":"string","description":"Documento do Expeditor."},"nomeExpeditor":{"type":"string","description":"Nome do Expeditor.","nullable":true},"telefoneExpeditor":{"type":"string","description":"Telefone do Expeditor.","nullable":true},"emailExpeditor":{"type":"string","description":"Email do Expeditor.","nullable":true},"logradouro":{"maxLength":60,"minLength":2,"type":"string","description":"Logradouro."},"numero":{"maxLength":60,"minLength":1,"type":"string","description":"Número."},"complemento":{"type":"string","description":"Complemento.","nullable":true},"bairro":{"maxLength":60,"minLength":2,"type":"string","description":"Bairro."},"codigoMunicipio":{"maxLength":7,"minLength":7,"type":"string","description":"Código do município."},"nomeMunicipio":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do município."},"uf":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"cep":{"type":"string","description":"CEP.","nullable":true},"codigoPais":{"type":"string","description":"Código do país.","nullable":true},"pais":{"type":"string","description":"Nome do país.","nullable":true}},"additionalProperties":false,"description":"Dados do endereço de retirada da NFe Automática."},"EnderecoRetiradaNfceInputModel":{"required":["bairro","codigoMunicipio","documentoExpeditor","logradouro","nomeMunicipio","numero"],"type":"object","properties":{"tipoDocumentoExpeditor":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documentoExpeditor":{"minLength":1,"type":"string","description":"Documento do Expeditor."},"nomeExpeditor":{"type":"string","description":"Nome do Expeditor.","nullable":true},"telefoneExpeditor":{"type":"string","description":"Telefone do Expeditor.","nullable":true},"emailExpeditor":{"type":"string","description":"Email do Expeditor.","nullable":true},"logradouro":{"maxLength":60,"minLength":2,"type":"string","description":"Logradouro."},"numero":{"maxLength":60,"minLength":1,"type":"string","description":"Número."},"complemento":{"type":"string","description":"Complemento.","nullable":true},"bairro":{"maxLength":60,"minLength":2,"type":"string","description":"Bairro."},"codigoMunicipio":{"maxLength":7,"minLength":7,"type":"string","description":"Código do município."},"nomeMunicipio":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do município."},"uf":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"cep":{"type":"string","description":"CEP.","nullable":true},"codigoPais":{"type":"string","description":"Código do país.","nullable":true},"pais":{"type":"string","description":"Nome do país.","nullable":true}},"additionalProperties":false,"description":"Dados do endereço de retirada da NFe simplificada."},"EnderecoRetiradaNfceSimplificadaInputModel":{"required":["bairro","codigoMunicipio","documentoExpeditor","logradouro","nomeMunicipio","numero"],"type":"object","properties":{"tipoDocumentoExpeditor":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documentoExpeditor":{"minLength":1,"type":"string","description":"Documento do Expeditor."},"nomeExpeditor":{"type":"string","description":"Nome do Expeditor.","nullable":true},"telefoneExpeditor":{"type":"string","description":"Telefone do Expeditor.","nullable":true},"emailExpeditor":{"type":"string","description":"Email do Expeditor.","nullable":true},"logradouro":{"maxLength":60,"minLength":2,"type":"string","description":"Logradouro."},"numero":{"maxLength":60,"minLength":1,"type":"string","description":"Número."},"complemento":{"type":"string","description":"Complemento.","nullable":true},"bairro":{"maxLength":60,"minLength":2,"type":"string","description":"Bairro."},"codigoMunicipio":{"maxLength":7,"minLength":7,"type":"string","description":"Código do município."},"nomeMunicipio":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do município."},"uf":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"cep":{"type":"string","description":"CEP.","nullable":true},"codigoPais":{"type":"string","description":"Código do país.","nullable":true},"pais":{"type":"string","description":"Nome do país.","nullable":true}},"additionalProperties":false,"description":"Dados do endereço de retirada da NFe simplificada."},"EnderecoRetiradaNfeAutomaticaInputModel":{"required":["bairro","codigoMunicipio","documentoExpeditor","logradouro","nomeMunicipio","numero"],"type":"object","properties":{"tipoDocumentoExpeditor":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documentoExpeditor":{"minLength":1,"type":"string","description":"Documento do Expeditor."},"nomeExpeditor":{"type":"string","description":"Nome do Expeditor.","nullable":true},"telefoneExpeditor":{"type":"string","description":"Telefone do Expeditor.","nullable":true},"emailExpeditor":{"type":"string","description":"Email do Expeditor.","nullable":true},"logradouro":{"maxLength":60,"minLength":2,"type":"string","description":"Logradouro."},"numero":{"maxLength":60,"minLength":1,"type":"string","description":"Número."},"complemento":{"type":"string","description":"Complemento.","nullable":true},"bairro":{"maxLength":60,"minLength":2,"type":"string","description":"Bairro."},"codigoMunicipio":{"maxLength":7,"minLength":7,"type":"string","description":"Código do município."},"nomeMunicipio":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do município."},"uf":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"cep":{"type":"string","description":"CEP.","nullable":true},"codigoPais":{"type":"string","description":"Código do país.","nullable":true},"pais":{"type":"string","description":"Nome do país.","nullable":true}},"additionalProperties":false,"description":"Dados do endereço de retirada da NFe Automática."},"EnderecoRetiradaNfeInputModel":{"required":["bairro","codigoMunicipio","documentoExpeditor","logradouro","nomeMunicipio","numero"],"type":"object","properties":{"tipoDocumentoExpeditor":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documentoExpeditor":{"minLength":1,"type":"string","description":"Documento do Expeditor."},"nomeExpeditor":{"type":"string","description":"Nome do Expeditor.","nullable":true},"telefoneExpeditor":{"type":"string","description":"Telefone do Expeditor.","nullable":true},"emailExpeditor":{"type":"string","description":"Email do Expeditor.","nullable":true},"logradouro":{"maxLength":60,"minLength":2,"type":"string","description":"Logradouro."},"numero":{"maxLength":60,"minLength":1,"type":"string","description":"Número."},"complemento":{"type":"string","description":"Complemento.","nullable":true},"bairro":{"maxLength":60,"minLength":2,"type":"string","description":"Bairro."},"codigoMunicipio":{"maxLength":7,"minLength":7,"type":"string","description":"Código do município."},"nomeMunicipio":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do município."},"uf":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"cep":{"type":"string","description":"CEP.","nullable":true},"codigoPais":{"type":"string","description":"Código do país.","nullable":true},"pais":{"type":"string","description":"Nome do país.","nullable":true}},"additionalProperties":false,"description":"Dados do endereço de retirada da NFe."},"EnderecoRetiradaNfeSimplificadaInputModel":{"required":["bairro","codigoMunicipio","documentoExpeditor","logradouro","nomeMunicipio","numero"],"type":"object","properties":{"tipoDocumentoExpeditor":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documentoExpeditor":{"minLength":1,"type":"string","description":"Documento do Expeditor."},"nomeExpeditor":{"type":"string","description":"Nome do Expeditor.","nullable":true},"telefoneExpeditor":{"type":"string","description":"Telefone do Expeditor.","nullable":true},"emailExpeditor":{"type":"string","description":"Email do Expeditor.","nullable":true},"logradouro":{"maxLength":60,"minLength":2,"type":"string","description":"Logradouro."},"numero":{"maxLength":60,"minLength":1,"type":"string","description":"Número."},"complemento":{"type":"string","description":"Complemento.","nullable":true},"bairro":{"maxLength":60,"minLength":2,"type":"string","description":"Bairro."},"codigoMunicipio":{"maxLength":7,"minLength":7,"type":"string","description":"Código do município."},"nomeMunicipio":{"maxLength":60,"minLength":2,"type":"string","description":"Nome do município."},"uf":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"cep":{"type":"string","description":"CEP.","nullable":true},"codigoPais":{"type":"string","description":"Código do país.","nullable":true},"pais":{"type":"string","description":"Nome do país.","nullable":true}},"additionalProperties":false,"description":"Dados do endereço de retirada da NFe."},"EnderecoTomadorNfseInputModel":{"type":"object","properties":{"logradouro":{"type":"string","description":"Tipo e nome do logradouro do endereço do tomador. Opcional.","nullable":true},"numero":{"type":"string","description":"Número no logradouro do endereço do tomador. Opcional.","nullable":true},"complemento":{"type":"string","description":"Complemento do endereço do tomador. Opcional.","nullable":true},"bairro":{"type":"string","description":"Bairro do endereço do tomador. Opcional.","nullable":true},"codigoMunicipio":{"type":"string","description":"Código do município do endereço do tomador (7 dígitos IBGE). Usar para endereço nacional.","nullable":true},"nomeMunicipio":{"type":"string","description":"Nome do município.","nullable":true},"uf":{"$ref":"#/components/schemas/UfExtNotaFiscalServicoModelEnum"},"cep":{"type":"string","description":"CEP do endereço do tomador (8 dígitos, sem hífen). Usar para endereço nacional.","nullable":true},"codigoPais":{"type":"string","description":"Código do país do endereço do tomador (Tabela ISO — até 4 chars). Usar para endereço no exterior.","nullable":true},"codigoPostalExterior":{"type":"string","description":"Código postal alfanumérico no exterior. Opcional.","nullable":true},"cidadeExterior":{"type":"string","description":"Nome da cidade no exterior. Opcional.","nullable":true},"estadoExterior":{"type":"string","description":"Estado, província ou região no exterior. Opcional.","nullable":true}},"additionalProperties":false,"description":"Endereço do tomador de serviços.\nPreencher os campos nacionais (CodigoMunicipio + Cep) OU os campos do exterior (CodigoPais + demais), nunca ambos."},"ExportacaoNfeInputModel":{"required":["localEmbarque","ufEmbarque"],"type":"object","properties":{"ufEmbarque":{"$ref":"#/components/schemas/UfNotaFiscalModelEnum"},"localEmbarque":{"maxLength":60,"minLength":1,"type":"string","description":"Descrição do Local de Embarque ou de transposição de fronteira."},"localDespacho":{"type":"string","description":"Descrição do local de despacho.","nullable":true}},"additionalProperties":false,"description":"Dados de exportação da NFe."},"ExportacaoNfeSimplificadaInputModel":{"required":["localEmbarque","ufEmbarque"],"type":"object","properties":{"ufEmbarque":{"$ref":"#/components/schemas/UfNotaFiscalModelEnum"},"localEmbarque":{"maxLength":60,"minLength":1,"type":"string","description":"Descrição do Local de Embarque ou de transposição de fronteira."},"localDespacho":{"type":"string","description":"Descrição do local de despacho.","nullable":true}},"additionalProperties":false,"description":"Dados de exportação da NFe."},"FinalidadeConsultaTributacaoModelEnum":{"enum":["VendaConsumidorFinalNaoContribuinte","VendaConsumidorFinalContribuinte","VendaParaRevenda","Bonificacao","Transferencia"],"type":"string","description":"Finalidade da operação fiscal."},"FinalidadeNfeModelEnum":{"enum":["Normal","Complementar","Ajuste","Devolucao"],"type":"string","description":"Finalidade da NFe."},"FluxoFiscalAutomaticoModelEnum":{"enum":["VendaConsumidorFinal","Revenda","Bonificacao","Transferencia"],"type":"string","description":"Fluxo fiscal para cálculo automático do tributo."},"FonteInformacaoConsultaProdutoModelEnum":{"enum":["Cache","CatalogoFiscal"],"type":"string","description":"Origem do resultado obtido na consulta."},"FormasPagamentoNotaFiscalModelEnum":{"enum":["Dinheiro","Cheque","CartaoCredito","CartaoDebito","CreditoLoja","ValeAlimentaçao","ValeRefeiçao","ValePresente","ValeCombustivel","BoletoBancario","DepósitoBancario","Pix","TransferenciaBancaria","ProgramaFidelidade","PagamentoInstantaneoPIXEstatico","CreditoEmLoja","PagamentoEletronicoNaoInformado","SemPagamento","Outros"],"type":"string","description":"Formas de pagamento."},"FormatoDanfeModelEnum":{"enum":["Html","Pdf"],"type":"string","description":"Formato do DANFE"},"GerarTokenInputModel":{"required":["clientId","secretId"],"type":"object","properties":{"clientId":{"minLength":1,"type":"string","description":"Identificador do cliente da requisição."},"secretId":{"minLength":1,"type":"string","description":"Senha do cliente da requisição."}},"additionalProperties":false,"description":"Dados para gerar token de acesso."},"GerarTokenViewModel":{"type":"object","properties":{"token":{"type":"string","description":"Token de acesso.","nullable":true},"expiresIn":{"type":"integer","description":"Tempo de expiração do token (segundos).","format":"int32"},"refreshExpiresIn":{"type":"integer","description":"Tempo de expiração do token para gerar nova sessão (segundos).","format":"int32"}},"additionalProperties":false,"description":"Informação de retorno da autenticação."},"GrupoCstIpiModelEnum":{"enum":["Imunidade","Suspensao","Isencao","Reducao","Outros"],"type":"string","description":"Grupo de CST do IPI."},"HabilitarAplicativoContratoInputModel":{"required":["recorrenciaAutomatica"],"type":"object","properties":{"recorrenciaAutomatica":{"type":"boolean","description":"Indica se a bilhetagem dos emissores será reiniciada de forma automática mensalmente."},"quantidadeEmissores":{"type":"integer","description":"Quantidade de emissores permitidos para o aplicativo. (Deixar nulo para quantidade ilimitada)","format":"int64","nullable":true},"quantidadeConsultasCatalogo":{"type":"integer","description":"Quantidade de consultas no catálogo permitidas para cada emissor. (Deixar nulo para quantidade ilimitada)","format":"int64","nullable":true},"quantidadeConsultasCnpj":{"type":"integer","description":"Quantidade de consultas de CNPJ´s permitidas para o aplicativo. (Deixar nulo para quantidade ilimitada)","format":"int64","nullable":true},"quantidadeConsultasCnpjEmissor":{"type":"integer","description":"Quantidade de consultas de CNPJ´s permitidas para cada emissor. (Deixar nulo para quantidade ilimitada)","format":"int64","nullable":true},"quantidadeNotasFiscais":{"type":"integer","description":"Quantidade de notas fiscais permitidas para emissão por emissor. (Deixar nulo para quantidade ilimitada)","format":"int64","nullable":true}},"additionalProperties":false,"description":"Dados do contrato ao habilitar o aplicativo."},"HabilitarAplicativoInputModel":{"required":["consoleId","contrato","nome"],"type":"object","properties":{"nome":{"maxLength":60,"minLength":1,"type":"string","description":"Nome do aplicativo."},"consoleId":{"maxLength":255,"minLength":1,"type":"string","description":"Identificador do aplicativo no console."},"responsavelTecnicoCnpj":{"type":"string","description":"CNPJ do responsável técnico.","nullable":true},"responsavelTecnicoNome":{"type":"string","description":"Nome do responsável técnico.","nullable":true},"responsavelTecnicoEmail":{"type":"string","description":"Email do responsável técnico.","nullable":true},"responsavelTecnicoFone":{"type":"string","description":"Telefone do responsável técnico.","nullable":true},"responsavelTecnicoCrtId":{"type":"string","description":"ID do responsável técnico exigido no estado do Paraná para emissão de NFe´s.","nullable":true},"responsavelTecnicoCrtHash":{"type":"string","description":"Hash do responsável técnico exigido no estado do Paraná para emissão de NFe´s.","nullable":true},"contrato":{"$ref":"#/components/schemas/HabilitarAplicativoContratoInputModel"}},"additionalProperties":false,"description":"Dados para ativação do aplicativo"},"HabilitarAplicativoViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador interno do aplicativo.","format":"uuid"},"clientId":{"type":"string","description":"ClientId usado na autenticação do aplicativo no sistema.","nullable":true},"secretId":{"type":"string","description":"Chave secreta usada na autenticação do aplicativo no sistema.","nullable":true}},"additionalProperties":false,"description":"Dados retornados ao habilitar um aplicativo para o parceiro."},"HabilitarEmissorInputModel":{"required":["endereco","nome","regimeTributario","tipoDocumento","tipoEstabelecimento","tipoIcmsSt"],"type":"object","properties":{"documento":{"type":"string","description":"Documento (CPF/CNPJ) do emissor.","nullable":true},"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoEmissorModelEnum"},"nome":{"maxLength":60,"minLength":3,"type":"string","description":"Nome ou Razão Social do emissor."},"nomeFantasia":{"type":"string","description":"Nome fantasia do emissor.","nullable":true},"regimeTributario":{"$ref":"#/components/schemas/RegimeTributarioModelEnum"},"aliquotaCreditoSimples":{"type":"number","description":"Alíquota do crédito de icms do simples nacional consedido em operações de revenda do regime Simples Nacional.","format":"double","nullable":true},"tipoIcmsSt":{"$ref":"#/components/schemas/TipoIcmsStEmissorModelEnum"},"tipoEstabelecimento":{"$ref":"#/components/schemas/TipoEstabelecimentoEmissorModelEnum"},"telefone":{"maxLength":14,"minLength":6,"type":"string","description":"Telefone de contato.","nullable":true},"inscricaoMunicipal":{"maxLength":15,"type":"string","description":"Inscrição municipal do emissor.","nullable":true},"cnae":{"maxLength":7,"type":"string","description":"Código CNAE principal.","nullable":true},"cnaeSecundario":{"maxLength":7,"type":"string","description":"Código CNAE secundário.","nullable":true},"endereco":{"$ref":"#/components/schemas/EnderecoEmissorInputModel"},"inscricoesEstaduais":{"type":"array","items":{"$ref":"#/components/schemas/InscricaoEstadualEmissorInputModel"},"description":"Lista de inscrições estaduais do emissor.","nullable":true}},"additionalProperties":false,"description":"Dados de entrada para habilitar o emissor."},"HabilitarParceiroInputModel":{"required":["cnpj","consoleId","razaoSocial"],"type":"object","properties":{"cnpj":{"minLength":1,"type":"string","description":"CNPJ do parceiro."},"razaoSocial":{"maxLength":60,"minLength":1,"type":"string","description":"Nome ou razão social do parceiro."},"consoleId":{"maxLength":255,"minLength":1,"type":"string","description":"Identificador do parceiro no console."}},"additionalProperties":false,"description":"Dados para habilitação do parceiro."},"HistoricoVigenciaMunicipioNfseViewModel":{"type":"object","properties":{"dataInicioVigencia":{"type":"string","description":"Data de início da vigência.","format":"date-time"},"dataFimVigencia":{"type":"string","description":"Data de fim da vigência, se houver.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Registro de vigência de uma configuração de retenção."},"IbsCbsNfseInputModel":{"type":"object","properties":{"indDest":{"$ref":"#/components/schemas/IndDestIbsCbsNfseModelEnum"},"cIndOp":{"type":"integer","description":"Código indicador da operação (cIndOp).","format":"int32"},"cst":{"$ref":"#/components/schemas/CstIbsCbsNfseModelEnum"},"cClassTrib":{"type":"string","description":"Código de classificação tributária (cClassTrib).","nullable":true},"cCredPres":{"type":"integer","description":"Código de crédito presumido (cCredPres). Opcional.","format":"int32","nullable":true},"gTribRegularCstReg":{"type":"integer","description":"CST da tributação regular (CSTReg). Opcional. Informar em conjunto com GTribRegularCClassTribReg.","format":"int32","nullable":true},"gTribRegularCClassTribReg":{"type":"string","description":"Código de classificação tributária regular (cClassTribReg). Opcional. Informar em conjunto com GTribRegularCstReg.","nullable":true},"destinatario":{"$ref":"#/components/schemas/DestinatarioIbsCbsNfseInputModel"}},"additionalProperties":false,"description":"Dados de tributação do IBS (Imposto sobre Bens e Serviços) e CBS (Contribuição sobre Bens e Serviços)\nda reforma tributária para a NFS-e. Obrigatório para Lucro Real e Lucro Presumido; opcional para Simples Nacional e MEI."},"IncidenciaIssCtnModelEnum":{"enum":["LocalPrestador","LocalPrestacao","LocalTomador"],"type":"string","description":"Incidência do ISS conforme a Lista de Serviços do CTN."},"IndDestIbsCbsNfseModelEnum":{"enum":["Tomador","Outro"],"type":"string","description":"Indicador a respeito do destinatário dos serviços (indDest) no IBS/CBS da NFS-e."},"IndicadorExigibilidadeIssqnModelEnum":{"enum":["Exigivel","NaoIncidencia","Isencao","Exportacao","Imunidade","ExigibilidadeSuspensaDecisaoJudicial","ExigibilidadeSuspensaProcessoAdministrativo"],"type":"string","description":"Indicador de exigibilidade do ISSQN."},"IndicadorInscricaoDestinatarioNotaFiscalModelEnum":{"enum":["ContribuinteIcms","ContribuinteIsentoIcms","NaoContribuinte"],"type":"string","description":"Indicador de inscrição estadual do destinatário."},"IndicadorPresencaNfceModelEnum":{"enum":["OperacaoPresencial","NfceEntregaDomicilio"],"type":"string","description":"Indicador de presença na operação."},"IndicadorPresencaNfeModelEnum":{"enum":["NaoSeAplica","OperacaoPresencial","OperacaoNaoPresencialInternet","OperacaoNaoPresencialTeleatendimento","NaoPresencialOutros"],"type":"string","description":"Indicador de presença na operação."},"IndicadorPresencaNotaFiscalModelEnum":{"enum":["NaoSeAplica","OperacaoPresencial","OperacaoNaoPresencialInternet","OperacaoNaoPresencialTeleatendimento","NfceEntregaDomicilio","NaoPresencialOutros"],"type":"string","description":"Indicador de presença na operação."},"InfCadCncNfseViewModel":{"type":"object","properties":{"inscricao":{"type":"string","description":"Número de inscrição do contribuinte.","nullable":true},"tipoInscricao":{"type":"string","description":"Tipo de inscrição do contribuinte.","nullable":true},"inscricaoMunicipal":{"type":"string","description":"Inscrição municipal do contribuinte, se houver.","nullable":true},"dataInicioInscricaoMunicipal":{"type":"string","description":"Data de início da inscrição municipal, se houver.","format":"date-time","nullable":true},"razaoSocial":{"type":"string","description":"Razão social do contribuinte.","nullable":true},"endereco":{"$ref":"#/components/schemas/EnderecoContribuinteCncNfseViewModel"},"telefone":{"type":"string","description":"Telefone do contribuinte, se houver.","nullable":true},"email":{"type":"string","description":"E-mail do contribuinte, se houver.","nullable":true},"situacaoEmissaoNFSe":{"type":"string","description":"Situação de emissão de NFS-e do contribuinte.","nullable":true},"situacaoContribuinteCNC":{"type":"string","description":"Situação do contribuinte no CNC.","nullable":true},"situacaoCadastral":{"type":"string","description":"Situação cadastral do contribuinte.","nullable":true}},"additionalProperties":false,"description":"Informações cadastrais do contribuinte no CNC."},"InscricaoEstadualEmissorInputModel":{"required":["endereco","inscricaoEstadual","nome"],"type":"object","properties":{"inscricaoEstadual":{"maxLength":14,"minLength":3,"type":"string","description":"Número da Inscrição Estadual do emissor."},"nome":{"maxLength":60,"minLength":3,"type":"string","description":"Nome na inscrição estadual."},"endereco":{"$ref":"#/components/schemas/EnderecoEmissorInputModel"}},"additionalProperties":false,"description":"Dados da inscrição estadual e identificação do emissor."},"InscricaoEstadualEmissorViewModel":{"type":"object","properties":{"inscricaoEstadual":{"type":"string","description":"Número da Inscrição Estadual do emissor.","nullable":true},"nome":{"type":"string","description":"Nome na inscrição estadual.","nullable":true},"endereco":{"$ref":"#/components/schemas/EnderecoEmissorViewModel"}},"additionalProperties":false,"description":"Dados da inscrição estadual do emissor."},"ItemNfceAutomaticaInputModel":{"required":["codigoInterno","descricao","unidade"],"type":"object","properties":{"codigoInterno":{"maxLength":60,"minLength":1,"type":"string","description":"Código interno do produto no ERP."},"ean":{"type":"string","description":"EAN do produto.","nullable":true},"descricao":{"maxLength":120,"minLength":2,"type":"string","description":"Descrição do produto."},"origemMercadoria":{"$ref":"#/components/schemas/OrigemMercadoriaNotaFiscalModelEnum"},"fabricacaoPropria":{"type":"boolean","description":"Indica se o produto é de fabricação própria. (Default: false)","nullable":true},"unidade":{"maxLength":6,"minLength":1,"type":"string","description":"Unidade comercializada."},"quantidade":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Quantidade comercializada.","format":"double"},"valorUnitario":{"minimum":0,"type":"number","description":"Valor unitário do item.","format":"double"},"valorTotalBruto":{"minimum":0,"type":"number","description":"Valor total bruto.","format":"double"},"valorTotalFrete":{"minimum":0,"type":"number","description":"Valor total de frete do item.","format":"double","nullable":true},"valorTotalSeguro":{"minimum":0,"type":"number","description":"Valor total de seguro do item.","format":"double","nullable":true},"valorTotalDesconto":{"minimum":0,"type":"number","description":"Valor total de descontos do item.","format":"double","nullable":true},"valorTotalOutros":{"minimum":0,"type":"number","description":"Valor total de outras despesas do item.","format":"double","nullable":true},"itemCompoeTotalNota":{"type":"boolean","description":"Indicador de item compõe o total da nota.","nullable":true},"numeroPedidoCompra":{"type":"string","description":"Número do pedido de compra.","nullable":true},"itemPedidoCompra":{"type":"integer","description":"Item de pedido de compra.","format":"int32","nullable":true},"produtoEspecifico":{"$ref":"#/components/schemas/ItemNfceAutomaticaProdutoEspecificoInputModel"}},"additionalProperties":false,"description":"Dados do item da NFe Automática."},"ItemNfceAutomaticaProdutoEspecificoInputModel":{"required":["tipoProdutoEspecifico"],"type":"object","properties":{"tipoProdutoEspecifico":{"$ref":"#/components/schemas/TipoProdutoEspecificoNotaFiscalModelEnum"}},"additionalProperties":false,"description":"Modelo abstrato para os Dados de Produto Específico do item da nota fiscal.\n\nO preenchimento dos campos abaixo é condicional ao TipoProdutoEspecifico informado.\n\n\n*************************************************************************\n\nMedicamento:\n\n• TipoProdutoEspecifico: Medicamento.\n\n• CodigoAnvisa (string): Código de Produto da ANVISA (13 dígitos).\n\n• MotivoIsensao (string): Texto explicativo do motivo da isenção da ANVISA.\n\n• ValorPmc (decimal): Preço Máximo ao Consumidor.\n\n \n*************************************************************************\n\nDicionário de Enumeradores:\n\n• TipoProdutoEspecificoNotaFiscalModelEnum:\n\n Medicamento = Produtos farmacêuticos e medicamentos."},"ItemNfceImpostoInputModel":{"required":["cofins","pis"],"type":"object","properties":{"icms":{"$ref":"#/components/schemas/ItemNfceTributacaoIcmsInputModel"},"icmssn":{"$ref":"#/components/schemas/ItemNfceTributacaoIcmssnInputModel"},"pis":{"$ref":"#/components/schemas/ItemNfceTributacaoPisInputModel"},"cofins":{"$ref":"#/components/schemas/ItemNfceTributacaoCofinsInputModel"},"ibsCbs":{"$ref":"#/components/schemas/ItemNfceTributacaoIbsCbsInputModel"}},"additionalProperties":false,"description":"Dados do imposto do item da nota fiscal."},"ItemNfceInputModel":{"required":["cfop","codigoInterno","descricao","ncm","unidade"],"type":"object","properties":{"codigoInterno":{"maxLength":60,"minLength":1,"type":"string","description":"Código interno do produto no ERP."},"ean":{"type":"string","description":"EAN do produto.","nullable":true},"descricao":{"maxLength":120,"minLength":2,"type":"string","description":"Descrição do produto."},"origemMercadoria":{"$ref":"#/components/schemas/OrigemMercadoriaNotaFiscalModelEnum"},"ncm":{"minLength":1,"pattern":"^\\d{8}$","type":"string","description":"NCM do produto. Lista de NCMs válidos em api/v1/RecursosAdicionais/Ncm/Listar."},"cest":{"type":"string","description":"Código Especificador da Substituição Tributária (CEST).\n\nO CEST é utilizado para identificar mercadorias e bens passíveis de sujeição aos regimes de \nsubstituição tributária e de antecipação do recolhimento do imposto.\n🔍 DICA DE BUSCA: Para obter uma lista de códigos válidos, utilize o endpoint \n`api/v1/RecursosAdicionais/Cest/Listar`. Além disso, ao consultar o detalhe de um NCM, \no sistema retornará automaticamente os CESTs associados àquela classificação fiscal.","nullable":true},"nve":{"type":"string","description":"Codificação NVE - Nomenclatura de Valor Aduaneiro e Estatística. (Opcional)","nullable":true},"exTipi":{"type":"integer","description":"Extensão da TIPI.","format":"int32","nullable":true},"cfop":{"minLength":1,"pattern":"^\\d{4}$","type":"string","description":"CFOP do item. Lista de CFOPs válidos em api/v1/RecursosAdicionais/Cfop/Listar."},"unidade":{"maxLength":6,"minLength":1,"type":"string","description":"Unidade comercializada."},"quantidade":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Quantidade comercializada.","format":"double"},"valorUnitario":{"minimum":0,"type":"number","description":"Valor unitário do item.","format":"double"},"valorTotalBruto":{"minimum":0,"type":"number","description":"Valor total bruto.","format":"double"},"valorTotalFrete":{"minimum":0,"type":"number","description":"Valor total de frete do item.","format":"double","nullable":true},"valorTotalSeguro":{"minimum":0,"type":"number","description":"Valor total de seguro do item.","format":"double","nullable":true},"valorTotalDesconto":{"minimum":0,"type":"number","description":"Valor total de descontos do item.","format":"double","nullable":true},"valorTotalOutros":{"minimum":0,"type":"number","description":"Valor total de outras despesas do item.","format":"double","nullable":true},"itemCompoeTotalNota":{"type":"boolean","description":"Indicador de item compõe o total da nota.","nullable":true},"numeroPedidoCompra":{"type":"string","description":"Número do pedido de compra.","nullable":true},"itemPedidoCompra":{"type":"integer","description":"Item de pedido de compra.","format":"int32","nullable":true},"impostos":{"$ref":"#/components/schemas/ItemNfceImpostoInputModel"},"produtoEspecifico":{"$ref":"#/components/schemas/ItemNfceProdutoEspecificoInputModel"}},"additionalProperties":false,"description":"Dados do item da NFe ."},"ItemNfceProdutoEspecificoInputModel":{"required":["tipoProdutoEspecifico"],"type":"object","properties":{"tipoProdutoEspecifico":{"$ref":"#/components/schemas/TipoProdutoEspecificoNotaFiscalModelEnum"}},"additionalProperties":false,"description":"Modelo abstrato para os Dados de Produto Específico do item da nota fiscal.\n\nO preenchimento dos campos abaixo é condicional ao TipoProdutoEspecifico informado.\n\n\n*************************************************************************\n\nMedicamento:\n\n• TipoProdutoEspecifico: Medicamento.\n\n• CodigoAnvisa (string): Código de Produto da ANVISA (13 dígitos).\n\n• MotivoIsensao (string): Texto explicativo do motivo da isenção da ANVISA.\n\n• ValorPmc (decimal): Preço Máximo ao Consumidor.\n\n \n*************************************************************************\n\nDicionário de Enumeradores:\n\n• TipoProdutoEspecificoNotaFiscalModelEnum:\n\n Medicamento = Produtos farmacêuticos e medicamentos."},"ItemNfceRastroAutomaticaInputModel":{"required":["dataFabricacao","dataValidade","numeroLote"],"type":"object","properties":{"numeroLote":{"maxLength":20,"minLength":1,"type":"string","description":"Número do lote do produto."},"quantidadeLote":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Quantidade do lote.","format":"double"},"dataFabricacao":{"minLength":1,"type":"string","description":"Data de fabricação do lote.","format":"date-time"},"dataValidade":{"minLength":1,"type":"string","description":"Data de validade do lote.","format":"date-time"}},"additionalProperties":false,"description":"Dados de rastreabilidade do item da NFe Automática."},"ItemNfceRastroInputModel":{"required":["dataFabricacao","dataValidade","numeroLote"],"type":"object","properties":{"numeroLote":{"maxLength":20,"minLength":1,"type":"string","description":"Número do lote do produto."},"quantidadeLote":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Quantidade do lote.","format":"double"},"dataFabricacao":{"minLength":1,"type":"string","description":"Data de fabricação do lote.","format":"date-time"},"dataValidade":{"minLength":1,"type":"string","description":"Data de validade do lote.","format":"date-time"}},"additionalProperties":false,"description":"Dados de rastreabilidade do item da NFe ."},"ItemNfceSimplificadaImpostoInputModel":{"required":["cofins","pis"],"type":"object","properties":{"icms":{"$ref":"#/components/schemas/ItemNfceSimplificadaTribIcmsInputModel"},"icmssn":{"$ref":"#/components/schemas/ItemNfceSimplificadaTribIcmssnInputModel"},"pis":{"$ref":"#/components/schemas/ItemNfceSimplificadaTribPisInputModel"},"cofins":{"$ref":"#/components/schemas/ItemNfceSimplificadaTribCofinsInputModel"},"ibsCbs":{"$ref":"#/components/schemas/ItemNfceSimplificadaTribIbsCbsInputModel"}},"additionalProperties":false,"description":"Dados do imposto do item da nota fiscal."},"ItemNfceSimplificadaInputModel":{"required":["cfop","codigoInterno","descricao","ncm","unidade"],"type":"object","properties":{"codigoInterno":{"maxLength":60,"minLength":1,"type":"string","description":"Código interno do produto no ERP."},"ean":{"type":"string","description":"EAN do produto.","nullable":true},"descricao":{"maxLength":120,"minLength":2,"type":"string","description":"Descrição do produto."},"origemMercadoria":{"$ref":"#/components/schemas/OrigemMercadoriaNotaFiscalModelEnum"},"ncm":{"minLength":1,"pattern":"^\\d{8}$","type":"string","description":"NCM do produto. Lista de NCMs válidos em api/v1/RecursosAdicionais/Ncm/Listar."},"cest":{"type":"string","description":"Código Especificador da Substituição Tributária (CEST).\n\nO CEST é utilizado para identificar mercadorias e bens passíveis de sujeição aos regimes de \nsubstituição tributária e de antecipação do recolhimento do imposto.\n🔍 DICA DE BUSCA: Para obter uma lista de códigos válidos, utilize o endpoint \n`api/v1/RecursosAdicionais/Cest/Listar`. Além disso, ao consultar o detalhe de um NCM, \no sistema retornará automaticamente os CESTs associados àquela classificação fiscal.","nullable":true},"nve":{"type":"string","description":"Codificação NVE - Nomenclatura de Valor Aduaneiro e Estatística. (Opcional)","nullable":true},"exTipi":{"type":"integer","description":"Extensão da TIPI.","format":"int32","nullable":true},"cfop":{"minLength":1,"pattern":"^\\d{4}$","type":"string","description":"CFOP do item. Lista de CFOPs válidos em api/v1/RecursosAdicionais/Cfop/Listar."},"unidade":{"maxLength":6,"minLength":1,"type":"string","description":"Unidade comercializada."},"quantidade":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Quantidade comercializada.","format":"double"},"valorUnitario":{"minimum":0,"type":"number","description":"Valor unitário do item.","format":"double"},"valorTotalBruto":{"minimum":0,"type":"number","description":"Valor total bruto.","format":"double"},"valorTotalFrete":{"minimum":0,"type":"number","description":"Valor total de frete do item.","format":"double","nullable":true},"valorTotalSeguro":{"minimum":0,"type":"number","description":"Valor total de seguro do item.","format":"double","nullable":true},"valorTotalDesconto":{"minimum":0,"type":"number","description":"Valor total de descontos do item.","format":"double","nullable":true},"valorTotalOutros":{"minimum":0,"type":"number","description":"Valor total de outras despesas do item.","format":"double","nullable":true},"itemCompoeTotalNota":{"type":"boolean","description":"Indicador de item compõe o total da nota.","nullable":true},"numeroPedidoCompra":{"type":"string","description":"Número do pedido de compra.","nullable":true},"itemPedidoCompra":{"type":"integer","description":"Item de pedido de compra.","format":"int32","nullable":true},"impostos":{"$ref":"#/components/schemas/ItemNfceSimplificadaImpostoInputModel"},"produtoEspecifico":{"$ref":"#/components/schemas/ItemNfceSimplificadaProdEspInputModel"}},"additionalProperties":false,"description":"Dados do item da NFe ."},"ItemNfceSimplificadaProdEspInputModel":{"required":["tipoProdutoEspecifico"],"type":"object","properties":{"tipoProdutoEspecifico":{"$ref":"#/components/schemas/TipoProdutoEspecificoNotaFiscalModelEnum"}},"additionalProperties":false,"description":"Modelo abstrato para os Dados de Produto Específico do item da nota fiscal.\n\nO preenchimento dos campos abaixo é condicional ao TipoProdutoEspecifico informado.\n\n\n*************************************************************************\n\nMedicamento:\n\n• TipoProdutoEspecifico: Medicamento.\n\n• CodigoAnvisa (string): Código de Produto da ANVISA (13 dígitos).\n\n• MotivoIsensao (string): Texto explicativo do motivo da isenção da ANVISA.\n\n• ValorPmc (decimal): Preço Máximo ao Consumidor.\n\n \n*************************************************************************\n\nDicionário de Enumeradores:\n\n• TipoProdutoEspecificoNotaFiscalModelEnum:\n\n Medicamento = Produtos farmacêuticos e medicamentos."},"ItemNfceSimplificadaRastroInputModel":{"required":["dataFabricacao","dataValidade","numeroLote"],"type":"object","properties":{"numeroLote":{"maxLength":20,"minLength":1,"type":"string","description":"Número do lote do produto."},"quantidadeLote":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Quantidade do lote.","format":"double"},"dataFabricacao":{"minLength":1,"type":"string","description":"Data de fabricação do lote.","format":"date-time"},"dataValidade":{"minLength":1,"type":"string","description":"Data de validade do lote.","format":"date-time"}},"additionalProperties":false,"description":"Dados de rastreabilidade do item da NFe ."},"ItemNfceSimplificadaTribCbsInputModel":{"type":"object","properties":{"aliquotaCheiaCbs":{"minimum":0,"type":"number","description":"Alíquota cheia do CBS.","format":"double","nullable":true},"reducaoAliquotaCbs":{"maximum":100,"minimum":0,"type":"number","description":"Percentual de redução da alíquota do CBS.","format":"double","nullable":true},"percentualDiferimentoCbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota cheia de CBS.","format":"double","nullable":true}},"additionalProperties":false,"description":"Dados do CBS - Contribuição sobre Bens e Serviços na tributação do item da nota fiscal."},"ItemNfceSimplificadaTribCofinsInputModel":{"required":["cst"],"type":"object","properties":{"cst":{"$ref":"#/components/schemas/CstPisCofinsNfceModelEnum"},"aliquotaCofins":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota do Cofins em percentual.","format":"double","nullable":true},"aliquotaQuantidadeCofins":{"maximum":100,"minimum":0,"type":"number","description":"Valor da alíquota do Cofins quando quantidade.","format":"double","nullable":true}},"additionalProperties":false,"description":"Dados da tributação COFINS."},"ItemNfceSimplificadaTribIbsCbsInputModel":{"required":["cClassTrib","cst"],"type":"object","properties":{"cst":{"$ref":"#/components/schemas/CstIbsCbsNfceModelEnum"},"cClassTrib":{"maxLength":10,"minLength":1,"type":"string","description":"CClassTrib - Código de Classificação Tributária do IBS e CBS."},"ibsEstadual":{"$ref":"#/components/schemas/ItemNfceSimplificadaTribIbsEstInputModel"},"ibsMunicipal":{"$ref":"#/components/schemas/ItemNfceSimplificadaTribIbsMunInputModel"},"cbs":{"$ref":"#/components/schemas/ItemNfceSimplificadaTribCbsInputModel"}},"additionalProperties":false,"description":"Dados do IBS e CSB na tributação do item da nota fiscal. (Reforma Tributária)"},"ItemNfceSimplificadaTribIbsEstInputModel":{"type":"object","properties":{"aliquotaCheiaIbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota cheia de IBS de competência da UF.","format":"double","nullable":true},"reducaoAliquotaIbs":{"maximum":100,"minimum":0,"type":"number","description":"Percentual de redução da alíquota de IBS de competência da UF.","format":"double","nullable":true},"percentualDiferimentoIbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota cheia de IBS de competência da UF.","format":"double","nullable":true}},"additionalProperties":false,"description":"Dados do IBS - Imposto sobre Bens e Serviços na tributação do item da nota fiscal de competência da UF."},"ItemNfceSimplificadaTribIbsMunInputModel":{"type":"object","properties":{"aliquotaCheiaIbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota cheia de IBS de competência do município.","format":"double","nullable":true},"reducaoAliquotaIbs":{"maximum":100,"minimum":0,"type":"number","description":"Percentual de redução da alíquota de IBS de competência do município.","format":"double","nullable":true},"percentualDiferimentoIbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota cheia de IBS de competência do município.","format":"double","nullable":true}},"additionalProperties":false,"description":"Dados do IBS - Imposto sobre Bens e Serviços na tributação do item da nota fiscal de competência do município."},"ItemNfceSimplificadaTribIcmsInputModel":{"required":["cst"],"type":"object","properties":{"cst":{"$ref":"#/components/schemas/CstIcmsNfceModelEnum"}},"additionalProperties":false,"description":"Modelo abstrato para a Tributação de ICMS da nota fiscal.\n\nO preenchimento dos campos abaixo é condicional ao CST informado.\n\n\n*************************************************************************\n\nCST 00 - Tributado integralmente:\n\n• Cst: 00.\n\n• AliquotaIcms (decimal): Alíquota do imposto ICMS.\n\n• AliquotaFcp (decimal): Alíquota do FCP.\n\n \n*************************************************************************\n\nCST 20 - Tributado com redução de base de cálculo:\n\n• Cst: 20.\n\n• ReducaoBaseIcms (decimal): Percentual de redução de base ICMS.\n\n• AliquotaIcms (decimal): Alíquota do imposto ICMS.\n\n• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.\n\n• CodigoBeneficio (string): Código de benefício fiscal.\n\n• AliquotaFcp (decimal): Alíquota do FCP.\n\n \n*************************************************************************\n\nCST 40 e 41 - Isenta ou Não Tributada:\n\n• Cst: (40 ou 41).\n\n• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.\n\n• AliquotaDesoneracao (decimal): Alíquota aplicada para cálculo do valor de desoneração.\n\n• CodigoBeneficio (string): Código de benefício fiscal.\n\n \n*************************************************************************\n\nCST 60 - Cobrado anteriormente por substituição tributária:\n\n• Cst: 60.\n \n*************************************************************************\n\n\nDicionário de Enumeradores:\n\n• ModalidadeBaseIcmsNotaFiscalModelEnum:\n\n MargemValorAgregado = Margem Valor Agregado (%).\n\n PrecoPauta = Pauta (Valor).\n\n PrecoTabeladoMax = Preço Tabelado Máx. (valor).\n\n ValorDaOperacao = Valor da operação.\n\n\n• MotivoDesoneracaoNotaFiscalModelEnum:\n\n Taxi = Táxi.\n\n DeficienteFisico = Deficiente físico.\n\n ProdutorAgropecuario = Produtor agropecuário.\n\n FrotistaLocadora = Frotista/Locadora.\n\n DiplomaticoConsular = Diplomático/consular.\n\n UtilitariosMotocicletasAmazoniaOcidental = Utilitários produzidos na amazônia ocidental.\n\n SUFRAMA = SUFRAMA.\n\n VendaOrgaoPublico = Venda a órgãos públicos.\n\n Outros = Outros.\n\n DeficienteCondutor = Deficiente condutor.\n\n DeficienteNaoCondutor = Deficiente não condutor.\n\n OrgaoDeFomentoDesenvolvimentoAgropecuario = Órgão de fomento e desenvolvimento agropecuário."},"ItemNfceSimplificadaTribIcmssnInputModel":{"required":["csosn"],"type":"object","properties":{"csosn":{"$ref":"#/components/schemas/CsosnNfceModelEnum"}},"additionalProperties":false,"description":"Modelo abstrato para a Tributação de ICMSSN (Simples Nacional) da nota fiscal.\n\nO preenchimento dos campos abaixo é condicional ao CSOSN informado.\n\n\n*************************************************************************\n\nCSOSN 102 - Tributada pelo Simples Nacional sem permissão de crédito:\n\n• Csosn: 102.\n\n• Nota: Não exige campos adicionais de valores ou alíquotas.\n\n\n*************************************************************************\n\nCSOSN 103 - Isento:\n\n• Csosn: 103.\n\n• Nota: Não exige campos adicionais de valores ou alíquotas.\n\n \n*************************************************************************\n\nCSOSN 300 - Imune:\n\n• Csosn: 300.\n\n• Nota: Não exige campos adicionais de valores ou alíquotas.\n\n\n*************************************************************************\n\nCSOSN 400 - Não Tributada:\n\n• Csosn: 400.\n\n• Nota: Não exige campos adicionais de valores ou alíquotas.\n\n\n*************************************************************************\n\nCSOSN 500 - ICMS cobrado anteriormente por substituição tributária:\n\n• Csosn: 500."},"ItemNfceSimplificadaTribPisInputModel":{"required":["cst"],"type":"object","properties":{"cst":{"$ref":"#/components/schemas/CstPisCofinsNfceModelEnum"},"aliquotaPis":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota do PIS em percentual.","format":"double","nullable":true},"aliquotaQuantidadePis":{"maximum":100,"minimum":0,"type":"number","description":"Valor da alíquota do PIS quando quantidade.","format":"double","nullable":true}},"additionalProperties":false,"description":"Tributação de PIS."},"ItemNfceTributacaoCbsInputModel":{"type":"object","properties":{"aliquotaCheiaCbs":{"minimum":0,"type":"number","description":"Alíquota cheia do CBS.","format":"double","nullable":true},"reducaoAliquotaCbs":{"maximum":100,"minimum":0,"type":"number","description":"Percentual de redução da alíquota do CBS.","format":"double","nullable":true},"aliquotaEfetivaCbs":{"minimum":0,"type":"number","description":"Alíquota efetiva do CBS.","format":"double","nullable":true},"valorCbs":{"minimum":0,"type":"number","description":"Valor do CBS.","format":"double","nullable":true},"percentualDiferimentoCbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota cheia de CBS.","format":"double","nullable":true},"valorDiferimentoCbs":{"minimum":0,"type":"number","description":"Alíquota cheia de CBS.","format":"double","nullable":true}},"additionalProperties":false,"description":"Dados do CBS - Contribuição sobre Bens e Serviços na tributação do item da nota fiscal."},"ItemNfceTributacaoCofinsInputModel":{"required":["cst"],"type":"object","properties":{"cst":{"$ref":"#/components/schemas/CstPisCofinsNfceModelEnum"},"baseCofins":{"minimum":0,"type":"number","description":"Base de cálculo do Cofins.","format":"double","nullable":true},"aliquotaCofins":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota do Cofins em percentual.","format":"double","nullable":true},"baseQuantidadeCofins":{"minimum":0,"type":"number","description":"Base do Cofins quando quantidade.","format":"double","nullable":true},"aliquotaQuantidadeCofins":{"maximum":100,"minimum":0,"type":"number","description":"Valor da alíquota do Cofins quando quantidade.","format":"double","nullable":true},"valorCofins":{"minimum":0,"type":"number","description":"Valor do Cofins.","format":"double","nullable":true}},"additionalProperties":false,"description":"Dados da tributação COFINS."},"ItemNfceTributacaoIbsCbsInputModel":{"required":["cClassTrib","cst"],"type":"object","properties":{"cst":{"$ref":"#/components/schemas/CstIbsCbsNfceModelEnum"},"cClassTrib":{"maxLength":10,"minLength":1,"type":"string","description":"CClassTrib - Código de Classificação Tributária do IBS e CBS."},"baseIbs":{"type":"number","description":"Base IBS e CBS.","format":"double","nullable":true},"ibsEstadual":{"$ref":"#/components/schemas/ItemNfceTributacaoIbsEstadualInputModel"},"ibsMunicipal":{"$ref":"#/components/schemas/ItemNfceTributacaoIbsMunicipalInputModel"},"cbs":{"$ref":"#/components/schemas/ItemNfceTributacaoCbsInputModel"}},"additionalProperties":false,"description":"Dados do IBS e CSB na tributação do item da nota fiscal. (Reforma Tributária)"},"ItemNfceTributacaoIbsEstadualInputModel":{"type":"object","properties":{"aliquotaCheiaIbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota cheia de IBS de competência da UF.","format":"double","nullable":true},"reducaoAliquotaIbs":{"maximum":100,"minimum":0,"type":"number","description":"Percentual de redução da alíquota de IBS de competência da UF.","format":"double","nullable":true},"aliquotaEfetivaIbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota efetiva do IBS de competência da UF.","format":"double","nullable":true},"valorIbs":{"minimum":0,"type":"number","description":"Valor de IBS de competência da UF.","format":"double","nullable":true},"percentualDiferimentoIbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota cheia de IBS de competência da UF.","format":"double","nullable":true},"valorDiferimentoIbs":{"minimum":0,"type":"number","description":"Alíquota cheia de IBS de competência da UF.","format":"double","nullable":true}},"additionalProperties":false,"description":"Dados do IBS - Imposto sobre Bens e Serviços na tributação do item da nota fiscal de competência da UF."},"ItemNfceTributacaoIbsMunicipalInputModel":{"type":"object","properties":{"aliquotaCheiaIbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota cheia de IBS de competência do município.","format":"double","nullable":true},"reducaoAliquotaIbs":{"maximum":100,"minimum":0,"type":"number","description":"Percentual de redução da alíquota de IBS de competência do município.","format":"double","nullable":true},"aliquotaEfetivaIbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota efetiva do IBS de competência do município.","format":"double","nullable":true},"valorIbs":{"minimum":0,"type":"number","description":"Valor de IBS de competência do município.","format":"double","nullable":true},"percentualDiferimentoIbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota cheia de IBS de competência do município.","format":"double","nullable":true},"valorDiferimentoIbs":{"minimum":0,"type":"number","description":"Alíquota cheia de IBS de competência do município.","format":"double","nullable":true}},"additionalProperties":false,"description":"Dados do IBS - Imposto sobre Bens e Serviços na tributação do item da nota fiscal de competência do município."},"ItemNfceTributacaoIcmsInputModel":{"required":["cst"],"type":"object","properties":{"cst":{"$ref":"#/components/schemas/CstIcmsNfceModelEnum"}},"additionalProperties":false,"description":"Modelo abstrato para a Tributação de ICMS da nota fiscal.\n\nO preenchimento dos campos abaixo é condicional ao CST informado.\n\n\n*************************************************************************\n\nCST 00 - Tributado integralmente:\n\n• Cst: 00.\n\n• ModalidadeBaseIcms (Enum): Modalidade de determinação da base ICMS.\n\n• BaseIcms (decimal): Valor da base de cálculo do ICMS.\n\n• AliquotaIcms (decimal): Alíquota do imposto ICMS.\n\n• ValorIcms (decimal): Valor do ICMS resultante.\n\n• BaseFcp (decimal): Valor da base de cálculo do FCP.\n\n• AliquotaFcp (decimal): Alíquota do FCP.\n\n• ValorFcp (decimal): Valor do FCP resultante.\n\n \n*************************************************************************\n\nCST 20 - Tributado com redução de base de cálculo:\n\n• Cst: 20.\n\n• ModalidadeBaseIcms (Enum): Modalidade de determinação da base ICMS.\n\n• BaseIcms (decimal): Valor da base de cálculo do ICMS.\n\n• ReducaoBaseIcms (decimal): Percentual de redução de base ICMS.\n\n• AliquotaIcms (decimal): Alíquota do imposto ICMS.\n\n• ValorIcms (decimal): Valor do ICMS resultante.\n\n• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.\n\n• ValorIcmsDesonerado (decimal): Valor do ICMS desonerado.\n\n• CodigoBeneficio (string): Código de benefício fiscal.\n\n• BaseFcp (decimal): Base de cálculo do FCP.\n\n• AliquotaFcp (decimal): Alíquota do FCP.\n\n• ValorFcp (decimal): Valor do FCP resultante.\n\n \n*************************************************************************\n\nCST 40 e 41 - Isenta ou Não Tributada:\n\n• Cst: (40 ou 41).\n\n• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.\n\n• ValorIcmsDesonerado (decimal): Valor do ICMS desonerado.\n\n• CodigoBeneficio (string): Código de benefício fiscal.\n\n \n*************************************************************************\n\nCST 60 - Cobrado anteriormente por substituição tributária:\n\n• Cst: 60.\n \n*************************************************************************\n\n\nDicionário de Enumeradores:\n\n• ModalidadeBaseIcmsNotaFiscalModelEnum:\n\n MargemValorAgregado = Margem Valor Agregado (%).\n\n PrecoPauta = Pauta (Valor).\n\n PrecoTabeladoMax = Preço Tabelado Máx. (valor).\n\n ValorDaOperacao = Valor da operação.\n\n\n• MotivoDesoneracaoNotaFiscalModelEnum:\n\n Taxi = Táxi.\n\n DeficienteFisico = Deficiente físico.\n\n ProdutorAgropecuario = Produtor agropecuário.\n\n FrotistaLocadora = Frotista/Locadora.\n\n DiplomaticoConsular = Diplomático/consular.\n\n UtilitariosMotocicletasAmazoniaOcidental = Utilitários produzidos na amazônia ocidental.\n\n SUFRAMA = SUFRAMA.\n\n VendaOrgaoPublico = Venda a órgãos públicos.\n\n Outros = Outros.\n\n DeficienteCondutor = Deficiente condutor.\n\n DeficienteNaoCondutor = Deficiente não condutor.\n\n OrgaoDeFomentoDesenvolvimentoAgropecuario = Órgão de fomento e desenvolvimento agropecuário."},"ItemNfceTributacaoIcmssnInputModel":{"required":["csosn"],"type":"object","properties":{"csosn":{"$ref":"#/components/schemas/CsosnNfceModelEnum"}},"additionalProperties":false,"description":"Modelo abstrato para a Tributação de ICMSSN (Simples Nacional) da nota fiscal.\n\nO preenchimento dos campos abaixo é condicional ao CSOSN informado.\n\n\n*************************************************************************\n\nCSOSN 102 - Tributada pelo Simples Nacional sem permissão de crédito:\n\n• Csosn: 102.\n\n• Nota: Não exige campos adicionais de valores ou alíquotas.\n\n\n*************************************************************************\n\nCSOSN 103 - Isento:\n\n• Csosn: 103.\n\n• Nota: Não exige campos adicionais de valores ou alíquotas.\n\n \n*************************************************************************\n\nCSOSN 300 - Imune:\n\n• Csosn: 300.\n\n• Nota: Não exige campos adicionais de valores ou alíquotas.\n\n\n*************************************************************************\n\nCSOSN 400 - Não Tributada:\n\n• Csosn: 400.\n\n• Nota: Não exige campos adicionais de valores ou alíquotas.\n\n\n*************************************************************************\n\nCSOSN 500 - ICMS cobrado anteriormente por substituição tributária:\n\n• Csosn: 500."},"ItemNfceTributacaoPisInputModel":{"required":["cst"],"type":"object","properties":{"cst":{"$ref":"#/components/schemas/CstPisCofinsNfceModelEnum"},"basePis":{"minimum":0,"type":"number","description":"Base de cálculo do PIS.","format":"double","nullable":true},"aliquotaPis":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota do PIS em percentual.","format":"double","nullable":true},"baseQuantidadePis":{"minimum":0,"type":"number","description":"Base do pis quando quantidade.","format":"double","nullable":true},"aliquotaQuantidadePis":{"maximum":100,"minimum":0,"type":"number","description":"Valor da alíquota do PIS quando quantidade.","format":"double","nullable":true},"valorPis":{"minimum":0,"type":"number","description":"Valor do PIS.","format":"double","nullable":true}},"additionalProperties":false,"description":"Tributação de PIS."},"ItemNfeAutomaticaInputModel":{"required":["codigoInterno","descricao","origemMercadoria","unidade"],"type":"object","properties":{"codigoInterno":{"maxLength":60,"minLength":1,"type":"string","description":"Código interno do produto ou serviço no ERP."},"ean":{"type":"string","description":"EAN do produto.","nullable":true},"descricao":{"maxLength":120,"minLength":2,"type":"string","description":"Descrição do produto."},"origemMercadoria":{"$ref":"#/components/schemas/OrigemMercadoriaNotaFiscalModelEnum"},"fabricacaoPropria":{"type":"boolean","description":"Indica se o produto é de fabricação própria. (Default: false)","nullable":true},"unidade":{"maxLength":6,"minLength":1,"type":"string","description":"Unidade comercializada."},"quantidade":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Quantidade comercializada.","format":"double"},"valorUnitario":{"minimum":0,"type":"number","description":"Valor unitário do item.","format":"double"},"valorTotalBruto":{"minimum":0,"type":"number","description":"Valor total bruto.","format":"double"},"valorTotalFrete":{"minimum":0,"type":"number","description":"Valor total de frete do item.","format":"double","nullable":true},"valorTotalSeguro":{"minimum":0,"type":"number","description":"Valor total de seguro do item.","format":"double","nullable":true},"valorTotalDesconto":{"minimum":0,"type":"number","description":"Valor total de descontos do item.","format":"double","nullable":true},"valorTotalOutros":{"minimum":0,"type":"number","description":"Valor total de outras despesas do item.","format":"double","nullable":true},"itemCompoeTotalNota":{"type":"boolean","description":"Indicador de item compõe o total da nota.","nullable":true},"numeroPedidoCompra":{"type":"string","description":"Número do pedido de compra.","nullable":true},"itemPedidoCompra":{"type":"integer","description":"Item de pedido de compra.","format":"int32","nullable":true},"produtoEspecifico":{"$ref":"#/components/schemas/ItemNfeAutomaticaProdutoEspecificoInputModel"}},"additionalProperties":false,"description":"Dados do item da NFe Automática."},"ItemNfeAutomaticaProdutoEspecificoInputModel":{"required":["tipoProdutoEspecifico"],"type":"object","properties":{"tipoProdutoEspecifico":{"$ref":"#/components/schemas/TipoProdutoEspecificoNotaFiscalModelEnum"}},"additionalProperties":false,"description":"Modelo abstrato para os Dados de Produto Específico do item da nota fiscal.\n\nO preenchimento dos campos abaixo é condicional ao TipoProdutoEspecifico informado.\n\n\n*************************************************************************\n\nMedicamento:\n\n• TipoProdutoEspecifico: Medicamento.\n\n• CodigoAnvisa (string): Código de Produto da ANVISA (13 dígitos).\n\n• MotivoIsensao (string): Texto explicativo do motivo da isenção da ANVISA.\n\n• ValorPmc (decimal): Preço Máximo ao Consumidor.\n\n \n*************************************************************************\n\nDicionário de Enumeradores:\n\n• TipoProdutoEspecificoNotaFiscalModelEnum:\n\n Medicamento = Produtos farmacêuticos e medicamentos."},"ItemNfeDeclaracaoImportacaoAdicaoInputModel":{"required":["codigoFabricante","numeroAdicao","sequencial"],"type":"object","properties":{"numeroAdicao":{"minimum":0,"exclusiveMinimum":true,"type":"integer","description":"Numero da Adição.","format":"int32"},"sequencial":{"minimum":0,"exclusiveMinimum":true,"type":"integer","description":"Numero sequencial do item dentro da Adição.","format":"int32"},"codigoFabricante":{"maxLength":60,"minLength":1,"type":"string","description":"Código do fabricante estrangeiro."},"valorDesconto":{"type":"number","description":"Valor do desconto do item da DI – Adição.","format":"double","nullable":true},"numeroDrawback":{"type":"string","description":"Número do ato concessório de Drawback.","nullable":true}},"additionalProperties":false,"description":"Adições da declaração de importação do item da nota fiscal."},"ItemNfeDeclaracaoImportacaoInputModel":{"required":["adicoes","codigoExportador","dataDesembaraco","dataRegistro","localDesembaraco","numeroDi","tipoIntermedio","tipoViaTransporte","ufDesembaraco","valorAfrmm"],"type":"object","properties":{"numeroDi":{"maxLength":12,"minLength":1,"type":"string","description":"Número do Documento de Importação (DI, DSI, DIRE, ...)."},"dataRegistro":{"type":"string","description":"Data de Registro do documento.","format":"date","example":"2025-03-31"},"localDesembaraco":{"maxLength":60,"minLength":1,"type":"string","description":"Local de desembaraço."},"ufDesembaraco":{"$ref":"#/components/schemas/UfNotaFiscalModelEnum"},"dataDesembaraco":{"type":"string","description":"Data do Desembaraço Aduaneiro.","format":"date","example":"2025-03-31"},"tipoViaTransporte":{"$ref":"#/components/schemas/TipoViaTransporteNotaFiscalModelEnum"},"valorAfrmm":{"type":"number","description":"Valor da AFRMM - Adicional ao Frete para Renovação da Marinha Mercante.","format":"double"},"tipoIntermedio":{"$ref":"#/components/schemas/TipoIntermedioImportacaoNotaFiscalModelEnum"},"cnpjEncomendante":{"type":"string","description":"CNPJ do adquirente ou do encomendante.","nullable":true},"ufEncomendante":{"$ref":"#/components/schemas/UfExtNotaFiscalModelEnum"},"codigoExportador":{"maxLength":60,"minLength":1,"type":"string","description":"Código do Exportador."},"adicoes":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ItemNfeDeclaracaoImportacaoAdicaoInputModel"},"description":"Adições da declaração de importação do item da nota fiscal."}},"additionalProperties":false,"description":"Informações da declaração de importação do item da nota fiscal."},"ItemNfeExportacaoInputModel":{"required":["chaveNotaExportacaoIndireta","numeroDrawback","numeroRegistroExportacaoIndireta","quantidadeExportacaoIndireta"],"type":"object","properties":{"numeroDrawback":{"maxLength":11,"minLength":1,"type":"string","description":"Número do ato concessório de Drawback."},"numeroRegistroExportacaoIndireta":{"maxLength":12,"minLength":1,"type":"string","description":"Número do Registro de Exportação."},"chaveNotaExportacaoIndireta":{"minLength":1,"pattern":"^\\d{44}$","type":"string","description":"Chave de Acesso da NF-e recebida para exportação."},"quantidadeExportacaoIndireta":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Quantidade do item realmente exportado.","format":"double"}},"additionalProperties":false,"description":"Dados de exportação do item da nota fiscal."},"ItemNfeImpostoDevolvidoInputModel":{"required":["percentualMercadoriaDevolvida","valorIpiDevolvido"],"type":"object","properties":{"percentualMercadoriaDevolvida":{"maximum":100,"minimum":0,"type":"number","description":"Percentual de mercadoria devolvida.","format":"double"},"valorIpiDevolvido":{"minimum":0,"type":"number","description":"Valor do IPI devolvido.","format":"double"}},"additionalProperties":false,"description":"Dados do imposto devolvido do item da nota fiscal."},"ItemNfeImpostoImportacaoInputModel":{"required":["baseImpostoImportacao","despesaAduaneira","valorImpostoImportacao","valorIof"],"type":"object","properties":{"baseImpostoImportacao":{"minimum":0,"type":"number","description":"Base do imposto de importação.","format":"double"},"despesaAduaneira":{"minimum":0,"type":"number","description":"Despesa aduaneira.","format":"double"},"valorImpostoImportacao":{"minimum":0,"type":"number","description":"Valor do imposto de importação.","format":"double"},"valorIof":{"minimum":0,"type":"number","description":"Valor do IOF.","format":"double"}},"additionalProperties":false,"description":"Dados do imposto de importação."},"ItemNfeImpostoInputModel":{"required":["cofins","pis"],"type":"object","properties":{"icms":{"$ref":"#/components/schemas/ItemNfeTributacaoIcmsInputModel"},"icmssn":{"$ref":"#/components/schemas/ItemNfeTributacaoIcmssnInputModel"},"icmsUfDest":{"$ref":"#/components/schemas/ItemNfeTributacaoIcmsUfDestInputModel"},"issqn":{"$ref":"#/components/schemas/ItemNfeTributacaoIssqnInputModel"},"ipi":{"$ref":"#/components/schemas/ItemNfeTributacaoIpiInputModel"},"pis":{"$ref":"#/components/schemas/ItemNfeTributacaoPisInputModel"},"cofins":{"$ref":"#/components/schemas/ItemNfeTributacaoCofinsInputModel"},"impostoImportacao":{"$ref":"#/components/schemas/ItemNfeImpostoImportacaoInputModel"},"ibsCbs":{"$ref":"#/components/schemas/ItemNfeTributacaoIbsCbsInputModel"}},"additionalProperties":false,"description":"Dados do imposto do item da nota fiscal."},"ItemNfeInputModel":{"required":["cfop","codigoInterno","descricao","impostos","ncm","unidade"],"type":"object","properties":{"tipoItem":{"$ref":"#/components/schemas/TipoItemNotaModelEnum"},"codigoInterno":{"maxLength":60,"minLength":1,"type":"string","description":"Código interno do produto ou serviço no ERP."},"ean":{"type":"string","description":"EAN do produto.","nullable":true},"descricao":{"maxLength":120,"minLength":2,"type":"string","description":"Descrição do produto."},"origemMercadoria":{"$ref":"#/components/schemas/OrigemMercadoriaNotaFiscalModelEnum"},"ncm":{"minLength":1,"pattern":"^\\d{8}$","type":"string","description":"NCM do produto. Lista de NCMs válidos em api/v1/RecursosAdicionais/Ncm/Listar."},"cest":{"type":"string","description":"Código Especificador da Substituição Tributária (CEST).\n\nO CEST é utilizado para identificar mercadorias e bens passíveis de sujeição aos regimes de \nsubstituição tributária e de antecipação do recolhimento do imposto.\n🔍 DICA DE BUSCA: Para obter uma lista de códigos válidos, utilize o endpoint \n`api/v1/RecursosAdicionais/Cest/Listar`. Além disso, ao consultar o detalhe de um NCM, \no sistema retornará automaticamente os CESTs associados àquela classificação fiscal.","nullable":true},"nve":{"type":"string","description":"Codificação NVE - Nomenclatura de Valor Aduaneiro e Estatística. (Opcional)","nullable":true},"exTipi":{"type":"integer","description":"Extensão da TIPI.","format":"int32","nullable":true},"cfop":{"minLength":1,"pattern":"^\\d{4}$","type":"string","description":"CFOP do item. Lista de CFOPs válidos em api/v1/RecursosAdicionais/Cfop/Listar."},"unidade":{"maxLength":6,"minLength":1,"type":"string","description":"Unidade comercializada."},"quantidade":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Quantidade comercializada.","format":"double"},"valorUnitario":{"minimum":0,"type":"number","description":"Valor unitário do item.","format":"double"},"valorTotalBruto":{"minimum":0,"type":"number","description":"Valor total bruto.","format":"double"},"valorTotalFrete":{"minimum":0,"type":"number","description":"Valor total de frete do item.","format":"double","nullable":true},"valorTotalSeguro":{"minimum":0,"type":"number","description":"Valor total de seguro do item.","format":"double","nullable":true},"valorTotalDesconto":{"minimum":0,"type":"number","description":"Valor total de descontos do item.","format":"double","nullable":true},"valorTotalOutros":{"minimum":0,"type":"number","description":"Valor total de outras despesas do item.","format":"double","nullable":true},"itemCompoeTotalNota":{"type":"boolean","description":"Indicador de item compõe o total da nota.","nullable":true},"numeroPedidoCompra":{"type":"string","description":"Número do pedido de compra.","nullable":true},"itemPedidoCompra":{"type":"integer","description":"Item de pedido de compra.","format":"int32","nullable":true},"impostos":{"$ref":"#/components/schemas/ItemNfeImpostoInputModel"},"impostoDevolvido":{"$ref":"#/components/schemas/ItemNfeImpostoDevolvidoInputModel"},"declaracoesImportacao":{"type":"array","items":{"$ref":"#/components/schemas/ItemNfeDeclaracaoImportacaoInputModel"},"description":"Lista de declaração de importação do item.","nullable":true},"exportacao":{"$ref":"#/components/schemas/ItemNfeExportacaoInputModel"},"produtoEspecifico":{"$ref":"#/components/schemas/ItemNfeProdutoEspecificoInputModel"}},"additionalProperties":false,"description":"Dados do item da NFe."},"ItemNfeProdutoEspecificoInputModel":{"required":["tipoProdutoEspecifico"],"type":"object","properties":{"tipoProdutoEspecifico":{"$ref":"#/components/schemas/TipoProdutoEspecificoNotaFiscalModelEnum"}},"additionalProperties":false,"description":"Modelo abstrato para os Dados de Produto Específico do item da nota fiscal.\n\nO preenchimento dos campos abaixo é condicional ao TipoProdutoEspecifico informado.\n\n\n*************************************************************************\n\nMedicamento:\n\n• TipoProdutoEspecifico: Medicamento.\n\n• CodigoAnvisa (string): Código de Produto da ANVISA (13 dígitos).\n\n• MotivoIsensao (string): Texto explicativo do motivo da isenção da ANVISA.\n\n• ValorPmc (decimal): Preço Máximo ao Consumidor.\n\n \n*************************************************************************\n\nDicionário de Enumeradores:\n\n• TipoProdutoEspecificoNotaFiscalModelEnum:\n\n Medicamento = Produtos farmacêuticos e medicamentos."},"ItemNfeRastroAutomaticaInputModel":{"required":["dataFabricacao","dataValidade","numeroLote"],"type":"object","properties":{"numeroLote":{"maxLength":20,"minLength":1,"type":"string","description":"Número do lote do produto."},"quantidadeLote":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Quantidade do lote.","format":"double"},"dataFabricacao":{"minLength":1,"type":"string","description":"Data de fabricação do lote.","format":"date-time"},"dataValidade":{"minLength":1,"type":"string","description":"Data de validade do lote.","format":"date-time"}},"additionalProperties":false,"description":"Dados de rastreabilidade do item da NFe Automática."},"ItemNfeSimplificadaExportacaoInputModel":{"required":["chaveNotaExportacaoIndireta","numeroDrawback","numeroRegistroExportacaoIndireta","quantidadeExportacaoIndireta"],"type":"object","properties":{"numeroDrawback":{"maxLength":11,"minLength":1,"type":"string","description":"Número do ato concessório de Drawback."},"numeroRegistroExportacaoIndireta":{"maxLength":12,"minLength":1,"type":"string","description":"Número do Registro de Exportação."},"chaveNotaExportacaoIndireta":{"minLength":1,"pattern":"^\\d{44}$","type":"string","description":"Chave de Acesso da NF-e recebida para exportação."},"quantidadeExportacaoIndireta":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Quantidade do item realmente exportado.","format":"double"}},"additionalProperties":false,"description":"Dados de exportação do item da nota fiscal."},"ItemNfeSimplificadaImpostoInputModel":{"required":["cofins","pis"],"type":"object","properties":{"icms":{"$ref":"#/components/schemas/ItemNfeSimplificadaTribIcmsInputModel"},"icmssn":{"$ref":"#/components/schemas/ItemNfeSimplificadaTribIcmssnInputModel"},"icmsUfDest":{"$ref":"#/components/schemas/ItemNfeSimplificadaTribIcmsUfDestInputModel"},"issqn":{"$ref":"#/components/schemas/ItemNfeSimplificadaTribIssqnInputModel"},"ipi":{"$ref":"#/components/schemas/ItemNfeSimplificadaTribIpiInputModel"},"pis":{"$ref":"#/components/schemas/ItemNfeSimplificadaTribPisInputModel"},"cofins":{"$ref":"#/components/schemas/ItemNfeSimplificadaTribCofinsInputModel"},"ibsCbs":{"$ref":"#/components/schemas/ItemNfeSimplificadaTribIbsCbsInputModel"}},"additionalProperties":false,"description":"Dados do imposto do item da nota fiscal."},"ItemNfeSimplificadaInputModel":{"required":["cfop","codigoInterno","descricao","impostos","ncm","unidade"],"type":"object","properties":{"tipoItem":{"$ref":"#/components/schemas/TipoItemNotaModelEnum"},"codigoInterno":{"maxLength":60,"minLength":1,"type":"string","description":"Código interno do produto ou serviço no ERP."},"ean":{"type":"string","description":"EAN do produto.","nullable":true},"descricao":{"maxLength":120,"minLength":2,"type":"string","description":"Descrição do produto."},"origemMercadoria":{"$ref":"#/components/schemas/OrigemMercadoriaNotaFiscalModelEnum"},"ncm":{"minLength":1,"pattern":"^\\d{8}$","type":"string","description":"NCM do produto. Lista de NCMs válidos em api/v1/RecursosAdicionais/Ncm/Listar."},"cest":{"type":"string","description":"Código Especificador da Substituição Tributária (CEST).\n\nO CEST é utilizado para identificar mercadorias e bens passíveis de sujeição aos regimes de \nsubstituição tributária e de antecipação do recolhimento do imposto.\n🔍 DICA DE BUSCA: Para obter uma lista de códigos válidos, utilize o endpoint \n`api/v1/RecursosAdicionais/Cest/Listar`. Além disso, ao consultar o detalhe de um NCM, \no sistema retornará automaticamente os CESTs associados àquela classificação fiscal.","nullable":true},"nve":{"type":"string","description":"Codificação NVE - Nomenclatura de Valor Aduaneiro e Estatística. (Opcional)","nullable":true},"exTipi":{"type":"integer","description":"Extensão da TIPI.","format":"int32","nullable":true},"cfop":{"minLength":1,"pattern":"^\\d{4}$","type":"string","description":"CFOP do item. Lista de CFOPs válidos em api/v1/RecursosAdicionais/Cfop/Listar."},"unidade":{"maxLength":6,"minLength":1,"type":"string","description":"Unidade comercializada."},"quantidade":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Quantidade comercializada.","format":"double"},"valorUnitario":{"minimum":0,"type":"number","description":"Valor unitário do item.","format":"double"},"valorTotalBruto":{"minimum":0,"type":"number","description":"Valor total bruto.","format":"double"},"valorTotalFrete":{"minimum":0,"type":"number","description":"Valor total de frete do item.","format":"double","nullable":true},"valorTotalSeguro":{"minimum":0,"type":"number","description":"Valor total de seguro do item.","format":"double","nullable":true},"valorTotalDesconto":{"minimum":0,"type":"number","description":"Valor total de descontos do item.","format":"double","nullable":true},"valorTotalOutros":{"minimum":0,"type":"number","description":"Valor total de outras despesas do item.","format":"double","nullable":true},"itemCompoeTotalNota":{"type":"boolean","description":"Indicador de item compõe o total da nota.","nullable":true},"numeroPedidoCompra":{"type":"string","description":"Número do pedido de compra.","nullable":true},"itemPedidoCompra":{"type":"integer","description":"Item de pedido de compra.","format":"int32","nullable":true},"impostos":{"$ref":"#/components/schemas/ItemNfeSimplificadaImpostoInputModel"},"exportacao":{"$ref":"#/components/schemas/ItemNfeSimplificadaExportacaoInputModel"},"produtoEspecifico":{"$ref":"#/components/schemas/ItemNfeSimplificadaProdEspInputModel"}},"additionalProperties":false,"description":"Dados do item da NFe."},"ItemNfeSimplificadaProdEspInputModel":{"required":["tipoProdutoEspecifico"],"type":"object","properties":{"tipoProdutoEspecifico":{"$ref":"#/components/schemas/TipoProdutoEspecificoNotaFiscalModelEnum"}},"additionalProperties":false,"description":"Modelo abstrato para os Dados de Produto Específico do item da nota fiscal.\n\nO preenchimento dos campos abaixo é condicional ao TipoProdutoEspecifico informado.\n\n\n*************************************************************************\n\nMedicamento:\n\n• TipoProdutoEspecifico: Medicamento.\n\n• CodigoAnvisa (string): Código de Produto da ANVISA (13 dígitos).\n\n• MotivoIsensao (string): Texto explicativo do motivo da isenção da ANVISA.\n\n• ValorPmc (decimal): Preço Máximo ao Consumidor.\n\n \n*************************************************************************\n\nDicionário de Enumeradores:\n\n• TipoProdutoEspecificoNotaFiscalModelEnum:\n\n Medicamento = Produtos farmacêuticos e medicamentos."},"ItemNfeSimplificadaTribCbsInputModel":{"type":"object","properties":{"aliquotaCheiaCbs":{"minimum":0,"type":"number","description":"Alíquota cheia do CBS.","format":"double","nullable":true},"reducaoAliquotaCbs":{"maximum":100,"minimum":0,"type":"number","description":"Percentual de redução da alíquota do CBS.","format":"double","nullable":true},"percentualDiferimentoCbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota cheia de CBS.","format":"double","nullable":true}},"additionalProperties":false,"description":"Dados do CBS - Contribuição sobre Bens e Serviços na tributação do item da nota fiscal."},"ItemNfeSimplificadaTribCofinsInputModel":{"required":["cst"],"type":"object","properties":{"cst":{"$ref":"#/components/schemas/CstPisCofinsNfeModelEnum"},"aliquotaCofins":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota do Cofins em percentual.","format":"double","nullable":true},"aliquotaQuantidadeCofins":{"maximum":100,"minimum":0,"type":"number","description":"Valor da alíquota do Cofins quando quantidade.","format":"double","nullable":true}},"additionalProperties":false,"description":"Dados da tributação COFINS."},"ItemNfeSimplificadaTribIbsCbsInputModel":{"required":["cClassTrib","cst"],"type":"object","properties":{"cst":{"$ref":"#/components/schemas/CstIbsCbsNfeModelEnum"},"cClassTrib":{"maxLength":10,"minLength":1,"type":"string","description":"CClassTrib - Código de Classificação Tributária do IBS e CBS."},"ibsEstadual":{"$ref":"#/components/schemas/ItemNfeSimplificadaTribIbsEstInputModel"},"ibsMunicipal":{"$ref":"#/components/schemas/ItemNfeSimplificadaTribIbsMunInputModel"},"cbs":{"$ref":"#/components/schemas/ItemNfeSimplificadaTribCbsInputModel"}},"additionalProperties":false,"description":"Dados do IBS e CSB na tributação do item da nota fiscal. (Reforma Tributária)"},"ItemNfeSimplificadaTribIbsEstInputModel":{"type":"object","properties":{"aliquotaCheiaIbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota cheia de IBS de competência da UF.","format":"double","nullable":true},"reducaoAliquotaIbs":{"maximum":100,"minimum":0,"type":"number","description":"Percentual de redução da alíquota de IBS de competência da UF.","format":"double","nullable":true},"percentualDiferimentoIbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota cheia de IBS de competência da UF.","format":"double","nullable":true}},"additionalProperties":false,"description":"Dados do IBS - Imposto sobre Bens e Serviços na tributação do item da nota fiscal de competência da UF."},"ItemNfeSimplificadaTribIbsMunInputModel":{"type":"object","properties":{"aliquotaCheiaIbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota cheia de IBS de competência do município.","format":"double","nullable":true},"reducaoAliquotaIbs":{"maximum":100,"minimum":0,"type":"number","description":"Percentual de redução da alíquota de IBS de competência do município.","format":"double","nullable":true},"percentualDiferimentoIbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota cheia de IBS de competência do município.","format":"double","nullable":true}},"additionalProperties":false,"description":"Dados do IBS - Imposto sobre Bens e Serviços na tributação do item da nota fiscal de competência do município."},"ItemNfeSimplificadaTribIcmsInputModel":{"required":["cst"],"type":"object","properties":{"cst":{"$ref":"#/components/schemas/CstIcmsNfeModelEnum"}},"additionalProperties":false,"description":"Modelo abstrato para a Tributação de ICMS da nota fiscal.\n\nO preenchimento dos campos abaixo é condicional ao CST informado.\n\n\n*************************************************************************\n\nCST 00 - Tributado integralmente:\n\n• Cst: 00.\n\n• AliquotaIcms (decimal): Alíquota do imposto ICMS.\n\n• AliquotaFcp (decimal): Alíquota do FCP.\n\n\n*************************************************************************\n\nCST 02 - Monofásica sobre Combustíveis:\n\n• Cst: 02.\n\n• AliquotaQuantidade (decimal): Alíquota ad rem do imposto (valor por quantidade).\n\n\n*************************************************************************\n\nCST 10 - Tributada com cobrança de ICMS ST:\n\n• Cst: 10.\n\n• AliquotaIcms (decimal): Alíquota do ICMS próprio.\n\n• Mva (decimal): Percentual da margem de valor adicionado (MVA).\n\n• ReducaoBaseSt (decimal): Percentual de redução de base ICMS ST.\n\n• AliquotaIcmsDeducaoSt (decimal): Alíquota para dedução do ICMS no cálculo do ICMS ST (Utilizada para calcular o valor a ser deduzido do ICMS ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaSt (decimal): Alíquota do imposto ICMS ST.\n\n• AliquotaFcp (decimal): Alíquota do FCP próprio.\n\n• AliquotaFcpDeducaoSt (decimal): Alíquota para dedução do FCP no cálculo do FCP ST (Utilizada para calcular o valor a ser deduzido do FCP ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaFcpSt (decimal): Alíquota do FCP ST.\n\n\n*************************************************************************\n\nCST 15 - Monofásica com retenção sobre Combustíveis:\n\n• Cst: 15.\n\n• AliquotaQuantidade (decimal): Alíquota ad rem do imposto (própria).\n\n• AliquotaRetencaoQuantidade (decimal): Alíquota ad rem do imposto retido.\n\n\n*************************************************************************\n\nCST 20 - Tributado com redução de base de cálculo:\n\n• Cst: 20.\n\n• ReducaoBaseIcms (decimal): Percentual de redução de base ICMS.\n\n• AliquotaIcms (decimal): Alíquota do imposto ICMS.\n\n• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.\n\n• DesoneracaoDeduzValorItem (boleano): Indica se a desoneração está deduzindo no valor do item.\n\n• CodigoBeneficio (string): Código de benefício fiscal.\n\n• AliquotaFcp (decimal): Alíquota do FCP.\n\n\n*************************************************************************\n\nCST 30 - Isenta/Não Tributada com cobrança de ICMS ST:\n\n• Cst: 30.\n\n• Mva (decimal): Percentual de MVA ST.\n\n• ReducaoBaseSt (decimal): Percentual de redução de base ST.\n\n• AliquotaIcmsDeducaoSt (decimal): Alíquota para dedução do ICMS no cálculo do ICMS ST (Utilizada para calcular o valor a ser deduzido do ICMS ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaSt (decimal): Alíquota do imposto ICMS ST.\n\n• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.\n\n• AliquotaDesoneracao (decimal): Alíquota aplicada para cálculo do valor de desoneração.\n\n• DesoneracaoDeduzValorItem (boleano): Indica se a desoneração está deduzindo no valor do item.\n\n• CodigoBeneficio (string): Código de benefício fiscal.\n\n• AliquotaFcpDeducaoSt (decimal): Alíquota para dedução do FCP no cálculo do FCP ST (Utilizada para calcular o valor a ser deduzido do FCP ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaFcpSt (decimal): Alíquota do FCP ST.\n\n\n*************************************************************************\n\nCST 40, 41 e 50 - Isenta, Não Tributada ou Suspensão:\n\n• Cst: (40, 41 ou 50).\n\n• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.\n\n• AliquotaDesoneracao (decimal): Alíquota aplicada para cálculo do valor de desoneração.\n\n• DesoneracaoDeduzValorItem (boleano): Indica se a desoneração está deduzindo no valor do item.\n\n• CodigoBeneficio (string): Código de benefício fiscal.\n\n\n*************************************************************************\n\nCST 51 - Tributação com Diferimento:\n\n• Cst: 51.\n\n• ModalidadeBaseIcms (Enum): Modalidade de determinação da base ICMS.\n\n• AliquotaIcms (decimal): Alíquota do imposto ICMS.\n\n• PercentualDiferimento (decimal): Percentual do diferimento aplicado.\n\n• AliquotaFcp (decimal): Alíquota do FCP.\n\n\n*************************************************************************\n\nCST 53 - Monofásica sobre Combustíveis com Diferimento:\n\n• Cst: 53.\n\n• AliquotaQuantidadeDiferida (decimal): Alíquota ad rem diferida.\n\n\n*************************************************************************\n\nCST 60 - Cobrado anteriormente por substituição tributária:\n\n• Cst: 60.\n\n• BaseIcmsRetidoAnteriormente (decimal): Base de ICMS retido anteriormente.\n\n• AliquotaRetidoAnteriormente (decimal): Alíquota de ICMS retido anteriormente.\n\n• ValorIcmsProprioSubstituto (decimal): Valor do ICMS próprio do Substituto.\n\n• ValorIcmsRetidoAnteriormente (decimal): Valor do ICMS retido anteriormente.\n\n• BaseFcpRetidoAnteriormente (decimal): Base de FCP retido anteriormente.\n\n• AliquotaFcpRetidoAnteriormente (decimal): Alíquota de FCP retido anteriormente.\n\n• ValorFcpRetidoAnteriormente (decimal): Valor de FCP retido anteriormente.\n\n• PercentualReducaoBaseEfetivaIcmsRetido (decimal): Percentual de redução da base de ICMS efetiva se ouvesse a cobrança normal do ICMS.\n\n• AliquotaEfetivaIcmsRetido (decimal): Alíquota de ICMS efetivo se ouvesse a cobrança normal do ICMS.\n\n\n*************************************************************************\n\nCST 61 - Monofásica sobre Combustíveis cobrada anteriormente:\n\n• Cst: 61.\n\n• AliquotaQuantidadeRetida (decimal): Alíquota ad rem retida anteriormente.\n\n\n*************************************************************************\n\nCST 70 - Redução de base e cobrança de ICMS ST:\n\n• Cst: 70.\n\n• ReducaoBaseIcms (decimal): Percentual de redução de base própria.\n\n• AliquotaIcms (decimal): Alíquota do ICMS próprio.\n\n• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.\n\n• AliquotaDesoneracao (decimal): Alíquota aplicada para cálculo do valor de desoneração.\n\n• DesoneracaoDeduzValorItem (boleano): Indica se a desoneração está deduzindo no valor do item.\n\n• CodigoBeneficio (string): Código de benefício fiscal.\n\n• Mva (decimal): Percentual de MVA ST.\n\n• ReducaoBaseSt (decimal): Percentual de redução de base ST.\n\n• AliquotaIcmsDeducaoSt (decimal): Alíquota para dedução do ICMS no cálculo do ICMS ST (Utilizada para calcular o valor a ser deduzido do ICMS ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaSt (decimal): Alíquota do imposto ICMS ST.\n\n• AliquotaFcp (decimal): Alíquota do FCP próprio.\n\n• AliquotaFcpDeducaoSt (decimal): Alíquota para dedução do FCP no cálculo do FCP ST (Utilizada para calcular o valor a ser deduzido do FCP ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaFcpSt (decimal): Alíquota do FCP ST.\n\n\n*************************************************************************\n\nCST 90 - Outros:\n\n• Cst: 90.\n\n• ModalidadeBaseIcms (Enum): Modalidade de determinação da base ICMS.\n\n• BaseIcms (decimal): Valor da base de cálculo própria.\n\n• ReducaoBaseIcms (decimal): Percentual de redução de base própria.\n\n• AliquotaIcms (decimal): Alíquota do imposto próprio.\n\n• ValorIcms (decimal): Valor do ICMS próprio resultante.\n\n• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.\n\n• AliquotaDesoneracao (decimal): Alíquota aplicada para cálculo do valor de desoneração.\n\n• ValorIcmsDesonerado (decimal): Valor do ICMS desonerado.\n\n• ModalidadeBaseSt (Enum): Modalidade de determinação da base ST.\n\n• Mva (decimal): Percentual de MVA ST.\n\n• ReducaoBaseSt (decimal): Percentual de redução de base ST.\n\n• BaseSt (decimal): Valor da base de cálculo do ICMS ST.\n\n• AliquotaIcmsDeducaoSt (decimal): Alíquota para dedução do ICMS no cálculo do ICMS ST (Utilizada para calcular o valor a ser deduzido do ICMS ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaSt (decimal): Alíquota do imposto ICMS ST.\n\n• ValorSt (decimal): Valor do ICMS ST resultante.\n\n• BaseFcp (decimal): Base de cálculo do FCP próprio.\n\n• AliquotaFcp (decimal): Alíquota do FCP próprio.\n\n• ValorFcp (decimal): Valor do FCP próprio.\n\n• BaseFcpSt (decimal): Base de cálculo do FCP ST.\n\n• AliquotaFcpDeducaoSt (decimal): Alíquota para dedução do FCP no cálculo do FCP ST (Utilizada para calcular o valor a ser deduzido do FCP ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaFcpSt (decimal): Alíquota do FCP ST.\n\n• ValorFcpSt (decimal): Valor do FCP ST resultante.\n\n*************************************************************************\n\n\nDicionário de Enumeradores:\n\n• ModalidadeBaseIcmsNotaFiscalModelEnum:\n\n MargemValorAgregado = Margem Valor Agregado (%).\n\n PrecoPauta = Pauta (Valor).\n\n PrecoTabeladoMax = Preço Tabelado Máx. (valor).\n\n ValorDaOperacao = Valor da operação.\n\n\n• ModalidadeBaseStNotaFiscalModelEnum:\n\n PrecoTabeladoMaximoSugerido = Preço tabelado ou máximo sugerido.\n\n ListaNegativa = Lista Negativa (valor).\n\n ListaPositiva = Lista Positiva (valor).\n\n ListaNeutra = Lista Neutra (valor).\n\n MargemValorAgregado = Margem Valor Agregado (%).\n\n PrecoPauta = Pauta (valor).\n\n\n• MotivoDesoneracaoNotaFiscalModelEnum:\n\n Taxi = Táxi.\n\n DeficienteFisico = Deficiente físico.\n\n ProdutorAgropecuario = Produtor agropecuário.\n\n FrotistaLocadora = Frotista/Locadora.\n\n DiplomaticoConsular = Diplomático/consular.\n\n UtilitariosMotocicletasAmazoniaOcidental = Utilitários produzidos na amazônia ocidental.\n\n SUFRAMA = SUFRAMA.\n\n VendaOrgaoPublico = Venda a órgãos públicos.\n\n Outros = Outros.\n\n DeficienteCondutor = Deficiente condutor.\n\n DeficienteNaoCondutor = Deficiente não condutor.\n\n OrgaoDeFomentoDesenvolvimentoAgropecuario = Órgão de fomento e desenvolvimento agropecuário."},"ItemNfeSimplificadaTribIcmsUfDestInputModel":{"required":["aliquotaFcpInternaUfDestino","aliquotaInternaUfDestino"],"type":"object","properties":{"aliquotaInternaUfDestino":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota de ICMS interna na UF de destino.","format":"double"},"aliquotaFcpInternaUfDestino":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota de FCP interna na UF de destino.","format":"double"}},"additionalProperties":false,"description":"Informação do ICMS Interestadual destinado a consumidor final em outra UF."},"ItemNfeSimplificadaTribIcmssnInputModel":{"required":["csosn"],"type":"object","properties":{"csosn":{"$ref":"#/components/schemas/CsosnNfeModelEnum"}},"additionalProperties":false,"description":"Modelo abstrato para a Tributação de ICMSSN (Simples Nacional) da nota fiscal.\n\nO preenchimento dos campos abaixo é condicional ao CSOSN informado.\n\n\n*************************************************************************\n\nCSOSN 101 - Tributada pelo Simples Nacional com permissão de crédito:\n\n• Csosn: 101.\n\n• AliquotaCreditoSimples (decimal): Alíquota de crédito do simples nacional.\n\n\n*************************************************************************\n\nCSOSN 102 - Tributada pelo Simples Nacional sem permissão de crédito:\n\n• Csosn: 102.\n\n• Nota: Não exige campos adicionais de valores ou alíquotas.\n\n\n*************************************************************************\n\nCSOSN 103 - Isento:\n\n• Csosn: 103.\n\n• Nota: Não exige campos adicionais de valores ou alíquotas.\n\n\n*************************************************************************\n\nCSOSN 201 - Tributada pelo Simples com permissão de crédito e cobrança de ICMS ST:\n\n• Csosn: 201.\n\n• AliquotaCreditoSimples (decimal): Alíquota de crédito do simples nacional.\n\n• Mva (decimal): Percentual de MVA.\n\n• ReducaoBaseSt (decimal): Percentual de redução de base ICMS ST.\n\n• AliquotaIcmsDeducaoSt (decimal): Alíquota para dedução do ICMS no cálculo do ICMS ST (Utilizada para calcular o valor a ser deduzido do ICMS ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaSt (decimal): Alíquota de ICMS ST.\n\n• AliquotaFcpDeducaoSt (decimal): Alíquota para dedução do FCP no cálculo do FCP ST (Utilizada para calcular o valor a ser deduzido do FCP ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaFcpSt (decimal): Alíquota de FCP ST.\n\n\n*************************************************************************\n\nCSOSN 202 - Tributada pelo Simples sem permissão de crédito com cobrança de ST:\n\n• Csosn: 202.\n\n• Mva (decimal): Percentual de MVA.\n\n• ReducaoBaseSt (decimal): Percentual de redução de base ICMS ST.\n\n• AliquotaIcmsDeducaoSt (decimal): Alíquota para dedução do ICMS no cálculo do ICMS ST (Utilizada para calcular o valor a ser deduzido do ICMS ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaSt (decimal): Alíquota de ICMS ST.\n\n• AliquotaFcpDeducaoSt (decimal): Alíquota para dedução do FCP no cálculo do FCP ST (Utilizada para calcular o valor a ser deduzido do FCP ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaFcpSt (decimal): Alíquota de FCP ST.\n\n\n*************************************************************************\n\nCSOSN 203 - Isento com ST:\n\n• Csosn: 203.\n\n• Mva (decimal): Percentual de MVA.\n\n• ReducaoBaseSt (decimal): Percentual de redução de base ICMS ST.\n\n• AliquotaIcmsDeducaoSt (decimal): Alíquota para dedução do ICMS no cálculo do ICMS ST (Utilizada para calcular o valor a ser deduzido do ICMS ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaSt (decimal): Alíquota de ICMS ST.\n\n• AliquotaFcpDeducaoSt (decimal): Alíquota para dedução do FCP no cálculo do FCP ST (Utilizada para calcular o valor a ser deduzido do FCP ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaFcpSt (decimal): Alíquota de FCP ST.\n\n\n*************************************************************************\n\nCSOSN 300 - Imune:\n\n• Csosn: 300.\n\n• Nota: Não exige campos adicionais de valores ou alíquotas.\n\n\n*************************************************************************\n\nCSOSN 400 - Não Tributada:\n\n• Csosn: 400.\n\n• Nota: Não exige campos adicionais de valores ou alíquotas.\n\n\n*************************************************************************\n\nCSOSN 500 - ICMS cobrado anteriormente por substituição tributária:\n\n• Csosn: 500.\n\n• BaseIcmsRetidoAnteriormente (decimal): Base de ICMS retido anteriormente.\n\n• AliquotaConsumidorFinal (decimal): Alíquota suportada pelo consumidor final.\n\n• ValorIcmsSubstituto (decimal): Valor do ICMS próprio do Substituto.\n\n• ValorIcmsRetido (decimal): Valor do ICMS ST cobrado anteriormente.\n\n• BaseFcpRetidoAnteriormente (decimal): Base do FCP retido anteriormente.\n\n• AliquotaFcpRetidoAnteriormente (decimal): Alíquota de FCP retido anteriormente.\n\n• ValorFcpRetidoAnteriormente (decimal): Valor do FCP retido anteriormente.\n\n• PercentualReducaoBaseEfetivaIcmsRetido (decimal): Percentual de redução da base de ICMS efetiva se ouvesse a cobrança normal do ICMS.\n\n• AliquotaEfetivaIcmsRetido (decimal): Alíquota de ICMS efetivo se ouvesse a cobrança normal do ICMS.\n\n\n*************************************************************************\n\nCSOSN 900 - Outros:\n\n• Csosn: 900.\n\n• ModalidadeBaseIcms (Enum): Modalidade de determinação da base ICMS.\n\n• BaseIcms (decimal): Valor da base de cálculo do ICMS.\n\n• ReducaoBaseIcms (decimal): Percentual de redução de base ICMS.\n\n• AliquotaIcms (decimal): Alíquota do imposto ICMS.\n\n• ValorIcms (decimal): Valor do ICMS resultante.\n\n• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.\n\n• ValorIcmsDesonerado (decimal): Valor do ICMS desonerado.\n\n• ModalidadeBaseSt (Enum): Modalidade de base ICMS ST.\n\n• Mva (decimal): Percentual de MVA ST.\n\n• ReducaoBaseSt (decimal): Percentual de redução de base ICMS ST.\n\n• BaseSt (decimal): Valor da base de cálculo de ICMS ST.\n\n• AliquotaSt (decimal): Alíquota de ICMS ST.\n\n• ValorSt (decimal): Valor de ICMS ST resultante.\n\n• BaseFcpSt (decimal): Base de cálculo do FCP ST.\n\n• AliquotaFcpSt (decimal): Alíquota do FCP ST.\n\n• ValorFcpSt (decimal): Valor do FCP ST resultante.\n\n• AliquotaCreditoSimples (decimal): Alíquota de crédito do simples nacional.\n\n• ValorCreditoSimples (decimal): Valor de crédito do simples nacional.\n\n\n*************************************************************************\n\nDicionário de Enumeradores:\n\n• ModalidadeBaseIcmsNotaFiscalModelEnum:\n\n MargemValorAgregado = Margem Valor Agregado (%).\n\n PrecoPauta = Pauta (Valor).\n\n PrecoTabeladoMax = Preço Tabelado Máx. (valor).\n\n ValorDaOperacao = Valor da operação.\n\n\n• ModalidadeBaseStNotaFiscalModelEnum:\n\n PrecoTabeladoMaximoSugerido = Preço tabelado ou máximo sugerido.\n\n ListaNegativa = Lista Negativa (valor).\n\n ListaPositiva = Lista Positiva (valor).\n\n ListaNeutra = Lista Neutra (valor).\n\n MargemValorAgregado = Margem Valor Agregado (%).\n\n PrecoPauta = Pauta (valor)."},"ItemNfeSimplificadaTribIpiInputModel":{"required":["cst"],"type":"object","properties":{"cst":{"$ref":"#/components/schemas/CstIpiNfeModelEnum"},"aliquotaIpi":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota do IPI.","format":"double","nullable":true},"aliquotaQuantidadeIpi":{"minimum":0,"type":"number","description":"Valor do IPI pela quantidade.","format":"double","nullable":true},"cnpjProdutorMercadoria":{"type":"string","description":"CNPJ do produtor da mercadoria, quando diferente do emitente.Somente para os casos de exportação direta ou indireta.","nullable":true},"codigoSeloControle":{"type":"string","description":"Código do selo de controle IPI.","nullable":true},"quantidadeSeloControle":{"type":"integer","description":"Quantidade do selo de controle.","format":"int32","nullable":true},"codigoEnquadramentoLegal":{"type":"string","description":"Código de enquadramento legal.","nullable":true}},"additionalProperties":false,"description":"Dados da tributação IPI do item."},"ItemNfeSimplificadaTribIssqnInputModel":{"required":["aliquotaIssqn","baseIssqn","codigoMunicipioFatoGerador","indicadorExigibilidade","itemListaServico","nomeMunicipioFatoGerador","valorIssqn"],"type":"object","properties":{"baseIssqn":{"minimum":0,"type":"number","description":"Base de ISSQN.","format":"double"},"aliquotaIssqn":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota do ISSQN.","format":"double"},"valorIssqn":{"minimum":0,"type":"number","description":"Valor do ISSQN.","format":"double"},"codigoMunicipioFatoGerador":{"minLength":1,"pattern":"^\\d{7}$","type":"string","description":"Código do município onde ocorreu o fato gerador."},"nomeMunicipioFatoGerador":{"maxLength":60,"minLength":1,"type":"string","description":"Nome do município onde ocorreu o fato gerador."},"itemListaServico":{"maxLength":5,"minLength":1,"type":"string","description":"Código do item na lista fiscal de serviços."},"valorDeducao":{"type":"number","description":"Valor dedução para redução da Base de Cálculo.","format":"double","nullable":true},"valorOutrasRetencoes":{"type":"number","description":"Valor de outras retenções.","format":"double","nullable":true},"valorDescontoCondicional":{"type":"number","description":"Valor de desconto condicional.","format":"double","nullable":true},"valorDescontoIncondicional":{"type":"number","description":"Valor de desconto incondicional.","format":"double","nullable":true},"valorRetencaoIssqn":{"type":"number","description":"Valor de retenção do ISSQN.","format":"double","nullable":true},"indicadorExigibilidade":{"$ref":"#/components/schemas/IndicadorExigibilidadeIssqnModelEnum"},"codigoServicoMunicipio":{"type":"string","description":"Código do serviço no município.","nullable":true},"codigoMunicipioIncidencia":{"type":"string","description":"Código do município onde ocorreu a insidência do serviço.","nullable":true},"nomeMunicipioIncidencia":{"type":"string","description":"Nome do município onde ocorreu a insidência do serviço.","nullable":true},"codigoPaisIncidencia":{"type":"string","description":"Código do país onde ocorreu a insidência do serviço.","nullable":true},"numeroProcesso":{"type":"string","description":"Número do processo judicial ou administrativo de suspensão da exigibilidade.","nullable":true},"utilizouIncentivoFiscal":{"type":"boolean","description":"Indicador de incentivo Fiscal."}},"additionalProperties":false,"description":"Dados do ISSQN."},"ItemNfeSimplificadaTribPisInputModel":{"required":["cst"],"type":"object","properties":{"cst":{"$ref":"#/components/schemas/CstPisCofinsNfeModelEnum"},"aliquotaPis":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota do PIS em percentual.","format":"double","nullable":true},"aliquotaQuantidadePis":{"maximum":100,"minimum":0,"type":"number","description":"Valor da alíquota do PIS quando quantidade.","format":"double","nullable":true}},"additionalProperties":false,"description":"Tributação de PIS."},"ItemNfeTributacaoCbsInputModel":{"type":"object","properties":{"aliquotaCheiaCbs":{"minimum":0,"type":"number","description":"Alíquota cheia do CBS.","format":"double","nullable":true},"reducaoAliquotaCbs":{"maximum":100,"minimum":0,"type":"number","description":"Percentual de redução da alíquota do CBS.","format":"double","nullable":true},"aliquotaEfetivaCbs":{"minimum":0,"type":"number","description":"Alíquota efetiva do CBS.","format":"double","nullable":true},"valorCbs":{"minimum":0,"type":"number","description":"Valor do CBS.","format":"double","nullable":true},"percentualDiferimentoCbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota cheia de CBS.","format":"double","nullable":true},"valorDiferimentoCbs":{"minimum":0,"type":"number","description":"Alíquota cheia de CBS.","format":"double","nullable":true}},"additionalProperties":false,"description":"Dados do CBS - Contribuição sobre Bens e Serviços na tributação do item da nota fiscal."},"ItemNfeTributacaoCofinsInputModel":{"required":["cst"],"type":"object","properties":{"cst":{"$ref":"#/components/schemas/CstPisCofinsNfeModelEnum"},"baseCofins":{"minimum":0,"type":"number","description":"Base de cálculo do Cofins.","format":"double","nullable":true},"aliquotaCofins":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota do Cofins em percentual.","format":"double","nullable":true},"baseQuantidadeCofins":{"minimum":0,"type":"number","description":"Base do Cofins quando quantidade.","format":"double","nullable":true},"aliquotaQuantidadeCofins":{"maximum":100,"minimum":0,"type":"number","description":"Valor da alíquota do Cofins quando quantidade.","format":"double","nullable":true},"valorCofins":{"minimum":0,"type":"number","description":"Valor do Cofins.","format":"double","nullable":true}},"additionalProperties":false,"description":"Dados da tributação COFINS."},"ItemNfeTributacaoIbsCbsInputModel":{"required":["cClassTrib","cst"],"type":"object","properties":{"cst":{"$ref":"#/components/schemas/CstIbsCbsNfeModelEnum"},"cClassTrib":{"maxLength":10,"minLength":1,"type":"string","description":"CClassTrib - Código de Classificação Tributária do IBS e CBS."},"baseIbs":{"type":"number","description":"Base IBS e CBS.","format":"double","nullable":true},"ibsEstadual":{"$ref":"#/components/schemas/ItemNfeTributacaoIbsEstadualInputModel"},"ibsMunicipal":{"$ref":"#/components/schemas/ItemNfeTributacaoIbsMunicipalInputModel"},"cbs":{"$ref":"#/components/schemas/ItemNfeTributacaoCbsInputModel"}},"additionalProperties":false,"description":"Dados do IBS e CSB na tributação do item da nota fiscal. (Reforma Tributária)"},"ItemNfeTributacaoIbsEstadualInputModel":{"type":"object","properties":{"aliquotaCheiaIbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota cheia de IBS de competência da UF.","format":"double","nullable":true},"reducaoAliquotaIbs":{"maximum":100,"minimum":0,"type":"number","description":"Percentual de redução da alíquota de IBS de competência da UF.","format":"double","nullable":true},"aliquotaEfetivaIbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota efetiva do IBS de competência da UF.","format":"double","nullable":true},"valorIbs":{"minimum":0,"type":"number","description":"Valor de IBS de competência da UF.","format":"double","nullable":true},"percentualDiferimentoIbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota cheia de IBS de competência da UF.","format":"double","nullable":true},"valorDiferimentoIbs":{"minimum":0,"type":"number","description":"Alíquota cheia de IBS de competência da UF.","format":"double","nullable":true}},"additionalProperties":false,"description":"Dados do IBS - Imposto sobre Bens e Serviços na tributação do item da nota fiscal de competência da UF."},"ItemNfeTributacaoIbsMunicipalInputModel":{"type":"object","properties":{"aliquotaCheiaIbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota cheia de IBS de competência do município.","format":"double","nullable":true},"reducaoAliquotaIbs":{"maximum":100,"minimum":0,"type":"number","description":"Percentual de redução da alíquota de IBS de competência do município.","format":"double","nullable":true},"aliquotaEfetivaIbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota efetiva do IBS de competência do município.","format":"double","nullable":true},"valorIbs":{"minimum":0,"type":"number","description":"Valor de IBS de competência do município.","format":"double","nullable":true},"percentualDiferimentoIbs":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota cheia de IBS de competência do município.","format":"double","nullable":true},"valorDiferimentoIbs":{"minimum":0,"type":"number","description":"Alíquota cheia de IBS de competência do município.","format":"double","nullable":true}},"additionalProperties":false,"description":"Dados do IBS - Imposto sobre Bens e Serviços na tributação do item da nota fiscal de competência do município."},"ItemNfeTributacaoIcmsInputModel":{"required":["cst"],"type":"object","properties":{"cst":{"$ref":"#/components/schemas/CstIcmsNfeModelEnum"}},"additionalProperties":false,"description":"Modelo abstrato para a Tributação de ICMS da nota fiscal.\n\nO preenchimento dos campos abaixo é condicional ao CST informado.\n\n\n*************************************************************************\n\nCST 00 - Tributado integralmente:\n\n• Cst: 00.\n\n• ModalidadeBaseIcms (Enum): Modalidade de determinação da base ICMS.\n\n• BaseIcms (decimal): Valor da base de cálculo do ICMS.\n\n• AliquotaIcms (decimal): Alíquota do imposto ICMS.\n\n• ValorIcms (decimal): Valor do ICMS resultante.\n\n• BaseFcp (decimal): Valor da base de cálculo do FCP.\n\n• AliquotaFcp (decimal): Alíquota do FCP.\n\n• ValorFcp (decimal): Valor do FCP resultante.\n\n\n*************************************************************************\n\nCST 02 - Monofásica sobre Combustíveis:\n\n• Cst: 02.\n\n• AliquotaQuantidade (decimal): Alíquota ad rem do imposto (valor por quantidade).\n\n• ValorIcms (decimal): Valor do ICMS monofásico.\n\n\n*************************************************************************\n\nCST 10 - Tributada com cobrança de ICMS ST:\n\n• Cst: 10.\n\n• ModalidadeBaseIcms (Enum): Modalidade de determinação da base ICMS.\n\n• BaseIcms (decimal): Base de cálculo do ICMS próprio.\n\n• AliquotaIcms (decimal): Alíquota do ICMS próprio.\n\n• ValorIcms (decimal): Valor do ICMS próprio.\n\n• ModalidadeBaseSt (Enum): Modalidade de determinação da base de ICMS ST.\n\n• Mva (decimal): Percentual da margem de valor adicionado (MVA).\n\n• ReducaoBaseSt (decimal): Percentual de redução de base ICMS ST.\n\n• BaseSt (decimal): Valor da base de cálculo do ICMS ST.\n\n• AliquotaSt (decimal): Alíquota do imposto ICMS ST.\n\n• ValorSt (decimal): Valor do ICMS ST resultante.\n\n• BaseFcp (decimal): Base de cálculo do FCP próprio.\n\n• AliquotaFcp (decimal): Alíquota do FCP próprio.\n\n• ValorFcp (decimal): Valor do FCP próprio.\n\n• BaseFcpSt (decimal): Base de cálculo do FCP retido por ST.\n\n• AliquotaFcpSt (decimal): Alíquota do FCP ST.\n\n• ValorFcpSt (decimal): Valor do FCP ST resultante.\n\n\n*************************************************************************\n\nCST 15 - Monofásica com retenção sobre Combustíveis:\n\n• Cst: 15.\n\n• AliquotaQuantidade (decimal): Alíquota ad rem do imposto (própria).\n\n• ValorIcms (decimal): Valor do ICMS próprio.\n\n• AliquotaRetencaoQuantidade (decimal): Alíquota ad rem do imposto retido.\n\n• ValorIcmsRetido (decimal): Valor do ICMS monofásico retido.\n\n\n*************************************************************************\n\nCST 20 - Tributado com redução de base de cálculo:\n\n• Cst: 20.\n\n• ModalidadeBaseIcms (Enum): Modalidade de determinação da base ICMS.\n\n• BaseIcms (decimal): Valor da base de cálculo do ICMS.\n\n• ReducaoBaseIcms (decimal): Percentual de redução de base ICMS.\n\n• AliquotaIcms (decimal): Alíquota do imposto ICMS.\n\n• ValorIcms (decimal): Valor do ICMS resultante.\n\n• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.\n\n• ValorIcmsDesonerado (decimal): Valor do ICMS desonerado.\n\n• DesoneracaoDeduzValorItem (boleano): Indica se a desoneração está deduzindo no valor do item.\n\n• CodigoBeneficio (string): Código de benefício fiscal.\n\n• BaseFcp (decimal): Base de cálculo do FCP.\n\n• AliquotaFcp (decimal): Alíquota do FCP.\n\n• ValorFcp (decimal): Valor do FCP resultante.\n\n\n*************************************************************************\n\nCST 30 - Isenta/Não Tributada com cobrança de ICMS ST:\n\n• Cst: 30.\n\n• ModalidadeBaseSt (Enum): Modalidade de determinação da base ICMS ST.\n\n• Mva (decimal): Percentual de MVA ST.\n\n• ReducaoBaseSt (decimal): Percentual de redução de base ST.\n\n• BaseSt (decimal): Valor da base de cálculo do ICMS ST.\n\n• AliquotaSt (decimal): Alíquota do imposto ICMS ST.\n\n• ValorSt (decimal): Valor do ICMS ST resultante.\n\n• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.\n\n• ValorIcmsDesonerado (decimal): Valor do ICMS desonerado.\n\n• DesoneracaoDeduzValorItem (boleano): Indica se a desoneração está deduzindo no valor do item.\n\n• CodigoBeneficio (string): Código de benefício fiscal.\n\n• BaseFcpSt (decimal): Base de cálculo do FCP ST.\n\n• AliquotaFcpSt (decimal): Alíquota do FCP ST.\n\n• ValorFcpSt (decimal): Valor do FCP ST resultante.\n\n\n*************************************************************************\n\nCST 40, 41 e 50 - Isenta, Não Tributada ou Suspensão:\n\n• Cst: (40, 41 ou 50).\n\n• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS. \n\n• ValorIcmsDesonerado (decimal): Valor do ICMS desonerado.\n\n• DesoneracaoDeduzValorItem (boleano): Indica se a desoneração está deduzindo no valor do item.\n\n• CodigoBeneficio (string): Código de benefício fiscal.\n\n\n*************************************************************************\n\nCST 51 - Tributação com Diferimento:\n\n• Cst: 51.\n\n• ModalidadeBaseIcms (Enum): Modalidade de determinação da base ICMS.\n\n• BaseIcms (decimal): Valor da base de cálculo do ICMS.\n\n• AliquotaIcms (decimal): Alíquota do imposto ICMS.\n\n• ValorIcmsOperacao (decimal): Valor do ICMS da operação (sem diferimento).\n\n• PercentualDiferimento (decimal): Percentual do diferimento aplicado.\n\n• ValorIcmsDiferido (decimal): Valor do ICMS diferido.\n\n• ValorIcms (decimal): Valor do ICMS efetivamente devido.\n\n• BaseFcp (decimal): Base de cálculo do FCP.\n\n• AliquotaFcp (decimal): Alíquota do FCP.\n\n• ValorFcp (decimal): Valor do FCP resultante.\n\n\n*************************************************************************\n\nCST 53 - Monofásica sobre Combustíveis com Diferimento:\n\n• Cst: 53.\n\n• AliquotaQuantidadeDiferida (decimal): Alíquota ad rem diferida.\n\n• ValorIcmsDiferido (decimal): Valor do ICMS diferido.\n\n\n*************************************************************************\n\nCST 60 - Cobrado anteriormente por substituição tributária:\n\n• Cst: 60.\n\n• BaseIcmsRetidoAnteriormente (decimal): Base de ICMS retido anteriormente.\n\n• AliquotaRetidoAnteriormente (decimal): Alíquota de ICMS retido anteriormente.\n\n• ValorIcmsProprioSubstituto (decimal): Valor do ICMS próprio do Substituto.\n\n• ValorIcmsRetidoAnteriormente (decimal): Valor do ICMS retido anteriormente.\n\n• BaseFcpRetidoAnteriormente (decimal): Base de FCP retido anteriormente.\n\n• AliquotaFcpRetidoAnteriormente (decimal): Alíquota de FCP retido anteriormente.\n\n• ValorFcpRetidoAnteriormente (decimal): Valor de FCP retido anteriormente.\n\n• BaseEfetivaIcmsRetido (decimal): Base de ICMS efetivo se ouvesse a cobrança normal de ICMS.\n\n• PercentualReducaoBaseEfetivaIcmsRetido (decimal): Percentual de redução da base de ICMS efetiva se ouvesse a cobrança normal do ICMS.\n\n• AliquotaEfetivaIcmsRetido (decimal): Alíquota de ICMS efetivo se ouvesse a cobrança normal do ICMS.\n\n• ValorEfetivoIcmsRetido (decimal): Valor do ICMS efetivo se ouvesse a cobrança normal de ICMS.\n\n\n*************************************************************************\n\nCST 61 - Monofásica sobre Combustíveis cobrada anteriormente:\n\n• Cst: 61.\n\n• AliquotaQuantidadeRetida (decimal): Alíquota ad rem retida anteriormente.\n\n• ValorIcmsRetido (decimal): Valor do ICMS retido anteriormente.\n\n\n*************************************************************************\n\nCST 70 - Redução de base e cobrança de ICMS ST:\n\n• Cst: 70.\n\n• ModalidadeBaseIcms (Enum): Modalidade de determinação da base ICMS.\n\n• BaseIcms (decimal): Base de cálculo do ICMS próprio.\n\n• ReducaoBaseIcms (decimal): Percentual de redução de base própria.\n\n• AliquotaIcms (decimal): Alíquota do ICMS próprio.\n\n• ValorIcms (decimal): Valor do ICMS próprio.\n\n• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.\n\n• ValorIcmsDesonerado (decimal): Valor do ICMS desonerado.\n\n• DesoneracaoDeduzValorItem (boleano): Indica se a desoneração está deduzindo no valor do item.\n\n• CodigoBeneficio (string): Código de benefício fiscal.\n\n• ModalidadeBaseSt (Enum): Modalidade de determinação da base ICMS ST.\n\n• Mva (decimal): Percentual de MVA ST.\n\n• ReducaoBaseSt (decimal): Percentual de redução de base ST.\n\n• BaseSt (decimal): Valor da base de cálculo do ICMS ST.\n\n• AliquotaSt (decimal): Alíquota do imposto ICMS ST.\n\n• ValorSt (decimal): Valor do ICMS ST resultante.\n\n• BaseFcp (decimal): Base de cálculo do FCP próprio.\n\n• AliquotaFcp (decimal): Alíquota do FCP próprio.\n\n• ValorFcp (decimal): Valor do FCP próprio.\n\n• BaseFcpSt (decimal): Base de cálculo do FCP ST.\n\n• AliquotaFcpSt (decimal): Alíquota do FCP ST.\n\n• ValorFcpSt (decimal): Valor do FCP ST resultante.\n\n\n*************************************************************************\n\nCST 90 - Outros:\n\n• Cst: 90.\n\n• ModalidadeBaseIcms (Enum): Modalidade de determinação da base ICMS.\n\n• BaseIcms (decimal): Valor da base de cálculo própria.\n\n• ReducaoBaseIcms (decimal): Percentual de redução de base própria.\n\n• AliquotaIcms (decimal): Alíquota do imposto próprio.\n\n• ValorIcms (decimal): Valor do ICMS próprio resultante.\n\n• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS. \n\n• ValorIcmsDesonerado (decimal): Valor do ICMS desonerado.\n\n• ModalidadeBaseSt (Enum): Modalidade de determinação da base ST.\n\n• Mva (decimal): Percentual de MVA ST.\n\n• ReducaoBaseSt (decimal): Percentual de redução de base ST.\n\n• BaseSt (decimal): Valor da base de cálculo do ICMS ST.\n\n• AliquotaSt (decimal): Alíquota do imposto ICMS ST.\n\n• ValorSt (decimal): Valor do ICMS ST resultante.\n\n• BaseFcp (decimal): Base de cálculo do FCP próprio.\n\n• AliquotaFcp (decimal): Alíquota do FCP próprio.\n\n• ValorFcp (decimal): Valor do FCP próprio.\n\n• BaseFcpSt (decimal): Base de cálculo do FCP ST.\n\n• AliquotaFcpSt (decimal): Alíquota do FCP ST.\n\n• ValorFcpSt (decimal): Valor do FCP ST resultante.\n\n*************************************************************************\n\n\nDicionário de Enumeradores:\n\n• ModalidadeBaseIcmsNotaFiscalModelEnum:\n\n MargemValorAgregado = Margem Valor Agregado (%).\n\n PrecoPauta = Pauta (Valor).\n\n PrecoTabeladoMax = Preço Tabelado Máx. (valor).\n\n ValorDaOperacao = Valor da operação.\n\n\n• ModalidadeBaseStNotaFiscalModelEnum:\n\n PrecoTabeladoMaximoSugerido = Preço tabelado ou máximo sugerido.\n\n ListaNegativa = Lista Negativa (valor).\n\n ListaPositiva = Lista Positiva (valor).\n\n ListaNeutra = Lista Neutra (valor).\n\n MargemValorAgregado = Margem Valor Agregado (%).\n\n PrecoPauta = Pauta (valor).\n\n\n• MotivoDesoneracaoNotaFiscalModelEnum:\n\n Taxi = Táxi.\n\n DeficienteFisico = Deficiente físico.\n\n ProdutorAgropecuario = Produtor agropecuário.\n\n FrotistaLocadora = Frotista/Locadora.\n\n DiplomaticoConsular = Diplomático/consular.\n\n UtilitariosMotocicletasAmazoniaOcidental = Utilitários produzidos na amazônia ocidental.\n\n SUFRAMA = SUFRAMA.\n\n VendaOrgaoPublico = Venda a órgãos públicos.\n\n Outros = Outros.\n\n DeficienteCondutor = Deficiente condutor.\n\n DeficienteNaoCondutor = Deficiente não condutor.\n\n OrgaoDeFomentoDesenvolvimentoAgropecuario = Órgão de fomento e desenvolvimento agropecuário."},"ItemNfeTributacaoIcmsUfDestInputModel":{"required":["aliquotaFcpInternaUfDestino","aliquotaInterestadual","aliquotaInternaUfDestino","baseFcp","baseIcms","valorFcpUfDestino","valorIcmsUfDestino"],"type":"object","properties":{"baseIcms":{"minimum":0,"type":"number","description":"Base do ICMS na UF de destino.","format":"double"},"aliquotaInternaUfDestino":{"maximum":100,"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Alíquota de ICMS interna na UF de destino.","format":"double"},"aliquotaInterestadual":{"maximum":100,"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Alíquota interestadual das UFs envolvidas na operação, conforme tabela do CONFAZ.","format":"double"},"valorIcmsUfDestino":{"minimum":0,"type":"number","description":"Valor do ICMS devido a UF de destino.","format":"double"},"baseFcp":{"minimum":0,"type":"number","description":"Base do FCP na UF de destino.","format":"double"},"aliquotaFcpInternaUfDestino":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota de FCP interna na UF de destino.","format":"double"},"valorFcpUfDestino":{"minimum":0,"type":"number","description":"Valor do FCP devido a UF de destino.","format":"double"}},"additionalProperties":false,"description":"Informação do ICMS Interestadual destinado a consumidor final em outra UF."},"ItemNfeTributacaoIcmssnInputModel":{"required":["csosn"],"type":"object","properties":{"csosn":{"$ref":"#/components/schemas/CsosnNfeModelEnum"}},"additionalProperties":false,"description":"Modelo abstrato para a Tributação de ICMSSN (Simples Nacional) da nota fiscal.\n\nO preenchimento dos campos abaixo é condicional ao CSOSN informado.\n\n\n*************************************************************************\n\nCSOSN 101 - Tributada pelo Simples Nacional com permissão de crédito:\n\n• Csosn: 101.\n\n• AliquotaCreditoSimples (decimal): Alíquota de crédito do simples nacional.\n\n• ValorCreditoSimples (decimal): Valor de crédito do simples nacional.\n\n\n*************************************************************************\n\nCSOSN 102 - Tributada pelo Simples Nacional sem permissão de crédito:\n\n• Csosn: 102.\n\n• Nota: Não exige campos adicionais de valores ou alíquotas.\n\n\n*************************************************************************\n\nCSOSN 103 - Isento:\n\n• Csosn: 103.\n\n• Nota: Não exige campos adicionais de valores ou alíquotas.\n\n\n*************************************************************************\n\nCSOSN 201 - Tributada pelo Simples com permissão de crédito e cobrança de ICMS ST:\n\n• Csosn: 201.\n\n• AliquotaCreditoSimples (decimal): Alíquota de crédito do simples nacional.\n\n• ValorCreditoSimples (decimal): Valor de crédito do simples nacional.\n\n• ModalidadeBaseSt (Enum): Modalidade de base ICMS ST.\n\n• Mva (decimal): Percentual de MVA.\n\n• ReducaoBaseSt (decimal): Percentual de redução de base ICMS ST.\n\n• BaseSt (decimal): Valor da base de cálculo de ICMS ST.\n\n• AliquotaIcmsDeducaoSt (decimal): Alíquota para dedução do ICMS no cálculo do ICMS ST (Utilizada para calcular o valor a ser deduzido do ICMS ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaSt (decimal): Alíquota de ICMS ST.\n\n• ValorSt (decimal): Valor de ICMS ST resultante.\n\n• BaseFcpSt (decimal): Base de cálculo do FCP ST.\n\n• AliquotaFcpDeducaoSt (decimal): Alíquota para dedução do FCP no cálculo do FCP ST (Utilizada para calcular o valor a ser deduzido do FCP ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaFcpSt (decimal): Alíquota de FCP ST.\n\n• ValorFcpSt (decimal): Valor de FCP ST resultante.\n\n\n*************************************************************************\n\nCSOSN 202 - Tributada pelo Simples sem permissão de crédito com cobrança de ST:\n\n• Csosn: 202.\n\n• ModalidadeBaseSt (Enum): Modalidade de base ICMS ST.\n\n• Mva (decimal): Percentual de MVA.\n\n• ReducaoBaseSt (decimal): Percentual de redução de base ICMS ST.\n\n• BaseSt (decimal): Valor da base de cálculo de ICMS ST.\n\n• AliquotaIcmsDeducaoSt (decimal): Alíquota para dedução do ICMS no cálculo do ICMS ST (Utilizada para calcular o valor a ser deduzido do ICMS ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaSt (decimal): Alíquota de ICMS ST.\n\n• ValorSt (decimal): Valor de ICMS ST resultante.\n\n• BaseFcpSt (decimal): Base de cálculo do FCP ST.\n\n• AliquotaFcpDeducaoSt (decimal): Alíquota para dedução do FCP no cálculo do FCP ST (Utilizada para calcular o valor a ser deduzido do FCP ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaFcpSt (decimal): Alíquota de FCP ST.\n\n• ValorFcpSt (decimal): Valor de FCP ST resultante.\n\n\n*************************************************************************\n\nCSOSN 203 - Isento com ST:\n\n• Csosn: 203.\n\n• ModalidadeBaseSt (Enum): Modalidade de base ICMS ST.\n\n• Mva (decimal): Percentual de MVA.\n\n• ReducaoBaseSt (decimal): Percentual de redução de base ICMS ST.\n\n• BaseSt (decimal): Valor da base de cálculo de ICMS ST.\n\n• AliquotaIcmsDeducaoSt (decimal): Alíquota para dedução do ICMS no cálculo do ICMS ST (Utilizada para calcular o valor a ser deduzido do ICMS ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaSt (decimal): Alíquota de ICMS ST.\n\n• ValorSt (decimal): Valor de ICMS ST resultante.\n\n• BaseFcpSt (decimal): Base de cálculo do FCP ST.\n\n• AliquotaFcpDeducaoSt (decimal): Alíquota para dedução do FCP no cálculo do FCP ST (Utilizada para calcular o valor a ser deduzido do FCP ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaFcpSt (decimal): Alíquota de FCP ST.\n\n• ValorFcpSt (decimal): Valor de FCP ST resultante.\n\n\n*************************************************************************\n\nCSOSN 300 - Imune:\n\n• Csosn: 300.\n\n• Nota: Não exige campos adicionais de valores ou alíquotas.\n\n\n*************************************************************************\n\nCSOSN 400 - Não Tributada:\n\n• Csosn: 400.\n\n• Nota: Não exige campos adicionais de valores ou alíquotas.\n\n\n*************************************************************************\n\nCSOSN 500 - ICMS cobrado anteriormente por substituição tributária:\n\n• Csosn: 500.\n\n• BaseIcmsRetidoAnteriormente (decimal): Base de ICMS retido anteriormente.\n\n• AliquotaConsumidorFinal (decimal): Alíquota suportada pelo consumidor final.\n\n• ValorIcmsSubstituto (decimal): Valor do ICMS próprio do Substituto.\n\n• ValorIcmsRetido (decimal): Valor do ICMS ST cobrado anteriormente.\n\n• BaseFcpRetidoAnteriormente (decimal): Base do FCP retido anteriormente.\n\n• AliquotaFcpRetidoAnteriormente (decimal): Alíquota de FCP retido anteriormente.\n\n• ValorFcpRetidoAnteriormente (decimal): Valor do FCP retido anteriormente.\n\n• BaseEfetivaIcmsRetido (decimal): Base de ICMS efetivo se ouvesse a cobrança normal de ICMS.\n\n• PercentualReducaoBaseEfetivaIcmsRetido (decimal): Percentual de redução da base de ICMS efetiva se ouvesse a cobrança normal do ICMS.\n\n• AliquotaEfetivaIcmsRetido (decimal): Alíquota de ICMS efetivo se ouvesse a cobrança normal do ICMS.\n\n• ValorEfetivoIcmsRetido (decimal): Valor do ICMS efetivo se ouvesse a cobrança normal de ICMS.\n\n\n*************************************************************************\n\nCSOSN 900 - Outros:\n\n• Csosn: 900.\n\n• ModalidadeBaseIcms (Enum): Modalidade de determinação da base ICMS.\n\n• BaseIcms (decimal): Valor da base de cálculo do ICMS.\n\n• ReducaoBaseIcms (decimal): Percentual de redução de base ICMS.\n\n• AliquotaIcms (decimal): Alíquota do imposto ICMS.\n\n• ValorIcms (decimal): Valor do ICMS resultante.\n\n• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.\n\n• ValorIcmsDesonerado (decimal): Valor do ICMS desonerado.\n\n• ModalidadeBaseSt (Enum): Modalidade de base ICMS ST.\n\n• Mva (decimal): Percentual de MVA ST.\n\n• ReducaoBaseSt (decimal): Percentual de redução de base ICMS ST.\n\n• BaseSt (decimal): Valor da base de cálculo de ICMS ST.\n\n• AliquotaIcmsDeducaoSt (decimal): Alíquota para dedução do ICMS no cálculo do ICMS ST (Utilizada para calcular o valor a ser deduzido do ICMS ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaSt (decimal): Alíquota de ICMS ST.\n\n• ValorSt (decimal): Valor de ICMS ST resultante.\n\n• BaseFcpSt (decimal): Base de cálculo do FCP ST.\n\n• AliquotaFcpDeducaoSt (decimal): Alíquota para dedução do FCP no cálculo do FCP ST (Utilizada para calcular o valor a ser deduzido do FCP ST quando o contribuinte for substituído e tiver direito à dedução).\n\n• AliquotaFcpSt (decimal): Alíquota do FCP ST.\n\n• ValorFcpSt (decimal): Valor do FCP ST resultante.\n\n• AliquotaCreditoSimples (decimal): Alíquota de crédito do simples nacional.\n\n• ValorCreditoSimples (decimal): Valor de crédito do simples nacional.\n\n\n*************************************************************************\n\nDicionário de Enumeradores:\n\n• ModalidadeBaseIcmsNotaFiscalModelEnum:\n\n MargemValorAgregado = Margem Valor Agregado (%).\n\n PrecoPauta = Pauta (Valor).\n\n PrecoTabeladoMax = Preço Tabelado Máx. (valor).\n\n ValorDaOperacao = Valor da operação.\n\n\n• ModalidadeBaseStNotaFiscalModelEnum:\n\n PrecoTabeladoMaximoSugerido = Preço tabelado ou máximo sugerido.\n\n ListaNegativa = Lista Negativa (valor).\n\n ListaPositiva = Lista Positiva (valor).\n\n ListaNeutra = Lista Neutra (valor).\n\n MargemValorAgregado = Margem Valor Agregado (%).\n\n PrecoPauta = Pauta (valor)."},"ItemNfeTributacaoIpiInputModel":{"required":["cst"],"type":"object","properties":{"cst":{"$ref":"#/components/schemas/CstIpiNfeModelEnum"},"baseIpi":{"minimum":0,"type":"number","description":"Base do IPI.","format":"double","nullable":true},"aliquotaIpi":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota do IPI.","format":"double","nullable":true},"baseQuantidadeIpi":{"minimum":0,"type":"number","description":"Base do IPI pela quantidade.","format":"double","nullable":true},"aliquotaQuantidadeIpi":{"minimum":0,"type":"number","description":"Valor do IPI pela quantidade.","format":"double","nullable":true},"valorIpi":{"minimum":0,"type":"number","description":"Valor do IPI.","format":"double","nullable":true},"cnpjProdutorMercadoria":{"type":"string","description":"CNPJ do produtor da mercadoria, quando diferente do emitente.Somente para os casos de exportação direta ou indireta.","nullable":true},"codigoSeloControle":{"type":"string","description":"Código do selo de controle IPI.","nullable":true},"quantidadeSeloControle":{"type":"integer","description":"Quantidade do selo de controle.","format":"int32","nullable":true},"codigoEnquadramentoLegal":{"type":"string","description":"Código de enquadramento legal.","nullable":true}},"additionalProperties":false,"description":"Dados da tributação IPI do item."},"ItemNfeTributacaoIssqnInputModel":{"required":["aliquotaIssqn","baseIssqn","codigoMunicipioFatoGerador","indicadorExigibilidade","itemListaServico","nomeMunicipioFatoGerador","valorIssqn"],"type":"object","properties":{"baseIssqn":{"minimum":0,"type":"number","description":"Base de ISSQN.","format":"double"},"aliquotaIssqn":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota do ISSQN.","format":"double"},"valorIssqn":{"minimum":0,"type":"number","description":"Valor do ISSQN.","format":"double"},"codigoMunicipioFatoGerador":{"minLength":1,"pattern":"^\\d{7}$","type":"string","description":"Código do município onde ocorreu o fato gerador."},"nomeMunicipioFatoGerador":{"maxLength":60,"minLength":1,"type":"string","description":"Nome do município onde ocorreu o fato gerador."},"itemListaServico":{"maxLength":5,"minLength":1,"type":"string","description":"Código do item na lista fiscal de serviços."},"valorDeducao":{"type":"number","description":"Valor dedução para redução da Base de Cálculo.","format":"double","nullable":true},"valorOutrasRetencoes":{"type":"number","description":"Valor de outras retenções.","format":"double","nullable":true},"valorDescontoCondicional":{"type":"number","description":"Valor de desconto condicional.","format":"double","nullable":true},"valorDescontoIncondicional":{"type":"number","description":"Valor de desconto incondicional.","format":"double","nullable":true},"valorRetencaoIssqn":{"type":"number","description":"Valor de retenção do ISSQN.","format":"double","nullable":true},"indicadorExigibilidade":{"$ref":"#/components/schemas/IndicadorExigibilidadeIssqnModelEnum"},"codigoServicoMunicipio":{"type":"string","description":"Código do serviço no município.","nullable":true},"codigoMunicipioIncidencia":{"type":"string","description":"Código do município onde ocorreu a insidência do serviço.","nullable":true},"nomeMunicipioIncidencia":{"type":"string","description":"Nome do município onde ocorreu a insidência do serviço.","nullable":true},"codigoPaisIncidencia":{"type":"string","description":"Código do país onde ocorreu a insidência do serviço.","nullable":true},"numeroProcesso":{"type":"string","description":"Número do processo judicial ou administrativo de suspensão da exigibilidade.","nullable":true},"utilizouIncentivoFiscal":{"type":"boolean","description":"Indicador de incentivo Fiscal."}},"additionalProperties":false,"description":"Dados do ISSQN."},"ItemNfeTributacaoPisInputModel":{"required":["cst"],"type":"object","properties":{"cst":{"$ref":"#/components/schemas/CstPisCofinsNfeModelEnum"},"basePis":{"minimum":0,"type":"number","description":"Base de cálculo do PIS.","format":"double","nullable":true},"aliquotaPis":{"maximum":100,"minimum":0,"type":"number","description":"Alíquota do PIS em percentual.","format":"double","nullable":true},"baseQuantidadePis":{"minimum":0,"type":"number","description":"Base do pis quando quantidade.","format":"double","nullable":true},"aliquotaQuantidadePis":{"maximum":100,"minimum":0,"type":"number","description":"Valor da alíquota do PIS quando quantidade.","format":"double","nullable":true},"valorPis":{"minimum":0,"type":"number","description":"Valor do PIS.","format":"double","nullable":true}},"additionalProperties":false,"description":"Tributação de PIS."},"ListarCartasCorrecaoViewModel":{"type":"object","properties":{"codigoErp":{"type":"string","description":"Identificador da operação fiscal no ERP.","nullable":true},"chaveAcesso":{"type":"string","description":"Chave de acesso do documento fiscal.","nullable":true},"modeloNotaFiscal":{"$ref":"#/components/schemas/ModeloNotaFiscalModelEnum"},"naturezaOperacao":{"type":"string","description":"Natureza da operação.","nullable":true},"numeroDocumento":{"type":"string","description":"Numero do documento fiscal.","nullable":true},"serie":{"type":"string","description":"Série do documento fiscal.","nullable":true},"tipoAmbiente":{"$ref":"#/components/schemas/TipoAmbienteSefazModelEnum"},"tipoOperacao":{"$ref":"#/components/schemas/TipoOperacaoNotaFiscalModelEnum"},"tipoIdDestino":{"$ref":"#/components/schemas/TipoIdDestinoNotaFiscalModelEnum"},"documentoParticipante":{"type":"string","description":"Documento do participante.","nullable":true},"nomeParticipante":{"type":"string","description":"Nome do participante.","nullable":true},"valorDocumento":{"type":"number","description":"Valor do documento.","format":"double"},"dataEmissao":{"type":"string","description":"Data de emissão do documento.","format":"date-time"},"dataSaidaEntrada":{"type":"string","description":"Data de saída/entrada.","format":"date-time","nullable":true},"statusNotaFiscal":{"$ref":"#/components/schemas/StatusNotaFiscalModelEnum"},"dataEnventoCartaCorrecao":{"type":"string","description":"Data e hora de envio do evento da carta de correção.","format":"date-time","nullable":true},"descricaoCartaCorrecao":{"type":"string","description":"Descrição da carta de correção.","nullable":true},"statusCartaCorrecao":{"$ref":"#/components/schemas/StatusCartaCorrecaoModelEnum"}},"additionalProperties":false,"description":"Dados de listagem de cartas de correção eletrônicas (CC-e)."},"ListarCartasCorrecaoViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListarCartasCorrecaoViewModel"},"nullable":true}},"additionalProperties":false},"ListarCestsViewModel":{"type":"object","properties":{"codigoCest":{"type":"string","description":"CEST - Código especificador da substituição tributária.","nullable":true},"descricao":{"type":"string","description":"Descrição do CEST.","nullable":true}},"additionalProperties":false,"description":"Dados para listagem de Cests."},"ListarCestsViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListarCestsViewModel"},"nullable":true}},"additionalProperties":false},"ListarCfopsViewModel":{"type":"object","properties":{"codigoCfop":{"type":"string","description":"Código numérico do CFOP.","nullable":true},"descricao":{"type":"string","description":"Descrição detalhada da operação fiscal.","nullable":true},"tipoOperacao":{"$ref":"#/components/schemas/TipoOperacaoCfopModelEnum"},"tipoDestino":{"$ref":"#/components/schemas/TipoDestinoCfopModelEnum"},"tipoIcms":{"$ref":"#/components/schemas/TipoIcmsCfopModelEnum"},"tipoDestinatario":{"$ref":"#/components/schemas/TipoDestinatarioCfopModelEnum"},"permiteNfe":{"type":"boolean","description":"Indica se o CFOP permite a emissão de Nota Fiscal Eletrônica."},"indicaComunicacao":{"type":"boolean","description":"Indica se a operação é relativa a serviços de comunicação."},"indicaTransporte":{"type":"boolean","description":"Indica se a operação é relativa a serviços de transporte."},"indicaDevolucao":{"type":"boolean","description":"Indica se a operação é de devolução de mercadoria."},"indicaCombustivel":{"type":"boolean","description":"Indica se a operação envolve combustíveis ou lubrificantes."},"compoeFaturamento":{"type":"boolean","description":"Indica se o valor da operação compõe o faturamento da empresa."}},"additionalProperties":false,"description":"Dados para listagem de CFOPs (Código Fiscal de Operações e de Prestações)."},"ListarCfopsViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListarCfopsViewModel"},"nullable":true}},"additionalProperties":false},"ListarCodigosBeneficioViewModel":{"type":"object","properties":{"codigo":{"type":"string","description":"Código do benefício fiscal.","nullable":true},"descricao":{"type":"string","description":"Descrição detalhada do benefício.","nullable":true},"uf":{"$ref":"#/components/schemas/UfCodigoBeneficioModelEnum"}},"additionalProperties":false,"description":"Dados de listagem do código de benefício fiscal."},"ListarCodigosBeneficioViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListarCodigosBeneficioViewModel"},"nullable":true}},"additionalProperties":false},"ListarConsultasCatalogoFiscalViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador interno da consulta no histórico.","format":"uuid"},"fonte":{"type":"string","description":"Fonte do dado.","nullable":true},"tipoConsulta":{"$ref":"#/components/schemas/TipoConsultaCatalogoFiscalModelEnum"},"filtro":{"type":"string","description":"Valor do filtro utilizado.","nullable":true},"dataConsulta":{"type":"string","description":"Data da consulta.","format":"date-time"},"statusConsulta":{"$ref":"#/components/schemas/StatusHistoricoConsultaCatalogoFiscalModelEnum"}},"additionalProperties":false,"description":"Dados da listagem das consultas realizadas internamente no catálogo fiscal."},"ListarConsultasCatalogoFiscalViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListarConsultasCatalogoFiscalViewModel"},"nullable":true}},"additionalProperties":false},"ListarConsultasCnpjAplicacaoViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único da consulta.","format":"uuid"},"filtro":{"type":"string","description":"Filtro utilizado na consulta (CNPJ).","nullable":true},"statusConsulta":{"$ref":"#/components/schemas/StatusHistoricoConsultaCnpjModelEnum"},"dataConsulta":{"type":"string","description":"Data e hora em que a consulta foi registrada.","format":"date-time"}},"additionalProperties":false,"description":"Dados para listagem do histórico de consultas do CNPJ."},"ListarConsultasCnpjAplicacaoViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListarConsultasCnpjAplicacaoViewModel"},"nullable":true}},"additionalProperties":false},"ListarConsultasCnpjCrmViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único da consulta.","format":"uuid"},"filtro":{"type":"string","description":"Filtro utilizado na consulta (CNPJ).","nullable":true},"statusConsulta":{"$ref":"#/components/schemas/StatusHistoricoConsultaCnpjModelEnum"},"dataConsulta":{"type":"string","description":"Data e hora em que a consulta foi registrada.","format":"date-time"},"fonteOrigem":{"type":"string","description":"Identificação da fonte de origem da informação.","nullable":true}},"additionalProperties":false,"description":"Dados para listagem do histórico de consultas do CNPJ."},"ListarConsultasCnpjCrmViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListarConsultasCnpjCrmViewModel"},"nullable":true}},"additionalProperties":false},"ListarConsultasProdutoVisaoAplicacaoViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador interno da consulta no histórico.","format":"uuid"},"modoConsulta":{"$ref":"#/components/schemas/ModoConsultaProdutoModelEnum"},"tipoFiltro":{"$ref":"#/components/schemas/TipoFiltroConsultaProdutoModelEnum"},"filtro":{"type":"string","description":"Valor do filtro utilizado.","nullable":true},"dataConsulta":{"type":"string","description":"Data de realização da consulta.","format":"date-time"},"statusConsulta":{"$ref":"#/components/schemas/StatusConsultaProdutoModelEnum"},"hash":{"type":"string","description":"Hash de integridade ou identificação da consulta.","nullable":true},"bilhetado":{"type":"boolean","description":"Indica se a consulta foi bilhetada."}},"additionalProperties":false,"description":"Dados detalhados da listagem de consultas do emissor exibidos pela aplicacao."},"ListarConsultasProdutoVisaoAplicacaoViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListarConsultasProdutoVisaoAplicacaoViewModel"},"nullable":true}},"additionalProperties":false},"ListarConsultasProdutoVisaoCrmViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador interno da consulta no histórico.","format":"uuid"},"modoConsulta":{"$ref":"#/components/schemas/ModoConsultaProdutoModelEnum"},"tipoFiltro":{"$ref":"#/components/schemas/TipoFiltroConsultaProdutoModelEnum"},"filtro":{"type":"string","description":"Valor do filtro utilizado.","nullable":true},"dataConsulta":{"type":"string","description":"Data de realização da consulta.","format":"date-time"},"statusConsulta":{"$ref":"#/components/schemas/StatusConsultaProdutoModelEnum"},"fonteInformacao":{"$ref":"#/components/schemas/FonteInformacaoConsultaProdutoModelEnum"},"hash":{"type":"string","description":"Hash de integridade ou identificação da consulta.","nullable":true},"bilhetado":{"type":"boolean","description":"Indica se a consulta foi bilhetada."}},"additionalProperties":false,"description":"Dados detalhados da listagem de consultas do emissor exibidos pela console CRM."},"ListarConsultasProdutoVisaoCrmViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListarConsultasProdutoVisaoCrmViewModel"},"nullable":true}},"additionalProperties":false},"ListarEnquadramentosLegalIpiViewModel":{"type":"object","properties":{"codigo":{"type":"string","description":"Código do enquadramento legal do IPI.","nullable":true},"descricao":{"type":"string","description":"Descrição do enquadramento legal do IPI.","nullable":true},"grupoCst":{"$ref":"#/components/schemas/GrupoCstIpiModelEnum"}},"additionalProperties":false,"description":"Dados de listagem do código de enquadramento legal do IPI."},"ListarEnquadramentosLegalIpiViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListarEnquadramentosLegalIpiViewModel"},"nullable":true}},"additionalProperties":false},"ListarHistoricoEventosNotaFiscalViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador interno do histórico do evento.","format":"uuid"},"tipoEvento":{"$ref":"#/components/schemas/TipoEventoNotaFiscalModelEnum"},"documentoEmissor":{"type":"string","description":"Documento (CPF/CNPJ) do emissor.","nullable":true},"nomeEmissor":{"type":"string","description":"Nome ou Razão Social do emissor.","nullable":true},"sucesso":{"type":"boolean","description":"Indica se o processamento do evento foi realizado com sucesso."},"rota":{"type":"string","description":"Rota ou endpoint do evento.","nullable":true},"inicioExecucao":{"type":"string","description":"Data de início da execução do evento.","format":"date-time"},"finalExecucao":{"type":"string","description":"Data do fim da execução do evento.","format":"date-time"},"duracaoMilissegundos":{"type":"number","description":"Tempo de duração do evento em milissegundos.","format":"double"},"duracao":{"type":"string","description":"Tempo de duração do evento.","nullable":true}},"additionalProperties":false,"description":"Dados da listagem do histórico de comandos de notas fiscais."},"ListarHistoricoEventosNotaFiscalViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListarHistoricoEventosNotaFiscalViewModel"},"nullable":true}},"additionalProperties":false},"ListarIndicadoresOperacaoNfseViewModel":{"type":"object","properties":{"codigo":{"type":"string","description":"Código indicador da operação de fornecimento (cIndOp).","nullable":true},"artigo":{"type":"string","description":"Artigo do indicador de operação.","nullable":true},"tipoOperacao":{"type":"string","description":"Tipo de operação do indicador.","nullable":true},"caracteristicaFornecimento":{"type":"string","description":"Característica do fornecimento do indicador.","nullable":true},"localFornecimento":{"type":"string","description":"Local do fornecimento do indicador.","nullable":true}},"additionalProperties":false,"description":"Dados de listagem de um indicador de operação de NFS-e."},"ListarIndicadoresOperacaoNfseViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListarIndicadoresOperacaoNfseViewModel"},"nullable":true}},"additionalProperties":false},"ListarNbsViewModel":{"type":"object","properties":{"codigoNbs":{"type":"string","description":"Código NBS (9 dígitos).","nullable":true},"descricao":{"type":"string","description":"Descrição do serviço conforme a tabela NBS.","nullable":true}},"additionalProperties":false,"description":"Dados de listagem de um código NBS (Nomenclatura Brasileira de Serviços)."},"ListarNbsViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListarNbsViewModel"},"nullable":true}},"additionalProperties":false},"ListarNcmsViewModel":{"type":"object","properties":{"codigoNcm":{"type":"string","description":"Código da Nomenclatura Comum do Mercosul.","nullable":true},"extensaoTipi":{"type":"integer","description":"Código de extensão da TIPI (Tabela de Incidência do IPI).","format":"int32"},"descricao":{"type":"string","description":"Descrição completa da mercadoria ou serviço vinculada ao NCM.","nullable":true},"inicioVigencia":{"type":"string","description":"Data de início da vigência do código NCM.","format":"date","example":"2025-03-31"},"fimVigencia":{"type":"string","description":"Data de término da vigência (opcional).","format":"date","nullable":true}},"additionalProperties":false,"description":"Dados para a listagem de NCMs."},"ListarNcmsViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListarNcmsViewModel"},"nullable":true}},"additionalProperties":false},"ListarNotasFiscaisServicoViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador interno da nota fiscal de serviço.","format":"uuid","nullable":true},"codigoErp":{"type":"string","description":"Identificador da operação no ERP.","nullable":true},"tipoAmbiente":{"$ref":"#/components/schemas/TipoAmbienteSefazModelEnum"},"tipoEmissor":{"$ref":"#/components/schemas/TipoEmissorNfseModelEnum"},"serie":{"type":"string","description":"Série da DPS.","nullable":true},"numeroDps":{"type":"integer","description":"Número sequencial da DPS.","format":"int64"},"numeroNfse":{"type":"integer","description":"Número sequencial da NFS-e gerado pelo ADN. Disponível após autorização.","format":"int64","nullable":true},"chaveNfse":{"type":"string","description":"Chave da NFS-e. Disponível após autorização pelo ADN.","nullable":true},"status":{"$ref":"#/components/schemas/StatusNotaFiscalServicoModelEnum"},"dataEmissao":{"type":"string","description":"Data e hora de emissão da DPS.","format":"date-time"},"dataCompetencia":{"type":"string","description":"Mês de competência da prestação do serviço (formato \"AAAA-MM\").","nullable":true},"dataAutorizacao":{"type":"string","description":"Data e hora de autorização pelo ADN.","format":"date-time","nullable":true},"dataCancelamento":{"type":"string","description":"Data e hora de cancelamento.","format":"date-time","nullable":true},"justificativaCancelamento":{"type":"string","description":"Justificativa do cancelamento.","nullable":true},"documentoPrestador":{"type":"string","description":"Documento (CPF ou CNPJ) do prestador do serviço.","nullable":true},"nomePrestador":{"type":"string","description":"Nome ou Razão Social do prestador do serviço.","nullable":true},"documentoTomador":{"type":"string","description":"Documento (CPF ou CNPJ) do tomador do serviço.","nullable":true},"nomeTomador":{"type":"string","description":"Nome ou Razão Social do tomador do serviço.","nullable":true},"descricaoServico":{"type":"string","description":"Descrição do serviço prestado.","nullable":true},"valorServico":{"type":"number","description":"Valor do serviço prestado.","format":"double"},"ultimoCstat":{"type":"integer","description":"Último código de status retornado pela sefaz.","format":"int32","nullable":true},"mensagemSefaz":{"type":"string","description":"Última mensagem retornada pelo ADN.","nullable":true},"protocoloAutorizacao":{"type":"string","description":"Protocolo de autorização emitido pelo ADN.","nullable":true}},"additionalProperties":false,"description":"Dados de listagem de notas fiscais de serviço eletrônicas (NFS-e Nacional)."},"ListarNotasFiscaisServicoViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListarNotasFiscaisServicoViewModel"},"nullable":true}},"additionalProperties":false},"ListarNotasFiscaisViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador interno do documento fiscal.","format":"uuid","nullable":true},"codigoErp":{"type":"string","description":"Identificador da operação fiscal no ERP.","nullable":true},"chaveAcesso":{"type":"string","description":"Chave de acesso do documento fiscal.","nullable":true},"modeloNotaFiscal":{"$ref":"#/components/schemas/ModeloNotaFiscalModelEnum"},"naturezaOperacao":{"type":"string","description":"Natureza da operação.","nullable":true},"numeroDocumento":{"type":"string","description":"Numero do documento fiscal.","nullable":true},"serie":{"type":"string","description":"Série do documento fiscal.","nullable":true},"tipoAmbiente":{"$ref":"#/components/schemas/TipoAmbienteSefazModelEnum"},"tipoOperacao":{"$ref":"#/components/schemas/TipoOperacaoNotaFiscalModelEnum"},"indicadorPresenca":{"$ref":"#/components/schemas/IndicadorPresencaNotaFiscalModelEnum"},"consumidorFinal":{"type":"boolean","description":"Indica se a operação foi destinada a consumidor final ou não."},"tipoIdDestino":{"$ref":"#/components/schemas/TipoIdDestinoNotaFiscalModelEnum"},"documentoParticipante":{"type":"string","description":"Documento do participante.","nullable":true},"nomeParticipante":{"type":"string","description":"Nome do participante.","nullable":true},"valorDocumento":{"type":"number","description":"Valor do documento.","format":"double"},"dataEmissao":{"type":"string","description":"Data de emissão do documento.","format":"date-time"},"dataSaidaEntrada":{"type":"string","description":"Data de saída/entrada.","format":"date-time","nullable":true},"dataCancelamento":{"type":"string","description":"Data de cancelamento do documento.","format":"date-time","nullable":true},"status":{"$ref":"#/components/schemas/StatusNotaFiscalModelEnum"},"ultimoCstat":{"type":"integer","description":"Último código de status retornado pela sefaz.","format":"int32","nullable":true},"mensagemSefaz":{"type":"string","description":"Última mensagem retornada pela sefaz.","nullable":true},"modalidadeFrete":{"$ref":"#/components/schemas/ModalidadeFreteNotaFiscalModelEnum"},"cnpjTransportador":{"type":"string","description":"CNPJ do transportador.","nullable":true},"nomeTransportador":{"type":"string","description":"Nome do transportador.","nullable":true},"cnpjIntermediador":{"type":"string","description":"CNPJ do intermediador.","nullable":true},"identificadorIntermediador":{"type":"string","description":"Identificador do intermediador.","nullable":true},"modoEmissao":{"$ref":"#/components/schemas/ModoEmissaoNotaFiscalModelEnum"},"modoContingenciaOffline":{"type":"boolean","description":"Indica se a nota fiscal foi emitida em modo de contingencia offline ou não."},"dataHoraEntradaContingencia":{"type":"string","description":"Data e hora de entrada em contingência offline.","format":"date-time","nullable":true},"justificativaContingencia":{"type":"string","description":"Justificativa de entrada em contingência offline.","nullable":true}},"additionalProperties":false,"description":"Dados de listagem de notas fiscais eletrônicas (NFe e NFCe)."},"ListarNotasFiscaisViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListarNotasFiscaisViewModel"},"nullable":true}},"additionalProperties":false},"ListarProdutosEmissorViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador interno do produto do emissor.","format":"uuid"},"hash":{"type":"string","description":"Hash de identificação da tributação.","nullable":true},"filtro":{"type":"string","description":"Filtro usado na consulta para identificar o produto.","nullable":true},"ultimaConsulta":{"type":"string","description":"Data da última consulta realizada.","format":"date-time"},"ultimaAtualizacaoFiscal":{"type":"string","description":"Data da última atualização fiscal.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Dados do produto do emissor."},"ListarProdutosEmissorViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListarProdutosEmissorViewModel"},"nullable":true}},"additionalProperties":false},"ListarServicoCtnViewModel":{"type":"object","properties":{"codigoCtn":{"type":"string","description":"Código do serviço conforme a Lista de Serviços do CTN.","nullable":true},"descricao":{"type":"string","description":"Descrição do serviço.","nullable":true},"incidenciaIss":{"$ref":"#/components/schemas/IncidenciaIssCtnModelEnum"}},"additionalProperties":false,"description":"Dados de listagem de um serviço da Lista de Serviços do CTN."},"ListarServicoCtnViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListarServicoCtnViewModel"},"nullable":true}},"additionalProperties":false},"ListarTributacaoAlteradaViewModel":{"type":"object","properties":{"hash":{"type":"string","description":"Hash de identificação da tributação.","nullable":true},"ultimaConsulta":{"type":"string","description":"Data da última consulta realizada.","format":"date-time"},"ultimaAtualizacaoFiscal":{"type":"string","description":"Data da última atualização fiscal.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Dados da tributação alterada."},"ListarTributacaoAlteradaViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListarTributacaoAlteradaViewModel"},"nullable":true}},"additionalProperties":false},"MensagemNfseViewModel":{"type":"object","properties":{"codigo":{"type":"string","description":"Código da mensagem.","nullable":true},"descricao":{"type":"string","description":"Descrição da mensagem.","nullable":true},"complemento":{"type":"string","description":"Complemento da mensagem.","nullable":true}},"additionalProperties":false,"description":"Mensagem de processamento retornada pelo ADN."},"ModalidadeFreteNotaFiscalModelEnum":{"enum":["Cif","Fob","FretePorContaDeTerceiros","TransporteProprioRemetente","TransporteProprioDestinatario","SemOcorrenciaDeTransporte"],"type":"string","description":"Modalidade de frete."},"ModeloDocumentoDownloadXmlModelEnum":{"enum":["Nfe","Nfce"],"type":"string","description":"Modelo de documentos solicitados para download."},"ModeloNotaFiscalModelEnum":{"enum":["Nfe","Nfce"],"type":"string","description":"Modelo de nota fiscal."},"ModoConsultaProdutoModelEnum":{"enum":["ConsultaProduto","EmissaoDeNotaFiscal"],"type":"string","description":"Tipo de consulta realizada pelo emissor."},"ModoEmissaoNotaFiscalModelEnum":{"enum":["EmissaoCompleta","EmissaoSimplificada","EmissaoAutomatica"],"type":"string","description":"Modo de emissão da nota fiscal."},"ModoOrdenacaoModelEnum":{"enum":["Crescente","Decrescente"],"type":"string","description":"Modo de ordenação da listagem de emissores, aplicatovos ou parceiros."},"MotivoSubstituicaoNfseModelEnum":{"enum":["DesenquadramentoSimplesNacional","EnquadramentoSimplesNacional","InclusaoRetroativaImunidadeIsencao","ExclusaoRetroativaImunidadeIsencao","RejeicaoPeloTomadorOuIntermediario","Outros"],"type":"string","description":"Código do motivo da substituição de uma NFS-e (cMotivo)."},"NcmCestViewModel":{"type":"object","properties":{"codigoCest":{"type":"string","description":"CEST - Código especificador da substituição tributária.","nullable":true},"descricao":{"type":"string","description":"Descrição do CEST.","nullable":true}},"additionalProperties":false,"description":"Dados do CEST do NCM."},"NcmTributoAproximadoViewModel":{"type":"object","properties":{"uf":{"$ref":"#/components/schemas/UfTributoAproximadoModelEnum"},"aproximadoMunicipal":{"type":"number","description":"Alíquota aproximada dos tributos municipais.","format":"double"},"aproximadoEstadual":{"type":"number","description":"Alíquota aproximada dos tributos estaduais.","format":"double"},"aproximadoNacional":{"type":"number","description":"Alíquota aproximada dos tributos nacionais (federais).","format":"double"},"aproximadoImportados":{"type":"number","description":"Alíquota aproximada para produtos importados.","format":"double"},"fonte":{"type":"string","description":"Fonte da informação técnica (ex: IBPT).","nullable":true}},"additionalProperties":false,"description":"Dados dos tributos aproximados vinculados a um NCM (Lei da Transparência)."},"NcmViewModel":{"type":"object","properties":{"codigoNcm":{"type":"string","description":"Código da Nomenclatura Comum do Mercosul.","nullable":true},"extensaoTipi":{"type":"integer","description":"Código de extensão da TIPI (Tabela de Incidência do IPI).","format":"int32"},"descricao":{"type":"string","description":"Descrição completa da mercadoria ou serviço vinculada ao NCM.","nullable":true},"inicioVigencia":{"type":"string","description":"Data de início da vigência do código NCM.","format":"date","example":"2025-03-31"},"fimVigencia":{"type":"string","description":"Data de término da vigência (opcional).","format":"date","nullable":true},"tributosAproximados":{"type":"array","items":{"$ref":"#/components/schemas/NcmTributoAproximadoViewModel"},"description":"Lista de tributos aproximados por UF.","nullable":true},"cests":{"type":"array","items":{"$ref":"#/components/schemas/NcmCestViewModel"},"description":"Lista de CEST´s associados ao NCM.","nullable":true}},"additionalProperties":false,"description":"Dados detalhados do NCM."},"NfceAutomaticaInputModel":{"required":["codigoErp","itens","pagamentos","valorTotal"],"type":"object","properties":{"codigoErp":{"minLength":1,"type":"string","description":"Identificador da pré-venda no ERP."},"serie":{"type":"string","description":"Série do documento fiscal (Informar somente se estiver configurado para geração numérica manual).","nullable":true},"numeroDocumento":{"type":"integer","description":"Numero do documento fiscal (Informar somente se estiver configurado para geração numérica manual).","format":"int64","nullable":true},"naturezaOperacao":{"type":"string","description":"Descrição da natureza da operação.","nullable":true},"indicadorPresenca":{"$ref":"#/components/schemas/IndicadorPresencaNfceModelEnum"},"tipoEmissao":{"$ref":"#/components/schemas/TipoEmissaoNfceModelEnum"},"dataHoraEntradaContingencia":{"type":"string","description":"Data e hora de entrada em contingência (Opcional).","format":"date-time","nullable":true},"justificativaContingencia":{"type":"string","description":"Justificativa de entrada em contingência (Opcional).","nullable":true},"destinatario":{"$ref":"#/components/schemas/DestinatarioNfceAutomaticaInputModel"},"enderecoEntrega":{"$ref":"#/components/schemas/EnderecoEntregaNfceAutomaticaInputModel"},"enderecoRetirada":{"$ref":"#/components/schemas/EnderecoRetiradaNfceAutomaticaInputModel"},"itens":{"type":"array","items":{"$ref":"#/components/schemas/ItemNfceAutomaticaInputModel"},"description":"Itens da nota fiscal."},"transporte":{"$ref":"#/components/schemas/TransporteNfceAutomaticaInputModel"},"cobranca":{"$ref":"#/components/schemas/CobrancaNfceAutomaticaInputModel"},"pagamentos":{"$ref":"#/components/schemas/PagamentosNfceAutomaticaInputModel"},"informacaoAdicionalFisco":{"maxLength":2000,"type":"string","description":"Informação adicional de interesse do fisco.","nullable":true},"informacaoComplementar":{"maxLength":5000,"type":"string","description":"Informação complementar.","nullable":true},"valorTotal":{"type":"number","description":"Valor total do documento fiscal (Não incluir os impostos da reforma tributária: IBS, CBS e IS).","format":"double"}},"additionalProperties":false,"description":"Dados da nota fiscal eletrônica Automática."},"NfceInputModel":{"required":["codigoErp","itens","pagamentos","valorTotal"],"type":"object","properties":{"codigoErp":{"minLength":1,"type":"string","description":"Identificador da pré-venda no ERP."},"serie":{"type":"string","description":"Série do documento fiscal (Informar somente se estiver configurado para geração numérica manual).","nullable":true},"numeroDocumento":{"type":"integer","description":"Numero do documento fiscal (Informar somente se estiver configurado para geração numérica manual).","format":"int64","nullable":true},"naturezaOperacao":{"type":"string","description":"Descrição da natureza da operação.","nullable":true},"indicadorPresenca":{"$ref":"#/components/schemas/IndicadorPresencaNfceModelEnum"},"tipoEmissao":{"$ref":"#/components/schemas/TipoEmissaoNfceModelEnum"},"dataHoraEntradaContingencia":{"type":"string","description":"Data e hora de entrada em contingência (Opcional).","format":"date-time","nullable":true},"justificativaContingencia":{"type":"string","description":"Justificativa de entrada em contingência (Opcional).","nullable":true},"destinatario":{"$ref":"#/components/schemas/DestinatarioNfceInputModel"},"enderecoEntrega":{"$ref":"#/components/schemas/EnderecoEntregaNfceInputModel"},"enderecoRetirada":{"$ref":"#/components/schemas/EnderecoRetiradaNfceInputModel"},"itens":{"type":"array","items":{"$ref":"#/components/schemas/ItemNfceInputModel"},"description":"Itens da nota fiscal."},"transporte":{"$ref":"#/components/schemas/TransporteNfceInputModel"},"pagamentos":{"$ref":"#/components/schemas/PagamentosNfceInputModel"},"informacaoAdicionalFisco":{"maxLength":2000,"type":"string","description":"Informação adicional de interesse do fisco.","nullable":true},"informacaoComplementar":{"maxLength":5000,"type":"string","description":"Informação complementar.","nullable":true},"valorTotal":{"type":"number","description":"Valor total do documento fiscal (Não incluir os impostos da reforma tributária: IBS, CBS e IS).","format":"double"}},"additionalProperties":false,"description":"Dados da nota fiscal eletrônica simplificada."},"NfceSimplificadaInputModel":{"required":["codigoErp","itens","pagamentos","valorTotal"],"type":"object","properties":{"codigoErp":{"minLength":1,"type":"string","description":"Identificador da pré-venda no ERP."},"serie":{"type":"string","description":"Série do documento fiscal (Informar somente se estiver configurado para geração numérica manual).","nullable":true},"numeroDocumento":{"type":"integer","description":"Numero do documento fiscal (Informar somente se estiver configurado para geração numérica manual).","format":"int64","nullable":true},"naturezaOperacao":{"type":"string","description":"Descrição da natureza da operação.","nullable":true},"indicadorPresenca":{"$ref":"#/components/schemas/IndicadorPresencaNfceModelEnum"},"tipoEmissao":{"$ref":"#/components/schemas/TipoEmissaoNfceModelEnum"},"dataHoraEntradaContingencia":{"type":"string","description":"Data e hora de entrada em contingência (Opcional).","format":"date-time","nullable":true},"justificativaContingencia":{"type":"string","description":"Justificativa de entrada em contingência (Opcional).","nullable":true},"destinatario":{"$ref":"#/components/schemas/DestinatarioNfceSimplificadaInputModel"},"enderecoEntrega":{"$ref":"#/components/schemas/EnderecoEntregaNfceSimplificadaInputModel"},"enderecoRetirada":{"$ref":"#/components/schemas/EnderecoRetiradaNfceSimplificadaInputModel"},"itens":{"type":"array","items":{"$ref":"#/components/schemas/ItemNfceSimplificadaInputModel"},"description":"Itens da nota fiscal."},"transporte":{"$ref":"#/components/schemas/TransporteNfceSimplificadaInputModel"},"pagamentos":{"$ref":"#/components/schemas/PagamentosNfceSimplificadaInputModel"},"informacaoAdicionalFisco":{"maxLength":2000,"type":"string","description":"Informação adicional de interesse do fisco.","nullable":true},"informacaoComplementar":{"maxLength":5000,"type":"string","description":"Informação complementar.","nullable":true},"valorTotal":{"type":"number","description":"Valor total do documento fiscal (Não incluir os impostos da reforma tributária: IBS, CBS e IS).","format":"double"}},"additionalProperties":false,"description":"Dados da nota fiscal eletrônica simplificada."},"NfeAutomaticaInputModel":{"required":["codigoErp","destinatario","itens"],"type":"object","properties":{"codigoErp":{"minLength":1,"type":"string","description":"Identificador da pré-venda no ERP."},"serie":{"type":"string","description":"Série do documento fiscal (Informar somente se estiver configurado para geração numérica manual).","nullable":true},"numeroDocumento":{"type":"integer","description":"Numero do documento fiscal (Informar somente se estiver configurado para geração numérica manual).","format":"int64","nullable":true},"naturezaOperacao":{"type":"string","description":"Descrição da natureza da operação.","nullable":true},"fluxoFiscalAutomatico":{"$ref":"#/components/schemas/FluxoFiscalAutomaticoModelEnum"},"indicadorPresenca":{"$ref":"#/components/schemas/IndicadorPresencaNfeModelEnum"},"tipoEmissao":{"$ref":"#/components/schemas/TipoEmissaoNfeModelEnum"},"dataHoraEntradaContingencia":{"type":"string","description":"Data e hora de entrada em contingência (Opcional).","format":"date-time","nullable":true},"justificativaContingencia":{"type":"string","description":"Justificativa de entrada em contingência (Opcional).","nullable":true},"dataSaidaEntrada":{"type":"string","description":"Data de saída/entrada.","format":"date-time","nullable":true},"destinatario":{"$ref":"#/components/schemas/DestinatarioNfeAutomaticaInputModel"},"enderecoEntrega":{"$ref":"#/components/schemas/EnderecoEntregaNfeAutomaticaInputModel"},"enderecoRetirada":{"$ref":"#/components/schemas/EnderecoRetiradaNfeAutomaticaInputModel"},"autXml":{"type":"array","items":{"$ref":"#/components/schemas/NfeAuxXmlInputModel"},"description":"Documentos autorizados a visualizar a NFe.","nullable":true},"itens":{"type":"array","items":{"$ref":"#/components/schemas/ItemNfeAutomaticaInputModel"},"description":"Itens da nota fiscal."},"transporte":{"$ref":"#/components/schemas/TransporteNfeAutomaticaInputModel"},"cnpjIntermediador":{"type":"string","description":"CNPJ do intermediador.","nullable":true},"identificadorIntermediador":{"type":"string","description":"Identificador do intermediador.","nullable":true},"informacaoAdicionalFisco":{"maxLength":2000,"type":"string","description":"Informação adicional de interesse do fisco.","nullable":true},"informacaoComplementar":{"maxLength":5000,"type":"string","description":"Informação complementar.","nullable":true}},"additionalProperties":false,"description":"Dados da nota fiscal eletrônica Automática."},"NfeAuxXmlInputModel":{"required":["documento"],"type":"object","properties":{"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documento":{"minLength":1,"type":"string","description":"Documento autorizado."}},"additionalProperties":false,"description":"Documentos autorizados a capturar e visualizar a NFe."},"NfeInputModel":{"required":["codigoErp","destinatario","itens","pagamentos","valorTotal"],"type":"object","properties":{"codigoErp":{"minLength":1,"type":"string","description":"Identificador da operação fiscal no ERP."},"serie":{"type":"string","description":"Série do documento fiscal (Informar somente se estiver configurado para geração numérica manual).","nullable":true},"numeroDocumento":{"type":"integer","description":"Numero do documento fiscal (Informar somente se estiver configurado para geração numérica manual).","format":"int64","nullable":true},"naturezaOperacao":{"type":"string","description":"Descrição da natureza da operação.","nullable":true},"tipoOperacao":{"$ref":"#/components/schemas/TipoOperacaoNotaFiscalModelEnum"},"indicadorPresenca":{"$ref":"#/components/schemas/IndicadorPresencaNfeModelEnum"},"consumidorFinal":{"type":"boolean","description":"Indica se é operação com consumidor final.","nullable":true},"tipoEmissao":{"$ref":"#/components/schemas/TipoEmissaoNfeModelEnum"},"dataHoraEntradaContingencia":{"type":"string","description":"Data e hora de entrada em contingência (Opcional).","format":"date-time","nullable":true},"justificativaContingencia":{"type":"string","description":"Justificativa de entrada em contingência (Opcional).","nullable":true},"finalidade":{"$ref":"#/components/schemas/FinalidadeNfeModelEnum"},"dataSaidaEntrada":{"type":"string","description":"Data de saída/entrada.","format":"date-time","nullable":true},"destinatario":{"$ref":"#/components/schemas/DestinatarioNfeInputModel"},"enderecoEntrega":{"$ref":"#/components/schemas/EnderecoEntregaNfeInputModel"},"enderecoRetirada":{"$ref":"#/components/schemas/EnderecoRetiradaNfeInputModel"},"autXml":{"type":"array","items":{"$ref":"#/components/schemas/NfeAuxXmlInputModel"},"description":"Documentos autorizados a visualizar a NFe.","nullable":true},"itens":{"type":"array","items":{"$ref":"#/components/schemas/ItemNfeInputModel"},"description":"Itens da nota fiscal."},"notasReferenciadas":{"type":"array","items":{"$ref":"#/components/schemas/NfeNotasReferenciadasInputModel"},"description":"Lista de notas referenciadas na NFe se houver. Utilizado para informar documentos fiscais relacionados, como em casos de devolução, remessa para conserto, entre outros cenários que exigem a referência a outras notas fiscais.","nullable":true},"transporte":{"$ref":"#/components/schemas/TransporteNfeInputModel"},"cobranca":{"$ref":"#/components/schemas/CobrancaNfeInputModel"},"pagamentos":{"$ref":"#/components/schemas/PagamentosNfeInputModel"},"cnpjIntermediador":{"type":"string","description":"CNPJ do intermediador.","nullable":true},"identificadorIntermediador":{"type":"string","description":"Identificador do intermediador.","nullable":true},"exportacao":{"$ref":"#/components/schemas/ExportacaoNfeInputModel"},"informacaoAdicionalFisco":{"maxLength":2000,"type":"string","description":"Informação adicional de interesse do fisco.","nullable":true},"informacaoComplementar":{"maxLength":5000,"type":"string","description":"Informação complementar.","nullable":true},"valorTotal":{"type":"number","description":"Valor total do documento fiscal (Não incluir os impostos da reforma tributária: IBS, CBS e IS).","format":"double"}},"additionalProperties":false,"description":"Dados da nota fiscal eletrônica."},"NfeNotasReferenciadasInputModel":{"required":["chaveAcesso"],"type":"object","properties":{"tipoNotaReferenciada":{"$ref":"#/components/schemas/TipoNotaReferenciadaModelEnum"},"chaveAcesso":{"minLength":1,"type":"string","description":"Chave de acesso da nota referenciada."}},"additionalProperties":false,"description":"Dados para notas referenciadas na NFe."},"NfeSimplificadaInputModel":{"required":["codigoErp","destinatario","itens"],"type":"object","properties":{"codigoErp":{"minLength":1,"type":"string","description":"Identificador da operação fiscal no ERP."},"serie":{"type":"string","description":"Série do documento fiscal (Informar somente se estiver configurado para geração numérica manual).","nullable":true},"numeroDocumento":{"type":"integer","description":"Numero do documento fiscal (Informar somente se estiver configurado para geração numérica manual).","format":"int64","nullable":true},"naturezaOperacao":{"type":"string","description":"Descrição da natureza da operação.","nullable":true},"tipoOperacao":{"$ref":"#/components/schemas/TipoOperacaoNotaFiscalModelEnum"},"indicadorPresenca":{"$ref":"#/components/schemas/IndicadorPresencaNfeModelEnum"},"consumidorFinal":{"type":"boolean","description":"Indica se é operação com consumidor final.","nullable":true},"tipoEmissao":{"$ref":"#/components/schemas/TipoEmissaoNfeModelEnum"},"dataHoraEntradaContingencia":{"type":"string","description":"Data e hora de entrada em contingência (Opcional).","format":"date-time","nullable":true},"justificativaContingencia":{"type":"string","description":"Justificativa de entrada em contingência (Opcional).","nullable":true},"dataSaidaEntrada":{"type":"string","description":"Data de saída/entrada.","format":"date-time","nullable":true},"destinatario":{"$ref":"#/components/schemas/DestinatarioNfeSimplificadaInputModel"},"enderecoEntrega":{"$ref":"#/components/schemas/EnderecoEntregaNfeSimplificadaInputModel"},"enderecoRetirada":{"$ref":"#/components/schemas/EnderecoRetiradaNfeSimplificadaInputModel"},"autXml":{"type":"array","items":{"$ref":"#/components/schemas/NfeAuxXmlInputModel"},"description":"Documentos autorizados a visualizar a NFe.","nullable":true},"itens":{"type":"array","items":{"$ref":"#/components/schemas/ItemNfeSimplificadaInputModel"},"description":"Itens da nota fiscal."},"transporte":{"$ref":"#/components/schemas/TransporteNfeSimplificadaInputModel"},"cnpjIntermediador":{"type":"string","description":"CNPJ do intermediador.","nullable":true},"identificadorIntermediador":{"type":"string","description":"Identificador do intermediador.","nullable":true},"exportacao":{"$ref":"#/components/schemas/ExportacaoNfeSimplificadaInputModel"},"informacaoAdicionalFisco":{"maxLength":2000,"type":"string","description":"Informação adicional de interesse do fisco.","nullable":true},"informacaoComplementar":{"maxLength":5000,"type":"string","description":"Informação complementar.","nullable":true}},"additionalProperties":false,"description":"Dados da nota fiscal eletrônica."},"ObterAliquotaIssDoMunicipioNfseViewModel":{"type":"object","properties":{"incidencia":{"type":"string","description":"Tipo de incidência da alíquota.","nullable":true},"aliquota":{"type":"number","description":"Valor percentual da alíquota de ISS.","format":"double"},"dataInicioVigencia":{"type":"string","description":"Data de início da vigência da alíquota.","format":"date-time"},"dataFimVigencia":{"type":"string","description":"Data de fim da vigência da alíquota, se houver.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Alíquota de ISS vigente do município para o serviço informado."},"ObterDetalheCestNcmViewModel":{"type":"object","properties":{"codigoNcm":{"type":"string","description":"Código da Nomenclatura Comum do Mercosul.","nullable":true},"extensaoTipi":{"type":"integer","description":"Código de extensão da TIPI (Tabela de Incidência do IPI).","format":"int32"},"descricao":{"type":"string","description":"Descrição completa da mercadoria ou serviço vinculada ao NCM.","nullable":true}},"additionalProperties":false,"description":"Dados do NCM no detalhe do CEST."},"ObterDetalheCestViewModel":{"type":"object","properties":{"codigoCest":{"type":"string","description":"CEST - Código especificador da substituição tributária.","nullable":true},"descricao":{"type":"string","description":"Descrição do CEST.","nullable":true},"ncms":{"type":"array","items":{"$ref":"#/components/schemas/ObterDetalheCestNcmViewModel"},"description":"Lista de NCM´s associados ao CEST.","nullable":true}},"additionalProperties":false,"description":"Dados detalhados do CEST."},"ObterDetalheConsultaCnpjAplicacaoViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único da consulta.","format":"uuid"},"filtro":{"type":"string","description":"Filtro utilizado na consulta (CNPJ).","nullable":true},"statusConsulta":{"$ref":"#/components/schemas/StatusHistoricoConsultaCnpjModelEnum"},"dataConsulta":{"type":"string","description":"Data e hora em que a consulta foi registrada.","format":"date-time"},"mensagemFalha":{"type":"string","description":"Mensagem detalhando o motivo de uma eventual falha.","nullable":true},"jsonResultadoInformado":{"type":"string","description":"JSON com o resultado final processado ou informado.","nullable":true}},"additionalProperties":false,"description":"Dados detalhados do histórico de consulta de CNPJ."},"ObterDetalheConsultaCnpjCrmViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único da consulta.","format":"uuid"},"filtro":{"type":"string","description":"Filtro utilizado na consulta (CNPJ).","nullable":true},"statusConsulta":{"$ref":"#/components/schemas/StatusHistoricoConsultaCnpjModelEnum"},"dataConsulta":{"type":"string","description":"Data e hora em que a consulta foi registrada.","format":"date-time"},"fonteOrigem":{"type":"string","description":"Identificação da fonte de origem da informação.","nullable":true},"dadosEnvioFonte":{"type":"string","description":"Dados que foram enviados para a fonte de consulta.","nullable":true},"jsonRetornoFonte":{"type":"string","description":"JSON bruto retornado pela fonte original.","nullable":true},"mensagemFalha":{"type":"string","description":"Mensagem detalhando o motivo de uma eventual falha.","nullable":true},"jsonResultadoInformado":{"type":"string","description":"JSON com o resultado final processado ou informado.","nullable":true}},"additionalProperties":false,"description":"Dados detalhados do histórico de consulta de CNPJ."},"ObterDetalheHistoricoEventosNotaFiscalViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador interno do histórico do evento.","format":"uuid"},"tipoEvento":{"$ref":"#/components/schemas/TipoEventoNotaFiscalModelEnum"},"documentoEmissor":{"type":"string","description":"Documento (CPF/CNPJ) do emissor.","nullable":true},"nomeEmissor":{"type":"string","description":"Nome ou Razão Social do emissor.","nullable":true},"sucesso":{"type":"boolean","description":"Indica se o processamento do evento foi realizado com sucesso."},"rota":{"type":"string","description":"Rota ou endpoint do evento.","nullable":true},"jsonEnviado":{"type":"string","description":"Conteúdo do body enviado na requisição.","nullable":true},"jsonRetornado":{"type":"string","description":"Conteúdo retornado na requisição.","nullable":true},"inicioExecucao":{"type":"string","description":"Data de início da execução do evento.","format":"date-time"},"finalExecucao":{"type":"string","description":"Data do fim da execução do evento.","format":"date-time"},"duracaoMilissegundos":{"type":"number","description":"Tempo de duração do evento em milissegundos.","format":"double"},"duracao":{"type":"string","description":"Tempo de duração do evento.","nullable":true}},"additionalProperties":false,"description":"Dados detalhados do histórico de evento de nota fiscal."},"ObterDetalheServicoCtnCClassTribViewModel":{"type":"object","properties":{"cClassTrib":{"type":"string","description":"Código da classificação tributária.","nullable":true}},"additionalProperties":false,"description":"Dados da classificação tributária no detalhe do Serviço CTN."},"ObterDetalheServicoCtnIndicadorOperacaoNfseViewModel":{"type":"object","properties":{"codigo":{"type":"string","description":"Código do indicador de operação (cIndOp).","nullable":true},"artigo":{"type":"string","description":"Artigo legal relacionado ao indicador de operação.","nullable":true},"tipoOperacao":{"type":"string","description":"Tipo de operação do serviço.","nullable":true},"caracteristicaFornecimento":{"type":"string","description":"Característica do fornecimento do serviço.","nullable":true},"localFornecimento":{"type":"string","description":"Local de fornecimento do serviço.","nullable":true}},"additionalProperties":false,"description":"Dados do indicador de operação de NFS-e no detalhe do Serviço CTN."},"ObterDetalheServicoCtnNbsViewModel":{"type":"object","properties":{"codigoNbs":{"type":"string","description":"Código da Nomenclatura Brasileira de Serviços.","nullable":true},"descricao":{"type":"string","description":"Descrição do serviço conforme a NBS.","nullable":true}},"additionalProperties":false,"description":"Dados do NBS no detalhe do Serviço CTN."},"ObterDetalheServicoCtnViewModel":{"type":"object","properties":{"codigoCtn":{"type":"string","description":"Código do serviço conforme a Lista de Serviços do CTN.","nullable":true},"descricao":{"type":"string","description":"Descrição do serviço.","nullable":true},"incidenciaIss":{"$ref":"#/components/schemas/IncidenciaIssCtnModelEnum"},"nbs":{"type":"array","items":{"$ref":"#/components/schemas/ObterDetalheServicoCtnNbsViewModel"},"description":"Lista de códigos NBS associados ao serviço.","nullable":true},"indicadoresOperacaoNfse":{"type":"array","items":{"$ref":"#/components/schemas/ObterDetalheServicoCtnIndicadorOperacaoNfseViewModel"},"description":"Lista de indicadores de operação de NFS-e associados ao serviço.","nullable":true},"cClassTribs":{"type":"array","items":{"$ref":"#/components/schemas/ObterDetalheServicoCtnCClassTribViewModel"},"description":"Lista de classificações tributárias associadas ao serviço.","nullable":true}},"additionalProperties":false,"description":"Dados detalhados de um serviço da Lista de Serviços do CTN."},"ObterParametrosMunicipioNfseViewModel":{"type":"object","properties":{"parametrosConvenio":{"$ref":"#/components/schemas/ParametrosConvenioMunicipioNfseViewModel"},"retencoes":{"$ref":"#/components/schemas/RetencoesDetalhesMunicipioNfseViewModel"}},"additionalProperties":false,"description":"Parâmetros do município para emissão de NFS-e."},"ObterResumoConsultaCnpjAplicacaoViewModel":{"type":"object","properties":{"totalConsultas":{"type":"integer","description":"Total de consultas realizadas pelo emissor.","format":"int32"},"totalSucesso":{"type":"integer","description":"Total de consultas concluídas com sucesso.","format":"int32"},"totalNaoEncontrado":{"type":"integer","description":"Total de consultas cujo CNPJ não foi encontrado.","format":"int32"},"totalFalha":{"type":"integer","description":"Total de consultas que apresentaram falhas no processo.","format":"int32"}},"additionalProperties":false,"description":"Dados do resumo do histórico de consultas de CNPJ."},"ObterResumoConsultaCnpjCrmViewModel":{"type":"object","properties":{"totalConsultas":{"type":"integer","description":"Total de consultas realizadas pelo emissor.","format":"int32"},"totalSucesso":{"type":"integer","description":"Total de consultas concluídas com sucesso.","format":"int32"},"totalNaoEncontrado":{"type":"integer","description":"Total de consultas cujo CNPJ não foi encontrado.","format":"int32"},"totalFalha":{"type":"integer","description":"Total de consultas que apresentaram falhas no processo.","format":"int32"}},"additionalProperties":false,"description":"Dados do resumo do histórico de consultas de CNPJ."},"ObterResumoHistoricoEventosNotaFiscalViewModel":{"type":"object","properties":{"tipoEvento":{"$ref":"#/components/schemas/TipoEventoNotaFiscalModelEnum"},"totalEventos":{"type":"integer","description":"Quantidade total de eventos registrados para o tipo de evento e filtros aplicados.","format":"int32"},"totalSucesso":{"type":"integer","description":"Quantidade total de eventos processados com sucesso para o tipo de evento e filtros aplicados.","format":"int32"},"totalFalha":{"type":"integer","description":"Quantidade total de eventos processados com falha para o tipo de evento e filtros aplicados.","format":"int32"}},"additionalProperties":false,"description":"Resumo do histórico de eventos de nota fiscal."},"ObterStatusFiscalNfseViewModel":{"type":"object","properties":{"codigoErp":{"type":"string","description":"Identificador da operação fiscal no ERP.","nullable":true},"serie":{"type":"string","description":"Série da DPS.","nullable":true},"numeroDps":{"type":"integer","description":"Número sequencial da DPS.","format":"int64"},"numeroNfse":{"type":"integer","description":"Número sequencial da NFS-e gerado pelo ADN após autorização.","format":"int64","nullable":true},"chaveNfse":{"type":"string","description":"Chave de acesso da NFS-e.","nullable":true},"dataEmissao":{"type":"string","description":"Data de emissão da DPS.","format":"date-time"},"dataCompetencia":{"type":"string","description":"Mês de competência da prestação do serviço (formato \"AAAA-MM\").","nullable":true},"tipoAmbiente":{"$ref":"#/components/schemas/TipoAmbienteSefazModelEnum"},"status":{"$ref":"#/components/schemas/StatusNotaFiscalServicoModelEnum"},"ultimoCstat":{"type":"integer","description":"Último código de status retornado pela sefaz.","format":"int32","nullable":true},"mensagemSefaz":{"type":"string","description":"Última mensagem retornada pelo ADN.","nullable":true},"protocoloAutorizacao":{"type":"string","description":"Protocolo de autorização emitido pelo ADN.","nullable":true}},"additionalProperties":false,"description":"Dados fiscais de uma nota fiscal de serviço identificada pelo filtro."},"ObterStatusFiscalViewModel":{"type":"object","properties":{"codigoErp":{"type":"string","description":"Identificador da operação fiscal no ERP.","nullable":true},"modelo":{"$ref":"#/components/schemas/ModeloNotaFiscalModelEnum"},"serie":{"type":"string","description":"Série do documento fiscal.","nullable":true},"numeroDocumento":{"type":"integer","description":"Número do documento fiscal.","format":"int64"},"chaveAcesso":{"type":"string","description":"Chave de acesso do documento fiscal.","nullable":true},"dataEmissao":{"type":"string","description":"Data de emissão do documento fiscal.","format":"date-time"},"naturezaOperacao":{"type":"string","description":"Natureza da operação.","nullable":true},"tipoAmbiente":{"$ref":"#/components/schemas/TipoAmbienteSefazModelEnum"},"status":{"$ref":"#/components/schemas/StatusNotaFiscalModelEnum"},"ultimoCstat":{"type":"integer","description":"Último código de status retornado pela sefaz.","format":"int32","nullable":true},"mensagemSefaz":{"type":"string","description":"Última mensagem retornada pela SEFAZ.","nullable":true},"qrcodeLink":{"type":"string","description":"Link do QR Code da NFC-e.","nullable":true},"protocoloAutorizacao":{"type":"string","description":"Protocolo de autorização emitido pela SEFAZ.","nullable":true},"protocoloCancelamento":{"type":"string","description":"Protocolo de cancelamento emitido pela SEFAZ.","nullable":true}},"additionalProperties":false,"description":"Dados fiscais de uma nota fiscal identificada pelo código ERP."},"ObterTotalizacaoListagemNfseViewModel":{"type":"object","properties":{"quantidadeTotalNotas":{"type":"integer","description":"Quantidade total de notas.","format":"int32"},"quantidadeTotalNotasAprovadas":{"type":"integer","description":"Quantidade total de notas autorizadas.","format":"int32"},"quantidadeTotalNotasCanceladas":{"type":"integer","description":"Quantidade total de notas canceladas.","format":"int32"},"quantidadeTotalNotasRejeitadas":{"type":"integer","description":"Quantidade total de notas rejeitadas.","format":"int32"},"quantidadeTotalNotasPendentes":{"type":"integer","description":"Quantidade total de notas pendentes de emissão.","format":"int32"},"quantidadeTotalNotasSubstituidas":{"type":"integer","description":"Quantidade total de notas substituídas por nova emissão.","format":"int32"},"valorTotalNotas":{"type":"number","description":"Valor total em notas fiscais de serviço.","format":"double"},"valorTotalNotasAprovadas":{"type":"number","description":"Valor total de notas autorizadas.","format":"double"},"valorTotalNotasCanceladas":{"type":"number","description":"Valor total de notas canceladas.","format":"double"},"valorTotalNotasRejeitadas":{"type":"number","description":"Valor total de notas rejeitadas.","format":"double"},"valorTotalNotasPendentes":{"type":"number","description":"Valor total de notas pendentes de emissão.","format":"double"},"valorTotalNotasSubstituidas":{"type":"number","description":"Valor total de notas substituídas por nova emissão.","format":"double"}},"additionalProperties":false,"description":"Dados totalizados da listagem de notas fiscais de serviço (NFS-e Nacional)."},"ObterTotalizacaoListagemViewModel":{"type":"object","properties":{"quantidadeTotalNotas":{"type":"integer","description":"Quantidade total de notas.","format":"int32"},"quantidadeTotalNotasAprovadas":{"type":"integer","description":"Quantidade total de notas aprovadas.","format":"int32"},"quantidadeTotalNotasCanceladas":{"type":"integer","description":"Quantidade total de notas canceladas, em cancelamento ou inutilizadas.","format":"int32"},"quantidadeTotalNotasRejeitadas":{"type":"integer","description":"Quantidade total de notas rejeitadas.","format":"int32"},"quantidadeTotalNotasPendentes":{"type":"integer","description":"Quantidade total de notas pendentes de emissão.","format":"int32"},"quantidadeTotalNotasEmContingencia":{"type":"integer","description":"Quantidade total de notas geradas em contingência pendentes de transmissão.","format":"int32"},"quantidadeTotalNotasSubstituidas":{"type":"integer","description":"Quantidade total de notas substituidas por nota em contingencia devido a timed out na emissão.","format":"int32"},"valorTotalNotas":{"type":"number","description":"Valor total em notas fiscais.","format":"double"},"valorTotalNotasAprovadas":{"type":"number","description":"Valor total de notas aprovadas.","format":"double"},"valorTotalNotasCanceladas":{"type":"number","description":"Valor total de notas canceladas, em cancelamento ou inutilizadas.","format":"double"},"valorTotalNotasRejeitadas":{"type":"number","description":"Valor total de notas rejeitadas.","format":"double"},"valorTotalNotasPendentes":{"type":"number","description":"Valor total de notas pendentes de emissão.","format":"double"},"valorTotalNotasEmContingencia":{"type":"number","description":"Valor total de notas geradas em contingência pendentes de transmissão.","format":"double"},"valorTotalNotasSubstituidas":{"type":"number","description":"Valor total de notas substituidas por nota em contingencia devido a timed out na emissão.","format":"double"}},"additionalProperties":false,"description":"Dados totalizados da listagem de notas fiscais."},"OpcaoSimpleNacionalNfseEnum":{"enum":["NaoOptante","OptanteMeEppAcimaLimite","OptanteMicroempresaAteSubLimite"],"type":"string"},"OpcaoSimpleNacionalNfseModelEnum":{"enum":["NaoOptante","OptanteMeEppAcimaLimite","OptanteMicroempresaAteSubLimite"],"type":"string","description":"Opção pelo Simples Nacional para fins do ISSQN (opSimpNac)."},"OrdenacaoListarNotasFiscaisModelEnum":{"enum":["DataEmissao","SerieNumeracao","NomeDestinatario"],"type":"string","description":"Campo pelo qual a listagem de notas fiscais será ordenada."},"OrdenacaoListarNotasFiscaisServicoModelEnum":{"enum":["DataEmissao","SerieNumeracao","NomeTomador"],"type":"string","description":"Campo pelo qual a listagem de notas fiscais de serviço será ordenada."},"OrdenacaoTopAplicativosModelEnum":{"enum":["DataCriacao","Nome","QuantidadeTotalEmissoresAtivos","QuantidadeTotalNotasEmitidas","ValorTotalNotasEmitidas","QuantidadeConsultasCnpj","QuantidadeConsultasCatalogoFiscal"],"type":"string","description":"Ordenação para top aplicativos."},"OrdenacaoTopEmissoresModelEnum":{"enum":["DataCriacao","Nome","QuantidadeTotalNotasEmitidas","ValorTotalNotasEmitidas","QuantidadeConsultasCnpj","QuantidadeConsultasCatalogoFiscal"],"type":"string","description":"Ordenação para top emissores."},"OrdenacaoTopParceirosModelEnum":{"enum":["DataCriacao","RazaoSocial","QuantidadeTotalAplicativosAtivos","QuantidadeTotalEmissoresAtivos","QuantidadeTotalNotasEmitidas","ValorTotalNotasEmitidas","QuantidadeConsultasCnpj","QuantidadeConsultasCatalogoFiscal"],"type":"string","description":"Ordenação para top parceiros."},"OrigemMercadoriaNotaFiscalModelEnum":{"enum":["Nacional","EstrangeiraImportacaoDireta","EstrangeiraAdquiridaMercadoInterno","NacionalConteudoImportacaoEntre40e70","NacionalProducaoEmConformidade","NacionalConteudoImportacaoMenorQue40","EstrangeiraImportacaoDiretaSemSimilarNacional","EstrangeiraAdquiridaMercadoInternoSemSimilarNacional","NacionalConteudoImportacaoSuperior70"],"type":"string","description":"Origem da mercadoria."},"OrigemProdutoConsultaTributacaoModelEnum":{"enum":["Nacional","EstrangeiraImportacaoDireta","EstrangeiraAdquiridaMercadoInterno","NacionalConteudoImportacaoSuperior40A70","NacionalPPB","NacionalConteudoImportacaoInferior40","EstrangeiraImportacaoDiretaSemSimilar","EstrangeiraAdquiridaMercadoInternoSemSimilar","NacionalConteudoImportacaoSuperior70"],"type":"string","description":"Origem do produto para consulta."},"PagamentoDetalheNfceAutomaticaInputModel":{"type":"object","properties":{"formaPagamento":{"$ref":"#/components/schemas/FormasPagamentoNotaFiscalModelEnum"},"valorPagamento":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Valor do pagamento.","format":"double"},"tipoIntegracaoCartao":{"$ref":"#/components/schemas/TipoIntegracaoPagamentoNotaFiscalModelEnum"},"cnpjOperadorCartao":{"type":"string","description":"CNPJ do operador de cartão.","nullable":true},"bandeiraCartao":{"$ref":"#/components/schemas/BandeiraCartaoNotaFiscalModelEnum"},"numeroAutorizacaoCartao":{"type":"string","description":"Número de autorização do cartão.","nullable":true}},"additionalProperties":false,"description":"Dados do detalhe dos pagamentos da NFe Automática."},"PagamentoDetalheNfceInputModel":{"type":"object","properties":{"formaPagamento":{"$ref":"#/components/schemas/FormasPagamentoNotaFiscalModelEnum"},"valorPagamento":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Valor do pagamento.","format":"double"},"tipoIntegracaoCartao":{"$ref":"#/components/schemas/TipoIntegracaoPagamentoNotaFiscalModelEnum"},"cnpjOperadorCartao":{"type":"string","description":"CNPJ do operador de cartão.","nullable":true},"bandeiraCartao":{"$ref":"#/components/schemas/BandeiraCartaoNotaFiscalModelEnum"},"numeroAutorizacaoCartao":{"type":"string","description":"Número de autorização do cartão.","nullable":true}},"additionalProperties":false,"description":"Dados do detalhe dos pagamentos da NFe ."},"PagamentoDetalheNfceSimplificadaInputModel":{"type":"object","properties":{"formaPagamento":{"$ref":"#/components/schemas/FormasPagamentoNotaFiscalModelEnum"},"valorPagamento":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Valor do pagamento.","format":"double"},"tipoIntegracaoCartao":{"$ref":"#/components/schemas/TipoIntegracaoPagamentoNotaFiscalModelEnum"},"cnpjOperadorCartao":{"type":"string","description":"CNPJ do operador de cartão.","nullable":true},"bandeiraCartao":{"$ref":"#/components/schemas/BandeiraCartaoNotaFiscalModelEnum"},"numeroAutorizacaoCartao":{"type":"string","description":"Número de autorização do cartão.","nullable":true}},"additionalProperties":false,"description":"Dados do detalhe dos pagamentos da NFe ."},"PagamentoDetalheNfeInputModel":{"type":"object","properties":{"formaPagamento":{"$ref":"#/components/schemas/FormasPagamentoNotaFiscalModelEnum"},"valorPagamento":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Valor do pagamento.","format":"double"},"tipoIntegracaoCartao":{"$ref":"#/components/schemas/TipoIntegracaoPagamentoNotaFiscalModelEnum"},"cnpjOperadorCartao":{"type":"string","description":"CNPJ do operador de cartão.","nullable":true},"bandeiraCartao":{"$ref":"#/components/schemas/BandeiraCartaoNotaFiscalModelEnum"},"numeroAutorizacaoCartao":{"type":"string","description":"Número de autorização do cartão.","nullable":true}},"additionalProperties":false,"description":"Dados do detalhe dos pagamentos da NFe."},"PagamentosNfceAutomaticaInputModel":{"required":["formasDePagamento"],"type":"object","properties":{"formasDePagamento":{"type":"array","items":{"$ref":"#/components/schemas/PagamentoDetalheNfceAutomaticaInputModel"},"description":"Detalhe das formas de pagamento da NFe Simplificada."},"valorTroco":{"minimum":0,"type":"number","description":"Valor do troco.","format":"double"}},"additionalProperties":false,"description":"Dados dos pagamentos da NFe Automática."},"PagamentosNfceInputModel":{"required":["formasDePagamento"],"type":"object","properties":{"formasDePagamento":{"type":"array","items":{"$ref":"#/components/schemas/PagamentoDetalheNfceInputModel"},"description":"Detalhe das formas de pagamento da NFe ."},"valorTroco":{"minimum":0,"type":"number","description":"Valor do troco.","format":"double"}},"additionalProperties":false,"description":"Dados dos pagamentos da NFe ."},"PagamentosNfceSimplificadaInputModel":{"required":["formasDePagamento"],"type":"object","properties":{"formasDePagamento":{"type":"array","items":{"$ref":"#/components/schemas/PagamentoDetalheNfceSimplificadaInputModel"},"description":"Detalhe das formas de pagamento da NFe ."},"valorTroco":{"minimum":0,"type":"number","description":"Valor do troco.","format":"double"}},"additionalProperties":false,"description":"Dados dos pagamentos da NFe ."},"PagamentosNfeInputModel":{"required":["formasDePagamento"],"type":"object","properties":{"formasDePagamento":{"type":"array","items":{"$ref":"#/components/schemas/PagamentoDetalheNfeInputModel"},"description":"Detalhe das formas de pagamento da NFe."},"valorTroco":{"minimum":0,"type":"number","description":"Valor do troco.","format":"double"}},"additionalProperties":false,"description":"Dados dos pagamentos da NFe."},"ParametroNfceTipoDanfeModelEnum":{"enum":["Danfe56mm","Danfe80mm"],"type":"string","description":"Tipo de danfe para NFC-e."},"ParametroNfeTipoDanfeModelEnum":{"enum":["Retrato","Paisagem","Simplificado"],"type":"string","description":"Tipos de Danfe para NFe."},"ParametrosConvenioMunicipioNfseViewModel":{"type":"object","properties":{"aderenteAmbienteNacional":{"type":"boolean","description":"Indica se o município é aderente ao Ambiente Nacional NFS-e."},"aderenteEmissorNacional":{"type":"boolean","description":"Indica se o município é aderente ao Emissor Nacional NFS-e."},"emissorNacionalLiberadoParaUso":{"type":"boolean","description":"Indica se o município já está com o processo de emissão de NFS-e liberado para uso."},"situacaoEmissaoPadraoContribuintesRFB":{"type":"boolean","description":"Situação de emissão padrão para contribuintes da RFB."},"aderenteMAN":{"type":"boolean","description":"Indica se o município é aderente ao MAN (Módulo de Autorização Nacional)."},"permiteAproveitamentoDeCreditos":{"type":"boolean","description":"Indica se o município permite o aproveitamento de créditos."}},"additionalProperties":false,"description":"Parâmetros do convênio do município com o Ambiente Nacional NFS-e."},"ParametrosNfceViewModel":{"type":"object","properties":{"sequenciaAutomatica":{"type":"boolean","description":"Indica se a sequência da numeração será automática ou manual."},"serie":{"type":"string","description":"Série da NFC-e. (Apenas se a sequência for automática)","nullable":true},"numeroUltimaNfce":{"type":"integer","description":"Número da última NFC-e emitida. (Apenas se a sequência for automática)","format":"int64","nullable":true},"enviarEmailNfe":{"type":"boolean","description":"Enviar email com a NFC-e para o cliente de forma automatica."},"tipoDanfe":{"$ref":"#/components/schemas/ParametroNfceTipoDanfeModelEnum"},"diasInutilizacaoAutomatica":{"type":"integer","description":"Dias \"A partir de\" para inutilização automática de notas rejeitadas ou pendentes de emissão.","format":"int32"},"contingenciaAutomaticaAtiva":{"type":"boolean","description":"Indica se a contingência automática está ativa no momento."},"dataHoraInicioContingenciaAutomatica":{"type":"string","description":"Data e hora de início da contingência automática atual.","format":"date-time","nullable":true},"contingenciaTimeOut":{"type":"boolean","description":"Indica se o timeout de comunicação com a SEFAZ deve acionar o modo de contingência automaticamente."}},"additionalProperties":false,"description":"Parâmetros da NFC-e."},"ParametrosNfeViewModel":{"type":"object","properties":{"sequenciaAutomatica":{"type":"boolean","description":"Indica se a sequência da numeração será automática ou manual."},"serie":{"type":"string","description":"Série da NF-e. (Apenas se a sequência for automática)","nullable":true},"numeroUltimaNfe":{"type":"integer","description":"Número da última NF-e emitida. (Apenas se a sequência for automática)","format":"int64","nullable":true},"enviarEmailNfe":{"type":"boolean","description":"Enviar email com a NF-e para o cliente de forma automatica."},"tipoDanfe":{"$ref":"#/components/schemas/ParametroNfeTipoDanfeModelEnum"},"diasInutilizacaoAutomatica":{"type":"integer","description":"Dias \"A partir de\" para inutilização automática de notas rejeitadas ou pendentes de emissão.","format":"int32"},"crtId":{"type":"string","description":"ID do responsável técnico exigido no estado do Paraná para emissão de NFe´s.","nullable":true},"crtHash":{"type":"string","description":"Hash do responsável técnico exigido no estado do Paraná para emissão de NFe´s.","nullable":true},"contingenciaAutomaticaAtiva":{"type":"boolean","description":"Indica se a contingência automática está ativa no momento."},"dataHoraInicioContingenciaAutomatica":{"type":"string","description":"Data e hora de início da contingência automática atual.","format":"date-time","nullable":true},"contingenciaTimeOut":{"type":"boolean","description":"Indica se o timeout de comunicação com a SEFAZ deve acionar o modo de contingência automaticamente."}},"additionalProperties":false,"description":"Parâmetros da NF-e."},"ParametrosNfseViewModel":{"type":"object","properties":{"sequenciaAutomatica":{"type":"boolean","description":"Indica se a sequência da numeração do DPS será automática ou manual."},"serie":{"type":"string","description":"Série do DPS. (Apenas se a sequência for automática)","nullable":true},"numeroUltimoDps":{"type":"integer","description":"Número do último DPS emitido. (Apenas se a sequência for automática)","format":"int64","nullable":true},"enviarEmailNfse":{"type":"boolean","description":"Enviar e-mail com a NFS-e para o cliente de forma automática."},"opcaoSimpleNacional":{"$ref":"#/components/schemas/OpcaoSimpleNacionalNfseModelEnum"},"regimeEspecialTributacao":{"$ref":"#/components/schemas/RegimeEspecialTributacaoNfseModelEnum"},"regimeApuracaoSimplesNacional":{"$ref":"#/components/schemas/RegimeApuracaoSimplesNacionalNfseModelEnum"},"diasInutilizacaoAutomatica":{"type":"integer","description":"Quantidade de dias para inutilização automática de numerações não utilizadas.","format":"int32"},"aliquotaEfetivaSn":{"type":"number","description":"Alíquota efetiva do Simples Nacional (pTotTribSN) em %.\nPreenchido apenas para emissores do Simples Nacional e MEI.","format":"double","nullable":true}},"additionalProperties":false,"description":"Parâmetros da NFS-e."},"ParceiroDetalheViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador interno do parceiro no sistema.","format":"uuid"},"cnpj":{"type":"string","description":"CNPJ do parceiro.","nullable":true},"razaoSocial":{"type":"string","description":"Nome ou razão social do parceiro.","nullable":true},"status":{"$ref":"#/components/schemas/StatusParceiroModelEnum"},"consoleId":{"type":"string","description":"Identificador do parceiro no console.","nullable":true},"dataCriacao":{"type":"string","description":"Data de criação do parceiro no sistema.","format":"date-time"},"ultimaAlteracao":{"type":"string","description":"Data de última alteração dos dados do parceiro no sistema.","format":"date-time"}},"additionalProperties":false,"description":"Dados detalhados do parceiro."},"ParceiroListagemViewModel":{"type":"object","properties":{"cnpj":{"type":"string","description":"CNPJ do parceiro.","nullable":true},"razaoSocial":{"type":"string","description":"Nome ou razão social do parceiro.","nullable":true},"status":{"$ref":"#/components/schemas/StatusParceiroModelEnum"}},"additionalProperties":false,"description":"Dados de listagem do parceiro."},"ParceiroListagemViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ParceiroListagemViewModel"},"nullable":true}},"additionalProperties":false},"PisCofinsNfseModoPrestadorInputModel":{"type":"object","properties":{"cst":{"$ref":"#/components/schemas/CstPisCofinsNfseModoPrestadorModelEnum"},"baseCalculoPisCofins":{"type":"number","description":"Valor da Base de Cálculo do PIS/COFINS (vBCPisCofins) em R$. Opcional.","format":"double","nullable":true},"aliquotaPis":{"type":"number","description":"Alíquota do PIS (pAliqPis) em %. Opcional.","format":"double","nullable":true},"aliquotaCofins":{"type":"number","description":"Alíquota da COFINS (pAliqCofins) em %. Opcional.","format":"double","nullable":true},"valorPis":{"type":"number","description":"Valor do débito de PIS (vPis) em R$. Opcional.","format":"double","nullable":true},"valorCofins":{"type":"number","description":"Valor do débito de COFINS (vCofins) em R$. Opcional.","format":"double","nullable":true},"tipoRetencaoPisCofins":{"$ref":"#/components/schemas/TipoRetencaoPisCofinsNfseModelEnum"}},"additionalProperties":false,"description":"Informações PIS/COFINS (piscofins) para NFS-e no modo prestador."},"PisCofinsNfseModoTomadorInputModel":{"type":"object","properties":{"cst":{"$ref":"#/components/schemas/CstPisCofinsNfseModoTomadorModelEnum"},"baseCalculoPisCofins":{"type":"number","description":"Valor da Base de Cálculo do PIS/COFINS (vBCPisCofins) em R$. Opcional.","format":"double","nullable":true},"aliquotaPis":{"type":"number","description":"Alíquota do PIS (pAliqPis) em %. Opcional.","format":"double","nullable":true},"aliquotaCofins":{"type":"number","description":"Alíquota da COFINS (pAliqCofins) em %. Opcional.","format":"double","nullable":true},"valorPis":{"type":"number","description":"Valor do débito de PIS (vPis) em R$. Opcional.","format":"double","nullable":true},"valorCofins":{"type":"number","description":"Valor do débito de COFINS (vCofins) em R$. Opcional.","format":"double","nullable":true},"tipoRetencaoPisCofins":{"$ref":"#/components/schemas/TipoRetencaoPisCofinsNfseModelEnum"}},"additionalProperties":false,"description":"Informações PIS/COFINS (piscofins) para NFS-e no modo tomador."},"PrestadorNfseInputModel":{"required":["documento","endereco"],"type":"object","properties":{"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoPrestadorNfseModelEnum"},"documento":{"minLength":1,"type":"string","description":"Documento de identificação do prestador.\nCNPJ (14 dígitos), CPF (11 dígitos), NIF (até 40 chars) ou código cNaoNIF (\"0\", \"1\" ou \"2\")."},"caepf":{"type":"string","description":"CAEPF — Cadastro de Atividade Econômica da Pessoa Física (14 dígitos). Opcional.","nullable":true},"inscricaoMunicipal":{"type":"string","description":"Inscrição municipal do prestador. Opcional.","nullable":true},"nome":{"type":"string","description":"Nome / razão social do prestador. Opcional.","nullable":true},"telefone":{"type":"string","description":"Telefone do prestador. Opcional.","nullable":true},"email":{"type":"string","description":"E-mail do prestador. Opcional.","nullable":true},"opcaoSimpleNacional":{"$ref":"#/components/schemas/OpcaoSimpleNacionalNfseEnum"},"regimeEspecialTributacao":{"$ref":"#/components/schemas/RegimeEspecialTributacaoNfseEnum"},"endereco":{"$ref":"#/components/schemas/EnderecoPrestadorNfseInputModel"}},"additionalProperties":false,"description":"Dados do prestador de serviços (prest) informado pelo tomador na emissão de NFS-e no modo tomador."},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"ProdutoEmissorBilhetagemViewModel":{"type":"object","properties":{"dataBilhetagem":{"type":"string","description":"Data de ocorrência da bilhetagem.","format":"date-time"},"codigoMunicipioEmissor":{"type":"string","description":"Código do município do emissor utilizado na consulta.","nullable":true},"regimeTributarioEmissor":{"type":"string","description":"Regime tributário do emissor utilizado na consulta.","nullable":true},"cnaeEmissor":{"type":"string","description":"CNAE do emissor utilizado na consulta.","nullable":true},"cnaeSecundarioEmissor":{"type":"string","description":"CNAE secundário do emissor utilizado na consulta.","nullable":true},"codigoMunicipioDestinatario":{"type":"string","description":"Código do município do destinatário utilizado na consulta.","nullable":true},"finalidade":{"type":"string","description":"Finalidade da operação utilizada na consulta.","nullable":true},"situacaoEspecialDestinatario":{"type":"string","description":"Situação especial do destinatário utilizada na consulta.","nullable":true},"origem":{"type":"string","description":"Origem do produto utilizado na consulta.","nullable":true},"destinatarioSimplesNacional":{"type":"boolean","description":"Indicador de destinatário optante pelo Simples Nacional utilizado na consulta."},"destinatarioSubstitutoTributario":{"type":"boolean","description":"Indicador de destinatário substituto tributário utilizado na consulta."},"mercadoriaProduzidaZFM":{"type":"boolean","description":"Indicador de mercadoria produzida na Zona Franca de Manaus (ZFM) utilizado na consulta."},"fabricacaoPropria":{"type":"boolean","description":"Indicador de fabricacao própria utilizado na consulta."}},"additionalProperties":false,"description":"Dados da bilhetagem do produto."},"ProdutoEmissorViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador interno do produto do emissor.","format":"uuid"},"hash":{"type":"string","description":"Hash de identificação da tributação.","nullable":true},"filtro":{"type":"string","description":"Filtro usado na consulta para identificar o produto.","nullable":true},"ultimaConsulta":{"type":"string","description":"Data da última consulta realizada.","format":"date-time"},"ultimaAtualizacaoFiscal":{"type":"string","description":"Data da última atualização fiscal.","format":"date-time","nullable":true},"bilhetagem":{"type":"array","items":{"$ref":"#/components/schemas/ProdutoEmissorBilhetagemViewModel"},"description":"Histórico de bilhetagem do produto.","nullable":true}},"additionalProperties":false,"description":"Dados detalhados do produto relacionado ao emissor."},"RecricarAutenticacaoAplicativoViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador interno do aplicativo.","format":"uuid"},"clientId":{"type":"string","description":"ClientId usado na autenticação do aplicativo no sistema.","nullable":true},"secretId":{"type":"string","description":"Chave secreta usada na autenticação do aplicativo no sistema.","nullable":true}},"additionalProperties":false,"description":"Dados retornados na recriação das credenciais de autenticação do aplicativo."},"RegimeApuracaoSimplesNacionalNfseModelEnum":{"enum":["TributosFederaisEMunicipalPeloSn","TributosFederaisPeloSnEIssqnPelaNfse","TributosFederaisEMunicipalPelaNfse"],"type":"string","description":"Regime de apuração do Simples Nacional (regApuracao)."},"RegimeEspecialTributacaoNfseEnum":{"enum":["Nenhum","MicroempresaMunicipal","Estimativa","SociedadeProfissionais","Cooperativa","Mei","MeEppSimplesNacional"],"type":"string"},"RegimeEspecialTributacaoNfseModelEnum":{"enum":["Nenhum","MicroempresaMunicipal","Estimativa","SociedadeProfissionais","Cooperativa","Mei","MeEppSimplesNacional"],"type":"string","description":"Regime especial de tributação do prestador (regEspTrib)."},"RegimeTributarioModelEnum":{"enum":["Mei","SimplesNacional","SimplesNacionalExcessoReceita","LucroPresumido","LucroReal"],"type":"string","description":"Regime tributário do emissor."},"ResponseErrorResult":{"type":"object","properties":{"status":{"type":"integer","format":"int32"},"titulo":{"type":"string","nullable":true},"erros":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"nullable":true}},"additionalProperties":false},"ResumoConsultasCatalogoFiscalViewModel":{"type":"object","properties":{"totalConsultas":{"type":"integer","description":"Total de consultas realizadas pelo emissor.","format":"int32"},"totalSucesso":{"type":"integer","description":"Total de consultas concluídas com sucesso.","format":"int32"},"totalNaoEncontrado":{"type":"integer","description":"Total de consultas cujo produto não foi encontrado.","format":"int32"},"totalFalha":{"type":"integer","description":"Total de consultas que apresentaram falhas no processo.","format":"int32"}},"additionalProperties":false,"description":"Dados do resumo das consultas realizadas internamente no catálogo fiscal."},"ResumoConsultasProdutoVisaoAplicacaoViewModel":{"type":"object","properties":{"totalConsultas":{"type":"integer","description":"Total de consultas realizadas pelo emissor.","format":"int32"},"totalSucesso":{"type":"integer","description":"Total de consultas concluídas com sucesso.","format":"int32"},"totalNaoEncontrado":{"type":"integer","description":"Total de consultas cujo produto não foi encontrado.","format":"int32"},"totalFalha":{"type":"integer","description":"Total de consultas que apresentaram falhas no processo.","format":"int32"}},"additionalProperties":false,"description":"Dados do resumo da consulta realizada pelo emissor exibidos na aplicação."},"ResumoConsultasProdutoVisaoCrmViewModel":{"type":"object","properties":{"totalConsultas":{"type":"integer","description":"Total de consultas realizadas pelo emissor.","format":"int32"},"totalSucesso":{"type":"integer","description":"Total de consultas concluídas com sucesso.","format":"int32"},"totalNaoEncontrado":{"type":"integer","description":"Total de consultas cujo produto não foi encontrado.","format":"int32"},"totalFalha":{"type":"integer","description":"Total de consultas que apresentaram falhas no processo.","format":"int32"}},"additionalProperties":false,"description":"Dados do resumo da consulta realizada pelo emissor exibidos pela console CRM."},"RetencaoMunicipalNfseViewModel":{"type":"object","properties":{"descricao":{"type":"string","description":"Descrição da retenção municipal.","nullable":true},"dataInicioVigencia":{"type":"string","description":"Data de início da vigência da retenção.","format":"date-time"},"dataFimVigencia":{"type":"string","description":"Data de fim da vigência da retenção, se houver.","format":"date-time","nullable":true},"tiposRetencao":{"type":"array","items":{"type":"integer","format":"int32"},"description":"Tipos de retenção aplicados.","nullable":true},"servicos":{"type":"array","items":{"type":"string"},"description":"Códigos de serviço aos quais a retenção se aplica.","nullable":true}},"additionalProperties":false,"description":"Retenção municipal configurada para o município."},"RetencoesDetalhesMunicipioNfseViewModel":{"type":"object","properties":{"artigoSexto":{"$ref":"#/components/schemas/ArtigoSextoMunicipioNfseViewModel"},"retencoesMunicipais":{"type":"array","items":{"$ref":"#/components/schemas/RetencaoMunicipalNfseViewModel"},"description":"Lista de retenções municipais configuradas.","nullable":true}},"additionalProperties":false,"description":"Detalhes das retenções configuradas no município."},"ServicoNfseInputModel":{"required":["codigoNbs","codigoServicoCtn","descricaoServico"],"type":"object","properties":{"codigoMunicipioLocalizacao":{"type":"string","description":"Código IBGE (7 dígitos) do município onde o serviço foi prestado. Usar para prestações nacionais.","nullable":true},"codigoPaisLocalizacao":{"type":"string","description":"Código do país (Tabela ISO) onde o serviço foi prestado. Usar para exportações de serviço.","nullable":true},"codigoServicoCtn":{"maxLength":6,"minLength":6,"type":"string","description":"Código de tributação nacional do serviço conforme tabela NFS-e Nacional (cTribNac — 6 dígitos)."},"codigoTribMunicipal":{"type":"string","description":"Código de tributação municipal do serviço (Complemento do código CTN no município - cTribMun). Opcional.","nullable":true},"descricaoServico":{"maxLength":2000,"minLength":1,"type":"string","description":"Descrição do serviço prestado (xDescServ)."},"codigoNbs":{"maxLength":9,"minLength":9,"type":"string","description":"Código NBS — Nomenclatura Brasileira de Serviços (cNBS — 9 dígitos)."},"informacaoComplementar":{"type":"string","description":"Informação complementar do serviço prestado (xInfComp). Opcional.","nullable":true}},"additionalProperties":false,"description":"Dados do serviço prestado (serv).\nInformar CodigoMunicipioLocalizacao (nacional) OU CodigoPaisLocalizacao (exterior), nunca ambos."},"ServicoVigenciaBeneficioNfseViewModel":{"type":"object","properties":{"codigoServico":{"type":"string","description":"Código do serviço (LC 116/2003).","nullable":true},"dataInicioVigencia":{"type":"string","description":"Data de início da vigência do serviço no benefício.","format":"date-time"},"dataFimVigencia":{"type":"string","description":"Data de fim da vigência do serviço no benefício, se houver.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Serviço contemplado pelo benefício fiscal e seu período de vigência."},"SituacaoEspecialDestinatarioConsultaTributacaoModelEnum":{"enum":["Industrial","Distribuidor","Atacadista","ProdutorRural","ArmazemGeral","OrgaoPublico"],"type":"string","description":"Situação especial do destinatário da operação fiscal."},"SituacaoEspecialDestinatarioModelEnum":{"enum":["Industrial","Distribuidor","Atacadista","ProdutorRural","ArmazemGeral","OrgaoPublico"],"type":"string","description":"Situação especial do destinatário da NF-e automática."},"SolicitarConsultaEmLoteInputModel":{"required":["filtros"],"type":"object","properties":{"filtros":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ConsultaLoteFiltroInputModel"},"description":"Lista de filtros dos produtos a serem consultados."},"perfilTributario":{"$ref":"#/components/schemas/ConsultaLotePerfilTributarioInputModel"},"urlCallback":{"type":"string","description":"URL de callback para notificação após a conclusão do processamento.","nullable":true}},"additionalProperties":false,"description":"Dados para solicitação de consulta de tributação de produtos em lote de forma assíncrona."},"SolicitarDownloadXmlInputModel":{"required":["dataFim","dataInicio"],"type":"object","properties":{"dataInicio":{"minLength":1,"type":"string","description":"Filtrar pela data de emissão da nota \"a partir de\".","format":"date","example":"2025-03-31"},"dataFim":{"minLength":1,"type":"string","description":"Filtrar pela data de emissão da nota \"até\".","format":"date","example":"2025-03-31"},"inscricaoEstadual":{"type":"string","description":"Filtrar pela inscrição estadual do emissor da nota fiscal.","nullable":true},"busca":{"type":"string","description":"Filtro de busca genérica (dados do destinatário, transportador, chave de acesso, intermediador ou número do documento).","nullable":true},"modelosDocumento":{"type":"array","items":{"$ref":"#/components/schemas/ModeloDocumentoDownloadXmlModelEnum"},"description":"Filtrar pelo modelo do arquivo XML.","nullable":true},"urlCallback":{"type":"string","description":"URL de callback para disparar notificação após conclusão do processamento da solicitação.","nullable":true}},"additionalProperties":false,"description":"Filtros solicitados para download de arquivos xmls."},"StatusAplicativoModelEnum":{"enum":["Inativo","Ativo"],"type":"string","description":"Status de ativação do aplicativo."},"StatusCallbackConsultaLoteModelEnum":{"enum":["NaoRealizado","Sucesso","Falha"],"type":"string","description":"Status do callback de notificação da consulta de tributação de produtos em lote."},"StatusCallbackDownloadXmlModelEnum":{"enum":["NaoRealizado","Sucesso","Falha"],"type":"string","description":"Status do envio de callback."},"StatusCartaCorrecaoModelEnum":{"enum":["Pendente","Autorizada","Rejeitada","Substituida"],"type":"string","description":"Status da carta de correção eletrônica (CC-e)."},"StatusConsultaEmLoteModelEnum":{"enum":["Pendente","EmProcessamento","Concluido"],"type":"string","description":"Status da consulta de tributação de produtos em lote."},"StatusConsultaLoteFiltroResultadoModelEnum":{"enum":["Pendente","Sucesso","Falha"],"type":"string","description":"Status do resultado de um filtro da consulta de tributação de produtos em lote."},"StatusConsultaProdutoModelEnum":{"enum":["Sucesso","NaoEncontrado","Falha"],"type":"string","description":"Status de retorno da consulta do produto."},"StatusDownloadXmlModelEnum":{"enum":["Pendente","EmProcessamento","Concluido","Falha","Expirado"],"type":"string","description":"Status do processamento da solicitação de download de XML."},"StatusEmissorEnum":{"enum":["Inativo","Ativo"],"type":"string"},"StatusEmissorModelEnum":{"enum":["Inativo","Ativo"],"type":"string","description":"Status do emissor."},"StatusHistoricoConsultaCatalogoFiscalModelEnum":{"enum":["Sucesso","NaoEncontrado","Falha"],"type":"string","description":"Status de retorno da consulta no catálogo fiscal."},"StatusHistoricoConsultaCnpjModelEnum":{"enum":["Sucesso","NaoEncontrado","Falha"],"type":"string","description":"Status da consulta de CNPJ."},"StatusNotaFiscalModelEnum":{"enum":["Pendente","Autorizada","Cancelada","Inutilizada","Rejeitada","Denegada","EmCancelamento","EmContingencia","Substituida"],"type":"string","description":"Status do documento eletrônico."},"StatusNotaFiscalServicoModelEnum":{"enum":["Pendente","Autorizada","Cancelada","Rejeitada","EmCancelamento","Substituida","Inutilizada"],"type":"string","description":"Status da nota fiscal de serviço."},"StatusParceiroModelEnum":{"enum":["Inativo","Ativo"],"type":"string","description":"Status de ativação do parceiro."},"SubstituicaoNfseInputModel":{"required":["chaveNfse"],"type":"object","properties":{"chaveNfse":{"maxLength":53,"minLength":53,"type":"string","description":"Chave de acesso da NFS-e substituída (chSubstda — 53 chars)."},"codigoMotivo":{"$ref":"#/components/schemas/MotivoSubstituicaoNfseModelEnum"},"descricaoMotivo":{"type":"string","description":"Descrição do motivo da substituição (xMotivo). Opcional.","nullable":true}},"additionalProperties":false,"description":"Dados da NFS-e substituída (subst)."},"TipoAmbienteSefazModelEnum":{"enum":["Producao","Homologacao"],"type":"string","description":"Tipo de ambiente da SEFAZ."},"TipoConsultaCatalogoFiscalModelEnum":{"enum":["ConsultaDetalhadaEan","ConsultaResumidaDescricao","ListarAlterados"],"type":"string","description":"Tipo de consulta realizada na api do catálogo fiscal."},"TipoDanfeNfceModelEnum":{"enum":["Danfe56mm","Danfe80mm"],"type":"string","description":"Tipo de danfe para NFCe."},"TipoDanfeNfeModelEnum":{"enum":["Retrato","Simplificado"],"type":"string","description":"Tipo de danfe para NFe."},"TipoDestinatarioCfopModelEnum":{"enum":["NaoContribuinte","Ambos"],"type":"string","description":"Tipo de destinatário do CFOP."},"TipoDestinoCfopModelEnum":{"enum":["Estadual","Interestadual","Exterior"],"type":"string","description":"Tipo de destino do CFOP."},"TipoDocumentoDestinatarioIbsCbsNfseModelEnum":{"enum":["Cpf","Cnpj","Nif","CodigoNaoNif"],"type":"string","description":"Tipo de documento de identificação do destinatário do IBS/CBS na NFS-e."},"TipoDocumentoEmissorModelEnum":{"enum":["Cpf","Cnpj"],"type":"string","description":"Tipo de documento do emissor."},"TipoDocumentoNotaFiscalModelEnum":{"enum":["Cpf","Cnpj","IdEstrangeiro"],"type":"string","description":"Tipo de documento."},"TipoDocumentoPrestadorNfseModelEnum":{"enum":["Cnpj","Cpf","Nif","CodigoNaoNif"],"type":"string","description":"Tipo de documento de identificação do prestador de serviços na NFS-e."},"TipoDocumentoTomadorNfseModelEnum":{"enum":["Cpf","Cnpj","Nif","CodigoNaoNif"],"type":"string","description":"Tipo de documento de identificação do tomador de serviços na NFS-e."},"TipoEmissaoNfceModelEnum":{"enum":["Automatica","Normal","ContingenciaNfce"],"type":"string","description":"Tipo de emissão de NFCe."},"TipoEmissaoNfeModelEnum":{"enum":["Automatica","Normal","ContingenciaFsda","ContingenciaSvcan","ContingenciaSvcrs"],"type":"string","description":"Tipo de emissão de NFe."},"TipoEmissorNfseModelEnum":{"enum":["Prestador","Tomador","Intermediario"],"type":"string","description":"Tipo do emitente da DPS (tpEmit)."},"TipoEstabelecimentoEmissorModelEnum":{"enum":["Outros","IndustriaOuEquiparado"],"type":"string","description":"Tipo de estabelecimento do emissor quanto ao IPI."},"TipoEventoNotaFiscalModelEnum":{"enum":["PreNotaAutomatica","PreNotaSimplificada","EmissaoNfe","EmissaoNfceAutomatica","EmissaoNfceSimplificada","EmissaoNfce","CancelarNotaFiscal","InutilizarFaixaNumeracao","TransmitirNotaFiscalEmitidaEmContingencia","EmitirNfeEstorno","EmitirNfeDevolucao","EmitirNfeDevolucaoXml","ObterDanfeNfe","ObterDanfeNfce","ObterArquivoXml","EmitirCartaDeCorrecao","ObterXmlCartaCorrecao","ObterArquivoXmlNfse","ObterDanfeNfse","CancelarNotaFiscalServico","EmissaoNfse"],"type":"string","description":"Tipo de evento do contexto de notas fiscais."},"TipoFiltroConsultaProdutoModelEnum":{"enum":["Ean","DescricaoSimilar","Hash"],"type":"string","description":"Tipo de filtro do catálogo de produto."},"TipoIcmsCfopModelEnum":{"enum":["IcmsTributado","IcmsRetido","Ambos"],"type":"string","description":"Tipo de ICMS do CFOP."},"TipoIcmsStEmissorModelEnum":{"enum":["Substituta","Substituida"],"type":"string","description":"Tipo de ICMS ST do emissor."},"TipoIdDestinoNotaFiscalModelEnum":{"enum":["OperacaoInterna","OperacaoInterestadual","OperacaoExterior"],"type":"string","description":"Tipo de destino da nota fiscal."},"TipoImunidadeNfseModelEnum":{"enum":["NaoInformado","PatrimonioRendaOuServicos","EntidadesReligiosas","PartidosSindicatosEducacaoAssistencia","LivrosJornaisPeriodicos","FontogramasVideofonogramas"],"type":"string","description":"Tipo de imunidade do ISSQN (tpImunidade).\nInformar somente quando TributacaoIssqn = Imunidade."},"TipoIntegracaoPagamentoNotaFiscalModelEnum":{"enum":["Tef","Pos"],"type":"string","description":"Tipo de integração de pagamento."},"TipoIntermedioImportacaoNotaFiscalModelEnum":{"enum":["ContaPropria","ContaOrdem","Encomenda"],"type":"string","description":"Indicador do tipo de intermediador da importação."},"TipoItemNotaModelEnum":{"enum":["Produto","Servico"],"type":"string","description":"Tipo do item da nota."},"TipoNotaReferenciadaModelEnum":{"enum":["Nfe"],"type":"string","description":"Tipo de nota referenciada."},"TipoOperacaoCfopModelEnum":{"enum":["Entrada","Saida"],"type":"string","description":"Tipo de operação do CFOP."},"TipoOperacaoNotaFiscalModelEnum":{"enum":["Entrada","Saida"],"type":"string","description":"Tipo de operação."},"TipoProdutoEspecificoNotaFiscalModelEnum":{"enum":["Medicamento"],"type":"string","description":"Tipos de produtos específicos para Nota Fiscal."},"TipoRetencaoIssqnEnum":{"enum":["NaoRetido","RetidoPeloTomador","RetidoPeloIntermediario"],"type":"string"},"TipoRetencaoPisCofinsNfseModelEnum":{"enum":["NaoRetidos","PisCofinsRetido","PisCofinsNaoRetido","PisCofinsCSLLRetidos","PisCofinsRetidosCSLLNaoRetido","PisRetidoCofinsCSLLNaoRetido","CofinsRetidoPisCSLLNaoRetido","PisNaoRetidoCofinsCSLLRetidos","PisCofinsNaoRetidosCSLLRetido","CofinsNaoRetidoPisCSLLRetidos"],"type":"string","description":"Tipo de retenção PIS/COFINS e CSLL (tpRetPisCofins)."},"TipoViaTransporteNotaFiscalModelEnum":{"enum":["Maritima","Fluvial","Lacustre","Aerea","Postal","Ferroviaria","Rodoviaria"],"type":"string","description":"Tipo de via de transporte da declaração de importação."},"TomadorNfseInputModel":{"required":["documento","endereco","nome"],"type":"object","properties":{"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoTomadorNfseModelEnum"},"documento":{"minLength":1,"type":"string","description":"Documento de identificação do tomador.\nCNPJ (14 dígitos), CPF (11 dígitos), NIF (até 40 chars) ou código cNaoNIF (\"0\", \"1\" ou \"2\")."},"caepf":{"type":"string","description":"CAEPF — Cadastro de Atividade Econômica da Pessoa Física (14 dígitos). Opcional.","nullable":true},"inscricaoMunicipal":{"type":"string","description":"Inscrição municipal do tomador. Opcional.","nullable":true},"nome":{"maxLength":150,"minLength":2,"type":"string","description":"Nome / razão social do tomador."},"telefone":{"type":"string","description":"Telefone do tomador. Opcional.","nullable":true},"email":{"type":"string","description":"E-mail do tomador. Opcional.","nullable":true},"endereco":{"$ref":"#/components/schemas/EnderecoTomadorNfseInputModel"}},"additionalProperties":false,"description":"Dados do tomador de serviços (toma)."},"TopAplicativosViewModel":{"type":"object","properties":{"id":{"type":"string","description":"Identificador interno do aplicativo.","format":"uuid"},"nome":{"type":"string","description":"Nome do aplicativo.","nullable":true},"status":{"$ref":"#/components/schemas/StatusAplicativoModelEnum"},"quantidadeTotalEmissoresAtivos":{"type":"integer","description":"Quantidade total de emissores vinculados e ativos para este aplicativo.","format":"int32"},"quantidadeTotalNotasEmitidas":{"type":"integer","description":"Volume total de notas fiscais emitidas através deste aplicativo.","format":"int32"},"valorTotalNotasEmitidas":{"type":"number","description":"Valor monetário total somado das notas emitidas pelo aplicativo.","format":"double"},"quantidadeConsultasCatalogoFiscal":{"type":"integer","description":"Quantidade de consultas realizadas ao catálogo fiscal via aplicativo.","format":"int32"},"quantidadeConsultasCnpj":{"type":"integer","description":"Quantidade de consultas de CNPJ realizadas via aplicativo.","format":"int32"},"dataCriacao":{"type":"string","description":"Data de criação do aplicativo no sistema.","format":"date-time"}},"additionalProperties":false,"description":"Dados listados no top aplicativos."},"TopAplicativosViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TopAplicativosViewModel"},"nullable":true}},"additionalProperties":false},"TopEmissoresViewModel":{"type":"object","properties":{"documento":{"type":"string","description":"Documento de identificação (CPF/CNPJ) do emissor.","nullable":true},"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoEmissorModelEnum"},"nome":{"type":"string","description":"Nome ou Razão Social do emissor.","nullable":true},"nomeFantasia":{"type":"string","description":"Nome fantasia do emissor, se aplicável.","nullable":true},"regimeTributario":{"$ref":"#/components/schemas/RegimeTributarioModelEnum"},"status":{"$ref":"#/components/schemas/StatusEmissorEnum"},"quantidadeTotalNotasEmitidas":{"type":"integer","description":"Volume total de notas fiscais emitidas por este emissor.","format":"int32"},"valorTotalNotasEmitidas":{"type":"number","description":"Valor monetário total somado das notas emitidas pelo emissor.","format":"double"},"quantidadeConsultasCatalogoFiscal":{"type":"integer","description":"Quantidade de consultas realizadas ao catálogo fiscal pelo emissor.","format":"int32"},"quantidadeConsultasCnpj":{"type":"integer","description":"Quantidade de consultas de CNPJ realizadas pelo emissor.","format":"int32"},"dataCriacao":{"type":"string","description":"Data de criação do emissor no sistema.","format":"date-time"},"ultimaAlteracao":{"type":"string","description":"Data de última alteração dos dados do emissor no sistema.","format":"date-time"}},"additionalProperties":false,"description":"Dados listados no top emissores."},"TopEmissoresViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TopEmissoresViewModel"},"nullable":true}},"additionalProperties":false},"TopParceirosViewModel":{"type":"object","properties":{"cnpj":{"type":"string","description":"CNPJ do parceiro.","nullable":true},"razaoSocial":{"type":"string","description":"Nome ou razão social do parceiro.","nullable":true},"status":{"$ref":"#/components/schemas/StatusParceiroModelEnum"},"quantidadeTotalAplicativosAtivos":{"type":"integer","description":"Quantidade total de aplicativos que estão ativos.","format":"int32"},"quantidadeTotalEmissoresAtivos":{"type":"integer","description":"Quantidade total de emissores configurados e ativos.","format":"int32"},"quantidadeTotalNotasEmitidas":{"type":"integer","description":"Volume total de notas fiscais emitidas pelo parceiro.","format":"int32"},"valorTotalNotasEmitidas":{"type":"number","description":"Valor monetário total somado das notas emitidas.","format":"double"},"quantidadeConsultasCatalogoFiscal":{"type":"integer","description":"Quantidade de consultas realizadas ao catálogo fiscal.","format":"int32"},"quantidadeConsultasCnpj":{"type":"integer","description":"Quantidade de consultas de CNPJ realizadas.","format":"int32"},"dataCriacao":{"type":"string","description":"Data de criação do parceiro no sistema.","format":"date-time"}},"additionalProperties":false,"description":"Dados listados no top parceiros."},"TopParceirosViewModelListPaginationResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TopParceirosViewModel"},"nullable":true}},"additionalProperties":false},"TransporteNfceAutomaticaInputModel":{"required":["modalidadeFrete"],"type":"object","properties":{"modalidadeFrete":{"$ref":"#/components/schemas/ModalidadeFreteNotaFiscalModelEnum"},"veiculo":{"$ref":"#/components/schemas/TransporteNfceVeiculoAutomaticaInputModel"},"transportador":{"$ref":"#/components/schemas/TransporteNfceTransportadorAutomaticaInputModel"}},"additionalProperties":false,"description":"Dados de transporte para NFe Automática."},"TransporteNfceInputModel":{"required":["modalidadeFrete"],"type":"object","properties":{"modalidadeFrete":{"$ref":"#/components/schemas/ModalidadeFreteNotaFiscalModelEnum"},"transportador":{"$ref":"#/components/schemas/TransporteNfceTransportadorInputModel"}},"additionalProperties":false,"description":"Dados de transporte para NFe"},"TransporteNfceSimplificadaInputModel":{"required":["modalidadeFrete"],"type":"object","properties":{"modalidadeFrete":{"$ref":"#/components/schemas/ModalidadeFreteNotaFiscalModelEnum"},"transportador":{"$ref":"#/components/schemas/TransporteNfceSimplificadaTranspInputModel"}},"additionalProperties":false,"description":"Dados de transporte para NFe"},"TransporteNfceSimplificadaTranspInputModel":{"required":["uf"],"type":"object","properties":{"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documento":{"type":"string","description":"Documento do transportador.","nullable":true},"nome":{"type":"string","description":"Nome do transportador.","nullable":true},"inscricaoEstadual":{"type":"string","description":"Inscrição estadual do transportador.","nullable":true},"enderecoCompleto":{"type":"string","description":"Endereço completo do transportador.","nullable":true},"nomeMunicipio":{"type":"string","description":"Nome do município do transportador.","nullable":true},"uf":{"$ref":"#/components/schemas/UfNotaFiscalModelEnum"}},"additionalProperties":false,"description":"Dados do transportador da NFe simplificada."},"TransporteNfceTransportadorAutomaticaInputModel":{"required":["uf"],"type":"object","properties":{"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documento":{"type":"string","description":"Documento do transportador.","nullable":true},"nome":{"type":"string","description":"Nome do transportador.","nullable":true},"inscricaoEstadual":{"type":"string","description":"Inscrição estadual do transportador.","nullable":true},"enderecoCompleto":{"type":"string","description":"Endereço completo do transportador.","nullable":true},"nomeMunicipio":{"type":"string","description":"Nome do município do transportador.","nullable":true},"uf":{"$ref":"#/components/schemas/UfNotaFiscalModelEnum"}},"additionalProperties":false,"description":"Dados do transportador da NFe Automática."},"TransporteNfceTransportadorInputModel":{"required":["uf"],"type":"object","properties":{"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documento":{"type":"string","description":"Documento do transportador.","nullable":true},"nome":{"type":"string","description":"Nome do transportador.","nullable":true},"inscricaoEstadual":{"type":"string","description":"Inscrição estadual do transportador.","nullable":true},"enderecoCompleto":{"type":"string","description":"Endereço completo do transportador.","nullable":true},"nomeMunicipio":{"type":"string","description":"Nome do município do transportador.","nullable":true},"uf":{"$ref":"#/components/schemas/UfNotaFiscalModelEnum"}},"additionalProperties":false,"description":"Dados do transportador da NFe simplificada."},"TransporteNfceVeiculoAutomaticaInputModel":{"required":["placaVeiculo","ufVeiculo"],"type":"object","properties":{"placaVeiculo":{"maxLength":7,"minLength":1,"type":"string","description":"Placa do veículo."},"ufVeiculo":{"type":"string","description":"UF do veículo."},"rntcVeiculo":{"type":"string","description":"RNTC do veículo.","nullable":true}},"additionalProperties":false,"description":"Dados do veículo para NFCe Automática."},"TransporteNfeAutomaticaInputModel":{"required":["modalidadeFrete"],"type":"object","properties":{"modalidadeFrete":{"$ref":"#/components/schemas/ModalidadeFreteNotaFiscalModelEnum"},"veiculo":{"$ref":"#/components/schemas/TransporteNfeAutomaticaVeiculoInputModel"},"transportador":{"$ref":"#/components/schemas/TransporteNfeAutomaticaTransportadorInputModel"},"reboques":{"type":"array","items":{"$ref":"#/components/schemas/TransporteNfeAutomaticaReboqueInputModel"},"description":"Lista de reboques.","nullable":true},"volumes":{"type":"array","items":{"$ref":"#/components/schemas/TransporteNfeAutomaticaVolumeInputModel"},"description":"Lista de volumes.","nullable":true},"identificadorVagao":{"type":"string","description":"Identificação do vagão.","nullable":true},"identificadorBalsa":{"type":"string","description":"Identificação da balsa.","nullable":true}},"additionalProperties":false,"description":"Dados de transporte para NFe."},"TransporteNfeAutomaticaLacresInputModel":{"required":["numeroLacre"],"type":"object","properties":{"numeroLacre":{"maxLength":60,"minLength":1,"type":"string","description":"Número do lacre."}},"additionalProperties":false,"description":"Lacres do transporte da NFe."},"TransporteNfeAutomaticaReboqueInputModel":{"required":["placaReboque","ufReboque"],"type":"object","properties":{"placaReboque":{"maxLength":7,"minLength":1,"type":"string","description":"Placa do reboque."},"ufReboque":{"$ref":"#/components/schemas/UfNotaFiscalModelEnum"},"rntcReboque":{"type":"string","description":"RNTC do reboque.","nullable":true}},"additionalProperties":false,"description":"Dados do reboque do transporte da NFe."},"TransporteNfeAutomaticaTransportadorInputModel":{"required":["uf"],"type":"object","properties":{"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documento":{"type":"string","description":"Documento do transportador.","nullable":true},"nome":{"type":"string","description":"Nome do transportador.","nullable":true},"inscricaoEstadual":{"type":"string","description":"Inscrição estadual do transportador.","nullable":true},"enderecoCompleto":{"type":"string","description":"Endereço completo do transportador.","nullable":true},"nomeMunicipio":{"type":"string","description":"Nome do município do transportador.","nullable":true},"uf":{"$ref":"#/components/schemas/UfNotaFiscalModelEnum"}},"additionalProperties":false,"description":"Dados do transportador da NFe."},"TransporteNfeAutomaticaVeiculoInputModel":{"required":["placaVeiculo","ufVeiculo"],"type":"object","properties":{"placaVeiculo":{"maxLength":7,"minLength":1,"type":"string","description":"Placa do veículo."},"ufVeiculo":{"$ref":"#/components/schemas/UfNotaFiscalModelEnum"},"rntcVeiculo":{"type":"string","description":"RNTC do veículo.","nullable":true}},"additionalProperties":false,"description":"Dados do veículo de transporte da NFe."},"TransporteNfeAutomaticaVolumeInputModel":{"required":["especie","marca","pesoBruto","pesoLiquido","quantidadeVolumes"],"type":"object","properties":{"quantidadeVolumes":{"minimum":0,"exclusiveMinimum":true,"type":"integer","description":"Quantidade de volumes transportados.","format":"int32"},"especie":{"maxLength":60,"minLength":1,"type":"string","description":"Espécie dos volumes transportados."},"marca":{"maxLength":60,"type":"string","description":"Marca dos volumes transportados."},"numeracaoVolumes":{"maxLength":60,"type":"string","description":"Numeração dos volumes transportados.","nullable":true},"pesoLiquido":{"minimum":0,"type":"number","description":"Peso Líquido (em kg).","format":"double"},"pesoBruto":{"minimum":0,"type":"number","description":"Peso Bruto (em kg).","format":"double"},"lacres":{"type":"array","items":{"$ref":"#/components/schemas/TransporteNfeAutomaticaLacresInputModel"},"description":"Lista de lacres dos volumes transportados.","nullable":true}},"additionalProperties":false,"description":"Dados de volume do transporte da NFe."},"TransporteNfeInputModel":{"required":["modalidadeFrete"],"type":"object","properties":{"modalidadeFrete":{"$ref":"#/components/schemas/ModalidadeFreteNotaFiscalModelEnum"},"veiculo":{"$ref":"#/components/schemas/TransporteNfeVeiculoInputModel"},"transportador":{"$ref":"#/components/schemas/TransporteNfeTransportadorInputModel"},"reboques":{"type":"array","items":{"$ref":"#/components/schemas/TransporteNfeReboqueInputModel"},"description":"Lista de reboques.","nullable":true},"volumes":{"type":"array","items":{"$ref":"#/components/schemas/TransporteNfeVolumeInputModel"},"description":"Lista de volumes.","nullable":true},"identificadorVagao":{"type":"string","description":"Identificação do vagão.","nullable":true},"identificadorBalsa":{"type":"string","description":"Identificação da balsa.","nullable":true}},"additionalProperties":false,"description":"Dados de transporte para NFe."},"TransporteNfeLacresInputModel":{"required":["numeroLacre"],"type":"object","properties":{"numeroLacre":{"maxLength":60,"minLength":1,"type":"string","description":"Número do lacre."}},"additionalProperties":false,"description":"Lacres do transporte da NFe."},"TransporteNfeReboqueInputModel":{"required":["placaReboque","ufReboque"],"type":"object","properties":{"placaReboque":{"maxLength":7,"minLength":1,"type":"string","description":"Placa do reboque."},"ufReboque":{"$ref":"#/components/schemas/UfNotaFiscalModelEnum"},"rntcReboque":{"type":"string","description":"RNTC do reboque.","nullable":true}},"additionalProperties":false,"description":"Dados do reboque do transporte da NFe."},"TransporteNfeSimplificadaInputModel":{"required":["modalidadeFrete"],"type":"object","properties":{"modalidadeFrete":{"$ref":"#/components/schemas/ModalidadeFreteNotaFiscalModelEnum"},"veiculo":{"$ref":"#/components/schemas/TransporteNfeSimplificadaVeiculoInputModel"},"transportador":{"$ref":"#/components/schemas/TransporteNfeSimplificadaTranspInputModel"},"reboques":{"type":"array","items":{"$ref":"#/components/schemas/TransporteNfeSimplificadaReboqueInputModel"},"description":"Lista de reboques.","nullable":true},"volumes":{"type":"array","items":{"$ref":"#/components/schemas/TransporteNfeSimplificadaVolumeInputModel"},"description":"Lista de volumes.","nullable":true},"identificadorVagao":{"type":"string","description":"Identificação do vagão.","nullable":true},"identificadorBalsa":{"type":"string","description":"Identificação da balsa.","nullable":true}},"additionalProperties":false,"description":"Dados de transporte para NFe."},"TransporteNfeSimplificadaLacresInputModel":{"required":["numeroLacre"],"type":"object","properties":{"numeroLacre":{"maxLength":60,"minLength":1,"type":"string","description":"Número do lacre."}},"additionalProperties":false,"description":"Lacres do transporte da NFe."},"TransporteNfeSimplificadaReboqueInputModel":{"required":["placaReboque","ufReboque"],"type":"object","properties":{"placaReboque":{"maxLength":7,"minLength":1,"type":"string","description":"Placa do reboque."},"ufReboque":{"$ref":"#/components/schemas/UfNotaFiscalModelEnum"},"rntcReboque":{"type":"string","description":"RNTC do reboque.","nullable":true}},"additionalProperties":false,"description":"Dados do reboque do transporte da NFe."},"TransporteNfeSimplificadaTranspInputModel":{"required":["uf"],"type":"object","properties":{"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documento":{"type":"string","description":"Documento do transportador.","nullable":true},"nome":{"type":"string","description":"Nome do transportador.","nullable":true},"inscricaoEstadual":{"type":"string","description":"Inscrição estadual do transportador.","nullable":true},"enderecoCompleto":{"type":"string","description":"Endereço completo do transportador.","nullable":true},"nomeMunicipio":{"type":"string","description":"Nome do município do transportador.","nullable":true},"uf":{"$ref":"#/components/schemas/UfNotaFiscalModelEnum"}},"additionalProperties":false,"description":"Dados do transportador da NFe."},"TransporteNfeSimplificadaVeiculoInputModel":{"required":["placaVeiculo","ufVeiculo"],"type":"object","properties":{"placaVeiculo":{"maxLength":7,"minLength":1,"type":"string","description":"Placa do veículo."},"ufVeiculo":{"$ref":"#/components/schemas/UfNotaFiscalModelEnum"},"rntcVeiculo":{"type":"string","description":"RNTC do veículo.","nullable":true}},"additionalProperties":false,"description":"Dados do veículo de transporte da NFe."},"TransporteNfeSimplificadaVolumeInputModel":{"required":["especie","marca","pesoBruto","pesoLiquido","quantidadeVolumes"],"type":"object","properties":{"quantidadeVolumes":{"minimum":0,"exclusiveMinimum":true,"type":"integer","description":"Quantidade de volumes transportados.","format":"int32"},"especie":{"maxLength":60,"minLength":1,"type":"string","description":"Espécie dos volumes transportados."},"marca":{"maxLength":60,"type":"string","description":"Marca dos volumes transportados."},"numeracaoVolumes":{"maxLength":60,"type":"string","description":"Numeração dos volumes transportados.","nullable":true},"pesoLiquido":{"minimum":0,"type":"number","description":"Peso Líquido (em kg).","format":"double"},"pesoBruto":{"minimum":0,"type":"number","description":"Peso Bruto (em kg).","format":"double"},"lacres":{"type":"array","items":{"$ref":"#/components/schemas/TransporteNfeSimplificadaLacresInputModel"},"description":"Lista de lacres dos volumes transportados.","nullable":true}},"additionalProperties":false,"description":"Dados de volume do transporte da NFe."},"TransporteNfeTransportadorInputModel":{"required":["uf"],"type":"object","properties":{"tipoDocumento":{"$ref":"#/components/schemas/TipoDocumentoNotaFiscalModelEnum"},"documento":{"type":"string","description":"Documento do transportador.","nullable":true},"nome":{"type":"string","description":"Nome do transportador.","nullable":true},"inscricaoEstadual":{"type":"string","description":"Inscrição estadual do transportador.","nullable":true},"enderecoCompleto":{"type":"string","description":"Endereço completo do transportador.","nullable":true},"nomeMunicipio":{"type":"string","description":"Nome do município do transportador.","nullable":true},"uf":{"$ref":"#/components/schemas/UfNotaFiscalModelEnum"}},"additionalProperties":false,"description":"Dados do transportador da NFe."},"TransporteNfeVeiculoInputModel":{"required":["placaVeiculo","ufVeiculo"],"type":"object","properties":{"placaVeiculo":{"maxLength":7,"minLength":1,"type":"string","description":"Placa do veículo."},"ufVeiculo":{"$ref":"#/components/schemas/UfNotaFiscalModelEnum"},"rntcVeiculo":{"type":"string","description":"RNTC do veículo.","nullable":true}},"additionalProperties":false,"description":"Dados do veículo de transporte da NFe."},"TransporteNfeVolumeInputModel":{"required":["especie","marca","pesoBruto","pesoLiquido","quantidadeVolumes"],"type":"object","properties":{"quantidadeVolumes":{"minimum":0,"exclusiveMinimum":true,"type":"integer","description":"Quantidade de volumes transportados.","format":"int32"},"especie":{"maxLength":60,"minLength":1,"type":"string","description":"Espécie dos volumes transportados."},"marca":{"maxLength":60,"type":"string","description":"Marca dos volumes transportados."},"numeracaoVolumes":{"maxLength":60,"type":"string","description":"Numeração dos volumes transportados.","nullable":true},"pesoLiquido":{"minimum":0,"type":"number","description":"Peso Líquido (em kg).","format":"double"},"pesoBruto":{"minimum":0,"type":"number","description":"Peso Bruto (em kg).","format":"double"},"lacres":{"type":"array","items":{"$ref":"#/components/schemas/TransporteNfeLacresInputModel"},"description":"Lista de lacres dos volumes transportados.","nullable":true}},"additionalProperties":false,"description":"Dados de volume do transporte da NFe."},"TributacaoIssqnEnum":{"enum":["OperacaoTributavel","Imunidade","ExportacaoServico","NaoIncidencia"],"type":"string"},"TributosFederaisNfseModoPrestadorInputModel":{"type":"object","properties":{"pisCofins":{"$ref":"#/components/schemas/PisCofinsNfseModoPrestadorInputModel"},"valorRetencaoCP":{"type":"number","description":"Valor de retenção de Contribuição Previdenciária (vRetCP) em R$. Opcional.","format":"double","nullable":true},"valorRetencaoIRRF":{"type":"number","description":"Valor de retenção do IRRF (vRetIRRF) em R$. Opcional.","format":"double","nullable":true},"valorRetencaoCSLL":{"type":"number","description":"Valor de retenção da CSLL (vRetCSLL) em R$. Opcional.","format":"double","nullable":true}},"additionalProperties":false,"description":"Tributação federal (tribFed) para NFS-e no modo prestador.\nObrigatório para emissores de Lucro Real e Lucro Presumido.\nNão deve ser preenchido para emissores do Simples Nacional e MEI."},"TributosFederaisNfseModoTomadorInputModel":{"type":"object","properties":{"pisCofins":{"$ref":"#/components/schemas/PisCofinsNfseModoTomadorInputModel"},"valorRetencaoCP":{"type":"number","description":"Valor de retenção de Contribuição Previdenciária (vRetCP) em R$. Opcional.","format":"double","nullable":true},"valorRetencaoIRRF":{"type":"number","description":"Valor de retenção do IRRF (vRetIRRF) em R$. Opcional.","format":"double","nullable":true},"valorRetencaoCSLL":{"type":"number","description":"Valor de retenção da CSLL (vRetCSLL) em R$. Opcional.","format":"double","nullable":true}},"additionalProperties":false,"description":"Tributação federal (tribFed) para NFS-e no modo tomador.\nObrigatório para emissores de Lucro Real e Lucro Presumido.\nNão deve ser preenchido para emissores do Simples Nacional e MEI."},"UfCodigoBeneficioModelEnum":{"enum":["RO","AC","AM","RR","PA","AP","TO","MA","PI","CE","RN","PB","PE","AL","SE","BA","MG","ES","RJ","SP","PR","SC","RS","MS","MT","GO","DF"],"type":"string","description":"Unidade Federativa."},"UfExtNotaFiscalModelEnum":{"enum":["RO","AC","AM","RR","PA","AP","TO","MA","PI","CE","RN","PB","PE","AL","SE","BA","MG","ES","RJ","SP","PR","SC","RS","MS","MT","GO","DF","EX"],"type":"string","description":"Lista de Unidades Federativas para Nota Fiscal incluíndo exterior."},"UfExtNotaFiscalServicoModelEnum":{"enum":["RO","AC","AM","RR","PA","AP","TO","MA","PI","CE","RN","PB","PE","AL","SE","BA","MG","ES","RJ","SP","PR","SC","RS","MS","MT","GO","DF","EX"],"type":"string","description":"Lista de Unidades Federativas para Nota Fiscal de Serviço incluindo exterior."},"UfModelEnum":{"enum":["RO","AC","AM","RR","PA","AP","TO","MA","PI","CE","RN","PB","PE","AL","SE","BA","MG","ES","RJ","SP","PR","SC","RS","MS","MT","GO","DF"],"type":"string","description":"Lista de Unidades Federativas."},"UfNotaFiscalModelEnum":{"enum":["RO","AC","AM","RR","PA","AP","TO","MA","PI","CE","RN","PB","PE","AL","SE","BA","MG","ES","RJ","SP","PR","SC","RS","MS","MT","GO","DF"],"type":"string","description":"Lista de Unidades Federativas para Nota Fiscal."},"UfTributoAproximadoModelEnum":{"enum":["RO","AC","AM","RR","PA","AP","TO","MA","PI","CE","RN","PB","PE","AL","SE","BA","MG","ES","RJ","SP","PR","SC","RS","MS","MT","GO","DF"],"type":"string","description":"Unidade Federativa."},"ValoresNfseModoPrestadorInputModel":{"required":["valorServico"],"type":"object","properties":{"valorServico":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Valor monetário do serviço (vServ) em R$.","format":"double"},"valorRecebidoIntermediario":{"type":"number","description":"Valor recebido pelo intermediário (vReceb) em R$. Preencher somente quando TipoEmissor = Intermediário.","format":"double","nullable":true},"valorDescontoIncondicionado":{"type":"number","description":"Valor do desconto incondicionado (vDescIncond) em R$. Opcional.","format":"double","nullable":true},"valorDescontoCondicionado":{"type":"number","description":"Valor do desconto condicionado (vDescCond) em R$. Opcional.","format":"double","nullable":true},"percentualDeducaoReducao":{"type":"number","description":"Percentual padrão de dedução/redução da base de cálculo do ISSQN (pDR) em %. Mutuamente exclusivo com ValorDeducaoReducao.","format":"double","nullable":true},"valorDeducaoReducao":{"type":"number","description":"Valor monetário padrão de dedução/redução da base de cálculo do ISSQN (vDR) em R$. Mutuamente exclusivo com PercentualDeducaoReducao.","format":"double","nullable":true},"tributacaoIssqn":{"$ref":"#/components/schemas/TributacaoIssqnEnum"},"tipoRetencaoIssqn":{"$ref":"#/components/schemas/TipoRetencaoIssqnEnum"},"aliquotaIssqn":{"type":"number","description":"Alíquota do ISSQN (pAliq) em %. Opcional.","format":"double","nullable":true},"codigoPaisResultado":{"type":"string","description":"Código do país onde ocorreu o resultado do serviço (cPaisResult — Tabela ISO). Informar quando TributacaoIssqn = ExportacaoServico.","nullable":true},"tipoImunidade":{"$ref":"#/components/schemas/TipoImunidadeNfseModelEnum"},"beneficioMunicipal":{"$ref":"#/components/schemas/BeneficioMunicipalNfseInputModel"},"tributosFederais":{"$ref":"#/components/schemas/TributosFederaisNfseModoPrestadorInputModel"}},"additionalProperties":false,"description":"Valores do serviço prestado e tributação ISSQN para NFS-e no modo prestador."},"ValoresNfseModoTomadorInputModel":{"required":["valorServico"],"type":"object","properties":{"valorServico":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Valor monetário do serviço (vServ) em R$.","format":"double"},"valorRecebidoIntermediario":{"type":"number","description":"Valor recebido pelo intermediário (vReceb) em R$. Preencher somente quando TipoEmissor = Intermediário.","format":"double","nullable":true},"valorDescontoIncondicionado":{"type":"number","description":"Valor do desconto incondicionado (vDescIncond) em R$. Opcional.","format":"double","nullable":true},"valorDescontoCondicionado":{"type":"number","description":"Valor do desconto condicionado (vDescCond) em R$. Opcional.","format":"double","nullable":true},"percentualDeducaoReducao":{"type":"number","description":"Percentual padrão de dedução/redução da base de cálculo do ISSQN (pDR) em %. Mutuamente exclusivo com ValorDeducaoReducao.","format":"double","nullable":true},"valorDeducaoReducao":{"type":"number","description":"Valor monetário padrão de dedução/redução da base de cálculo do ISSQN (vDR) em R$. Mutuamente exclusivo com PercentualDeducaoReducao.","format":"double","nullable":true},"tributacaoIssqn":{"$ref":"#/components/schemas/TributacaoIssqnEnum"},"tipoRetencaoIssqn":{"$ref":"#/components/schemas/TipoRetencaoIssqnEnum"},"aliquotaIssqn":{"type":"number","description":"Alíquota do ISSQN (pAliq) em %. Opcional.","format":"double","nullable":true},"codigoPaisResultado":{"type":"string","description":"Código do país onde ocorreu o resultado do serviço (cPaisResult — Tabela ISO). Informar quando TributacaoIssqn = ExportacaoServico.","nullable":true},"tipoImunidade":{"$ref":"#/components/schemas/TipoImunidadeNfseModelEnum"},"beneficioMunicipal":{"$ref":"#/components/schemas/BeneficioMunicipalNfseInputModel"},"tributosFederais":{"$ref":"#/components/schemas/TributosFederaisNfseModoTomadorInputModel"}},"additionalProperties":false,"description":"Valores do serviço prestado e tributação ISSQN para NFS-e no modo tomador."}},"securitySchemes":{"BearerAuth":{"type":"http","description":"Autenticação via token JWT. Obtenha o token através do endpoint /Autenticacao/ObterToken usando Basic Auth. O token expira em 1 hora.","scheme":"bearer","bearerFormat":"JWT"}}},"tags":[{"name":"Autenticacao","description":"Controlador responsável pelos processos de autenticação e autorização de acesso à Stone Tax API.\n \n Fornece recursos para que o Console e os Aplicativos realizem a autenticação\n na API por meio de credenciais de segurança, garantindo acesso seguro aos serviços disponíveis.\n \n Também disponibiliza mecanismos para renovação/atualização de tokens de acesso,\n permitindo a continuidade da comunicação mesmo após a expiração do token atual,\n sem necessidade de uma nova autenticação completa.\n "},{"name":"Emissor","description":"Controlador responsável pela gestão de Emissores vinculados aos aplicativos da Stone Tax API.\n \n Fornece operações para habilitação, atualização e desabilitação de emissores fiscais, \n permitindo a configuração detalhada de entidades que realizam a emissão de documentos na plataforma.\n \n Por meio desta controller é possível administrar os dados cadastrais, regimes tributários e tipos de estabelecimento,\n além de oferecer recursos avançados de listagem paginada e consulta de detalhes \n filtrando por documentos, status e períodos de criação.\n \n Todos os recursos disponibilizados exigem autenticação e são vinculados ao contexto do \n Parceiro e Aplicativo autenticados, garantindo isolamento de dados e conformidade \n com as regras de negócio fiscais.\n "},{"name":"CatalogoProduto","description":"Controlador responsável pelo Catálogo de Produtos e inteligência fiscal da Stone Tax API.\n \n Fornece operações para a identificação e curadoria de mercadorias, permitindo buscas assertivas \n baseadas em identificadores globais e descrições comerciais para facilitar o processo de faturamento.\n \n Por meio desta controller é possível obter a tributação de produtos, \n utilizando filtros por EAN (GTIN) ou descrição, além de retornar informações de \n tributação e classificação fiscal essenciais para a conformidade da emissão.\n \n Todos os recursos disponibilizados exigem autenticação e operam sob o contexto do \n Emissor informado no cabeçalho, garantindo que as regras fiscais aplicadas correspondam \n ao perfil tributário da entidade solicitante.\n "},{"name":"Nfe","description":"Controlador de Notas Fiscais Eletrônicas (NFe) da Stone Tax API.\n \n Centraliza os recursos destinados à emissão, cancelamento e gestão de notas fiscais eletrônicas (NFe). \n Fornece abstrações para simplificar a complexidade de comunicação com as Secretarias da Fazenda (SEFAZ).\n \n Através desta controller, é possível gerenciar todo o ciclo de vida de um documento fiscal: desde a emissão até a obtenção de artefatos finais como o XML e o DANFE.\n \n Operações de escrita (emissão/cancelamento) exigem assinatura digital e observância ao contexto do \n Emissor configurado, garantindo a validade jurídica perante o Fisco.\n "},{"name":"Nfce","description":"Controlador de Notas Fiscais de Consumidor Eletrônicas (NFCe) da Stone Tax API.\n \n Centraliza os recursos destinados à emissão, cancelamento e gestão de notas fiscais de consumidor (NFCe). \n Fornece abstrações para simplificar a complexidade de comunicação com as Secretarias da Fazenda (SEFAZ).\n \n Através desta controller, é possível gerenciar todo o ciclo de vida de um documento fiscal: desde a emissão até a obtenção de artefatos finais como o XML e o DANFE.\n \n Operações de escrita (emissão/cancelamento) exigem assinatura digital e observância ao contexto do \n Emissor configurado, garantindo a validade jurídica perante o Fisco.\n "},{"name":"Nfse","description":"Controlador de Notas Fiscais de Serviço Eletrônicas (NFSe) da Stone Tax API.\n \n Centraliza os recursos destinados à emissão, cancelamento e gestão de notas fiscais de serviços (NFSe).\n Fornece abstrações para simplificar a complexidade de comunicação com as Secretarias da Fazenda (SEFAZ).\n \n Através desta controller, é possível gerenciar todo o ciclo de vida de um documento fiscal: desde a emissão até a obtenção de artefatos finais como o XML e o DANFE.\n \n Operações de escrita (emissão/cancelamento) exigem assinatura digital e observância ao contexto do\n Emissor configurado, garantindo a validade jurídica perante o Fisco.\n "},{"name":"DocumentoFiscal","description":"Controlador de Serviços de Documentos Fiscais da Stone Tax API.\n \n Atua como uma camada de apoio e auditoria, fornecendo recursos para a gestão de artefatos \n e rastreabilidade operacional de documentos fiscais eletrônicos (NF-e, NFC-e, NFS-e, etc).\n \n Esta controller centraliza funcionalidades genéricas que permitem a extração de XMLs em massa \n e a consulta ao histórico completo de eventos (como autorizações, cancelamentos e correções) \n processados pela plataforma, garantindo conformidade técnica e fiscal.\n \n Todos os recursos operam sob o contexto do Emissor informado no cabeçalho, \n permitindo que o sistema consumidor monitore o ciclo de vida dos documentos e recupere dados históricos para fins contábeis.\n "},{"name":"RecursosAdicionais","description":"Controlador de Recursos Adicionais e Tabelas Auxiliares da Stone Tax API.\n \n Fornece acesso a tabelas normatizadas e metadados fiscais essenciais para o preenchimento de documentos eletrônicos, \n garantindo a integridade dos dados de classificação e operação fiscal.\n \n Centraliza a consulta a códigos de tabelas externas (como CFOP e NCM), permitindo que o sistema parceiro \n valide parâmetros de negócio contra as regras vigentes da SEFAZ e órgãos reguladores.\n \n Todos os recursos disponibilizados exigem autenticação e visam apoiar a manutenção de cadastros \n mestres e a correta parametrização de fluxos de entrada e saída de mercadorias.\n "}]}
```