From 9e17f0f035a6b07e5281e78dc780f75366794b36 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lu=C3=ADs=20Eduardo?= Date: Mon, 9 Nov 2026 16:12:13 -0300 Subject: [PATCH] =?UTF-8?q?feat:=20NFS-e=20por=20chave=20e=20Simples=20Nac?= =?UTF-8?q?ional=20na=20cole=C3=A7=C3=A3o?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- FiscalAPI.postman_collection.json | 166 ++++- README.md | 2 +- openapi-publico.json | 1161 ++++++++++++++++++++++++++--- 3 files changed, 1240 insertions(+), 89 deletions(-) diff --git a/FiscalAPI.postman_collection.json b/FiscalAPI.postman_collection.json index 8027442..dad92a2 100644 --- a/FiscalAPI.postman_collection.json +++ b/FiscalAPI.postman_collection.json @@ -534,6 +534,82 @@ } ] }, + { + "name": "Simples Nacional", + "description": "Situação no Simples Nacional e no SIMEI.", + "item": [ + { + "name": "Consultar Simples Nacional", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/consultar-simples-nacional?cnpj=11222333000181", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "consultar-simples-nacional" + ], + "query": [ + { + "key": "cnpj", + "value": "11222333000181" + } + ] + }, + "description": "Situação do CNPJ no Simples Nacional (com data da opção), no SIMEI e nos regimes regulares de IBS e CBS, com eventos futuros. Para filiais, a situação é a da matriz.\n\nO CNPJ pode ir com ou sem máscara. Resultados ficam em cache por 24 h (`cached: true`).\n\nDocumentação: https://docs.fiscalapi.com.br" + }, + "response": [ + { + "name": "200 - Sucesso", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/consultar-simples-nacional?cnpj=11222333000181", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "consultar-simples-nacional" + ], + "query": [ + { + "key": "cnpj", + "value": "11222333000181" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"request_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"cnpj\": \"11222333000181\",\n \"cnpj_matriz\": \"11222333000181\",\n \"nome_empresarial\": \"EMPRESA EXEMPLO LTDA\",\n \"data_consulta\": \"2026-11-09\",\n \"situacao_simples\": \"Optante pelo Simples Nacional\",\n \"optante_simples\": true,\n \"data_opcao_simples\": \"2020-01-01\",\n \"situacao_simei\": \"Não enquadrado no SIMEI\",\n \"enquadrado_simei\": false,\n \"regime_regular_ibs\": \"Não\",\n \"regime_regular_cbs\": \"Não\",\n \"eventos_futuros\": [],\n \"mais_info\": null,\n \"cached\": false\n}" + } + ] + } + ] + }, { "name": "Certidões estaduais (CND)", "description": "Certidão Negativa de Débitos estadual (ICMS).", @@ -1486,6 +1562,94 @@ } ] }, + { + "name": "NFS-e", + "description": "NFS-e do padrão nacional por chave de acesso, sem certificado.", + "item": [ + { + "name": "Consultar NFS-e por chave de acesso", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/consultar-nfse?chave=35503082211222333000181000000000012326100000045676", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "consultar-nfse" + ], + "query": [ + { + "key": "chave", + "value": "35503082211222333000181000000000012326100000045676" + }, + { + "key": "danfse", + "value": "true", + "disabled": true, + "description": "Incluir o PDF do DANFSe em base64." + } + ] + }, + "description": "NFS-e do padrão nacional pela chave de acesso (50 dígitos), sem certificado digital. Retorna emitente, tomador, serviço, tributação municipal e federal e a situação de geração (`situacao`: 100 gerada, 101 de substituição, 102 por decisão judicial, 103 avulsa; não indica cancelamento).\n\nCom `danfse=true`, a resposta inclui o PDF do DANFSe em base64 (`danfse_pdf_base64`). Uma consulta nova leva de 30 a 60 segundos; a mesma chave consultada de novo em até 24 h volta do cache (`cached: true`) e também é cobrada.\n\nCobra só a NFS-e entregue; chave inválida, nota não encontrada e falha não são cobradas." + }, + "response": [ + { + "name": "200 - Sucesso", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/consultar-nfse?chave=35503082211222333000181000000000012326100000045676", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "consultar-nfse" + ], + "query": [ + { + "key": "chave", + "value": "35503082211222333000181000000000012326100000045676" + }, + { + "key": "danfse", + "value": "true", + "disabled": true, + "description": "Incluir o PDF do DANFSe em base64." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"request_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"chave\": \"35503082211222333000181000000000012326100000045676\",\n \"numero_nfse\": \"4567\",\n \"codigo_municipio_emissor\": \"3550308\",\n \"data_geracao\": \"2026-10-15T10:30:00-03:00\",\n \"versao\": \"1.00\",\n \"dps\": {\n \"numero\": \"123\",\n \"serie\": \"1\",\n \"data_emissao\": \"2026-10-15\"\n },\n \"situacao\": {\n \"codigo\": \"100\",\n \"descricao\": \"NFS-e Gerada\"\n },\n \"emitente\": {\n \"razao_social\": \"EMPRESA EXEMPLO LTDA\",\n \"cpf_cnpj\": \"11222333000181\",\n \"inscricao_municipal\": null,\n \"situacao_simples_nacional\": null,\n \"regime_especial_tributacao\": null,\n \"endereco\": null\n },\n \"tomador\": {\n \"cpf_cnpj\": null,\n \"inscricao_municipal\": null,\n \"nome\": \"TOMADOR EXEMPLO\"\n },\n \"intermediario\": null,\n \"servico\": {\n \"pais\": null,\n \"municipio\": \"São Paulo\",\n \"codigo_tributacao_nacional\": null,\n \"descricao_codigo\": null,\n \"item_nbs\": null,\n \"descricao\": \"Serviço de exemplo\"\n },\n \"tributacao_municipal\": {\n \"tributacao_issqn\": null,\n \"municipio_incidencia\": null,\n \"valor_servico\": 1000.0,\n \"desconto_incondicionado\": null,\n \"deducoes\": null,\n \"beneficio_municipal\": null,\n \"base_calculo\": 1000.0,\n \"aliquota\": 2.5,\n \"valor_issqn\": 25.0,\n \"retencao\": null\n },\n \"tributacao_federal\": null,\n \"total_tributos\": [],\n \"informacoes_complementares\": null,\n \"ambiente_gerador\": null,\n \"cached\": false,\n \"danfse_pdf_base64\": null,\n \"aviso\": null\n}" + } + ] + } + ] + }, { "name": "SIGEF", "description": "Parcelas georreferenciadas certificadas pelo INCRA.", @@ -1956,4 +2120,4 @@ ] } ] -} +} \ No newline at end of file diff --git a/README.md b/README.md index 1e8a959..0343f37 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # FiscalAPI — coleção Postman e OpenAPI -Coleção Postman e especificação OpenAPI 3.1 da [FiscalAPI](https://fiscalapi.com.br): Inscrição Estadual nos 27 estados, CNPJ, certidões (CND estadual, CND Federal, CNDT, CRF/FGTS), XML de NF-e por chave (com certificado, ou cópia para leitura sem certificado), SIGEF, CNIR e perfil do produtor rural. +Coleção Postman e especificação OpenAPI 3.1 da [FiscalAPI](https://fiscalapi.com.br): Inscrição Estadual nos 27 estados, CNPJ, certidões (CND estadual, CND Federal, CNDT, CRF/FGTS), XML de NF-e por chave (com certificado, ou cópia para leitura sem certificado), NFS-e por chave, Simples Nacional, SIGEF, CNIR e perfil do produtor rural. | Arquivo | O que é | |---|---| diff --git a/openapi-publico.json b/openapi-publico.json index d5e258c..82fd97a 100644 --- a/openapi-publico.json +++ b/openapi-publico.json @@ -2,7 +2,7 @@ "openapi": "3.1.0", "info": { "title": "FiscalAPI", - "description": "API REST da FiscalAPI para consultar inscrição estadual (IE) nos 27 estados, CNPJ, certidões negativas estaduais e federais, XML de NF-e pela chave de acesso, imóveis rurais (CNIR e SIGEF), Simples Nacional, status da SEFAZ e o catálogo de rejeições da NF-e.\n\nAutenticação: envie a sua chave no cabeçalho `X-API-Key`. A chave é criada no painel (app.fiscalapi.com.br); sem ela, ou com chave inválida, a resposta é 403.\n\nCobrança: as consultas usam o saldo do plano. Conta que nunca assinou, com e-mail confirmado, tem 10 consultas grátis por mês de IE (em um estado) e de CNPJ, somadas com as do painel. O resto pede plano ou saldo, e a chamada sem saldo devolve 402. Limite por minuto conforme o plano; acima dele, 429 com o cabeçalho Retry-After.\n\nDocumentação completa: https://docs.fiscalapi.com.br", + "description": "API REST da FiscalAPI para consultar inscrição estadual (IE) nos 27 estados, CNPJ, certidões negativas estaduais e federais, XML de NF-e pela chave de acesso, NFS-e do padrão nacional pela chave de acesso, imóveis rurais (CNIR e SIGEF), Simples Nacional, status da SEFAZ e o catálogo de rejeições da NF-e.\n\nAutenticação: envie a sua chave no cabeçalho `X-API-Key`. A chave é criada no painel (app.fiscalapi.com.br); sem ela, ou com chave inválida, a resposta é 403.\n\nCobrança: as consultas usam o saldo do plano. Conta que nunca assinou, com e-mail confirmado, tem 10 consultas grátis por mês de IE (em um estado) e de CNPJ, somadas com as do painel. O resto pede plano ou saldo, e a chamada sem saldo devolve 402. Limite por minuto conforme o plano; acima dele, 429 com o cabeçalho Retry-After.\n\nDocumentação completa: https://docs.fiscalapi.com.br", "version": "1.0.0" }, "servers": [ @@ -1936,6 +1936,163 @@ } } }, + "/api/consultar-nfse": { + "get": { + "tags": [ + "NFS-e" + ], + "summary": "Consultar NFS-e por chave de acesso", + "description": "Consulta uma NFS-e do padrão nacional a partir da chave de acesso (50 dígitos), sem certificado digital. Retorna emitente, tomador, serviço, tributação municipal e federal e a situação de geração (`situacao`: 100 gerada, 101 de substituição, 102 por decisão judicial, 103 avulsa); `situacao` não indica cancelamento. Com `danfse=true`, inclui o PDF do DANFSe em base64 (`danfse_pdf_base64`). Uma consulta nova leva de 30 a 60 segundos; a mesma chave consultada de novo em até 24 h volta do cache na hora (`cached: true`) e também é cobrada. Cobra só a NFS-e entregue (mesmo preço do XML de NF-e sem certificado). Chave inválida, nota não encontrada e falha não são cobradas. Não entra nas consultas grátis.", + "operationId": "consultar_nfse_endpoint_api_consultar_nfse_get", + "parameters": [ + { + "name": "chave", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Chave de acesso da NFS-e (50 dígitos)", + "title": "Chave" + }, + "description": "Chave de acesso da NFS-e (50 dígitos)" + }, + { + "name": "danfse", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "description": "Incluir o PDF do DANFSe em base64", + "default": false, + "title": "Danfse" + }, + "description": "Incluir o PDF do DANFSe em base64" + } + ], + "responses": { + "200": { + "description": "NFS-e encontrada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NfseResponse" + } + } + } + }, + "400": { + "description": "Chave ausente ou inválida (formato ou dígito verificador)", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ErroProblema" + } + } + } + }, + "402": { + "description": "Saldo insuficiente para esta consulta. Assine um plano ou recarregue.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ErroProblema" + } + } + } + }, + "403": { + "description": "Chave ausente, inválida ou revogada.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ErroProblema" + } + } + } + }, + "404": { + "description": "NFS-e não encontrada para a chave informada", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ErroProblema" + } + } + } + }, + "409": { + "description": "Aceite da versão vigente dos Termos pendente", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ErroProblema" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + }, + "429": { + "description": "Limite de requisições por minuto excedido. Veja o cabeçalho Retry-After.", + "headers": { + "Retry-After": { + "description": "Segundos até poder tentar de novo.", + "schema": { + "type": "integer" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErroLimite" + } + }, + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ErroProblema" + } + } + } + }, + "502": { + "description": "Fonte oficial indisponível", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ErroProblema" + } + } + } + }, + "503": { + "description": "Consulta temporariamente indisponível (header Retry-After)", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ErroProblema" + } + } + } + } + } + } + }, "/api/v1/sefaz/status": { "get": { "tags": [ @@ -4582,98 +4739,106 @@ ], "title": "NfeXmlSemCertResponse" }, - "ProducerProfile": { + "NfseDps": { "properties": { - "request_id": { - "type": "string", - "title": "Request Id" - }, - "document": { - "type": "string", - "title": "Document" - }, - "receita_federal": { + "numero": { "anyOf": [ { - "$ref": "#/components/schemas/CNPJResponse" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Numero" }, - "inscricoes_estaduais": { + "serie": { "anyOf": [ { - "$ref": "#/components/schemas/CrossStateResponse" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Serie" }, - "cnd_estaduais": { + "data_emissao": { "anyOf": [ { - "$ref": "#/components/schemas/CrossStateCNDResponse" + "type": "string" }, { "type": "null" } - ] - }, - "certidoes_federais": { - "items": { - "$ref": "#/components/schemas/CertidaoFederalResponse" - }, - "type": "array", - "title": "Certidoes Federais", - "default": [] + ], + "title": "Data Emissao" + } + }, + "type": "object", + "title": "NfseDps" + }, + "NfseEmitente": { + "properties": { + "razao_social": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Razao Social" }, - "cnir": { + "cpf_cnpj": { "anyOf": [ { - "$ref": "#/components/schemas/CnirResponse" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Cpf Cnpj" }, - "lista_suja": { + "inscricao_municipal": { "anyOf": [ { - "$ref": "#/components/schemas/ListaSujaResponse" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Inscricao Municipal" }, - "embargos_ibama": { + "situacao_simples_nacional": { "anyOf": [ { - "$ref": "#/components/schemas/EmbargoIbamaResponse" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Situacao Simples Nacional" }, - "car": { + "regime_especial_tributacao": { "anyOf": [ { - "$ref": "#/components/schemas/CARResponse" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Regime Especial Tributacao" }, - "cadin": { + "endereco": { "anyOf": [ { - "$ref": "#/components/schemas/CADINResponse" + "$ref": "#/components/schemas/NfseEndereco" }, { "type": "null" @@ -4682,54 +4847,830 @@ } }, "type": "object", - "required": [ - "request_id", - "document" - ], - "title": "ProducerProfile", - "examples": [ - { - "document": "12345678000195", - "inscricoes_estaduais": { - "document": "12345678000195", - "document_type": "cnpj", - "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "results": [ - { - "results": [ - { - "inscricao_estadual": "13.234.567-6", - "razao_social": "JOAO DA SILVA FAZENDA SANTA MARIA" - } - ], - "source_status": { - "status": "success" - }, - "uf": "MT" - } - ] - }, - "receita_federal": { - "cached": false, - "cnpj": "12345678000195", - "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "result": { - "razao_social": "AGROPECUARIA BOA VISTA LTDA" - }, - "source_status": { - "status": "success" - } - }, - "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" - } - ] + "title": "NfseEmitente" }, - "RejeicaoDetailResponse": { + "NfseEndereco": { "properties": { - "codigo": { - "type": "integer", - "title": "Codigo" - }, + "logradouro": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Logradouro" + }, + "numero": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Numero" + }, + "complemento": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Complemento" + }, + "bairro": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Bairro" + }, + "cep": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Cep" + }, + "municipio": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Municipio" + }, + "uf": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Uf" + } + }, + "type": "object", + "title": "NfseEndereco" + }, + "NfsePessoa": { + "properties": { + "cpf_cnpj": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Cpf Cnpj" + }, + "inscricao_municipal": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Inscricao Municipal" + }, + "nome": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Nome" + } + }, + "type": "object", + "title": "NfsePessoa" + }, + "NfseResponse": { + "properties": { + "request_id": { + "type": "string", + "title": "Request Id" + }, + "chave": { + "type": "string", + "title": "Chave" + }, + "numero_nfse": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Numero Nfse", + "description": "Número da NFS-e (da chave)" + }, + "codigo_municipio_emissor": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Codigo Municipio Emissor", + "description": "Código IBGE do município emissor (da chave)" + }, + "data_geracao": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Data Geracao" + }, + "versao": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Versao" + }, + "dps": { + "anyOf": [ + { + "$ref": "#/components/schemas/NfseDps" + }, + { + "type": "null" + } + ] + }, + "situacao": { + "anyOf": [ + { + "$ref": "#/components/schemas/NfseSituacao" + }, + { + "type": "null" + } + ] + }, + "emitente": { + "anyOf": [ + { + "$ref": "#/components/schemas/NfseEmitente" + }, + { + "type": "null" + } + ] + }, + "tomador": { + "anyOf": [ + { + "$ref": "#/components/schemas/NfsePessoa" + }, + { + "type": "null" + } + ] + }, + "intermediario": { + "anyOf": [ + { + "$ref": "#/components/schemas/NfsePessoa" + }, + { + "type": "null" + } + ] + }, + "servico": { + "anyOf": [ + { + "$ref": "#/components/schemas/NfseServico" + }, + { + "type": "null" + } + ] + }, + "tributacao_municipal": { + "anyOf": [ + { + "$ref": "#/components/schemas/NfseTributacaoMunicipal" + }, + { + "type": "null" + } + ] + }, + "tributacao_federal": { + "anyOf": [ + { + "$ref": "#/components/schemas/NfseTributacaoFederal" + }, + { + "type": "null" + } + ] + }, + "total_tributos": { + "items": { + "$ref": "#/components/schemas/NfseTributoTotal" + }, + "type": "array", + "title": "Total Tributos", + "default": [] + }, + "informacoes_complementares": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Informacoes Complementares" + }, + "ambiente_gerador": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Ambiente Gerador" + }, + "cached": { + "type": "boolean", + "title": "Cached", + "description": "True quando a resposta veio do cache (TTL configurável)" + }, + "danfse_pdf_base64": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Danfse Pdf Base64", + "description": "PDF do DANFSe em base64 (só com danfse=true)" + }, + "aviso": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Aviso", + "description": "Presente quando o PDF pedido não pôde ser obtido" + } + }, + "type": "object", + "required": [ + "request_id", + "chave", + "cached" + ], + "title": "NfseResponse" + }, + "NfseServico": { + "properties": { + "pais": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Pais" + }, + "municipio": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Municipio" + }, + "codigo_tributacao_nacional": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Codigo Tributacao Nacional" + }, + "descricao_codigo": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Descricao Codigo" + }, + "item_nbs": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Item Nbs" + }, + "descricao": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Descricao" + } + }, + "type": "object", + "title": "NfseServico" + }, + "NfseSituacao": { + "properties": { + "codigo": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Codigo", + "description": "Ex.: 100" + }, + "descricao": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Descricao", + "description": "Ex.: NFS-e Gerada" + } + }, + "type": "object", + "title": "NfseSituacao" + }, + "NfseTributacaoFederal": { + "properties": { + "situacao_pis_cofins": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Situacao Pis Cofins" + }, + "base_calculo_pis_cofins": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Base Calculo Pis Cofins" + }, + "aliquota_pis": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Aliquota Pis" + }, + "valor_pis": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Valor Pis" + }, + "aliquota_cofins": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Aliquota Cofins" + }, + "valor_cofins": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Valor Cofins" + }, + "irrf": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Irrf" + }, + "contribuicoes_sociais_retidas": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Contribuicoes Sociais Retidas" + }, + "contribuicao_previdenciaria_retida": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Contribuicao Previdenciaria Retida" + } + }, + "type": "object", + "title": "NfseTributacaoFederal" + }, + "NfseTributacaoMunicipal": { + "properties": { + "tributacao_issqn": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Tributacao Issqn" + }, + "municipio_incidencia": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Municipio Incidencia" + }, + "valor_servico": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Valor Servico" + }, + "desconto_incondicionado": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Desconto Incondicionado" + }, + "deducoes": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Deducoes" + }, + "beneficio_municipal": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Beneficio Municipal" + }, + "base_calculo": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Base Calculo" + }, + "aliquota": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Aliquota", + "description": "Percentual (2.5 = 2,5%)" + }, + "valor_issqn": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Valor Issqn" + }, + "retencao": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Retencao" + } + }, + "type": "object", + "title": "NfseTributacaoMunicipal" + }, + "NfseTributoTotal": { + "properties": { + "descricao": { + "type": "string", + "title": "Descricao" + }, + "valor": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Valor" + } + }, + "type": "object", + "required": [ + "descricao" + ], + "title": "NfseTributoTotal" + }, + "ProducerProfile": { + "properties": { + "request_id": { + "type": "string", + "title": "Request Id" + }, + "document": { + "type": "string", + "title": "Document" + }, + "receita_federal": { + "anyOf": [ + { + "$ref": "#/components/schemas/CNPJResponse" + }, + { + "type": "null" + } + ] + }, + "inscricoes_estaduais": { + "anyOf": [ + { + "$ref": "#/components/schemas/CrossStateResponse" + }, + { + "type": "null" + } + ] + }, + "cnd_estaduais": { + "anyOf": [ + { + "$ref": "#/components/schemas/CrossStateCNDResponse" + }, + { + "type": "null" + } + ] + }, + "certidoes_federais": { + "items": { + "$ref": "#/components/schemas/CertidaoFederalResponse" + }, + "type": "array", + "title": "Certidoes Federais", + "default": [] + }, + "cnir": { + "anyOf": [ + { + "$ref": "#/components/schemas/CnirResponse" + }, + { + "type": "null" + } + ] + }, + "lista_suja": { + "anyOf": [ + { + "$ref": "#/components/schemas/ListaSujaResponse" + }, + { + "type": "null" + } + ] + }, + "embargos_ibama": { + "anyOf": [ + { + "$ref": "#/components/schemas/EmbargoIbamaResponse" + }, + { + "type": "null" + } + ] + }, + "car": { + "anyOf": [ + { + "$ref": "#/components/schemas/CARResponse" + }, + { + "type": "null" + } + ] + }, + "cadin": { + "anyOf": [ + { + "$ref": "#/components/schemas/CADINResponse" + }, + { + "type": "null" + } + ] + } + }, + "type": "object", + "required": [ + "request_id", + "document" + ], + "title": "ProducerProfile", + "examples": [ + { + "document": "12345678000195", + "inscricoes_estaduais": { + "document": "12345678000195", + "document_type": "cnpj", + "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "results": [ + { + "results": [ + { + "inscricao_estadual": "13.234.567-6", + "razao_social": "JOAO DA SILVA FAZENDA SANTA MARIA" + } + ], + "source_status": { + "status": "success" + }, + "uf": "MT" + } + ] + }, + "receita_federal": { + "cached": false, + "cnpj": "12345678000195", + "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "result": { + "razao_social": "AGROPECUARIA BOA VISTA LTDA" + }, + "source_status": { + "status": "success" + } + }, + "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" + } + ] + }, + "RejeicaoDetailResponse": { + "properties": { + "codigo": { + "type": "integer", + "title": "Codigo" + }, "titulo": { "type": "string", "title": "Titulo" @@ -5537,13 +6478,31 @@ "opcoes_periodos_anteriores": { "type": "string", "title": "Opcoes Periodos Anteriores", + "description": "'Não Existem' ou os períodos por extenso, separados por '; '", "default": "" }, + "opcoes_periodos_anteriores_lista": { + "items": { + "$ref": "#/components/schemas/SimplesNacionalPeriodoAnterior" + }, + "type": "array", + "title": "Opcoes Periodos Anteriores Lista", + "default": [] + }, "enquadramentos_simei_periodos_anteriores": { "type": "string", "title": "Enquadramentos Simei Periodos Anteriores", + "description": "'Não Existem' ou os períodos por extenso, separados por '; '", "default": "" }, + "enquadramentos_simei_periodos_anteriores_lista": { + "items": { + "$ref": "#/components/schemas/SimplesNacionalPeriodoAnterior" + }, + "type": "array", + "title": "Enquadramentos Simei Periodos Anteriores Lista", + "default": [] + }, "eventos_futuros_simples": { "type": "string", "title": "Eventos Futuros Simples", @@ -5563,6 +6522,30 @@ "type": "object", "title": "SimplesNacionalMaisInfo" }, + "SimplesNacionalPeriodoAnterior": { + "properties": { + "data_inicial": { + "type": "string", + "title": "Data Inicial" + }, + "data_final": { + "type": "string", + "title": "Data Final" + }, + "detalhamento": { + "type": "string", + "title": "Detalhamento", + "description": "Motivo do fim do período, como a Receita informa (ex.: 'Excluída por Opção do Contribuinte')" + } + }, + "type": "object", + "required": [ + "data_inicial", + "data_final", + "detalhamento" + ], + "title": "SimplesNacionalPeriodoAnterior" + }, "SimplesNacionalResponse": { "properties": { "request_id": { @@ -5874,6 +6857,10 @@ "name": "NF-e XML", "description": "XML da NF-e pela chave de acesso, com o seu certificado digital ou sem certificado." }, + { + "name": "NFS-e", + "description": "NFS-e do padrão nacional pela chave de acesso, sem certificado digital, com o PDF do DANFSe opcional." + }, { "name": "Saldo", "description": "Saldo restante da conta."