{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"https://piloto-cbs.tributos.gov.br:16994/servico/calculadora-consumo/api","description":"Generated server url"}],"tags":[{"name":"Base de Cálculo - VERSÃO BETA","description":"Serviço para Base de Cálculo"},{"name":"Calculadora - VERSÃO BETA","description":"Calculadora de Tributos"},{"name":"Dados Abertos - VERSÃO BETA","description":"Consultas para os Dados Abertos"},{"name":"Observabilidade - Calculadora - VERSÃO BETA","description":"Endpoint de observabilidade da Calculadora de Tributos"},{"name":"NFS-e - VERSÃO BETA","description":"Operações auxiliares: cálculo de base, validação e consultas de dados mestres de NFS-e"},{"name":"Pedágio - VERSÃO BETA","description":"IVA - Calculadora de Tributos para o Pedágio"}],"paths":{"/calculadora/xml/validate":{"get":{"tags":["Calculadora - VERSÃO BETA"],"summary":"Tipos de DFe","description":"Tipos de DFe para validação de XML","operationId":"getDocumentosValidacao","responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TipoDocumentoDTO"},"examples":{"Tipos de DFe Example":{"description":"Tipos de DFe Example","value":[{"nome":"NFe","mnemonico":"nfe","versaoNotaTecnica":"v1.30"},{"nome":"NFCe","mnemonico":"nfce","versaoNotaTecnica":"v1.30"},{"nome":"NFSe","mnemonico":"nfse","versaoNotaTecnica":"ND"},{"nome":"CTe","mnemonico":"cte","versaoNotaTecnica":"v1.10"},{"nome":"CTe Simplificado","mnemonico":"cte-simplificado","versaoNotaTecnica":"v1.10"},{"nome":"BPe","mnemonico":"bpe","versaoNotaTecnica":"v1.10"},{"nome":"NF3E","mnemonico":"nf3e","versaoNotaTecnica":"v1.10"}]}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/xml/validate"}}}}}}}},"post":{"tags":["Calculadora - VERSÃO BETA"],"summary":"Validação de XML","description":"Valida os dados no formato XML","operationId":"validate","parameters":[{"name":"tipo","in":"query","description":"Tipo do XML","required":true,"schema":{"type":"string","enum":["nfe","nfce","nfse","cte","cte-simplificado","bpe","bpe-tm","nf3e"]}},{"name":"subtipo","in":"query","description":"Subtipo do XML","required":true,"schema":{"type":"string","enum":["grupo","nota"]}}],"requestBody":{"description":"XML a ser validado","content":{"application/xml":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Validação realizada com sucesso","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"Estrutura e/ou dados informados em formato não reconhecido","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"404":{"description":"Erro na URL da requisição","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"422":{"description":"Erro de validação","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}},"/calculadora/xml/generate":{"get":{"tags":["Calculadora - VERSÃO BETA"],"summary":"Tipos de DFe","description":"Tipos de DFe para geração de XML","operationId":"getDocumentosGeracao","responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TipoDocumentoDTO"},"examples":{"Tipos de DFe Example":{"description":"Tipos de DFe Example","value":[{"nome":"NFe","mnemonico":"nfe","versaoNotaTecnica":"v1.30"},{"nome":"NFCe","mnemonico":"nfce","versaoNotaTecnica":"v1.30"},{"nome":"CTe","mnemonico":"cte","versaoNotaTecnica":"v1.10"},{"nome":"CTe Simplificado","mnemonico":"cte-simplificado","versaoNotaTecnica":"v1.10"},{"nome":"BPe","mnemonico":"bpe","versaoNotaTecnica":"v1.10"},{"nome":"NF3E","mnemonico":"nf3e","versaoNotaTecnica":"v1.10"}]}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/xml/generate"}}}}}}}},"post":{"tags":["Calculadora - VERSÃO BETA"],"summary":"Geração de XML","description":"Converte os dados para o formato XML","operationId":"generate","parameters":[{"name":"tipo","in":"query","description":"Tipo do documento","required":true,"schema":{"type":"string","enum":["nfe","nfce","nfse","cte","cte-simplificado","bpe","bpe-tm","nf3e"]}}],"requestBody":{"description":"Dados do CBS/IBS/IS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ROCDomain"}}},"required":true},"responses":{"200":{"description":"Conversão realizada com sucesso","content":{"application/xml":{"schema":{"type":"string"}}}},"400":{"description":"Estrutura e/ou dados informados em formato não reconhecido","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"404":{"description":"Erro na URL da requisição","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"422":{"description":"Erro de validação","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}},"/calculadora/regime-geral":{"post":{"tags":["Calculadora - VERSÃO BETA"],"summary":"Cálculo do tributo","description":"Calcula os tributos a partir dos dados de uma operação de consumo","operationId":"calcularTributos","requestBody":{"description":"Dados de uma operação de consumo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperacaoInput"}}},"required":true},"responses":{"200":{"description":"Cálculo realizado com sucesso","headers":{"x-warning-dados-simulados":{"description":"Indica que os dados são simulados. Valores possíveis:","style":"simple","schema":{"type":"integer","example":1}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ROCDomain"}}}},"400":{"description":"Estrutura e/ou dados informados em formato não reconhecido","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"404":{"description":"Erro na URL da requisição","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"422":{"description":"Erro de validação","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}},"/calculadora/pedagio":{"post":{"tags":["Pedágio - VERSÃO BETA"],"summary":"Cálculo do tributo","description":"Calculo do pedágio","operationId":"calcularTributo","requestBody":{"description":"Dados para cálculo do pedágio","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedagioInput"}}},"required":true},"responses":{"200":{"description":"Cálculo realizado com sucesso","headers":{"x-warning-dados-simulados":{"description":"Indica que os dados são simulados. Valores possíveis: 1 (alíquotas da CBS e do IBS ainda não definidas em lei).","style":"simple","schema":{"type":"integer","example":1}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedagioOutput"}}}},"400":{"description":"Estrutura e/ou dados informados em formato não reconhecido","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"404":{"description":"Erro na URL da requisição","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"422":{"description":"Erro de validação","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}},"/calculadora/observabilidade/regime-geral":{"post":{"tags":["Observabilidade - Calculadora - VERSÃO BETA"],"summary":"Cálculo com observabilidade","description":"Processa todos os itens acumulando erros individuais. Retorna resultado parcial com estado de cada item.","operationId":"calcularTributosObservabilidade","requestBody":{"description":"Dados de uma operação de consumo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperacaoInput"}}},"required":true},"responses":{"200":{"description":"Processamento realizado (itens podem ter erros individuais)","headers":{"x-warning-dados-simulados":{"description":"Indica que os dados são simulados. Valores possíveis:","style":"simple","schema":{"type":"integer","example":1}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObservabilidadeROCDomain"}}}},"400":{"description":"Estrutura e/ou dados informados em formato não reconhecido","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"422":{"description":"Erro de validação global (UF, Município, data do fato gerador)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}},"/calculadora/nfse/indicador-operacao/validate":{"post":{"tags":["NFS-e - VERSÃO BETA"],"summary":"Validação de Indicador de Operação","description":"Valida se o cIndOp é compatível com cClassTrib, NBS e cTribNac (opcional)","operationId":"validarIndicadorOperacao","requestBody":{"description":"Dados para validação: cIndOp, cClassTrib, NBS e cTribNac (opcional)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NfseValidacaoIndicadorOperacaoInput"}}},"required":true},"responses":{"200":{"description":"Validação realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NfseValidacaoIndicadorOperacaoOutput"}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"404":{"description":"Erro na URL da requisição","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}},"/calculadora/nfse/base-calculo":{"post":{"tags":["NFS-e - VERSÃO BETA"],"summary":"Base de Cálculo NFS-e","description":"Afere a Base de Cálculo de uma NFS-e no período de transição. ATENÇÃO: Os campos PIS e COFINS não podem ser informados a partir de 2027. O campo ISS não pode ser informado a partir de 2033.","operationId":"calcularBaseCalculo","requestBody":{"description":"Dados da base de cálculo da NFS-e","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NfseBaseCalculoInput"}}},"required":true},"responses":{"200":{"description":"Cálculo realizado com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NfseBaseCalculoOutput"}}}},"400":{"description":"Estrutura e/ou dados informados em formato não reconhecido ou campos incompatíveis com o ano do fato gerador informado (PIS e COFINS a partir de 2027; ISS a partir de 2033)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"404":{"description":"Erro na URL da requisição","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"422":{"description":"Erro de validação","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}},"/calculadora/base-calculo/is-mercadorias":{"post":{"tags":["Base de Cálculo - VERSÃO BETA"],"summary":"Imposto Seletivo","description":"Afere a Base de Cálculo do Imposto Seletivo de uma operação de consumo. ATENÇÃO: Os campos ICMS e ISS não podem ser informados a partir de 2033.","operationId":"calcularISMercadorias","requestBody":{"description":"Dados da base de cálculo do Imposto Seletivo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseCalculoISMercadoriasInput"}}},"required":true},"responses":{"200":{"description":"Cálculo realizado com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseCalculoISMercadoriasModel"}}}},"400":{"description":"Estrutura e/ou dados informados em formato não reconhecido ou campos incompatíveis com o ano do fato gerador informado (ICMS e ISS a partir de 2033)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"404":{"description":"Erro na URL da requisição","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"422":{"description":"Erro de validação","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}},"/calculadora/base-calculo/cbs-ibs-mercadorias":{"post":{"tags":["Base de Cálculo - VERSÃO BETA"],"summary":"CIBS","description":"Afere a Base de Cálculo da CBS/IBS de uma operação de consumo. ATENÇÃO: Os campos PIS, COFINS, PIS Importação e COFINS Importação não podem ser informados a partir de 2027. Os campos ICMS e ISS não podem ser informados a partir de 2033.","operationId":"calcularCibs","requestBody":{"description":"Dados da base de cálculo do CIBS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseCalculoCibsInput"}}},"required":true},"responses":{"200":{"description":"Cálculo realizado com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseCalculoCibsModel"}}}},"400":{"description":"Estrutura e/ou dados informados em formato não reconhecido ou campos incompatíveis com o ano do fato gerador informado (PIS, COFINS, PIS Importação e COFINS a partir de 2027; ICMS e ISS a partir de 2033)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"404":{"description":"Erro na URL da requisição","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"422":{"description":"Erro de validação","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}},"/calculadora/base-calculo/base-calculo-unificada":{"post":{"tags":["Base de Cálculo - VERSÃO BETA"],"summary":"Cálculo Base Unificada","description":"Calcula as três bases de cálculo (RG/IBS-CBS, IS, SN) para um único item. Recebe todos os campos possíveis e aplica as regras de vigência conforme ano, natureza e modelo. Campos informados com valor diferente de zero que não compõem o contexto (fora de vigência, natureza incompatível ou modelo de documento inválido) são listados em 'avisos' com o motivo — comportamento informativo, não bloqueante: as bases retornadas já desconsideram esses campos. ","operationId":"calcularBaseUnificada","requestBody":{"description":"Dados completos para cálculo das 3 bases.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseCalculoUnificadaInput","example":{"anoFatoGerador":2026,"tipoDocumento":55,"natureza":"BEM","vProd":1000.0,"vFrete":50.0,"vSeg":20.0,"vOutro":10.0,"vII":150.0,"vIS":30.0,"vDesc":50.0,"vPIS":9.25,"vCOFINS":46.25,"vICMS":180.0,"vICMSUFDest":20.0,"vICMSMono":100.0,"vFCP":10.0,"vFCPUFDest":5.0,"vISSQN":30.0}}}},"required":true},"responses":{"200":{"description":"Cálculo realizado com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseCalculoUnificadaOutput"}}}},"400":{"description":"Dados inconsistentes ou ano/modelo/natureza inválidos","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"422":{"description":"Erro de validação de campos","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}},"/calculadora/base-calculo/base-calculo-unificada-nfse":{"post":{"tags":["Base de Cálculo - VERSÃO BETA"],"summary":"[EXPERIMENTAL] Base de Cálculo Unificada NFS-e","description":"Calcula as bases de cálculo de IBS/CBS (RG) e Simples Nacional (SN) para operações de NFS-e. Retorna bases, avisos e erros de negócio na mesma resposta.","operationId":"calcularBaseUnificadaNfse","requestBody":{"description":"Dados da operação NFS-e para cálculo das bases de cálculo unificadas.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseCalculoUnificadaNfseInput"}}},"required":true},"responses":{"200":{"description":"Cálculo realizado com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseCalculoUnificadaNfseOutput"}}}},"400":{"description":"Campos obrigatórios ausentes ou valores inválidos","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}},"/calculadora/observabilidade/erros":{"get":{"tags":["Observabilidade - Calculadora - VERSÃO BETA"],"summary":"Consultar descrição de erro","description":"Retorna título e descrição em PT-BR para o código de erro informado (REG, CAL ou VAL).","operationId":"buscarErro","parameters":[{"name":"codigo","in":"query","description":"Código do erro (ex: REG-020, CAL-001, VAL-001)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Descrição do erro encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErroDescricao"}}}},"404":{"description":"Código de erro não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErroDescricao"}}}}}}},"/calculadora/nfse/situacoes-classificacoes-tributarias":{"get":{"tags":["NFS-e - VERSÃO BETA"],"summary":"Consultar Classificações e Situações Tributárias por NBS","description":"Retorna todas as combinações de Classificações Tributárias e Situações Tributárias associadas a um código NBS em uma data específica","operationId":"consultarSituacoesClassificacoesPorNbs","parameters":[{"name":"nbs","in":"query","description":"Código NBS sem formatação","required":true,"schema":{"type":"string","pattern":"^\\d{9}$"},"example":101011100},{"name":"data","in":"query","description":"Data no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2026-06-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NfseSituacaoClassificacaoOutput"},"examples":{"Classificações e Situações Example":{"description":"Classificações e Situações Example","value":[{"codigoClassificacaoTributaria":"200045","descricaoClassificacaoTributaria":"Operações relacionadas a projetos de reabilitação urbana de zonas históricas e de áreas críticas de recuperação e reconversão urbanística","codigoSituacaoTributaria":"200","descricaoSituacaoTributaria":"Alíquota reduzida"},{"codigoClassificacaoTributaria":"200046","descricaoClassificacaoTributaria":"Operações com bens imóveis","codigoSituacaoTributaria":"200","descricaoSituacaoTributaria":"Alíquota reduzida"}]}}}}},"400":{"description":"Parâmetros inválidos","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"NBS deve conter exatamente 9 dígitos numéricos","instance":"/api/calculadora/nfse/classificacoes-situacoes-tributarias"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}},"/calculadora/nfse/local-operacao":{"get":{"tags":["NFS-e - VERSÃO BETA"],"summary":"Local da Operação","description":"Consulta o local da operação baseado no código do Indicador de Operação (cIndOp) e data de ocorrência do fato gerador","operationId":"consultarLocalOperacao","parameters":[{"name":"cIndOp","in":"query","description":"Código do Indicador de Operação (6 dígitos)","required":true,"schema":{"type":"string","minLength":1,"pattern":"^\\d{6}$"},"example":100301},{"name":"dataOcorrenciaFatoGerador","in":"query","description":"Data de ocorrência do fato gerador no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2026-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NfseLocalOperacaoOutput"},"examples":{"Local Operação Example":{"description":"Local Operação Example","value":{"cIndOp":"100301","dataOcorrenciaFatoGerador":"2026-01-01","codigoLocalFornecimento":11,"localFornecimento":"Local do domicílio principal do adquirente residente ou domiciliado no País. Nas aquisições indicadas no art. 11, §4º, II, considera-se domicílio principal do adquirente o estabelecimentro matriz","codigoLocalIncidencia":2,"localIncidencia":"Endereço do Tomador/Adquirente"}}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Required parameter 'cIndOp' is not present.","instance":"/api/calculadora/nfse/local-operacao"}}}}}},"404":{"description":"Erro na URL da requisição","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Not Found Example":{"description":"Not Found Example","value":{"type":"about:blank","title":"Not Found","status":404,"detail":"No static resource calculadora/nfse/local-operacao.","instance":"/api/calculadora/nfse/local-operacao-invalido"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/nfse/local-operacao"}}}}}}}}},"/calculadora/nfse/locais-incidencia":{"get":{"tags":["NFS-e - VERSÃO BETA"],"summary":"Locais de Incidência","description":"Retorna a lista de códigos e descrições dos locais de incidência. Se o parâmetro codigo for informado, retorna apenas o valor correspondente.","operationId":"consultarLocaisIncidencia","parameters":[{"name":"codigo","in":"query","description":"Código do local de incidência (opcional)","required":false,"schema":{"type":"integer","format":"int32"},"example":3}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NfseCodigoDescricaoOutput"}}}},"400":{"description":"Código inválido","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}},"/calculadora/nfse/locais-fornecimento":{"get":{"tags":["NFS-e - VERSÃO BETA"],"summary":"Locais de Fornecimento","description":"Retorna a lista de códigos e descrições dos locais de fornecimento. Se o parâmetro codigo for informado, retorna apenas o valor correspondente.","operationId":"consultarLocaisFornecimento","parameters":[{"name":"codigo","in":"query","description":"Código do local de fornecimento (opcional)","required":false,"schema":{"type":"integer","format":"int32"},"example":5}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NfseCodigoDescricaoOutput"}}}},"400":{"description":"Código inválido","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}},"/calculadora/nfse/indicador-operacao":{"get":{"tags":["NFS-e - VERSÃO BETA"],"summary":"Indicador de Operação","description":"Consulta os indicadores de operação baseado na data de ocorrência do fato gerador","operationId":"consultarIndicadoresOperacao","parameters":[{"name":"dataOcorrenciaFatoGerador","in":"query","description":"Data de ocorrência do fato gerador no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2026-01-01"},{"name":"nbs","in":"query","description":"Código NBS (9 dígitos numéricos) - quando informado, retorna campos adicionais prestacaoServicoOnerosa e adquirenteExterior","required":false,"schema":{"type":"string","pattern":"^\\d{9}$"},"example":123456789}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NfseIndicadorOperacaoOutput"},"examples":{"Indicador Operação Example":{"description":"Indicador Operação Example","value":[{"cIndOp":"020101","tipoOperacao":"Operação com bem imóvel, bem imaterial, inclusive direito, relacionada a bem imóvel","codigoLocalFornecimento":14,"localFornecimento":"Localidade do imóvel","codigoLocalIncidencia":6,"localIncidencia":"Localidade do Imóvel"},{"cIndOp":"020201","tipoOperacao":"Serviço prestado fisicamente sobre bem imóvel","codigoLocalFornecimento":14,"localFornecimento":"Localidade do imóvel","codigoLocalIncidencia":6,"localIncidencia":"Localidade do Imóvel"},{"cIndOp":"020301","tipoOperacao":"Serviço de administração e intermediação de bem imóvel","codigoLocalFornecimento":14,"localFornecimento":"Localidade do imóvel","codigoLocalIncidencia":6,"localIncidencia":"Localidade do Imóvel"}]},"Indicador Operação com NBS Example":{"description":"Indicador Operação com NBS Example","value":[{"cIndOp":"100301","tipoOperacao":"Demais serviços, em operações onerosas","codigoLocalFornecimento":11,"localFornecimento":"Local do domicílio principal do adquirente residente ou domiciliado no País. Nas aquisições indicadas no art. 11, §4º, II, considera-se domicílio principal do adquirente o estabelecimentro matriz","codigoLocalIncidencia":2,"localIncidencia":"Endereço do Tomador/Adquirente","prestacaoServicoOnerosa":true,"adquirenteExterior":false}]}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Required parameter 'dataOcorrenciaFatoGerador' is not present.","instance":"/api/calculadora/nfse/indicador-operacao"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/nfse/indicador-operacao"}}}}}}}}},"/calculadora/dados-abertos/versao":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Versão do Aplicativo e do Banco de Dados","description":"Obtém a versão do aplicativo e do banco de dados","operationId":"consultarVersao","responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersaoOutput"},"examples":{"Versão Example":{"description":"Versão Example","value":{"versaoApp":"SNAPSHOT-b7bb06d6","descricaoVersaoApp":"demanda5430315Cofis42615ValidadeNcm-SNAPSHOT-b7bb06d6","versaoDb":"v0011","descricaoVersaoDb":"Nova carga de classificação tributária e novos campos em CLASSIFICACAO_TRIBUTARIA e SITUACAO_TRIBUTARIA.","dataVersaoDb":"2025-10-16","ambiente":"online"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/versao"}}}}}}}}},"/calculadora/dados-abertos/ufs":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Unidade Federativa","description":"Obtém a lista das unidades federativas cadastradas","operationId":"consultarUfs","responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UfDadosAbertosOutput"},"examples":{"UFs Example":{"description":"UFs Example","value":[{"sigla":"RO","nome":"RONDÔNIA","codigo":11},{"sigla":"AC","nome":"ACRE","codigo":12}]}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Parâmetro inválido ou ausente.","instance":"/api/calculadora/dados-abertos/ufs"}}}}}},"404":{"description":"Erro na URL da requisição","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Not Found Example":{"description":"Not Found Example","value":{"type":"about:blank","title":"Not Found","status":404,"detail":"No static resource calculadora/dados-abertos/ufs/1.","instance":"/api/calculadora/dados-abertos/ufs/1"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/ufs"}}}}}}}}},"/calculadora/dados-abertos/ufs/municipios":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Município","description":"Obtém a lista dos municípios cadastrados com base na sigla de uma unidade federativa","operationId":"consultarMunicipiosPorSiglaUf","parameters":[{"name":"siglaUf","in":"query","description":"Sigla da unidade federativa","required":true,"schema":{"type":"string"},"example":"RS"}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MunicipioDadosAbertosOutput"},"examples":{"Municípios Example":{"description":"Municípios Example","value":[{"codigo":4314902,"nome":"Porto Alegre"},{"codigo":4305108,"nome":"Caxias do Sul"}]}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/municipios/RS"}}}}}}}}},"/calculadora/dados-abertos/transferencias-ibs":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Transferência IBS para Entes Governamentais","description":"Obtém a lista de todos os percentuais de transferência IBS cadastrados","operationId":"consultarTransferenciasIBS","responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferenciaIBSDadosAbertosOutput"},"examples":{"Transferências IBS Example":{"description":"Transferências IBS Example","value":[{"valor":0,"inicioVigencia":"2026-01-01","fimVigencia":"2026-12-31"},{"valor":100,"inicioVigencia":"2027-01-01"}]}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/transferencias-ibs"}}}}}}}}},"/calculadora/dados-abertos/transferencias-cbs":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Transferência CBS para Entes Governamentais","description":"Obtém a lista de todos os percentuais de transferência CBS cadastrados","operationId":"consultarTransferenciasCBS","responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferenciaCBSDadosAbertosOutput"},"examples":{"Transferências CBS Example":{"description":"Transferências CBS Example","value":[{"valor":0.15,"inicioVigencia":"2026-01-01"},{"valor":0.1,"inicioVigencia":"2025-01-01","fimVigencia":"2025-12-31"}]}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/transferencias-cbs"}}}}}}}}},"/calculadora/dados-abertos/situacoes-tributarias/is":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Situações Tributárias (CSTs) com Classificações Tributárias - IS","description":"Obtém a lista de situações tributárias (CSTs) com suas classificações tributárias aplicáveis para o Imposto Seletivo (IS) em uma data informada. O parâmetro siglaDfe é opcional; quando informado e o Imposto Seletivo não for aplicável ao tipo de DFe, retorna lista vazia.","operationId":"consultarCstsComClassificacoesIs","parameters":[{"name":"siglaDfe","in":"query","description":"Sigla do tipo de Documento Fiscal Eletrônico (opcional); quando omitida, retorna todas as situações sem filtro de DFe","required":false,"schema":{"type":"string"},"example":"NFE"},{"name":"data","in":"query","description":"Data do fato gerador (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2027-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SituacaoClassificacaoAninhadoOutput"},"examples":{"CSTs IS with Classifications Example":{"description":"CSTs IS with Classifications Example","value":[{"codigo":"000","descricao":"Tributado com Imposto Seletivo","classificacoesTributarias":[{"codigo":"000001","descricao":"Primeiro fornecimento a qualquer título de bem"}]},{"codigo":"100","descricao":"Imunidade","classificacoesTributarias":[{"codigo":"100001","descricao":"Exportação"}]}]}}}}},"400":{"description":"Requisição inválida","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Parâmetro inválido ou ausente","instance":"/api/calculadora/dados-abertos/situacoes-tributarias/is"}}}}}},"422":{"description":"Erro de validação nos parâmetros","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Validation Error Example":{"description":"Validation Error Example","value":{"type":"http://url-ambiente/errors/sigla-dfe-nao-reconhecida","title":"Sigla DFe não reconhecida","status":422,"detail":"Sigla DFe inválida: NFEJ","instance":"/api/calculadora/dados-abertos/situacoes-tributarias/is","timestamp":1.7607290741335235E9}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-de-sistema-nao-previsto","title":"Erro de sistema não previsto","status":500,"detail":"Falha ao acessar o banco de dados","instance":"/api/calculadora/dados-abertos/situacoes-tributarias/is","timestamp":1.7607302862395124E9}}}}}}}}},"/calculadora/dados-abertos/situacoes-tributarias/imposto-seletivo":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Situação Tributária (CST)","description":"Obtém a lista das situações tributárias cadastradas para Imposto Seletivo","operationId":"consultarSituacoesTributariasImpostoSeletivo","parameters":[{"name":"data","in":"query","description":"Data no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2027-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SituacaoTributariaDadosAbertosOutput"},"examples":{"Situações Tributárias Example":{"description":"Situações Tributárias Example","value":[{"id":19,"codigo":"000","descricao":"Tributado com Imposto Seletivo"},{"id":20,"codigo":"100","descricao":"Imunidade"}]}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Required parameter 'data' is not present.","instance":"/api/calculadora/dados-abertos/situacoes-tributarias/imposto-seletivo"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/situacoes-tributarias/imposto-seletivo"}}}}}}}}},"/calculadora/dados-abertos/situacoes-tributarias/cbs-ibs":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Situações Tributárias (CSTs) com Classificações Tributárias - CBS/IBS","description":"Obtém a lista de situações tributárias (CSTs) com suas classificações tributárias aplicáveis para CBS/IBS em uma data informada. Quando o parâmetro siglaDfe é informado, retorna apenas as CSTs e classificações aplicáveis ao tipo de DFe; quando omitido, retorna todas as situações sem filtro de DFe.","operationId":"consultarCstsComClassificacoesCbsIbs","parameters":[{"name":"siglaDfe","in":"query","description":"Sigla do tipo de Documento Fiscal Eletrônico (opcional); quando omitida, retorna todas as situações sem filtro de DFe","required":false,"schema":{"type":"string"},"example":"NFE"},{"name":"data","in":"query","description":"Data do fato gerador (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2026-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SituacaoClassificacaoAninhadoOutput"},"examples":{"CSTs CBS/IBS with Classifications Example":{"description":"CSTs CBS/IBS with Classifications Example","value":[{"id":1,"codigo":"000","descricao":"Tributação Integral","classificacoesTributarias":[{"codigo":"000001","descricao":"Situações tributadas integralmente pelo IBS e CBS."},{"codigo":"000002","descricao":"Operação Interestadual"}]},{"id":5,"codigo":"060","descricao":"Diferimento","classificacoesTributarias":[{"codigo":"060001","descricao":"Operação com Diferimento"}]}]}}}}},"400":{"description":"Requisição inválida","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Parâmetro inválido ou ausente","instance":"/api/calculadora/dados-abertos/situacoes-tributarias/cbs-ibs"}}}}}},"422":{"description":"Erro de validação nos parâmetros","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Validation Error Example":{"description":"Validation Error Example","value":{"type":"http://url-ambiente/errors/sigla-dfe-nao-reconhecida","title":"Sigla DFe não reconhecida","status":422,"detail":"Sigla DFe inválida: NFEJ","instance":"/api/calculadora/dados-abertos/situacoes-tributarias/cbs-ibs","timestamp":1.7607290741335235E9}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-de-sistema-nao-previsto","title":"Erro de sistema não previsto","status":500,"detail":"Falha ao acessar o banco de dados","instance":"/api/calculadora/dados-abertos/situacoes-tributarias/cbs-ibs","timestamp":1.7607302862395124E9}}}}}}}}},"/calculadora/dados-abertos/redutores-compra-governamental":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Redutor de Compra Governamental","description":"Obtém a lista de todos os redutores de compra governamental cadastrados","operationId":"consultarRedutoresCompraGovernamental","responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedutorCompraGovernamentalDadosAbertosOutput"},"examples":{"Redutores Example":{"description":"Redutores Example","value":[{"valor":0,"inicioVigencia":"2026-01-01","fimVigencia":"2026-12-31"},{"valor":50,"inicioVigencia":"2027-01-01"}]}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/redutores-compra-governamental"}}}}}}}}},"/calculadora/dados-abertos/nomenclatura/{siglaDfe}/{cClassTrib}":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Nomenclatura Aplicável","description":"Determina qual nomenclatura (NCM, NBS, MISTO,SEM, EXCECAO_NCM ou EXCECAO_NBS) é aplicável para uma combinação de tipo de documento fiscal eletrônico, classificação tributária e data. Devolve também os sinais de obrigatoriedade: obrigatorio (true para NCM, NBS, MISTO, EXCECAO_NCM e EXCECAO_NBS; false para SEM) e, para desambiguar o resultado SEM, ncmOpcional (true quando SEM e o DFe é NF-e/NFC-e) e nbsOpcional (true quando SEM e o DFe é NFS-e)","operationId":"consultarNomenclatura","parameters":[{"name":"siglaDfe","in":"path","description":"Sigla do tipo de Documento Fiscal Eletrônico","required":true,"schema":{"type":"string"},"example":"NFe"},{"name":"cClassTrib","in":"path","description":"Código da classificação tributária","required":true,"schema":{"type":"string"},"example":"000001"},{"name":"data","in":"query","description":"Data do fato gerador (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2026-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NomenclaturaDadosAbertosOutput"},"examples":{"NCM Aplicável":{"description":"NCM Aplicável","value":{"siglaDfe":"NFe","cClassTrib":"000001","data":"2026-01-01","nomenclatura":"NCM","obrigatorio":true,"ncmOpcional":false,"nbsOpcional":false}},"NBS Aplicável":{"description":"NBS Aplicável","value":{"siglaDfe":"NFSe","cClassTrib":"000001","data":"2026-01-01","nomenclatura":"NBS","obrigatorio":true,"ncmOpcional":false,"nbsOpcional":false}},"Nenhuma Aplicável (NCM opcional)":{"description":"Nenhuma Aplicável (NCM opcional)","value":{"siglaDfe":"NFe","cClassTrib":"200001","data":"2026-01-01","nomenclatura":"SEM","obrigatorio":false,"ncmOpcional":true,"nbsOpcional":false}},"Nenhuma Aplicável":{"description":"Nenhuma Aplicável","value":{"siglaDfe":"BPe","cClassTrib":"000001","data":"2026-01-01","nomenclatura":"SEM","obrigatorio":false,"ncmOpcional":false,"nbsOpcional":false}}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Required parameter 'data' is not present.","instance":"/api/calculadora/dados-abertos/nomenclatura/NFe/000001"}}}}}},"404":{"description":"Classificação tributária ou siglaDfe não encontrada","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Not Found Example":{"description":"Not Found Example","value":{"type":"https://url-ambiente/errors/classificacao-tributaria-nao-encontrada","title":"Classificação Tributária Não Encontrada","status":404,"detail":"Classificação tributária não encontrada para código 999999 e data 2026-01-01 (CBS/IBS)","instance":"/api/calculadora/dados-abertos/nomenclatura/NFe/999999"}}}}}},"422":{"description":"Erro de validação nos parâmetros","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Validation Error Example":{"description":"Validation Error Example","value":{"type":"http://url-ambiente/errors/sigla-dfe-nao-reconhecida","title":"Sigla DFe não reconhecida","status":422,"detail":"Sigla DFe inválida: NFEJ","instance":"/api/calculadora/dados-abertos/nomenclatura/NFEJ/000001"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-de-sistema-nao-previsto","title":"Erro de sistema não previsto","status":500,"detail":"Falha ao acessar o banco de dados","instance":"/api/calculadora/dados-abertos/nomenclatura/NFe/000001"}}}}}}}}},"/calculadora/dados-abertos/ncm":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Nomenclatura Comum do Mercosul (NCM)","description":"Obtém informações sobre a NCM em relação ao Imposto Seletivo","operationId":"consultarNcm","parameters":[{"name":"ncm","in":"query","description":"Código NCM sem formatação","required":true,"schema":{"type":"string"},"example":24021000},{"name":"data","in":"query","description":"Data no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2027-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","headers":{"x-warning-dados-simulados":{"description":"Indica que os dados são simulados. Valores possíveis: 1 (alíquotas do Imposto Seletivo ainda não definidas em lei).","style":"simple","schema":{"type":"boolean","example":true}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NcmDadosAbertosOutput"},"examples":{"NCM Example":{"description":"NCM Example","value":{"tributadoPeloImpostoSeletivo":true,"temAliquotaAdValorem":true,"temAliquotaAdRem":true,"capitulo":"Tabaco e seus sucedâneos manufaturados; produtos, mesmo com nicotina, destinados à inalação sem combustão; outros produtos que contenham nicotina destinados à absorção da nicotina pelo corpo humano.","posicao":"Charutos, cigarrilhas e cigarros, de tabaco ou dos seus sucedâneos.","subitem":"Charutos e cigarrilhas, que contenham tabaco","unidade":"VN"}}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Required parameter 'data' is not present.","instance":"/api/calculadora/dados-abertos/ncm/24021000"}}}}}},"404":{"description":"NCM não encontrada na data especificada","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Not Found Example":{"description":"Not Found Example","value":{"type":"http://url-ambiente/errors/ncm-nao-encontrada","title":"NCM não encontrada","status":404,"detail":"NCM de código 24020009 não encontrada para a data 2026-08-25","instance":"/api/calculadora/dados-abertos/ncm"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/ncm/24021000"}}}}}}}}},"/calculadora/dados-abertos/ncm/vigentes":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Consulta de NCMs Vigentes por Data","description":"Retorna todos os NCMs (Nomenclatura Comum do Mercosul) vigentes na data informada que possuam código com exatamente 8 dígitos (NCM completo).","operationId":"consultarNcmsVigentes","parameters":[{"name":"data","in":"query","description":"Data de referência no padrão ISO 8601 (yyyy-MM-dd) para validar vigência","required":true,"schema":{"type":"string","format":"date"},"example":"2026-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NcmVigenciaOutput"},"examples":{"NCMs Vigentes - Exemplo com dados":{"description":"Lista de NCMs com 8 dígitos vigentes na data informada","value":[{"ncm":"01012100","descricao":"Cavalos reprodutores de raça pura"},{"ncm":"01012900","descricao":"Outros cavalos vivos"},{"ncm":"01013000","descricao":"Asnos, mulas e bardotos, vivos"},{"ncm":"22030000","descricao":"Bebidas não alcoólicas, exceto sucos e bebidas à base de leite"}]},"NCMs Vigentes - Lista vazia":{"description":"Sem erros quando nenhum NCM está vigente na data","value":[]}}}}},"400":{"description":"Parâmetro 'data' inválido ou ausente","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Data ausente":{"description":"Data ausente","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Required parameter 'data' is not present.","instance":"/calculadora/dados-abertos/ncm/vigentes"}},"Data inválida":{"description":"Data inválida","value":{"type":"about:blank","title":"Tipo de argumento inválido","status":400,"detail":"Parâmetro inválido [data: 2026-99-99]","instance":"/calculadora/dados-abertos/ncm/vigentes?data=2026-99-99"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}},"/calculadora/dados-abertos/nbs":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Nomenclatura Brasileira de Serviços (NBS)","description":"Obtém informações sobre a NBS em relação ao Imposto Seletivo","operationId":"consultarNbs","parameters":[{"name":"nbs","in":"query","description":"Código NBS sem formatação","required":true,"schema":{"type":"string"},"example":114052200},{"name":"data","in":"query","description":"Data no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2027-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","headers":{"x-warning-dados-simulados":{"description":"Indica que os dados são simulados. Valores possíveis: 1 (alíquotas do Imposto Seletivo ainda não definidas em lei).","style":"simple","schema":{"type":"boolean","example":true}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NbsDadosAbertosOutput"},"examples":{"NBS Example":{"description":"NBS Example","value":{"tributadoPeloImpostoSeletivo":false,"temAliquotaAdValorem":false,"capitulo":"Serviços veterinários","posicao":"Serviços veterinários para animais de corte","item":"Serviços de atendimento, assistência ou tratamento para animais de corte"}}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Required parameter 'data' is not present.","instance":"/api/calculadora/dados-abertos/nbs/114052200"}}}}}},"404":{"description":"NBS não encontrada na data especificada","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Not Found Example":{"description":"Not Found Example","value":{"type":"http://url-ambiente/errors/nbs-nao-encontrada","title":"NBS não encontrada","status":404,"detail":"NBS de código 999999999 não encontrada para a data 2026-08-25","instance":"/api/calculadora/dados-abertos/nbs"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/nbs/114052200"}}}}}}}}},"/calculadora/dados-abertos/nbs/lista":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Lista de Nomenclatura Brasileira de Serviços (NBS)","description":"Obtém a lista de todas as NBS válidas em uma data, incluindo todos os níveis hierárquicos (capítulo, posição, subposições e itens)","operationId":"listarNbs","parameters":[{"name":"data","in":"query","description":"Data no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2027-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NbsListaDadosAbertosOutput"},"examples":{"Lista NBS Example":{"description":"Lista NBS Example","value":[{"codigo":"101","descricao":"Serviços de construção"},{"codigo":"10101","descricao":"Serviços de construção de edificações"},{"codigo":"101011","descricao":"Serviços de construção de edificações residenciais"},{"codigo":"101011100","descricao":"Serviços de construção de edificações residenciais de um e dois pavimentos"},{"codigo":"101011200","descricao":"Serviços de construção de edificações residenciais com mais de dois pavimentos"},{"codigo":"101012","descricao":"Serviços de construção de edificações não residenciais"},{"codigo":"101012100","descricao":"Serviços de construção de edificações industriais"},{"codigo":"101012200","descricao":"Serviços de construção de edificações comerciais"},{"codigo":"101012900","descricao":"Serviços de construção de edificações não residenciais não classificados em subposições anteriores"}]}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Required parameter 'data' is not present.","instance":"/api/calculadora/dados-abertos/nbs"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/nbs"}}}}}}}}},"/calculadora/dados-abertos/nbs-aplicaveis":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Lista de NBS aplicáveis por Classificação Tributária","description":"Obtém a lista de NBS aplicáveis a um cClassTrib em uma determinada data. Se não houver NBS associados e a nomenclatura for aplicável a serviços (NBS ou 'NBS ou NCM'), retorna todos os NBS vigentes. Se não for aplicável a serviços (apenas NCM), retorna lista vazia.","operationId":"listarNbsAplicaveisPorClassificacao","parameters":[{"name":"cClassTrib","in":"query","description":"Código da Classificação Tributária (cClassTrib)","required":true,"schema":{"type":"string","pattern":"^\\d{6}$"},"example":"000001"},{"name":"data","in":"query","description":"Data no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2027-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NbsListaDadosAbertosOutput"},"examples":{"Lista NBS Aplicáveis Example":{"description":"Lista NBS Aplicáveis Example","value":[{"codigo":"114052200","descricao":"Serviços de atendimento, assistência ou tratamento para animais de corte"},{"codigo":"114052300","descricao":"Serviços de atendimento, assistência ou tratamento para animais de produção"}]},"Lista NBS Aplicáveis Vazia Example":{"description":"Lista NBS Aplicáveis Vazia Example","value":[]}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Required parameter 'data' is not present.","instance":"/api/calculadora/dados-abertos/nbs/aplicaveis-por-classificacao"}}}}}},"404":{"description":"Classificação tributária não encontrada","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Not Found Example":{"description":"Not Found Example","value":{"type":"about:blank","title":"Not Found","status":404,"detail":"Classificação tributária não encontrada para código 999999 e data 2026-01-01 (CBS/IBS)","instance":"/api/calculadora/dados-abertos/nbs/aplicaveis-por-classificacao"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/nbs/aplicaveis-por-classificacao"}}}}}}}}},"/calculadora/dados-abertos/fundamentacoes-legais":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Fundamentação Legal","description":"Obtém informações sobre as fundamentações legais","operationId":"consultarFundamentacoesLegais","parameters":[{"name":"data","in":"query","description":"Data no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2027-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundamentacaoClassificacaoDadosAbertosOutput"},"examples":{"Fundamentações Legais Example":{"description":"Fundamentações Legais Example","value":[{"codigoClassificacaoTributaria":"000001","descricaoClassificacaoTributaria":"Situações tributadas integralmente pelo IBS e CBS.","codigoSituacaoTributaria":"000","descricaoSituacaoTributaria":"Tributação integral","conjuntoTributo":"CBS e IBS","texto":"","textoCurto":"","referenciaNormativa":"LIVRO I \n\nDO IMPOSTO SOBRE BENS E SERVIÇOS (IBS) E DA CONTRIBUIÇÃO SOCIAL SOBRE BENS E SERVIÇOS (CBS) \n\nTÍTULO I \n\nDAS NORMAS GERAIS DO IBS E DA CBS \n\nCAPÍTULO I \n\nDISPOSIÇÕES PRELIMINARES"},{"codigoClassificacaoTributaria":"000002","descricaoClassificacaoTributaria":"Exploração de via","codigoSituacaoTributaria":"000","descricaoSituacaoTributaria":"Tributação integral","conjuntoTributo":"CBS e IBS","texto":"Art. 11. Considera-se local da operação com:\nVIII - serviço de exploração de via, mediante cobrança de valor a qualquer título, incluindo tarifas, pedágios e quaisquer outras formas de cobrança, o território de cada Município e Estado, ou do Distrito Federal, proporcionalmente à correspondente extensão da via explorada;","textoCurto":"Art. 11, VIII","referenciaNormativa":"LIVRO I \n\nDO IMPOSTO SOBRE BENS E SERVIÇOS (IBS) E DA CONTRIBUIÇÃO SOCIAL SOBRE BENS E SERVIÇOS (CBS) \n\nTÍTULO I \n\nDAS NORMAS GERAIS DO IBS E DA CBS \n\nCAPÍTULO II\n\nDO IBS E DA CBS SOBRE OPERAÇÕES COM BENS E SERVIÇOS\n\nSeção IV\n\nDo Local da Operação"}]}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Required parameter 'data' is not present.","instance":"/api/calculadora/dados-abertos/fundamentacoes-legais"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/fundamentacoes-legais"}}}}}}}}},"/calculadora/dados-abertos/dfe/grupos":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Tipos de DFe agrupados","description":"Obtém os tipos de Documento Fiscal Eletrônico (DFe) vigentes, agrupados pela sua categoria, para a seleção do tipo de documento. O campo codigo de cada tipo é a sigla usada como siglaDfe nos demais endpoints","operationId":"consultarTiposDfeAgrupados","parameters":[{"name":"data","in":"query","description":"Data de vigência (yyyy-MM-dd); ausente usa a data atual","required":false,"schema":{"type":"string","format":"date"},"example":"2026-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrupoDfeDadosAbertosOutput"},"examples":{"Grupos DFe Example":{"description":"Grupos DFe Example","value":[{"id":"1","titulo":"MERCADORIAS","ordem":1,"tipos":[{"codigo":"NFE","titulo":"Nota Fiscal Eletrônica","modelo":"55","ordem":1},{"codigo":"NFCE","titulo":"Nota Fiscal de Consumidor Eletrônica","modelo":"65","ordem":2}]}]}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Parâmetro inválido ou ausente.","instance":"/api/calculadora/dados-abertos/dfe/grupos"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/dfe/grupos"}}}}}}}}},"/calculadora/dados-abertos/classificacoes-tributarias/{idSituacaoTributaria}":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Classificação Tributária (cClassTrib) - DEPRECATED","description":"Obtém a lista das classificações tributárias (cClassTrib) cadastradas com base no ID da situação tributária. DEPRECATED: Use os novos endpoints /classificacoes-tributarias/imposto-seletivo/{cst} ou /classificacoes-tributarias/cbs-ibs/{cst} que trabalham com CST ao invés de IDs.","operationId":"consultarClassificacoesTributariasPorIdSituacaoTributaria","parameters":[{"name":"idSituacaoTributaria","in":"path","description":"Id da Situação Tributária (CST)","required":true,"schema":{"type":"integer","format":"int64"},"example":1},{"name":"data","in":"query","description":"Data no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2026-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassificacaoTributariaDadosAbertosOutput"},"examples":{"Classificações Tributárias Example":{"description":"Classificações Tributárias Example","value":[{"codigo":"000003","descricao":"Regime automotivo - projetos incentivados (art. 311)","tipoAliquota":"Padrão","nomenclatura":"NCM","descricaoTratamentoTributario":"Tributação integral","incompativelComSuspensao":false,"exigeGrupoDesoneracao":false,"possuiPercentualReducao":true,"indicaApropriacaoCreditoAdquirenteCbs":false,"indicaApropriacaoCreditoAdquirenteIbs":false,"indicaCreditoPresumidoFornecedor":false,"indicaCreditoPresumidoAdquirente":false,"tiposDfeClassificacao":[{"tipo":55,"sigla":"NFe","descricao":"Nota Fiscal Eletrônica"}],"dataAtualizacao":"2025-12-15"},{"codigo":"000004","descricao":"Regime automotivo - projetos incentivados (art. 312)","tipoAliquota":"Padrão","nomenclatura":"NCM","descricaoTratamentoTributario":"Tributação integral","incompativelComSuspensao":false,"exigeGrupoDesoneracao":false,"possuiPercentualReducao":true,"indicaApropriacaoCreditoAdquirenteCbs":false,"indicaApropriacaoCreditoAdquirenteIbs":false,"indicaCreditoPresumidoFornecedor":false,"indicaCreditoPresumidoAdquirente":false,"tiposDfeClassificacao":[{"tipo":55,"sigla":"NFe","descricao":"Nota Fiscal Eletrônica"}],"dataAtualizacao":"2025-12-15"}]}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Required parameter 'data' is not present.","instance":"/api/calculadora/dados-abertos/classificacoes-tributarias/3244253"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/classificacoes-tributarias/1"}}}}}}},"deprecated":true}},"/calculadora/dados-abertos/classificacoes-tributarias/ncm-aplicavel":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Validar NCM Aplicável","description":"Valida se um NCM é aplicável para uma classificação tributária relacionada ao CBS e IBS em determinada data.","operationId":"validarNcmAplicavel","parameters":[{"name":"cClassTrib","in":"query","description":"Código da classificação tributária CBS/IBS","required":true,"schema":{"type":"string"},"example":"000001"},{"name":"ncm","in":"query","description":"NCM","required":true,"schema":{"type":"string"},"example":"09024000"},{"name":"dataOcorrenciaFatoGerador","in":"query","description":"Data de ocorrência do fato gerador","required":true,"schema":{"type":"string","format":"date"},"example":"2026-01-01"}],"responses":{"200":{"description":"Validação realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NcmAplicavelOutput"},"examples":{"NCM Aplicável Example":{"description":"NCM Aplicável Example","value":{"cClassTrib":"000001","ncm":"09024000","dataOcorrenciaFatoGerador":"2026-01-01","valido":true}}}}}},"400":{"description":"Parâmetro inválido","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"http://url-ambiente/errors/parametro-invalido","title":"Parâmetro inválido","status":400,"detail":"NCM ou cClassTrib inválido.","instance":"/api/calculadora/dados-abertos/classificacoes-tributarias/ncm-aplicavel"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/classificacoes-tributarias/ncm-aplicavel"}}}}}}}}},"/calculadora/dados-abertos/classificacoes-tributarias/nbs":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Classificações Tributárias aplicáveis por NBS","description":"Obtém a lista dos códigos cClassTrib aplicáveis a um NBS em uma determinada data, considerando vínculos e regras de exceção. Também inclui classificações de serviço vigentes não vinculadas a nenhum NBS.","operationId":"listarClassificacoesTributariasPorNbs","parameters":[{"name":"nbs","in":"query","description":"Código NBS sem formatação","required":true,"schema":{"type":"string","pattern":"^\\d{9}$"},"example":114052200},{"name":"data","in":"query","description":"Data no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2026-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"type":"string"},"examples":{"cClassTrib por NBS Example":{"description":"cClassTrib por NBS Example","value":["000001","000002","000003"]}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Parâmetro inválido ou ausente.","instance":"/api/calculadora/dados-abertos/classificacoes-tributarias/nbs"}}}}}},"404":{"description":"NBS não encontrado na data especificada","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Not Found Example":{"description":"Not Found Example","value":{"type":"about:blank","title":"Not Found","status":404,"detail":"Nenhum resultado foi encontrado para a NBS: 114052200 na data: 2026-01-01","instance":"/api/calculadora/dados-abertos/classificacoes-tributarias/nbs"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/classificacoes-tributarias/nbs"}}}}}}}}},"/calculadora/dados-abertos/classificacoes-tributarias/nbs-aplicavel":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Validar NBS Aplicável","description":"Valida se um NBS é aplicável para uma classificação tributária relacionada ao CBS e IBS em determinada data.","operationId":"validarNbsAplicavel","parameters":[{"name":"cClassTrib","in":"query","description":"Código da classificação tributária","required":true,"schema":{"type":"string"},"example":"000001"},{"name":"nbs","in":"query","description":"NBS","required":true,"schema":{"type":"string"},"example":114052200},{"name":"dataOcorrenciaFatoGerador","in":"query","description":"Data de ocorrência do fato gerador","required":true,"schema":{"type":"string","format":"date"},"example":"2026-01-01"}],"responses":{"200":{"description":"Validação realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NbsAplicavelOutput"},"examples":{"NBS Aplicável Example":{"description":"NBS Aplicável Example","value":{"cClassTrib":"000001","nbs":"114052200","dataOcorrenciaFatoGerador":"2026-01-01","valido":true}}}}}},"400":{"description":"Parâmetro inválido","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"http://url-ambiente/errors/parametro-invalido","title":"Parâmetro inválido","status":400,"detail":"NBS ou cClassTrib inválido.","instance":"/api/calculadora/dados-abertos/classificacoes-tributarias/nbs-aplicavel"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/classificacoes-tributarias/nbs-aplicavel"}}}}}}}}},"/calculadora/dados-abertos/classificacoes-tributarias/is/class-trib/{cClassTrib}":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Classificação Tributária (cClassTrib) por código - IS","description":"Obtém uma classificação tributária específica por seu código (cClassTrib) para o Imposto Seletivo (IS)","operationId":"consultarClassificacaoTributariaIsPorCodigo","parameters":[{"name":"cClassTrib","in":"path","description":"Código da Classificação Tributária (cClassTrib)","required":true,"schema":{"type":"string"},"example":"000001"},{"name":"data","in":"query","description":"Data no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2027-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassificacaoTributariaDadosAbertosOutput"},"examples":{"Classificação IS por código Example":{"description":"Classificação IS por código Example","value":{"codigo":"000001","descricao":"Primeiro fornecimento a qualquer título de bem","tipoAliquota":"Alíquotas Combinadas (Ad Valorem e Ad Rem)","nomenclatura":"NBS ou NCM","descricaoTratamentoTributario":"Tributação com Imposto Seletivo","incompativelComSuspensao":false,"exigeGrupoDesoneracao":false,"possuiPercentualReducao":false,"tiposDfeClassificacao":[{"tipo":55,"sigla":"NFe","descricao":"Nota Fiscal Eletrônica"}],"dataAtualizacao":"2025-12-15"}}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"404":{"description":"Classificação não encontrada","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}},"/calculadora/dados-abertos/classificacoes-tributarias/imposto-seletivo":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Classificação Tributária (cClassTrib) para Imposto Seletivo","description":"Obtém a lista das classificações tributárias (cClassTrib) para Imposto Seletivo","operationId":"consultarClassificacoesTributariasImpostoSeletivo","parameters":[{"name":"data","in":"query","description":"Data no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2027-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","headers":{"x-warning-dados-simulados":{"description":"Indica que os dados são simulados. Valores possíveis: 1 (alíquotas da CBS e do IBS ainda não definidas em lei).","style":"simple","schema":{"type":"integer","example":1}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassificacaoTributariaDadosAbertosOutput"},"examples":{"Classificações Tributárias Imposto Seletivo Example":{"description":"Classificações Tributárias Imposto Seletivo Example","value":[{"codigo":"000001","descricao":"Primeiro fornecimento a qualquer título de bem","tipoAliquota":"Alíquotas Combinadas (Ad Valorem e Ad Rem)","nomenclatura":"NBS ou NCM","descricaoTratamentoTributario":"Tributação pelo Imposto Seletivo - Com Cálculo","incompativelComSuspensao":false,"exigeGrupoDesoneracao":false,"possuiPercentualReducao":true,"indicaApropriacaoCreditoAdquirenteCbs":false,"indicaApropriacaoCreditoAdquirenteIbs":false,"indicaCreditoPresumidoFornecedor":false,"indicaCreditoPresumidoAdquirente":false},{"codigo":"000002","descricao":"Arrematação em leilão público","tipoAliquota":"Alíquotas Combinadas (Ad Valorem e Ad Rem)","nomenclatura":"NBS ou NCM","descricaoTratamentoTributario":"Tributação pelo Imposto Seletivo - Com Cálculo","incompativelComSuspensao":false,"exigeGrupoDesoneracao":false,"possuiPercentualReducao":true,"indicaApropriacaoCreditoAdquirenteCbs":false,"indicaApropriacaoCreditoAdquirenteIbs":false,"indicaCreditoPresumidoFornecedor":false,"indicaCreditoPresumidoAdquirente":false}]},"Classificações Tributárias Imposto Seletivo Vazia Example":{"description":"Classificações Tributárias Imposto Seletivo Vazia Example","value":[]}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Required parameter 'data' is not present.","instance":"/api/calculadora/dados-abertos/classificacoes-tributarias/imposto-seletivo"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/classificacoes-tributarias/imposto-seletivo"}}}}}}}}},"/calculadora/dados-abertos/classificacoes-tributarias/imposto-seletivo/{cst}":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Classificações Tributárias por CST - Imposto Seletivo","description":"Obtém a lista das classificações tributárias por CST para Imposto Seletivo","operationId":"listarPorCstImpostoSeletivo","parameters":[{"name":"cst","in":"path","description":"Código da Situação Tributária (CST)","required":true,"schema":{"type":"string"},"example":"000"},{"name":"data","in":"query","description":"Data no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2027-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassificacaoTributariaDadosAbertosOutput"},"examples":{"Classificações IS Example":{"description":"Classificações IS Example","value":[{"codigo":"000001","descricao":"Primeiro fornecimento a qualquer título de bem","tipoAliquota":"Alíquotas Combinadas (Ad Valorem e Ad Rem)","nomenclatura":"NBS ou NCM","descricaoTratamentoTributario":"Tributação pelo Imposto Seletivo - Com Cálculo","incompativelComSuspensao":false,"exigeGrupoDesoneracao":false,"possuiPercentualReducao":true,"indicaApropriacaoCreditoAdquirenteCbs":false,"indicaApropriacaoCreditoAdquirenteIbs":false,"indicaCreditoPresumidoFornecedor":false,"indicaCreditoPresumidoAdquirente":false,"tiposDfeClassificacao":[]}]}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}},"/calculadora/dados-abertos/classificacoes-tributarias/cbs-ibs":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Classificação Tributária (cClassTrib)","description":"Obtém a lista das classificações tributárias (cClassTrib) para CBS e IBS","operationId":"consultarClassificacoesTributariasCbsIbs","parameters":[{"name":"data","in":"query","description":"Data no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2026-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassificacaoTributariaDadosAbertosOutput"},"examples":{"Classificações Tributárias Example":{"description":"Classificações Tributárias Example","value":[{"codigo":"000004","descricao":"Regime automotivo - projetos incentivados (art. 312)","tipoAliquota":"Padrão","nomenclatura":"NCM","descricaoTratamentoTributario":"Tributação integral","incompativelComSuspensao":false,"exigeGrupoDesoneracao":false,"possuiPercentualReducao":true,"indicaApropriacaoCreditoAdquirenteCbs":true,"indicaApropriacaoCreditoAdquirenteIbs":true,"indicaCreditoPresumidoFornecedor":true,"indicaCreditoPresumidoAdquirente":false,"creditoOperacaoAntecedente":"Manutenção","percentualReducaoCbs":0,"percentualReducaoIbsUf":0,"percentualReducaoIbsMun":0,"tiposDfeClassificacao":[{"tipo":55,"sigla":"NFe","descricao":"Nota Fiscal Eletrônica"}]},{"codigo":"010001","descricao":"Operações do FGTS não realizadas pela Caixa Econômica Federal","tipoAliquota":"Uniforme setorial","nomenclatura":"NBS","descricaoTratamentoTributario":"Tributação com alíquotas uniformes - operações do FGTS","incompativelComSuspensao":false,"exigeGrupoDesoneracao":false,"possuiPercentualReducao":true,"indicaApropriacaoCreditoAdquirenteCbs":true,"indicaApropriacaoCreditoAdquirenteIbs":true,"indicaCreditoPresumidoFornecedor":false,"indicaCreditoPresumidoAdquirente":false,"creditoOperacaoAntecedente":"Manutenção","percentualReducaoCbs":0,"percentualReducaoIbsUf":0,"percentualReducaoIbsMun":0,"tiposDfeClassificacao":[{"tipo":91,"sigla":"NFSe","descricao":"Nota Fiscal de Serviços Eletrônica"},{"tipo":94,"sigla":"DERE","descricao":"Declaração Eletrônica de Regimes Específicos"}]}]}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Required parameter 'data' is not present.","instance":"/api/calculadora/dados-abertos/classificacoes-tributarias/cbs-ibs"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/classificacoes-tributarias/cbs-ibs"}}}}}}}}},"/calculadora/dados-abertos/classificacoes-tributarias/cbs-ibs/{siglaDfe}/{cClassTrib}":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Classificação Tributária CBS/IBS por DFe e cClassTrib","description":"Obtém a classificação tributária CBS/IBS com base na sigla do DFe e código da classificação","operationId":"consultarValidadeDfeClassificacaoTributaria","parameters":[{"name":"siglaDfe","in":"path","description":"Sigla do tipo de Documento Fiscal Eletrônico","required":true,"schema":{"type":"string"},"example":"NFSE"},{"name":"cClassTrib","in":"path","description":"Código da classificação tributária","required":true,"schema":{"type":"string"},"example":"000001"},{"name":"data","in":"query","description":"Data do fato gerador (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2026-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidadeDfeClassificacaoTributariaDadosAbertosOutput"}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Required parameter 'data' is not present.","instance":"/api/calculadora/dados-abertos/classificacoes-tributarias/cbs-ibs/NFE/000001"}}}}}},"404":{"description":"Classificação tributária não encontrada","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Not Found Example":{"description":"Not Found Example","value":{"type":"https://url-ambiente/errors/classificacao-tributaria-nao-encontrada","title":"Classificação Tributária Não Encontrada","status":404,"detail":"Classificação tributária não encontrada para DFe 'NFSE' e código '000001' na data '2026-01-01'","instance":"/api/calculadora/dados-abertos/classificacoes-tributarias/cbs-ibs/NFSE/000001","timestamp":1.7607241111784844E9}}}}}},"422":{"description":"Erro de validação nos parâmetros","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Validation Error Example":{"description":"Validation Error Example","value":{"type":"http://url-ambiente/errors/sigla-dfe-nao-reconhecida","title":"Sigla DFe não reconhecida","status":422,"detail":"Sigla DFe inválida: NFEJ","instance":"/api/calculadora/dados-abertos/classificacoes-tributarias/cbs-ibs/NFEe/620002","timestamp":1.7607290741335235E9}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-de-sistema-nao-previsto","title":"Erro de sistema não previsto","status":500,"detail":"Falha ao acessar o banco de dados","instance":"/api/calculadora/dados-abertos/classificacoes-tributarias/cbs-ibs/NFE/620001","timestamp":1.7607302862395124E9}}}}}}}}},"/calculadora/dados-abertos/classificacoes-tributarias/cbs-ibs/{cst}":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Classificações Tributárias por CST - CBS/IBS","description":"Obtém a lista das classificações tributárias por CST para CBS/IBS","operationId":"listarPorCstCbsIbs","parameters":[{"name":"cst","in":"path","description":"Código da Situação Tributária (CST)","required":true,"schema":{"type":"string"},"example":"000"},{"name":"data","in":"query","description":"Data no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2025-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassificacaoTributariaDadosAbertosOutput"},"examples":{"Classificações CBS/IBS Example":{"description":"Classificações CBS/IBS Example","value":[{"codigo":"000001","descricao":"Situações tributadas integralmente pelo IBS e CBS.","tipoAliquota":"Padrão","nomenclatura":"NBS ou NCM","descricaoTratamentoTributario":"Tributação integral","dataAtualizacao":"2025-12-15","incompativelComSuspensao":false,"exigeGrupoDesoneracao":false,"possuiPercentualReducao":true,"indicaApropriacaoCreditoAdquirenteCbs":true,"indicaApropriacaoCreditoAdquirenteIbs":true,"indicaCreditoPresumidoFornecedor":false,"indicaCreditoPresumidoAdquirente":false,"tiposDfeClassificacao":[]}]}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}},"/calculadora/dados-abertos/classificacoes-tributarias/cbs-ibs/por-atores":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Classificação Tributária (cClassTrib) por Atores - CBS/IBS","description":"Obtém a lista das classificações tributárias (cClassTrib) para CBS e IBS aplicáveis à combinação de atores da operação. Uma classificação sem vínculo de ator vigente em um papel (fornecedor ou adquirente) é aplicável a qualquer ator naquele papel e é sempre retornada; quando fornecedor e adquirente são informados juntos, as duas condições devem ser satisfeitas simultaneamente. Sem filtros, o resultado é idêntico ao do endpoint de classificações tributárias CBS/IBS.","operationId":"consultarClassificacoesTributariasCbsIbsPorAtores","parameters":[{"name":"data","in":"query","description":"Data no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2027-01-01"},{"name":"fornecedor","in":"query","description":"ATOR_ID do ator no papel de fornecedor da operação (opcional)","required":false,"schema":{"type":"integer","format":"int64"},"example":27},{"name":"adquirente","in":"query","description":"ATOR_ID do ator no papel de adquirente da operação (opcional)","required":false,"schema":{"type":"integer","format":"int64"},"example":28},{"name":"siglaDfe","in":"query","description":"Sigla do tipo de DF-e (opcional), em qualquer formato (ex.: NFe, NF-e, nfe)","required":false,"schema":{"type":"string"},"example":"NFSe"}],"responses":{"200":{"description":"Consulta realizada com sucesso","headers":{"Cache-Control":{"description":"public, max-age=3600","style":"simple"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassificacaoTributariaDadosAbertosOutput"},"examples":{"Classificações Tributárias por Atores Example":{"description":"Classificações Tributárias por Atores Example","value":[{"codigo":"200054","descricao":"Fornecimento de bens e serviços por agente financeiro do FGTS","tipoAliquota":"Padrão","nomenclatura":"NBS","descricaoTratamentoTributario":"Alíquota zero","incompativelComSuspensao":false,"exigeGrupoDesoneracao":false,"possuiPercentualReducao":true,"indicaApropriacaoCreditoAdquirenteCbs":true,"indicaApropriacaoCreditoAdquirenteIbs":true,"indicaCreditoPresumidoFornecedor":false,"indicaCreditoPresumidoAdquirente":false,"creditoOperacaoAntecedente":"Manutenção","percentualReducaoCbs":100,"percentualReducaoIbsUf":100,"percentualReducaoIbsMun":100,"tipoReceitaBrutaSimplesNacional":1,"tiposDfeClassificacao":[{"tipo":91,"sigla":"NFSe","descricao":"Nota Fiscal de Serviços Eletrônica"}],"dataAtualizacao":"2025-12-15"}]}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Required parameter 'data' is not present.","instance":"/api/calculadora/dados-abertos/classificacoes-tributarias/cbs-ibs/por-atores"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/classificacoes-tributarias/cbs-ibs/por-atores"}}}}}}}}},"/calculadora/dados-abertos/classificacoes-tributarias/cbs-ibs/class-trib/{cClassTrib}":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Classificação Tributária (cClassTrib) por código - CBS/IBS","description":"Obtém uma classificação tributária específica por seu código (cClassTrib) para CBS/IBS","operationId":"consultarClassificacaoTributariaCbsIbsPorCodigo","parameters":[{"name":"cClassTrib","in":"path","description":"Código da Classificação Tributária (cClassTrib)","required":true,"schema":{"type":"string"},"example":"000001"},{"name":"data","in":"query","description":"Data no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2027-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassificacaoTributariaDadosAbertosOutput"},"examples":{"Classificação CBS/IBS por código Example":{"description":"Classificação CBS/IBS por código Example","value":{"codigo":"000001","descricao":"Situações tributadas integralmente pelo IBS e CBS.","tipoAliquota":"Padrão","nomenclatura":"NBS ou NCM","descricaoTratamentoTributario":"Tributação integral","incompativelComSuspensao":false,"exigeGrupoDesoneracao":false,"possuiPercentualReducao":true,"indicaApropriacaoCreditoAdquirenteCbs":true,"indicaApropriacaoCreditoAdquirenteIbs":true,"indicaCreditoPresumidoFornecedor":false,"indicaCreditoPresumidoAdquirente":false,"creditoOperacaoAntecedente":"Manutenção","percentualReducaoCbs":0,"percentualReducaoIbsUf":0,"percentualReducaoIbsMun":0,"tipoReceitaBrutaSimplesNacional":1,"tiposDfeClassificacao":[{"tipo":55,"sigla":"NFe","descricao":"Nota Fiscal Eletrônica"},{"tipo":65,"sigla":"NFCe","descricao":"Nota Fiscal de Consumidor Eletrônica"}],"dataAtualizacao":"2025-12-15"}}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"404":{"description":"Classificação não encontrada","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}},"/calculadora/dados-abertos/ator/grupos":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Atores agrupados","description":"Obtém a lista de atores vigentes agrupados, com filtro opcional por papel.","operationId":"consultarAtoresAgrupados","parameters":[{"name":"data","in":"query","description":"Data no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2027-01-01"},{"name":"papel","in":"query","description":"Papel do ator (opcional)","required":false,"schema":{"type":"string","enum":["FORNECEDOR","ADQUIRENTE"]},"example":"FORNECEDOR"}],"responses":{"200":{"description":"Consulta realizada com sucesso","headers":{"Cache-Control":{"description":"public, max-age=3600","style":"simple"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrupoAtorDadosAbertosOutput"},"examples":{"Atores Agrupados Example":{"description":"Atores Agrupados Example","value":[{"id":1,"descricao":"Regime regular / contribuinte padrão (arts. 21 ss.)","ordem":1,"atores":[{"id":22,"descricao":"Contribuinte sujeito ao regime regular do IBS e da CBS","ordem":1}]},{"id":7,"descricao":"Serviços financeiros, seguros, FGTS e consórcios (arts. 181-233)","ordem":7,"atores":[{"id":4,"descricao":"Agente financeiro do FGTS (exceto CEF)","ordem":1},{"id":5,"descricao":"Estabelecimento bancário (exceto CEF)","ordem":2}]}]}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Required parameter 'data' is not present.","instance":"/api/calculadora/dados-abertos/ator/grupos"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/ator/grupos"}}}}}}}}},"/calculadora/dados-abertos/aliquota-uniao":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Alíquota Padrão ou de Referência","description":"Obtém a alíquota padrão ou de referência para CBS","operationId":"consultarAliquotaUniao","parameters":[{"name":"data","in":"query","description":"Data no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2026-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","headers":{"x-warning-dados-simulados":{"description":"Indica que os dados são simulados. Valores possíveis: 1 (Classificações Tributárias para o Imposto Seletivo ainda não foram estabelecidas em lei).","style":"simple","schema":{"type":"integer","example":1}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AliquotaDadosAbertosOutput"},"examples":{"Alíquota União Example":{"description":"Alíquota União Example","value":{"aliquotaReferencia":0.9,"aliquotaPropria":0.9}}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Required parameter 'data' is not present.","instance":"/api/calculadora/dados-abertos/aliquota-uniao"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/aliquota-uniao"}}}}}}}}},"/calculadora/dados-abertos/aliquota-uf":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Alíquota Padrão ou de Referência para IBS Estadual","description":"Obtém a alíquota padrão ou de referência para IBS Estadual","operationId":"consultarAliquotaUf","parameters":[{"name":"codigoUf","in":"query","description":"Código da UF","required":true,"schema":{"type":"integer","format":"int64"},"example":43},{"name":"data","in":"query","description":"Data no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2026-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","headers":{"x-warning-dados-simulados":{"description":"Indica que os dados são simulados. Valores possíveis: 1 (alíquotas da CBS ainda não definidas em lei).","style":"simple","schema":{"type":"integer","example":1}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AliquotaDadosAbertosOutput"},"examples":{"Alíquota UF Example":{"description":"Alíquota UF Example","value":{"aliquotaReferencia":0.9,"aliquotaPropria":0.9}}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Required parameter 'data' is not present.","instance":"/api/calculadora/dados-abertos/aliquota-uf"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/aliquota-uf"}}}}}}}}},"/calculadora/dados-abertos/aliquota-municipio":{"get":{"tags":["Dados Abertos - VERSÃO BETA"],"summary":"Alíquota Padrão ou de Referência para IBS Municipal","description":"Obtém a alíquota padrão ou de referência para IBS Municipal","operationId":"consultarAliquotaMunicipio","parameters":[{"name":"codigoMunicipio","in":"query","description":"Código do Município (Tabela IBGE)","required":true,"schema":{"type":"integer","format":"int64"},"example":4314902},{"name":"data","in":"query","description":"Data no padrão ISO 8601 (yyyy-MM-dd)","required":true,"schema":{"type":"string","format":"date"},"example":"2026-01-01"}],"responses":{"200":{"description":"Consulta realizada com sucesso","headers":{"x-warning-dados-simulados":{"description":"Indica que os dados são simulados. Valores possíveis: 1 (alíquotas da CBS e do IBS ainda não definidas em lei).","style":"simple","schema":{"type":"integer","example":1}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AliquotaDadosAbertosOutput"},"examples":{"Alíquota Município Example":{"description":"Alíquota Município Example","value":{"aliquotaReferencia":0.9,"aliquotaPropria":0.9}}}}}},"400":{"description":"Requisição com problema","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Bad Request Example":{"description":"Bad Request Example","value":{"type":"about:blank","title":"Bad Request","status":400,"detail":"Required parameter 'data' is not present.","instance":"/api/calculadora/dados-abertos/aliquota-municipio"}}}}}},"500":{"description":"Erro interno na API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"},"examples":{"Internal Server Error Example":{"description":"Internal Server Error Example","value":{"type":"http://url-ambiente/errors/erro-interno","title":"Erro interno na API","status":500,"detail":"Falha ao processar a requisição.","instance":"/api/calculadora/dados-abertos/aliquota-municipio"}}}}}}}}}},"components":{"schemas":{"ProblemDetail":{"type":"object","properties":{"type":{"type":"string","format":"uri"},"title":{"type":"string"},"status":{"type":"integer","format":"int32"},"detail":{"type":"string"},"instance":{"type":"string","format":"uri"},"properties":{"type":"object","additionalProperties":{}}}},"AjusteCompetenciaDomain":{"type":"object","properties":{"competApur":{"type":"string","description":"Ano e mês referência do período de apuração (AAAA-MM)"},"vIBS":{"type":"number","description":"Valor do IBS"},"vCBS":{"type":"number","description":"Valor da CBS"}}},"CBSDomain":{"type":"object","properties":{"pCBS":{"type":"number","description":"Alíquota da CBS"},"gDif":{"$ref":"#/components/schemas/DiferimentoDomain","description":"Grupo de Informações do Diferimento"},"gDevTrib":{"$ref":"#/components/schemas/DevolucaoTributosDomain","description":"Grupo de Informações da devolução de tributos"},"gRed":{"$ref":"#/components/schemas/ReducaoAliquotaDomain","description":"Grupo de Informações da redução da alíquota"},"vCBS":{"type":"number","description":"Valor da CBS"},"memoriaCalculo":{"type":"string","description":"Memória de Cálculo"}}},"CBSTotalDomain":{"type":"object","properties":{"vDif":{"type":"number","description":"Valor total do diferimento"},"vDevTrib":{"type":"number","description":"Valor total de devolução de tributos"},"vCBS":{"type":"number","description":"Valor total da CBS"},"vCredPres":{"type":"number","description":"Valor total do crédito presumido"},"vCredPresCondSus":{"type":"number","description":"Valor total do crédito presumido em condição suspensiva"}}},"CompraGovernamentalDomain":{"type":"object","properties":{"tpEnteGov":{"type":"integer","format":"int32","description":"Tipo de ente governamental.

\nValores:

\n

\n"},"pRedutor":{"type":"number","description":"Percentual de redução de alíquota em compra governamental"},"tpOperGov":{"type":"integer","format":"int32","description":"Tipo de operação com o ente governamental.

\nValores:

\n

\n"}}},"CreditoPresumidoIBSZFMDomain":{"type":"object","properties":{"competApur":{"type":"string","description":"Ano e mês referência do período de apuração (AAAA-MM)"},"tpCredPresIBSZFM":{"type":"integer","format":"int32","description":"Tipo de classificação de acordo com o art. 450, § 1º, da LC 214/25 para o cálculo do crédito presumido na ZFM"},"vCredPresIBSZFM":{"type":"number","description":"Valor do crédito presumido calculado sobre o saldo devedor apurado"}}},"CreditoPresumidoOperacaoDomain":{"type":"object","properties":{"vBCCredPres":{"type":"number","description":"Valor da Base de Cálculo do Crédito Presumido da Operação"},"cCredPres":{"type":"integer","format":"int32","description":"Código de Classificação do Crédito Presumido"},"gIBSCredPres":{"$ref":"#/components/schemas/IBSCBSCreditoPresumidoDomain","description":"Grupo de Informações do Crédito Presumido referente ao IBS"},"gCBSCredPres":{"$ref":"#/components/schemas/IBSCBSCreditoPresumidoDomain","description":"Grupo de Informações do Crédito Presumido referente a CBS"}}},"DevolucaoTributosDomain":{"type":"object","properties":{"pDevTrib":{"type":"number","description":"Percentual do tributo devolvido"},"vDevTrib":{"type":"number","description":"Valor do tributo devolvido"}}},"DiferimentoDomain":{"type":"object","properties":{"pDif":{"type":"number","description":"Percentual do Diferimento"},"vDif":{"type":"number","description":"Valor do Diferimento"}}},"EstornoCreditoDomain":{"type":"object","properties":{"vIBSEstCred":{"type":"number","description":"Valor do IBS a ser estornado"},"vCBSEstCred":{"type":"number","description":"Valor da CBS a ser estornada"}}},"GrupoIBSCBSDomain":{"type":"object","properties":{"vBC":{"type":"number","description":"Base de cálculo do IBS e CBS"},"gIBSUF":{"$ref":"#/components/schemas/IBSUFDomain","description":"Grupo de Informações do IBS para a UF"},"gIBSMun":{"$ref":"#/components/schemas/IBSMunDomain","description":"Grupo de Informações do IBS para o município"},"vIBS":{"type":"number","description":"Valor do IBS"},"gCBS":{"$ref":"#/components/schemas/CBSDomain","description":"Grupo de Informações da CBS"},"gTribRegular":{"$ref":"#/components/schemas/TributacaoRegularDomain","description":"Grupo de Informações da Tributação Regular"},"gTribCompraGov":{"$ref":"#/components/schemas/TributacaoCompraGovernamentalDomain","description":"Grupo de informações da composição do valor do IBS e da CBS em compras governamentais"}}},"IBSCBSCreditoPresumidoDomain":{"type":"object","properties":{"pCredPres":{"type":"number","description":"Percentual do Crédito Presumido"},"vCredPres":{"type":"number","description":"Valor do Crédito Presumido"},"vCredPresCondSus":{"type":"number","description":"Valor do Crédito Presumido em condição suspensiva"}}},"IBSCBSDomain":{"type":"object","properties":{"CST":{"type":"string","description":"Código de Situação Tributária do IBS e CBS"},"cClassTrib":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS"},"indDoacao":{"type":"integer","format":"int32","description":"Indica a natureza da operação de doação, orientando a apuração e a geração de débitos ou estornos conforme o cenário"},"gIBSCBS":{"$ref":"#/components/schemas/GrupoIBSCBSDomain","description":"Grupo de Informações do IBS e da CBS"},"gIBSCBSMono":{"$ref":"#/components/schemas/MonofasiaDomain","description":"Grupo de Informações do IBS e CBS em operações com imposto monofásico"},"gTransfCred":{"$ref":"#/components/schemas/TransferenciaCreditoDomain","description":"Transferências de Crédito"},"gAjusteCompet":{"$ref":"#/components/schemas/AjusteCompetenciaDomain","description":"Ajuste de competência"},"gEstornoCred":{"$ref":"#/components/schemas/EstornoCreditoDomain","description":"Estorno de crédito"},"gCredPresOper":{"$ref":"#/components/schemas/CreditoPresumidoOperacaoDomain","description":"Crédito presumido da Operação"},"gCredPresIBSZFM":{"$ref":"#/components/schemas/CreditoPresumidoIBSZFMDomain","description":"Informações do crédito presumido de IBS para fornecimentos a partir da ZFM"}}},"IBSCBSTotalDomain":{"type":"object","properties":{"vBCIBSCBS":{"type":"number","description":"Valor total da BC do IBS e da CBS"},"gIBS":{"$ref":"#/components/schemas/IBSTotalDomain","description":"Grupo total do IBS"},"gCBS":{"$ref":"#/components/schemas/CBSTotalDomain","description":"Grupo total da CBS"},"gMono":{"$ref":"#/components/schemas/MonofasiaTotalDomain","description":"Grupo total da Monofasia"},"gEstornoCred":{"$ref":"#/components/schemas/EstornoCreditoDomain","description":"Grupo total do Estorno de Crédito"}}},"IBSMunDomain":{"type":"object","properties":{"pIBSMun":{"type":"number","description":"Alíquota do IBS de competência do Município"},"gDif":{"$ref":"#/components/schemas/DiferimentoDomain","description":"Grupo de Informações do Diferimento"},"gDevTrib":{"$ref":"#/components/schemas/DevolucaoTributosDomain","description":"Grupo de Informações da devolução de tributos"},"gRed":{"$ref":"#/components/schemas/ReducaoAliquotaDomain","description":"Grupo de Informações da redução da alíquota"},"vIBSMun":{"type":"number","description":"Valor do IBS de competência do Município"},"memoriaCalculo":{"type":"string","description":"Memória de Cálculo"}}},"IBSMunTotalDomain":{"type":"object","properties":{"vDif":{"type":"number","description":"Valor total do diferimento"},"vDevTrib":{"type":"number","description":"Valor total de devolução de tributos"},"vIBSMun":{"type":"number","description":"Valor total do IBS do Município"}}},"IBSTotalDomain":{"type":"object","properties":{"gIBSUF":{"$ref":"#/components/schemas/IBSUFTotalDomain","description":"Grupo total do IBS da UF"},"gIBSMun":{"$ref":"#/components/schemas/IBSMunTotalDomain","description":"Grupo total do IBS do Município"},"vIBS":{"type":"number","description":"Valor total do IBS"},"vCredPres":{"type":"number","description":"Valor total do crédito presumido"},"vCredPresCondSus":{"type":"number","description":"Valor total do crédito presumido em condição suspensiva"}}},"IBSUFDomain":{"type":"object","properties":{"pIBSUF":{"type":"number","description":"Alíquota do IBS de competência das UF"},"gDif":{"$ref":"#/components/schemas/DiferimentoDomain","description":"Grupo de Informações do Diferimento"},"gDevTrib":{"$ref":"#/components/schemas/DevolucaoTributosDomain","description":"Grupo de Informações da devolução de tributos"},"gRed":{"$ref":"#/components/schemas/ReducaoAliquotaDomain","description":"Grupo de Informações da redução da alíquota"},"vIBSUF":{"type":"number","description":"Valor do IBS de competência da UF"},"memoriaCalculo":{"type":"string","description":"Memória de Cálculo"}}},"IBSUFTotalDomain":{"type":"object","properties":{"vDif":{"type":"number","description":"Valor total do diferimento"},"vDevTrib":{"type":"number","description":"Valor total de devolução de tributos"},"vIBSUF":{"type":"number","description":"Valor total do IBS da UF"}}},"ImpostoSeletivoDomain":{"type":"object","properties":{"CSTIS":{"type":"string","description":"Código de Situação Tributária do Imposto Seletivo"},"cClassTribIS":{"type":"string","description":"Código de Classificação Tributária do Imposto Seletivo"},"vBCIS":{"type":"number","description":"Valor da Base de Cálculo do Imposto Seletivo"},"pIS":{"type":"number","description":"Alíquota do Imposto Seletivo"},"pISEspec":{"type":"number","deprecated":true,"description":"Alíquota específica por unidade de medida apropriada - Depreciado (a ser removido na próxima versão), utilizar adRemIS"},"adRemIS":{"type":"number","description":"Alíquota específica por unidade de medida apropriada"},"uTrib":{"type":"string","description":"Unidade de Medida Tributável"},"qTrib":{"type":"number","description":"Quantidade Tributável"},"vIS":{"type":"number","description":"Valor do Imposto Seletivo"},"memoriaCalculo":{"type":"string","description":"Memória de Cálculo"}}},"ImpostoSeletivoTotalDomain":{"type":"object","properties":{"vIS":{"type":"number","description":"Total do imposto seletivo"}}},"MonofasiaDiferimentoDomain":{"type":"object","properties":{"pDifIBS":{"type":"number","description":"Percentual do diferimento do imposto monofásico do IBS"},"vIBSMonoDif":{"type":"number","description":"Valor do IBS monofásico diferido"},"pDifCBS":{"type":"number","description":"Percentual do diferimento do imposto monofásico da CBS"},"vCBSMonoDif":{"type":"number","description":"Valor da CBS monofásica diferida"}}},"MonofasiaDomain":{"type":"object","properties":{"gMonoPadrao":{"$ref":"#/components/schemas/MonofasiaPadraoDomain","description":"Grupo de informações da Tributação Monofásica Padrão"},"gMonoReten":{"$ref":"#/components/schemas/MonofasiaRetencaoDomain","description":"Grupo de informações da Tributação Monofásica Sujeita à Retenção"},"gMonoRet":{"$ref":"#/components/schemas/MonofasiaRetidoAnteriormenteDomain","description":"Grupo de informações da Tributação Monofásica Retida Anteriormente"},"gMonoDif":{"$ref":"#/components/schemas/MonofasiaDiferimentoDomain","description":"Grupo de informações do Diferimento da Tributação Monofásica"},"vTotIBSMonoItem":{"type":"number","description":"Total de IBS monofásico"},"vTotCBSMonoItem":{"type":"number","description":"Total de CBS monofásica"}}},"MonofasiaPadraoDomain":{"type":"object","properties":{"qBCMono":{"type":"number","description":"Quantidade tributada na monofasia"},"adRemIBS":{"type":"number","description":"Alíquota ad rem do IBS"},"adRemCBS":{"type":"number","description":"Alíquota ad rem da CBS"},"vIBSMono":{"type":"number","description":"Valor do IBS monofásico"},"vCBSMono":{"type":"number","description":"Valor da CBS monofásica"}}},"MonofasiaRetencaoDomain":{"type":"object","properties":{"qBCMonoReten":{"type":"number","description":"Quantidade tributada sujeita à retenção na monofasia"},"adRemIBSReten":{"type":"number","description":"Alíquota ad rem do IBS sujeito a retenção"},"vIBSMonoReten":{"type":"number","description":"Valor do IBS monofásico sujeito a retenção"},"adRemCBSReten":{"type":"number","description":"Alíquota ad rem da CBS sujeita a retenção"},"vCBSMonoReten":{"type":"number","description":"Valor da CBS monofásica sujeita a retenção"}}},"MonofasiaRetidoAnteriormenteDomain":{"type":"object","properties":{"qBCMonoRet":{"type":"number","description":"Quantidade tributada retida anteriormente"},"adRemIBSRet":{"type":"number","description":"Alíquota ad rem do IBS retido anteriormente"},"vIBSMonoRet":{"type":"number","description":"Valor do IBS retido anteriormente"},"adRemCBSRet":{"type":"number","description":"Alíquota ad rem da CBS retida anteriormente"},"vCBSMonoRet":{"type":"number","description":"Valor da CBS retida anteriormente"}}},"MonofasiaTotalDomain":{"type":"object","properties":{"vIBSMono":{"type":"number","description":"Total do IBS monofásico"},"vCBSMono":{"type":"number","description":"Total da CBS monofásica"},"vIBSMonoReten":{"type":"number","description":"Total do IBS monofásico sujeito a retenção"},"vCBSMonoReten":{"type":"number","description":"Total da CBS monofásica sujeita a retenção"},"vIBSMonoRet":{"type":"number","description":"Total do IBS monofásico retido anteriormente"},"vCBSMonoRet":{"type":"number","description":"Total da CBS monofásica retida anteriormente"}}},"ObjetoDomain":{"type":"object","properties":{"nObj":{"type":"integer","format":"int32"},"tribCalc":{"$ref":"#/components/schemas/TributosDomain"},"calculoSimulado":{"type":"boolean","description":"Indica se o cálculo foi simulado (true), com base em alíquotas informadas pelo usuário, ou não (false)"}}},"OperacaoConsumoDomain":{"type":"object","properties":{"gCompraGov":{"$ref":"#/components/schemas/CompraGovernamentalDomain"}}},"ROCDomain":{"type":"object","properties":{"oper":{"$ref":"#/components/schemas/OperacaoConsumoDomain"},"objetos":{"type":"array","items":{"$ref":"#/components/schemas/ObjetoDomain"}},"total":{"$ref":"#/components/schemas/ValoresTotaisDomain"}}},"ReducaoAliquotaDomain":{"type":"object","properties":{"pRedAliq":{"type":"number","description":"Percentual da redução de alíquota do cClassTrib"},"pAliqEfet":{"type":"number","description":"Alíquota Efetiva que será aplicada a Base de Cálculo"}}},"TransferenciaCreditoDomain":{"type":"object","properties":{"vIBS":{"type":"number","description":"Valor do IBS a ser transferido"},"vCBS":{"type":"number","description":"Valor da CBS a ser transferida"}}},"TributacaoCompraGovernamentalDomain":{"type":"object","properties":{"pAliqIBSUF":{"type":"number","description":"Alíquota do IBS de competência do Estado"},"vTribIBSUF":{"type":"number","description":"Valor do Tributo do IBS da UF calculado"},"pAliqIBSMun":{"type":"number","description":"Alíquota do IBS de competência do Município"},"vTribIBSMun":{"type":"number","description":"Valor do Tributo do IBS do Município calculado"},"pAliqCBS":{"type":"number","description":"Alíquota da CBS"},"vTribCBS":{"type":"number","description":"Valor do Tributo da CBS calculado"}}},"TributacaoRegularDomain":{"type":"object","properties":{"CSTReg":{"type":"string","description":"Código de Situação Tributária do IBS e CBS"},"cClassTribReg":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS"},"pAliqEfetRegIBSUF":{"type":"number","description":"Valor da alíquota do IBS da UF"},"vTribRegIBSUF":{"type":"number","description":"Valor do Tributo do IBS da UF"},"pAliqEfetRegIBSMun":{"type":"number","description":"Valor da alíquota do IBS do Município"},"vTribRegIBSMun":{"type":"number","description":"Valor do Tributo do IBS do Município"},"pAliqEfetRegCBS":{"type":"number","description":"Valor da alíquota da CBS"},"vTribRegCBS":{"type":"number","description":"Valor do Tributo da CBS"}}},"TributosDomain":{"type":"object","properties":{"IS":{"$ref":"#/components/schemas/ImpostoSeletivoDomain","description":"Informações do Imposto Seletivo"},"IBSCBS":{"$ref":"#/components/schemas/IBSCBSDomain","description":"Informações do Imposto de Bens e Serviços - IBS e da Contribuição de Bens e Serviços - CBS"}}},"TributosTotaisDomain":{"type":"object","properties":{"ISTot":{"$ref":"#/components/schemas/ImpostoSeletivoTotalDomain","description":"Grupo total do imposto seletivo"},"IBSCBSTot":{"$ref":"#/components/schemas/IBSCBSTotalDomain","description":"Totais com IBS e CBS"}}},"ValoresTotaisDomain":{"type":"object","properties":{"tribCalc":{"$ref":"#/components/schemas/TributosTotaisDomain"}}},"AliquotasNominaisImpostoSeletivo":{"type":"object","properties":{"adValorem":{"type":"number","description":"Alíquota ad valorem do Imposto Seletivo (%)","example":10.0,"maximum":100.00},"adRem":{"type":"number","description":"Alíquota ad rem do Imposto Seletivo","example":0.5,"minimum":0.00}}},"AliquotasNominaisInput":{"type":"object","properties":{"cbs":{"type":"number","description":"Alíquota nominal CBS (%)","example":8.8,"maximum":100.00},"ibsEstadual":{"type":"number","description":"Alíquota nominal IBS estadual (%)","example":8.85,"maximum":100.00},"ibsMunicipal":{"type":"number","description":"Alíquota nominal IBS municipal (%)","example":8.85,"maximum":100.00},"impostoSeletivo":{"$ref":"#/components/schemas/AliquotasNominaisImpostoSeletivo","description":"Alíquotas nominais do Imposto Seletivo"}}},"ComponentesBaseCalculoInput":{"type":"object","properties":{"vProd":{"type":"number","description":"Valor dos produtos/serviços","example":1000.0},"vFrete":{"type":"number","description":"Valor do frete","example":50.0},"vSeg":{"type":"number","description":"Valor do seguro","example":20.0},"vOutro":{"type":"number","description":"Outras despesas acessórias","example":10.0},"vII":{"type":"number","description":"Imposto de importação","example":150.0},"vIS":{"type":"number","description":"Imposto Seletivo","example":30.0},"vDesc":{"type":"number","description":"Desconto incondicional","example":50.0},"vPIS":{"type":"number","description":"PIS (vigente 2026)","example":9.25},"vCOFINS":{"type":"number","description":"COFINS (vigente 2026)","example":46.25},"vICMS":{"type":"number","description":"ICMS (vigente 2026-2032)","example":180.0},"vICMSUFDest":{"type":"number","description":"ICMS UF Destino (vigente 2026-2032)","example":20.0},"vFCP":{"type":"number","description":"FCP (vigente 2026-2032)","example":10.0},"vFCPUFDest":{"type":"number","description":"FCP UF Destino (vigente 2026-2032)","example":5.0},"vICMSMono":{"type":"number","description":"ICMS Monofásico (vigente 2026-2032)","example":100.0},"vISSQN":{"type":"number","description":"ISSQN (vigente 2026-2032, apenas serviço)","example":30.0}}},"CompraGovernamentalInput":{"type":"object","properties":{"tpEnteGov":{"type":"integer","format":"int32","description":"Tipo de ente governamental.

\nValores:

\n

\n"},"tpOperGov":{"type":"integer","format":"int32","description":"Tipo de operação com o ente governamental.

\nValores:

\n

\n"}},"required":["tpEnteGov"]},"ImpostoSeletivoInput":{"type":"object","properties":{"cst":{"type":"string","description":"Código da situação tributária","example":"000","maxLength":3,"minLength":3,"pattern":"\\d+"},"cClassTrib":{"type":"string","description":"Código da classificação tributária","example":"000000","maxLength":6,"minLength":6,"pattern":"\\d+"},"baseCalculo":{"type":"number","description":"Base de cálculo do Imposto Seletivo. Obrigatória quando o grupo do Imposto Seletivo é informado; serve de referência para a base de cálculo de CBS e IBS","example":188.0},"quantidade":{"type":"number","description":"Quantidade","example":1},"unidade":{"type":"string","description":"Unidade de medida","example":"LT"},"impostoInformado":{"type":"number","description":"Imposto Seletivo informado pelo contribuinte. Opcional; quando presente junto com a base de cálculo de CBS e IBS, deve satisfazer baseCalculo (CBS/IBS) = baseCalculo (IS) + impostoInformado. Quando ausente, é tratado como zero","example":12.0}},"required":["baseCalculo","cClassTrib","cst"]},"ItemOperacaoInput":{"type":"object","properties":{"numero":{"type":"integer","format":"int32","description":"Número do Item","example":1,"maximum":9999999,"minimum":1},"ncm":{"type":"string","description":"Código NCM","example":24021000},"nbs":{"type":"string","description":"Código NBS","example":109052100},"cst":{"type":"string","description":"Código de situação tributária","example":"000","maxLength":3,"minLength":3,"pattern":"\\d+"},"cClassTrib":{"type":"string","description":"Código de classificação tributária","example":"000001","maxLength":6,"minLength":6,"pattern":"\\d+"},"baseCalculo":{"type":"number","description":"Base de cálculo de CBS e IBS. Obrigatória quando impostoSeletivo e gComponentesBC não são informados; opcional com impostoSeletivo (derivada) ou com gComponentesBC (calculada automaticamente)","example":200.0},"quantidade":{"type":"number","description":"Quantidade","example":1},"unidade":{"type":"string","description":"Unidade de medida","example":"LT"},"impostoSeletivo":{"$ref":"#/components/schemas/ImpostoSeletivoInput","description":"Informações do Imposto Seletivo"},"tributacaoRegular":{"$ref":"#/components/schemas/TributacaoRegularInput","description":"Informações sobre tributação regular"},"gComponentesBC":{"$ref":"#/components/schemas/ComponentesBaseCalculoInput","description":"Grupo de componentes para cálculo/validação da Base de Cálculo. Quando informado, permite o cálculo automático da BC ou a validação cruzada com a BC declarada"},"aliquotasNominais":{"$ref":"#/components/schemas/AliquotasNominaisInput","description":"Alíquotas nominais aplicáveis à operação. Obrigatório para operações a partir de 01/01/2027 e proibido antes dessa data"}},"required":["cClassTrib","cst","numero"]},"OperacaoInput":{"type":"object","properties":{"id":{"type":"string","description":"Identificador do ROC","example":"6194602ea71cbf9431c236de4409d920"},"versao":{"type":"string","description":"Versão do ROC","example":"0.0.1"},"dhFatoGerador":{"type":"string","format":"date-time","description":"Data e hora do fato gerador no formato UTC","example":"2026-01-01T09:50:05-03:00"},"dataHoraEmissao":{"type":"string","format":"date-time","deprecated":true,"description":"<<<ATENÇÃO>>>

ESTE CAMPO SERÁ REMOVIDO EM FUTURO PRÓXIMO

Informar dhFatoGerador

Data e hora de emissão do documento no formato UTC

","example":"2026-01-01T09:50:05-03:00"},"municipio":{"type":"integer","format":"int64","description":"Código do Município (tabela IBGE)","example":4314902,"maximum":9999999,"minimum":0},"uf":{"type":"string","description":"Sigla da UF","example":"RS","maxLength":2,"minLength":2},"tpDoc":{"type":"integer","format":"int32","description":"Tipo do documento fiscal eletrônico que origina a operação (código numérico do modelo, ex.: 55 = NF-e, 65 = NFC-e). Opcional: quando informado, o tipo deve existir e estar vigente na data do fato gerador, a classificação tributária dos itens deve possuir vínculo com o tipo de documento e a exigência de NCM/NBS passa a ser dirigida pela nomenclatura aplicável ao documento","example":55,"maximum":999,"minimum":1},"gCompraGov":{"$ref":"#/components/schemas/CompraGovernamentalInput","description":"Grupo de Compra Governamental"},"itens":{"type":"array","description":"Itens da Operação","items":{"$ref":"#/components/schemas/ItemOperacaoInput"},"minItems":1}},"required":["id","itens","municipio","versao"]},"TributacaoRegularInput":{"type":"object","properties":{"cst":{"type":"string","description":"Código da situação tributária","example":"000","maxLength":3,"minLength":3,"pattern":"\\d+"},"cClassTrib":{"type":"string","description":"Código da classificação tributária","example":"000000","maxLength":6,"minLength":6,"pattern":"\\d+"}},"required":["cClassTrib","cst"]},"PedagioInput":{"type":"object","properties":{"dataHoraEmissao":{"type":"string","format":"date-time","description":"Data e hora de emissão do documento no formato UTC","example":"2027-01-01T09:50:05-03:00"},"codigoMunicipioOrigem":{"type":"integer","format":"int64","description":"Código do Município (tabela IBGE)","example":4314902,"maximum":9999999,"minimum":0},"ufMunicipioOrigem":{"type":"string","description":"Sigla da UF","example":"RS","maxLength":2,"minLength":2},"cst":{"type":"string","description":"Código de situação tributária","example":"000","maxLength":3,"minLength":3},"cClassTrib":{"type":"string","description":"Código de classificação tributária","example":"000002","maxLength":6,"minLength":6},"baseCalculo":{"type":"number","description":"Base de cálculo do imposto","example":200.0},"trechos":{"type":"array","description":"Trechos do pedágio","items":{"$ref":"#/components/schemas/TrechoPedagioInput"},"minItems":1}},"required":["baseCalculo","cClassTrib","codigoMunicipioOrigem","cst","dataHoraEmissao","trechos","ufMunicipioOrigem"]},"TrechoPedagioInput":{"type":"object","properties":{"numero":{"type":"integer","format":"int32","description":"Número do Trecho","example":1,"minimum":1},"municipio":{"type":"integer","format":"int64","description":"Código do Município (tabela IBGE)","example":4314902,"maximum":9999999,"minimum":0},"uf":{"type":"string","description":"Sigla da UF","example":"RS","maxLength":2,"minLength":2},"extensao":{"type":"number","description":"Extensão do trecho","example":10}},"required":["extensao","municipio","numero","uf"]},"PedagioOutput":{"type":"object","properties":{"dataHoraEmissao":{"type":"string","format":"date-time","description":"Data e hora de emissão do documento no formato UTC","example":"2027-01-01T09:50:05-03:00"},"municipioOrigem":{"type":"integer","format":"int64","description":"Código do Município (tabela IBGE)","example":4314902},"ufMunicipioOrigem":{"type":"string","description":"Sigla da UF","example":"RS"},"cst":{"type":"string","description":"Código de situação tributária","example":"000","maxLength":3,"minLength":3},"cClassTrib":{"type":"string","description":"Código de classificação tributária","example":"000001","maxLength":6,"minLength":6},"baseCalculo":{"type":"number","description":"Base de cálculo","example":200.0},"extensaoTotal":{"type":"number","description":"Extensão total (km)","example":200.0},"trechos":{"type":"array","description":"Trechos do pedágio","items":{"$ref":"#/components/schemas/TrechoPedagioOutput"}},"total":{"$ref":"#/components/schemas/TotalPedagioOutput","description":"Total de tributo calculado"}}},"TotalPedagioOutput":{"type":"object","properties":{"cbsTotal":{"$ref":"#/components/schemas/TributoTotalPedagioOutput","description":"Total de CBS apurado"},"ibsEstadualTotal":{"$ref":"#/components/schemas/TributoTotalPedagioOutput","description":"Total de IBS Estadual apurado"},"ibsMunicipalTotal":{"$ref":"#/components/schemas/TributoTotalPedagioOutput","description":"Total de IBS Municipal apurado"}}},"TrechoPedagioOutput":{"type":"object","properties":{"numero":{"type":"integer","format":"int32","description":"Número do Item","example":1},"municipio":{"type":"integer","format":"int64","description":"Código do Município (tabela IBGE)","example":4314902},"uf":{"type":"string","description":"Sigla da UF","example":"RS"},"baseCalculo":{"type":"number","description":"Base de cálculo do imposto","example":200.0},"extensaoTrecho":{"type":"number","description":"Extensao do trecho","example":20},"extensaoTotal":{"type":"number","description":"Extensao total","example":50},"cbs":{"$ref":"#/components/schemas/TributoPedagioOutput","description":"Informações do CBS"},"ibsEstadual":{"$ref":"#/components/schemas/TributoPedagioOutput","description":"Informações do IBS Estadual"},"ibsMunicipal":{"$ref":"#/components/schemas/TributoPedagioOutput","description":"Informações do IBS Municipal"}}},"TributoPedagioOutput":{"type":"object","properties":{"aliquota":{"type":"number","description":"Alíquota","example":0.5},"aliquotaEfetiva":{"type":"number","description":"Alíquota efetiva","example":0.5},"tributoCalculado":{"type":"number","description":"Tributo calculado","example":0.75},"memoriaCalculo":{"type":"string","description":"Descrição do processo de cálculo","example":"Texto descritivo"}}},"TributoTotalPedagioOutput":{"type":"object","properties":{"baseCalculo":{"type":"number","description":"Base de cálculo do imposto","example":200.0},"valorApurado":{"type":"number","description":"Valor de imposto apurado","example":0.75},"valorDevido":{"type":"number","description":"Valor de imposto devido","example":0.75},"valorTributo":{"type":"number","description":"Valor do tributo","example":0.75},"totalMontanteDesonerado":{"type":"number","description":"Total do montante desonerado","example":10.22}}},"ErroDetalhe":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"code":{"type":"string"},"pointer":{"type":"string"},"detail":{"type":"string"}}},"ObservabilidadeItemDomain":{"type":"object","properties":{"nObj":{"type":"integer","format":"int32"},"estadoItem":{"type":"string","enum":["CALCULADO","NAO_IMPLEMENTADO","INCONSISTENCIA_ENTRADA","FALHA_TECNICA","CALCULO_SIMULADO"]},"tribCalc":{"$ref":"#/components/schemas/TributosDomain"},"erros":{"type":"array","items":{"$ref":"#/components/schemas/ErroDetalhe"}}}},"ObservabilidadeROCDomain":{"type":"object","properties":{"oper":{"$ref":"#/components/schemas/OperacaoConsumoDomain"},"objetos":{"type":"array","items":{"$ref":"#/components/schemas/ObservabilidadeItemDomain"}},"total":{"$ref":"#/components/schemas/ValoresTotaisDomain"}}},"NfseValidacaoIndicadorOperacaoInput":{"type":"object","properties":{"cTribNac":{"type":"string","description":"Código de Tributação Nacional - opcional (4 ou 6 dígitos)","example":"0101","pattern":"^\\d{4}$|^\\d{6}$"},"cIndOp":{"type":"string","description":"Código do Indicador de Operação (6 dígitos)","example":100301,"minLength":1,"pattern":"^\\d{6}$"},"cClassTrib":{"type":"string","description":"Código de Classificação Tributária (6 dígitos)","example":620001,"minLength":1,"pattern":"^\\d{6}$"},"nbs":{"type":"string","description":"Código NBS - Nomenclatura Brasileira de Serviços (9 dígitos)","example":115021000,"minLength":1,"pattern":"^\\d{9}$"},"dataOcorrenciaFatoGerador":{"type":"string","format":"date","description":"Data de ocorrência do fato gerador da operação (formato: YYYY-MM-DD)","example":"2026-01-15"}},"required":["cClassTrib","cIndOp","dataOcorrenciaFatoGerador","nbs"]},"NfseValidacaoIndicadorOperacaoOutput":{"type":"object","description":"Resultado da validação do indicador de operação","properties":{"cTribNac":{"type":"string","description":"Código de Tributação Nacional informado (opcional)","example":"010101"},"cIndOp":{"type":"string","description":"Código do Indicador de Operação informado","example":100301},"cClassTrib":{"type":"string","description":"Código de Classificação Tributária informado","example":"000001"},"nbs":{"type":"string","description":"Código NBS informado","example":115021000},"dataOcorrenciaFatoGerador":{"type":"string","format":"date","description":"Data de ocorrência do fato gerador informada","example":"2025-01-01"},"valido":{"type":"boolean","description":"Indica se a combinação informada é válida","example":true}}},"NfseBaseCalculoInput":{"type":"object","properties":{"anoFatoGerador":{"type":"integer","format":"int32","description":"Ano do Fato Gerador","example":2026},"valorServico":{"type":"number","description":"Valor do Serviço","example":105.0},"descontoIncondicional":{"type":"number","default":"0.00","description":"Desconto Incondicional","example":5.0},"vCalcReeRepRes":{"type":"number","default":"0.00","description":"Valor monetário (R$) total relativo ao fornecimento próprio de bens materiais ou relacionados a operações de terceiros, objeto de reembolso, repasse ou ressarcimento pelo recebedor, já tributados e aqui referenciados e que não integram da base de cálculo (BC) do ISSQN, do IBS e da CBS.","example":5.0},"vCalcDedRedIBSCBS":{"type":"number","default":"0.00","description":"Valor monetário (R$) total relativo aos valores de dedução e redução da Base de Cálculo do IBS e da CBS referentes às operações de locação, cessão onerosa ou arrendamento de bens imóveis, e serviços médicos.","example":5.0},"iss":{"type":"number","default":"0.00","description":"Imposto sobre Serviços de Qualquer Natureza","example":5.0},"pis":{"type":"number","default":"0.00","description":"Programa de Integração Social","example":5.0},"cofins":{"type":"number","default":"0.00","description":"Contribuição para o Financiamento da Seguridade Social","example":5.0}},"required":["anoFatoGerador","valorServico"]},"NfseBaseCalculoOutput":{"type":"object","properties":{"baseCalculo":{"type":"number","description":"Base de cálculo da operação","example":100.55}}},"BaseCalculoISMercadoriasInput":{"type":"object","properties":{"anoFatoGerador":{"type":"integer","format":"int32","description":"Ano do Fato Gerador","example":2027},"valorBem":{"type":"number","default":"0.00","description":"Valor do bem (antes dos descontos/ajustes)","example":105.0},"ajusteAcrescimos":{"type":"number","default":"0.00","description":"Ajuste decorrentes de acréscimos","example":5.0},"juros":{"type":"number","default":"0.00","description":"Juros","example":5.0},"multas":{"type":"number","default":"0.00","description":"Multas","example":5.0},"encargos":{"type":"number","default":"0.00","description":"Encargos","example":5.0},"freteCobrado":{"type":"number","default":"0.00","description":"Frete cobrado como parte do valor da operação","example":5.0},"outrosTributos":{"type":"number","default":"0.00","description":"Tributos (exceto CBS, IBS e o próprio IS) e preços públicos, inclusive tarifas","example":5.0},"demaisImportancias":{"type":"number","default":"0.00","description":"Demais importâncias cobradas ou recebidas como parte do valor da operação, inclusive seguros e taxas","example":5.0},"icms":{"type":"number","default":"0.00","description":"ICMS","example":5.0},"iss":{"type":"number","default":"0.00","description":"ISS","example":5.0},"cosip":{"type":"number","default":"0.00","description":"COSIP","example":5.0},"ipi":{"type":"number","default":"0.00","description":"IPI","example":5.0},"descontoIncondicional":{"type":"number","default":"0.00","description":"Desconto Incondicional","example":5.0},"bonificacao":{"type":"number","default":"0.00","description":"Bonificações que constem do respectivo documento fiscal e não dependam de evento posterior, nos termos § 2º do Art. 417","example":5.0},"devolucaoVendas":{"type":"number","default":"0.00","description":"Devoluções de bens vendidos nos termos do Art. 418","example":5.0}},"required":["anoFatoGerador"]},"BaseCalculoISMercadoriasModel":{"type":"object","properties":{"baseCalculo":{"type":"number","description":"Base de cálculo da operação","example":100.55}}},"BaseCalculoCibsInput":{"type":"object","properties":{"anoFatoGerador":{"type":"integer","format":"int32","description":"Ano do Fato Gerador","example":2026},"valorBem":{"type":"number","default":"0.00","description":"Valor do Bem (antes dos descontos/ajustes)","example":105.0},"ajusteAcrescimos":{"type":"number","default":"0.00","description":"Ajuste decorrentes de acréscimos","example":5.0},"juros":{"type":"number","default":"0.00","description":"Juros","example":5.0},"multas":{"type":"number","default":"0.00","description":"Multas","example":5.0},"encargos":{"type":"number","default":"0.00","description":"Encargos","example":5.0},"frete":{"type":"number","default":"0.00","description":"Frete cobrado como parte do valor da operação","example":5.0},"impostoSeletivo":{"type":"number","default":"0.00","description":"Imposto Seletivo","example":5.0},"outrosTributos":{"type":"number","default":"0.00","description":"Outros tributos (exceto CBS e IBS) e preços públicos, inclusive tarifas","example":5.0},"demaisImportancias":{"type":"number","default":"0.00","description":"Demais importâncias cobradas ou recebidas como parte do valor da operação, inclusive seguros e taxas","example":5.0},"icms":{"type":"number","default":"0.00","description":"ICMS","example":5.0},"iss":{"type":"number","default":"0.00","description":"ISS","example":5.0},"pis":{"type":"number","default":"0.00","description":"PIS","example":5.0},"pisImportacao":{"type":"number","default":"0.00","description":"PIS Importação","example":5.0},"cofins":{"type":"number","default":"0.00","description":"COFINS","example":5.0},"cofinsImportacao":{"type":"number","default":"0.00","description":"COFINS Importação","example":5.0},"cosip":{"type":"number","default":"0.00","description":"COSIP","example":5.0},"ipi":{"type":"number","default":"0.00","description":"IPI","example":5.0},"descontoIncondicional":{"type":"number","default":"0.00","description":"Desconto Incondicional","example":5.0}},"required":["anoFatoGerador"]},"BaseCalculoCibsModel":{"type":"object","properties":{"baseCalculo":{"type":"number","description":"Base de cálculo da operação","example":100.55}}},"BaseCalculoUnificadaInput":{"type":"object","properties":{"anoFatoGerador":{"type":"integer","format":"int32","description":"Ano do Fato Gerador","example":2026},"tipoDocumento":{"type":"integer","format":"int32","description":"Tipo de documento fiscal","example":55},"natureza":{"type":"string","description":"Natureza da operação (bem ou serviço)","enum":["BEM","SERVICO"],"example":"bem"},"vProd":{"type":"number","description":"Valor dos produtos/serviços","example":1000.0},"vFrete":{"type":"number","description":"Valor do frete","example":50.0},"vSeg":{"type":"number","description":"Valor do seguro","example":20.0},"vOutro":{"type":"number","description":"Outras despesas acessórias","example":10.0},"vII":{"type":"number","description":"Imposto de importação","example":150.0},"vIS":{"type":"number","description":"Imposto Seletivo","example":30.0},"vDesc":{"type":"number","description":"Desconto incondicional","example":50.0},"vPIS":{"type":"number","description":"PIS (vigente 2026)","example":9.25},"vCOFINS":{"type":"number","description":"COFINS (vigente 2026)","example":46.25},"vICMS":{"type":"number","description":"ICMS (vigente 2026-2032)","example":180.0},"vICMSUFDest":{"type":"number","description":"ICMS UF Destino (vigente 2026-2032)","example":20.0},"vFCP":{"type":"number","description":"FCP (vigente 2026-2032)","example":10.0},"vFCPUFDest":{"type":"number","description":"FCP UF Destino (vigente 2026-2032)","example":5.0},"vICMSMono":{"type":"number","description":"ICMS Monofásico (vigente 2026-2032)","example":100.0},"vISSQN":{"type":"number","description":"ISSQN (vigente 2026-2032, apenas serviço)","example":30.0}},"required":["anoFatoGerador","natureza","tipoDocumento"]},"BaseCalculoUnificadaOutput":{"type":"object","properties":{"baseRG":{"type":"number"},"baseIS":{"type":"number"},"baseSN":{"type":"number"},"avisos":{"type":"array","description":"Avisos informativos sobre campos ignorados por não comporem o contexto (vigência, natureza ou modelo de documento). As bases retornadas já desconsideram esses campos.","items":{"type":"string"}}}},"BaseCalculoUnificadaNfseInput":{"type":"object","properties":{"anoFatoGerador":{"type":"integer","format":"int32","description":"Ano do fato gerador","example":2026},"opSimpNac":{"$ref":"#/components/schemas/OpcaoSimplesNacional","description":"Opção pelo Simples Nacional: 1=Não Optante, 2=MEI, 3=Optante ME/EPP, 4=Optante Pendente","enum":["1","2","3","4"],"example":1},"situacao":{"$ref":"#/components/schemas/SituacaoOperacaoNfse","description":"Situação da operação NFS-e","example":"comum"},"vServ":{"type":"number","description":"Valor do serviço (null → zero)","example":1000.0},"vDescIncond":{"type":"number","description":"Valor do desconto incondicional (null → zero)","example":50.0},"vISSQN":{"type":"number","description":"Valor do ISSQN destacado (null → zero)","example":30.0},"vPIS":{"type":"number","description":"Valor do PIS (null → zero)","example":9.25},"vCOFINS":{"type":"number","description":"Valor da COFINS (null → zero)","example":46.25},"regApIBSCBSSN":{"$ref":"#/components/schemas/RegimeApuracaoIbsCbsSN","description":"Regime de apuração IBS/CBS no SN: 1=IBS+CBS pelo SN, 2=CBS pelo SN + IBS regular, 3=Ambos regulares. Obrigatório para optantes.","enum":["1","2","3"],"example":1},"documentos":{"type":"array","description":"Documentos de ajuste à base de cálculo (null → lista vazia)","items":{"$ref":"#/components/schemas/DocumentoAjusteNfseInput"}},"locacao":{"$ref":"#/components/schemas/LocacaoNfseInput","description":"Dados de locação de imóveis. Obrigatório quando situacao=locacao9903"}},"required":["anoFatoGerador","opSimpNac","situacao"]},"DocumentoAjusteNfseInput":{"type":"object","properties":{"tpAjusteBC":{"type":"string","description":"Tipo de ajuste à base de cálculo (ex: 101, 102, 103, 104, 105, 199, 9)","example":101,"minLength":1},"vAjusteAplic":{"type":"number","description":"Valor do ajuste aplicado","example":50.0},"xTpAjusteBC":{"type":"string","description":"Descrição do tipo de ajuste (obrigatório para tipo 199)","example":"Ajuste personalizado"}},"required":["tpAjusteBC","vAjusteAplic"]},"LocacaoNfseInput":{"type":"object","properties":{"pCopropriedade":{"type":"number","description":"Percentual de copropriedade (100 = locador único)","example":100},"vTotOper":{"type":"number","description":"Valor total da operação de locação","example":5000.0},"vDescIncondTot":{"type":"number","description":"Valor do desconto incondicional total","example":500.0},"somaAjustesLocImoveis":{"type":"number","description":"Soma das parcelas de ajuste de locação de imóveis","example":100.0}},"required":["pCopropriedade","somaAjustesLocImoveis","vDescIncondTot","vTotOper"]},"OpcaoSimplesNacional":{"type":"string","description":"Opção pelo Simples Nacional","enum":["1","2","3","4"]},"RegimeApuracaoIbsCbsSN":{"type":"string","description":"Regime de apuração IBS/CBS no Simples Nacional","enum":["1","2","3"]},"SituacaoOperacaoNfse":{"type":"string","description":"Situação da operação NFS-e","enum":["comum","salaoParceiro","locacao9903"]},"BaseCalculoUnificadaNfseOutput":{"type":"object","properties":{"baseRG":{"type":"number"},"baseSN":{"type":"number"},"avisos":{"type":"array","items":{"type":"string"}},"erros":{"type":"array","items":{"$ref":"#/components/schemas/ErroBaseCalculoNfse"}}}},"ErroBaseCalculoNfse":{"type":"object","properties":{"codigo":{"type":"string"},"mensagem":{"type":"string"}}},"TipoDocumentoDTO":{"type":"object","properties":{"nome":{"type":"string"},"mnemonico":{"type":"string"},"versaoNotaTecnica":{"type":"string"}}},"ErroDescricao":{"type":"object","properties":{"codigo":{"type":"string"},"titulo":{"type":"string"},"descricao":{"type":"string"}}},"NfseSituacaoClassificacaoOutput":{"type":"object","properties":{"codigoSituacaoTributaria":{"type":"string"},"descricaoSituacaoTributaria":{"type":"string"},"codigoClassificacaoTributaria":{"type":"string"},"descricaoClassificacaoTributaria":{"type":"string"}}},"NfseLocalOperacaoOutput":{"type":"object","description":"Informações sobre o local da operação baseado no indicador de operação","properties":{"cIndOp":{"type":"string","description":"Código do Indicador de Operação informado","example":100301},"dataOcorrenciaFatoGerador":{"type":"string","format":"date","description":"Data de ocorrência do fato gerador informada","example":"2026-01-01"},"codigoLocalFornecimento":{"type":"string","description":"Código do local de fornecimento","enum":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29"],"example":5},"localFornecimento":{"type":"string","description":"Local de fornecimento","example":"Estabelecimento do Fornecedor"},"codigoLocalIncidencia":{"type":"string","description":"Código do local de incidência","enum":["1","2","3","4","5","6","7"],"example":3},"localIncidencia":{"type":"string","description":"Local de incidência","example":"Estabelecimento do Prestador/Fornecedor"}}},"NfseCodigoDescricaoOutput":{"type":"object","description":"Código e descrição de um valor de enumeração","properties":{"codigo":{"type":"integer","format":"int32","description":"Código do valor","example":1},"descricao":{"type":"string","description":"Descrição do valor","example":"Endereço do Destinatário"}}},"NfseIndicadorOperacaoOutput":{"type":"object","description":"Informações sobre o indicador de operação","properties":{"cIndOp":{"type":"string","description":"Código do Indicador de Operação","example":"020301"},"tipoOperacao":{"type":"string","description":"Tipo de operação","example":"Serviço de administração e intermediação de bem imóvel"},"codigoLocalFornecimento":{"type":"string","description":"Código do local de fornecimento","enum":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29"],"example":14},"localFornecimento":{"type":"string","description":"Local de fornecimento","example":"Estabelecimento do Fornecedor"},"codigoLocalIncidencia":{"type":"string","description":"Código do local de incidência","enum":["1","2","3","4","5","6","7"],"example":3},"localIncidencia":{"type":"string","description":"Local de incidência","example":"Estabelecimento do Prestador/Fornecedor"},"prestacaoServicoOnerosa":{"type":"boolean","description":"Indicador se é prestação de serviço onerosa (apenas quando NBS é informado)","example":true},"adquirenteExterior":{"type":"boolean","description":"Indicador se o adquirente é do exterior (apenas quando NBS é informado)","example":false}}},"VersaoOutput":{"type":"object","properties":{"versaoApp":{"type":"string","description":"Versão do aplicativo","example":"SNAPSHOT-b7bb06d6"},"descricaoVersaoApp":{"type":"string","description":"Descrição da versão do aplicativo","example":"demanda5430315Cofis42615ValidadeNcm-SNAPSHOT-b7bb06d6"},"versaoDb":{"type":"string","description":"Versão do banco de dados","example":"1.0.0"},"descricaoVersaoDb":{"type":"string","description":"Descrição da versão do banco de dados","example":"Versão de homologação"},"dataVersaoDb":{"type":"string","description":"Data da versão do banco de dados","example":"2026-01-01"},"ambiente":{"type":"string","description":"Ambiente da aplicação","example":"Online"}}},"UfDadosAbertosOutput":{"type":"object","properties":{"sigla":{"type":"string","description":"Sigla da UF","example":"RS"},"nome":{"type":"string","description":"Nome da UF","example":"Rio Grande do Sul"},"codigo":{"type":"integer","format":"int64","description":"Código IBGE da UF","example":43}}},"MunicipioDadosAbertosOutput":{"type":"object","properties":{"codigo":{"type":"integer","format":"int64","description":"Código IBGE do Município","example":4314902},"nome":{"type":"string","description":"Nome do município","example":"Porto Alegre"}}},"TransferenciaIBSDadosAbertosOutput":{"type":"object","properties":{"valor":{"type":"number","description":"Percentual de transferência IBS","example":0.15},"inicioVigencia":{"type":"string","format":"date","description":"Data de início da vigência","example":"2026-01-01"},"fimVigencia":{"type":"string","format":"date","description":"Data de fim da vigência","example":"2026-12-31"}}},"TransferenciaCBSDadosAbertosOutput":{"type":"object","properties":{"valor":{"type":"number","description":"Percentual de transferência CBS","example":0.15},"inicioVigencia":{"type":"string","format":"date","description":"Data de início da vigência","example":"2026-01-01"},"fimVigencia":{"type":"string","format":"date","description":"Data de fim da vigência","example":"2026-12-31"}}},"ClassificacaoTributariaOutput":{"type":"object","properties":{"codigo":{"type":"string","description":"Código da classificação tributária","example":"000001"},"descricao":{"type":"string","description":"Descrição da classificação tributária","example":"ICMS - Operação Interna"}}},"SituacaoClassificacaoAninhadoOutput":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Identificador único da situação tributária","example":1},"codigo":{"type":"string","description":"Código da situação tributária (CST)","example":"000"},"descricao":{"type":"string","description":"Descrição da situação tributária (CST)","example":"Tributação Integral"},"classificacoesTributarias":{"type":"array","description":"Lista de classificações tributárias aplicáveis","items":{"$ref":"#/components/schemas/ClassificacaoTributariaOutput"}}}},"SituacaoTributariaDadosAbertosOutput":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Identificador único da situacao tributária","example":0},"codigo":{"type":"string","description":"Código da situacao tributária","example":"000"},"descricao":{"type":"string","description":"Descricao da situacao tributária","example":"Tributação Integral"}}},"RedutorCompraGovernamentalDadosAbertosOutput":{"type":"object","properties":{"valor":{"type":"number","description":"Valor do redutor","example":0.6},"inicioVigencia":{"type":"string","format":"date","description":"Data de início da vigência","example":"2026-01-01"},"fimVigencia":{"type":"string","format":"date","description":"Data de fim da vigência","example":"2026-12-31"}}},"NomenclaturaDadosAbertosOutput":{"type":"object","properties":{"siglaDfe":{"type":"string","description":"Sigla do documento fiscal eletrônico","example":"NFe"},"cClassTrib":{"type":"string","description":"Código da classificação tributária","example":"000001"},"data":{"type":"string","format":"date","description":"Data da consulta","example":"2026-01-01"},"nomenclatura":{"type":"string","description":"Nomenclatura aplicável (NCM, NBS, MISTO, SEM, EXCECAO_NCM ou EXCECAO_NBS)","example":"NCM"},"obrigatorio":{"type":"boolean","description":"Indica se o preenchimento da nomenclatura é obrigatório: true para NCM, NBS, MISTO, EXCECAO_NCM e EXCECAO_NBS (há anexo, preenchimento obrigatório); false para SEM","example":true},"ncmOpcional":{"type":"boolean","description":"Desambiguação do resultado SEM: true quando a nomenclatura é SEM e o DFe é NF-e ou NFC-e (o NCM pode ser informado opcionalmente); false nos demais casos","example":false},"nbsOpcional":{"type":"boolean","description":"Desambiguação do resultado SEM: true quando a nomenclatura é SEM e o DFe é NFS-e (a NBS pode ser informada opcionalmente); false nos demais casos","example":false}}},"NcmDadosAbertosOutput":{"type":"object","properties":{"tributadoPeloImpostoSeletivo":{"type":"boolean","description":"Tributado pelo Imposto Seletivo"},"temAliquotaAdValorem":{"type":"boolean","description":"Indica se a NCM possui alíquota ad valorem do Imposto Seletivo, mesmo que o valor ainda não tenha sido definido em lei"},"temAliquotaAdRem":{"type":"boolean","description":"Indica se a NCM possui alíquota ad rem do Imposto Seletivo, mesmo que o valor ainda não tenha sido definido em lei"},"aliquotaAdValorem":{"type":"number","description":"Alíquota ad valorem do Imposto Seletivo"},"aliquotaAdRem":{"type":"number","description":"Alíquota ad rem do Imposto Seletivo"},"capitulo":{"type":"string","description":"Capítulo da NCM"},"posicao":{"type":"string","description":"Posição da NCM"},"subposicao":{"type":"string","description":"Subposição da NCM"},"item":{"type":"string","description":"Item da NCM"},"subitem":{"type":"string","description":"Subitem da NCM"},"unidade":{"type":"string","description":"Unidade da NCM"}}},"NcmVigenciaOutput":{"type":"object","properties":{"ncm":{"type":"string","description":"Código da NCM com 8 dígitos","example":22030000},"descricao":{"type":"string","description":"Descrição textual do NCM conforme tabela de Nomenclatura Comum do Mercosul","example":"Bebidas não alcoólicas, exceto sucos e bebidas à base de leite"}}},"NbsDadosAbertosOutput":{"type":"object","properties":{"tributadoPeloImpostoSeletivo":{"type":"boolean","description":"Tributado pelo Imposto Seletivo"},"temAliquotaAdValorem":{"type":"boolean","description":"Indica se a NBS possui alíquota ad valorem do Imposto Seletivo, mesmo que o valor ainda não tenha sido definido em lei"},"aliquotaAdValorem":{"type":"number","description":"Alíquota ad valorem do Imposto Seletivo"},"capitulo":{"type":"string","description":"Capítulo da NBS"},"posicao":{"type":"string","description":"Posição da NBS"},"subposicao1":{"type":"string","description":"Subposição 1 da NBS"},"subposicao2":{"type":"string","description":"Subposição 2 da NBS"},"item":{"type":"string","description":"Item da NBS"}}},"NbsListaDadosAbertosOutput":{"type":"object","properties":{"codigo":{"type":"string","description":"Código NBS","example":10101},"descricao":{"type":"string","description":"Descrição da NBS","example":"Serviços de construção de edificações"}}},"FundamentacaoClassificacaoDadosAbertosOutput":{"type":"object","properties":{"codigoClassificacaoTributaria":{"type":"string","description":"Código da classificação tributária vinculada à fundamentacao legal","example":"000001"},"descricaoClassificacaoTributaria":{"type":"string","description":"Descrição da classificação tributária vinculada à fundamentacao legal","example":"000001"},"codigoSituacaoTributaria":{"type":"string","description":"Código da situação tributária vinculada à fundamentacao legal","example":"000001"},"descricaoSituacaoTributaria":{"type":"string","description":"Descrição da situação tributária vinculada à fundamentacao legal","example":"000001"},"conjuntoTributo":{"type":"string","description":"Tributo(s) vinculado(s) à fundamentacao legal","example":"CBS e IBS"},"texto":{"type":"string","description":"Texto da fundamentação legal"},"textoCurto":{"type":"string","description":"Texto curto da fundamentação legal"},"referenciaNormativa":{"type":"string","description":"Referência normativa da fundamentação legal"}}},"GrupoDfeDadosAbertosOutput":{"type":"object","properties":{"id":{"type":"string","description":"Identificador estável do grupo","example":1},"titulo":{"type":"string","description":"Título da categoria de documento","example":"MERCADORIAS"},"ordem":{"type":"integer","format":"int32","description":"Ordem de exibição do grupo","example":1},"tipos":{"type":"array","description":"Tipos de DFe selecionáveis do grupo","items":{"$ref":"#/components/schemas/TipoDfeDadosAbertosOutput"}}}},"TipoDfeDadosAbertosOutput":{"type":"object","properties":{"codigo":{"type":"string","description":"Sigla normalizada do DFe, usada como siglaDfe nos demais endpoints","example":"NFE"},"titulo":{"type":"string","description":"Nome do tipo de documento fiscal eletrônico","example":"Nota Fiscal Eletrônica"},"descricao":{"type":"string","description":"Descrição curta auxiliar do tipo (pode ser omitida)","example":"Venda entre empresas, modelo 55."},"modelo":{"type":"string","description":"Número do modelo fiscal; nulo quando não há modelo único","example":55},"ordem":{"type":"integer","format":"int32","description":"Ordem de exibição do tipo dentro do grupo","example":1}}},"ClassificacaoTributariaDadosAbertosOutput":{"type":"object","properties":{"codigo":{"type":"string","description":"Código da classificação tributária","example":"000001"},"descricao":{"type":"string","description":"Descrição da classificação tributária"},"tipoAliquota":{"type":"string","description":"Tipo de alíquota da classificação tributária"},"nomenclatura":{"type":"string","description":"Nomenclatura da classificação tributária"},"descricaoTratamentoTributario":{"type":"string","description":"Descrição do tratamento tributário da classificação tributária"},"incompativelComSuspensao":{"type":"boolean"},"exigeGrupoDesoneracao":{"type":"boolean"},"possuiPercentualReducao":{"type":"boolean"},"indicaApropriacaoCreditoAdquirenteCbs":{"type":"boolean"},"indicaApropriacaoCreditoAdquirenteIbs":{"type":"boolean"},"indicaCreditoPresumidoFornecedor":{"type":"boolean"},"indicaCreditoPresumidoAdquirente":{"type":"boolean"},"creditoOperacaoAntecedente":{"type":"string"},"percentualReducaoCbs":{"type":"number"},"percentualReducaoIbsUf":{"type":"number"},"percentualReducaoIbsMun":{"type":"number"},"tipoReceitaBrutaSimplesNacional":{"type":"integer","format":"int32","description":"Tipo de Receita Bruta do Simples Nacional (tpRBSN): 0 = Não é receita bruta; 1 = Receita bruta - interna; 2 = Receita bruta - interna sem cálculo de IBS e CBS; 3 = Receita bruta - exportação direta; 4 = Receita bruta - exportação indireta; 5 = Receita bruta - mercado interno e exportação; 9 = Fornecimento incompatível com SN","example":1},"tiposDfeClassificacao":{"type":"array","items":{"$ref":"#/components/schemas/TipoDfeClassificacaoDadosAbertosOutput"}},"dataAtualizacao":{"type":"string","format":"date","description":"Data de atualização da classificação tributária (YYYY-MM-DD)","example":"2025-12-15"}}},"TipoDfeClassificacaoDadosAbertosOutput":{"type":"object","properties":{"tipo":{"type":"integer","format":"int32","description":"Tipo de DFE","example":55},"sigla":{"type":"string","description":"Sigla do DFE","example":"NF-e"},"descricao":{"type":"string","description":"Descrição do DFE","example":"Documento Fiscal Eletrônico"}}},"NcmAplicavelOutput":{"type":"object","properties":{"cClassTrib":{"type":"string","description":"Código da Classificação Tributária","example":"000001"},"ncm":{"type":"string","description":"Código NCM (Nomenclatura Comum do Mercosul)","example":24021000},"dataOcorrenciaFatoGerador":{"type":"string","description":"Data de ocorrência do fato gerador","example":"2026-01-01"},"valido":{"type":"boolean","description":"Indicador se o NCM é válido para a classificação tributária informada"}}},"NbsAplicavelOutput":{"type":"object","properties":{"cClassTrib":{"type":"string","description":"Código da Classificação Tributária","example":"000001"},"nbs":{"type":"string","description":"Código NBS (Nomenclatura Brasileira de Serviços)","example":114052200},"dataOcorrenciaFatoGerador":{"type":"string","description":"Data de ocorrência do fato gerador","example":"2026-01-01"},"valido":{"type":"boolean","description":"Indicador se a NBS é válida para a classificação tributária informada"}}},"ValidadeDfeClassificacaoTributariaDadosAbertosOutput":{"type":"object","properties":{"siglaDfeInformado":{"type":"string","description":"Sigla do DFE informado","example":"NFSe"},"validoParaSiglaDfeInformado":{"type":"boolean","description":"Indica se a classificação tributária é válida para a sigla do DFE informado","example":true},"nomenclatura":{"type":"string","description":"Nomenclatura da classificação tributária informada","example":"NBS ou NCM"},"exigeGrupoTributacaoRegular":{"type":"boolean","description":"Indica se a classificação tributária exige grupo de tributação regular","example":false},"permiteDiferimento":{"type":"boolean","description":"Indica se a classificação tributária permite diferimento","example":false},"possibilidadeCreditoPresumido":{"type":"boolean","description":"Indica se há possibilidade de crédito presumido na operação","example":false},"exigeGrupoIbsCbs":{"type":"boolean","description":"Indica se deve ser preenchido o grupo de informações padrão do IBS e da CBS no documento fiscal","example":false}}},"AtorDadosAbertosOutput":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Identificador do ator","example":22},"descricao":{"type":"string","description":"Descrição do ator","example":"Contribuinte sujeito ao regime regular do IBS e da CBS"},"ordem":{"type":"integer","format":"int32","description":"Ordem de exibição do ator dentro do grupo","example":1}}},"GrupoAtorDadosAbertosOutput":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Identificador do grupo de ator","example":1},"descricao":{"type":"string","description":"Descrição do grupo de ator","example":"Regime regular / contribuinte padrão (arts. 21 ss.)"},"ordem":{"type":"integer","format":"int32","description":"Ordem de exibição do grupo","example":1},"atores":{"type":"array","description":"Lista de atores pertencentes ao grupo","items":{"$ref":"#/components/schemas/AtorDadosAbertosOutput"}}}},"AliquotaDadosAbertosOutput":{"type":"object","properties":{"aliquotaReferencia":{"type":"number","description":"Alíquota de referência","example":0},"aliquotaPropria":{"type":"number","description":"Alíquota própria","example":0},"formaAplicacao":{"type":"string","description":"Forma de aplicação da alíquota própria em relação à alíquota de referência","enum":["SUBSTITUICAO","ACRESCIMO","DECRESCIMO"],"example":"ACRESCIMO"}}}}}}