Nota Fiscal de Serviço Eletronica
API para geração e emissão de NFS-e.
Ambiente
|
https://api.cloud-dfe.com.br/v1
https://hom.api.cloud-dfe.com.br/v1
|
Provedor
|
|
|
Nota: Este provedor opera em modo Assincrono e requer 2 requisiçõesRequisição 1: Envie a NFS-e utilizando o método /nfseRequisição 2: No retorno do envio será devolvido o código 5023 deve ser realizado a consulta da NFS-e utilizando o método /nfse/{chave} (Esta chave é retornada no uso da requisição 1) |
Comunicação
Clique para ver o exemplo
|
|
Você pode usar nosso SDK feito em PHP para otimizar o processo de integração, assim ira ganhar tempo e mais praticidade
https://github.com/cloud-dfe/sdk-php
Faça o download da coleção do POSTMAN com todos os endpoints já configurados e com exemplos funcionais
POST/nfse
Criação/Envio
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"numero": 1,
"serie": "0",
"tipo": "3",
"emissor_rps": 1,
"natureza_operacao": "1",
"data_emissao": "2017-12-27T17:43:14-03:00",
"data_competencia": "2017-12-27",
"regime_tributacao": "5",
"incentivador_cultural": "true",
"incentivo_fiscal": "true",
"status": "1",
"substituicao": true,
"nfse_substituido": 1234,
"tomador": {
"cnpj": "28586684000174",
"cpf": null,
"documento_estrangeiro": null,
"tipo_documento_estrangeiro": null,
"im": null,
"ie": null,
"razao_social": "EMPRESA DE TESTE",
"telefone": "1111111111111",
"email": "contato@minhaempresa.com.br",
"endereco": {
"bairro": "Jardim America",
"cep": "81530900",
"codigo_municipio": "4119905",
"nome_municipio": "MUNICIPIO DE TESTE",
"nome_pais": "BRASIL",
"logradouro": "Rua ABC",
"numero": "16",
"uf": "PR"
}
},
"servico": {
"codigo": "11.01",
"codigo_tributacao_municipio": "10500",
"codigo_cnae": "6319400",
"discriminacao": "Exemplo Serviço",
"codigo_municipio": "4119905",
"valor_servicos": "1.00",
"valor_deducoes": "1.00",
"justificativa_deducoes": "justificativa",
"aliquota_pis": "1.00",
"valor_pis": "1.00",
"aliquota_cofins": "1.00",
"valor_cofins": "1.00",
"aliquota_inss": "1.00",
"valor_inss": "1.00",
"aliquota_ir": "1.00",
"valor_ir": "1.00",
"aliquota_csll": "1.00",
"valor_csll": "1.00",
"valor_iss": "1.00",
"iss_retido": "false",
"valor_iss_retido": "1.00",
"exigibilidade_iss": "1",
"valor_base_calculo": "1.00",
"valor_outras": "1.00",
"valor_aliquota": "1.00",
"valor_liquido": "1.00",
"valor_previdencia_social": "0.00",
"valor_desconto_condicionado": "1.00",
"valor_desconto_incondicionado": "1.00",
"tipo_deducao": "1",
"descricao_deducao": "descricao",
"valor_carga_tributaria": "1.00",
"percentual_carga_tributaria": "0.20",
"fonte_carga_tributaria": "IBPT"
},
"intermediario": {
"cnpj": "28586684000174",
"im": "00000000",
"razao_social": "EMPRESA DE TESTE",
"iss_retido": "false",
"email": "contato@minhaempresa.com.br"
},
"obra": {
"codigo": "2222",
"art": "1111",
"numero_matricula": "123456",
"numero_encapsulamento": "002244"
},
"orgaogerador": {
"codigom_unicipio": "41222567",
"uf": "PR"
},
"informacoes_complementares": "informe aqui"
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 100,
"mensagem": "Autorizado o uso da NFS-e",
"status": "Autorizado",
"numero": "10015",
"rps_numero": "10015",
"rps_serie": "10",
"chave": "4104808200119822266000148000000011008",
"codigo_verificacao": "82 55 B2",
"data_hora_evento": "2019-08-30 11:25:22",
"xml": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ...VByb2M+", // BASE 64
"pdf": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QY...T0YK", // BASE 64
// Alguns provedores não devolvem essa URL para ver o PDF pelo site deles
"link_pdf": "https://nfe.prefeitura.sp.gov.br/contribuinte/notaprint.aspx?inscricao=57962227&nf=171&verificacao=URKIUIYG"
}
|
200 |
{
"sucesso": true,
"codigo": 5023,
"mensagem": "Lote em processamento, aguarde e tente novamente mais tarde.",
"chave": "4104808200119822266000148000000011008"
}
|
200 |
{
"sucesso": false,
"codigo": CODIGO,
"mensagem": MENSAGEM,
"chave": "4104808200119822266000148000000011008"
}
|
200 |
{
"sucesso": false,
"codigo": 5001,
"mensagem": "JSON com erros nos campos",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
200 |
{
"sucesso": false,
"codigo": 5002,
"mensagem": "Erros na geração do XML.",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
GET/nfse/{chave}
Consulta o documento pela chave de acesso em nosso banco de dados
Parameters
Name | Description |
---|---|
body
(body)
|
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 100,
"mensagem": "Autorizado o uso da NFS-e",
"status": "Autorizado",
"numero": "10015",
"rps_numero": "10015",
"rps_serie": "10",
"chave": "4104808200119822266000148000000011008",
"codigo_verificacao": "82 55 B2",
"data_hora_evento": "2019-08-30 11:25:22",
"xml": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ...VByb2M+", // BASE 64
"pdf": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QY...T0YK", // BASE 64
// Alguns provedores não devolvem essa URL para ver o PDF pelo site deles
"link_pdf": "https://nfe.prefeitura.sp.gov.br/contribuinte/notaprint.aspx?inscricao=57962227&nf=171&verificacao=URKIUIYG"
}
|
200 |
{
"sucesso": true,
"codigo": 5023,
"mensagem": "Lote em processamento, aguarde e tente novamente mais tarde.",
"chave": "4104808200119822266000148000000011008"
}
|
200 |
{
"sucesso": false,
"codigo": CODIGO,
"mensagem": MENSAGEM
}
|
200 |
{
"sucesso": false,
"codigo": 5001,
"mensagem": "JSON com erros nos campos",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
200 |
{
"sucesso": false,
"codigo": 5002,
"mensagem": "Erros na geração do XML.",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
GET/nfse/pdf/{chave}
Gera o DANFSe em PDF
Parameters
Name | Description |
---|---|
body
(body)
|
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 1001,
"mensagem": "Sucesso.",
"pdf": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYA+...GCg==" // BASE 64
}
|
200 |
{
"sucesso": false,
"codigo": CODIGO,
"mensagem": MENSAGEM
}
|
200 |
{
"sucesso": false,
"codigo": 5001,
"mensagem": "JSON com erros nos campos",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
200 |
{
"sucesso": false,
"codigo": 5002,
"mensagem": "Erros na geração do XML.",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
GET/nfse/info/{ibge}
Consulta os campos com diferentes valores de prenchimento do provedor que atende a cidade
Parameters
Name | Description |
---|---|
body
(body)
|
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 1000,
"mensagem": "Provedor encontrado.",
"info": {
"nome": "Publica",
"sincrono": true,
"autenticacao": [],
"cancela": 1,
"certificado": 1,
"homologacao": 0,
"campos": {
"regime_tributacao": {
"existe": false,
"obrigatorio": false,
"opcoes": [
{
"valor": "",
"descricao": "Nenhum"
}
]
},
"natureza_operacao": {
"existe": true,
"obrigatorio": true,
"opcoes": [
{
"valor": "1",
"descricao": "ISS devido para Município de Canoinhas"
},
{
"valor": "2",
"descricao": "Tributação fora do Município"
},
{
"valor": "3",
"descricao": "Isento"
},
{
"valor": "4",
"descricao": "Imune"
},
{
"valor": "9",
"descricao": "ISS retido pelo tomador"
},
{
"valor": "10",
"descricao": "ISS Fixo"
},
{
"valor": "11",
"descricao": "ISS devido para Município de Canoinhas (Simples Nacional)"
},
{
"valor": "12",
"descricao": "ISS devido para outro Município ( Simples Nacional )"
},
{
"valor": "13",
"descricao": "MEI"
},
{
"valor": "14",
"descricao": "ISS retido pelo tomador ( Simples Nacional )"
},
{
"valor": "15",
"descricao": "Não Incidência"
},
{
"valor": "16",
"descricao": "Isenção SEI"
},
{
"valor": "17",
"descricao": "ISS Retido pela Prefeitura"
},
{
"valor": "18",
"descricao": "ISS Retido pela Prefeitura (Simples Nacional)"
},
{
"valor": "19",
"descricao": "Serviço imune, isento ou não tributado"
},
{
"valor": "20",
"descricao": "ISS Nota Fiscal Avulsa Eletrônica"
}
]
},
"responsavel_retencao": {
"existe": false,
"obrigatorio": false,
"opcoes": [
{
"valor": "",
"descricao": "Nenhum"
}
]
},
"exigibilidade_iss": {
"existe": false,
"obrigatorio": false,
"opcoes": [
{
"valor": "",
"descricao": "Nenhum"
}
]
},
"codigo_cancelamento": {
"existe": true,
"obrigatorio": true,
"opcoes": [
{
"valor": "C001",
"descricao": "Dados do tomador incorretos"
},
{
"valor": "C002",
"descricao": "Erro na descrição do serviço"
},
{
"valor": "C003",
"descricao": "Erro no valor do serviço"
},
{
"valor": "C004",
"descricao": "Natureza da Operação e/ou Código do Item da Lista incorreto"
},
{
"valor": "C005",
"descricao": "Informações de descontos/outros tributos incorretas"
},
{
"valor": "C999",
"descricao": "Outros"
}
]
},
"tomador": {
"required": false,
"type": [
"object",
"null"
],
"properties": {
"cnpj": {
"required": false,
"type": [
"string",
"null"
],
"$ref": "#/definitions/cnpj",
"description": "CNPJ do Tomador do Serviço",
"options": "Apenas numeros sem simbolos."
},
"cpf": {
"required": false,
"type": [
"string",
"null"
],
"$ref": "#/definitions/cpf",
"description": "CPF do Tomador do Serviço",
"options": "Apenas numeros sem simbolos."
},
"razao_social": {
"required": false,
"type": [
"string",
"null"
],
"pattern": "^.{1,115}$",
"description": "Razão Social do Tomador do Serviço",
"options": "1 a 115 caracteres"
},
"im": {
"required": false,
"type": [
"string",
"null"
],
"maxLength": 15,
"description": "Inscrição Municipal do Tomador do Serviço",
"options": "Este elemento só deverá ser preenchido para tomadores cadastrados no município."
},
"telefone": {
"required": false,
"type": [
"string",
"null"
],
"pattern": "^.{1,20}$",
"description": "Número do telefone do Tomador do Serviço",
"options": "1 a 20 digitos"
},
"email": {
"required": false,
"type": [
"string",
"null"
],
"$ref": "#/definitions/email",
"description": "Email do Tomador do Serviço",
"options": "1 a 60 caracteres"
},
"endereco": {
"required": false,
"type": [
"object",
"null"
],
"properties": {
"logradouro": {
"required": false,
"type": [
"string",
"null"
],
"pattern": "^.{1,125}$",
"description": "Rua (Logradouro) do Tomador do Serviço",
"options": "1 a 125 caracteres"
},
"numero": {
"required": false,
"type": [
"string",
"null"
],
"maxLength": 10,
"description": "Número do Endereço do Tomador do Serviço",
"options": "1 a 10 caracteres"
},
"complemento": {
"required": false,
"type": [
"string",
"null"
],
"pattern": "^.{1,60}$",
"description": "Complemento do Endereço do Tomador do Serviço",
"options": "1 a 60 caracteres"
},
"bairro": {
"required": false,
"type": [
"string",
"null"
],
"pattern": "^.{1,60}$",
"description": "Bairro do Endereço do Tomador do Serviço",
"options": "1 a 60 caracteres"
},
"codigo_municipio": {
"required": false,
"type": [
"string",
"null"
],
"$ref": "#/definitions/ibge",
"description": "Código IBGE do Municipio do Endereço do Tomador do Serviço",
"options": "7 digitos"
},
"uf": {
"required": false,
"type": [
"string",
"null"
],
"$ref": "#/definitions/siglauf",
"description": "Sigla do Estado do Endereço do Tomador do Serviço",
"options": "Se EXPORTAÇÃO indicar \"EX\""
},
"codigo_pais": {
"required": false,
"type": [
"string",
"null"
],
"pattern": "^[0-9]{4}$",
"description": "Codigo do País (BACEN) do Endereço do Tomador do Serviço",
"options": "Indicar apenas se for uma EXPORTAÇÃO de SERVIÇO. Numero com 4 digitos."
},
"cep": {
"required": false,
"type": [
"string",
"null"
],
"$ref": "#/definitions/cep",
"description": "Codigo Postal do Tomador do Serviço",
"options": "Se exportação Não passar esse dado ou deixe null"
},
"nome_municipio": {
"required": false,
"type": [
"string",
"null"
],
"pattern": "^.{1,60}$",
"description": "Descrição do Municipio do Endereço do Tomador do Serviço",
"options": "1 a 60 caracteres"
}
}
}
}
},
"servico": {
"required": true,
"type": "object",
"properties": {
"iss_retido": {
"required": false,
"type": [
"boolean",
"null"
],
"description": "ISS foi retido",
"options": "true - SIM; false - Não (ocorre apenas quando o serviço realizado fora do municipio, vide legislação)"
},
"codigo": {
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9.-]{1,5}$",
"description": "Código do serviço prestado Item da LC 116/2003",
"options": "1 à 5 caracteres alfa-numericos ex. \"7.23\""
},
"descricao": {
"required": false,
"type": [
"string",
"null"
],
"maxLength": 60,
"description": "Descrição do serviço",
"options": "1 a 60 caracteres;Usado para mostrar no PDF a descrição do código do serviço"
},
"discriminacao": {
"required": true,
"type": "string",
"maxLength": 2000,
"description": "Discriminação dos serviços",
"options": "1 à 2000 caracteres. Evite usar acentos e simbolos.;Para quebra de linha use \\n ou ponto e virgula"
},
"codigo_municipio": {
"required": false,
"type": [
"string",
"null"
],
"pattern": "^[0-9]{7}$",
"description": "Código IBGE do município onde o serviço foi prestado.",
"options": "Se o serviço foi feito em outro pais indicar 9999999. Numero com 7 digitos."
},
"codigo_pais": {
"required": false,
"type": [
"string",
"null"
],
"pattern": "^[0-9]{4}$",
"description": "Código do país onde o serviço foi prestado",
"options": "Declarar somente for fora do Brasil (Exportação). Numero com 4 digitos."
},
"valor_servicos": {
"required": true,
"type": "number",
"minimum": 0,
"description": "Valor dos serviços em R$",
"options": "Use o formato com ponto na separaçao de decimais e não use virgula ex. 100.00"
},
"valor_deducoes": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor das deduções para Redução da Base de Cálculo em R$",
"options": "ex. 100.00"
},
"valor_pis": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor da retenção do PIS em R$ Informação declaratória",
"options": "ex. 100.00"
},
"valor_cofins": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor da retenção do COFINS em R$ Informação declaratória",
"options": "ex. 100.00"
},
"valor_inss": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor da retenção do INSS em R$ Informação declaratória",
"options": "ex. 100.00"
},
"valor_ir": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor da retenção do IR em R$ Informação declaratória",
"options": "ex. 100.00"
},
"valor_csll": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor da retenção do CSLL em R$ Informação declaratória",
"options": "ex. 100.00"
},
"valor_outras": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Outras retenções na Fonte. Informação declaratória",
"options": "ex. 100.00"
},
"valor_iss": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor do ISS devido em R$",
"options": "ex. 100.00"
},
"valor_iss_retido": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor do ISS retido em R$",
"options": "ex. 100.00"
},
"valor_base_calculo": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor da Base de Calculo dos Impostos em R$",
"options": "ex. 100.00"
},
"valor_aliquota": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"maximum": 100,
"description": "Alíquota do serviço prestado",
"options": "ex. 5.00;Deve ser sempre enviado esse valor em percentual, 5% seria enviado como 5.00 e nao 0.05"
},
"valor_liquido": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor liquido da NFse",
"options": "ex. 100.00"
},
"valor_desconto_condicionado": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor do desconto condicionado",
"options": "ex. 100.00"
},
"valor_desconto_incondicionado": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor do desconto incondicionado",
"options": "ex. 100.00"
}
}
},
"cancelamento": {
"motivo_cancelamento": {
"required": true,
"type": "string",
"pattern": "^.{1,255}$",
"description": "Motivo do cancelamento",
"options": "1 a 255 caracteres"
},
"codigo_cancelamento": {
"required": true,
"type": "string",
"pattern": "^(C001|C002|C003|C004|C005)$",
"description": "Código numérico do motivo do cancelamento.",
"options": "C001 - Dados do tomador incorretos; C002 - Erro na descrição do serviço; C003 - Erro no valor do serviço; C004 - Natureza da Operação e/ou Código do Item da Lista incorreto; C005 - Informações de descontos/outros tributos incorretas; C999 - Outros"
}
}
}
}
}
|
POST/nfse/consulta
Consulta as NFSe no webservice da prefeitura
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"data_inicial": "2019-12-01", // Emissão
"data_final": "2019-12-31",
"nfse_inicial": "12",
"nfse_final": "14",
"rps_inicial": "1234",
"rps_final": "1235",
"rps_serie": "1",
"rps_tipo": "N",
"numero": 1210,
"tomador_cnpj": null,
"tomador_cpf": null,
"tomador_im": null,
"tomador_nome": null,
"tomador_estrangeiro": null,
"pagina": 1
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 1000,
"mensagem": "Sucesso.",
"notas": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ...VByb2M+" // BASE 64 + ZIP do xml
}
|
200 |
{
"sucesso": false,
"codigo": CODIGO,
"mensagem": MENSAGEM
}
|
200 |
{
"sucesso": false,
"codigo": 5001,
"mensagem": "JSON com erros nos campos",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
200 |
{
"sucesso": false,
"codigo": 5002,
"mensagem": "Erros na geração do XML.",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
POST/nfse/busca
Busca um NFSe na base de dados
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"numero_rps_inicial": 1210,
"numero_rps_final": 1210,
"serie_rps": 1,
"numero_nfse_inicial": 1210,
"numero_nfse_final": 1210,
"data_inicial": "2019-12-01", // Autorização
"data_final": "2019-12-31",
"cancel_inicial": "2019-12-01", // Cancelamento
"cancel_final": "2019-12-31"
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 1000,
"mensagem": "Sucesso. Retornados 1 de 1. (1 de 1 páginas.)",
"pagina": 1,
"total_paginas": 1,
"chaves": [
"4104808200119822266000148000000011008"
]
}
|
200 |
{
"sucesso": false,
"codigo": CODIGO,
"mensagem": MENSAGEM
}
|
200 |
{
"sucesso": false,
"codigo": 5001,
"mensagem": "JSON com erros nos campos",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
200 |
{
"sucesso": false,
"codigo": 5002,
"mensagem": "Erros na geração do XML.",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
POST/nfse/backup
Solicita um backup por email
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"ano": 2019,
"mes": 12
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 1001,
"mensagem": "Backup disponível",
"total_docs": "5",
"download": "aqui fica a url para download por 3 dias",
"disponivel_ate": "2021-04-10"
}
|
200 |
{
"sucesso": false,
"codigo": CODIGO,
"mensagem": MENSAGEM
}
|
200 |
{
"sucesso": false,
"codigo": 5001,
"mensagem": "JSON com erros nos campos",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
200 |
{
"sucesso": false,
"codigo": 5002,
"mensagem": "Erros na geração do XML.",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
POST/nfse/cancela
Cancelamento
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"chave": "50191213188739000110650010000012151581978542",
"justificativa": "justificativa do cancelamento",
"codigo_cancelamento": "1" //ERRO_EMISSAO = 1; SERVICO_NAO_CONCLUIDO = 2
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": "101",
"mensagem": "Homologado o cancelamento da NFS-e",
"data_hora_evento": "2019-09-16 17:18:48",
"xml": "PGVudjpFbnZlbG9wZSB4bWxuczplbnY9J2h...cGU+", // BASE 64
"pdf": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYA+...GCg==" // BASE 64
}
|
200 |
{
"sucesso": false,
"codigo": CODIGO,
"mensagem": MENSAGEM
}
|
200 |
{
"sucesso": false,
"codigo": 5001,
"mensagem": "JSON com erros nos campos",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
200 |
{
"sucesso": false,
"codigo": 5002,
"mensagem": "Erros na geração do XML.",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
POST/nfse/conflito
Resolve o conflito na nota fiscal
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"chave": "50191213188739000110650010000012151581978542",
"xml": "PGVudjpFbnZlbG9wZSB4bWxuczplbnY9J2h...cGU+" // BASE 64
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 100,
"mensagem": "Autorizado o uso da NFS-e",
"status": "Autorizado",
"numero": "10015",
"rps_numero": "10015",
"rps_serie": "10",
"chave": "4104808200119822266000148000000011008",
"codigo_verificacao": "82 55 B2",
"data_hora_evento": "2019-08-30 11:25:22",
"xml": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ...VByb2M+", // BASE 64
"pdf": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QY...T0YK" // BASE 64
}
|
200 |
{
"sucesso": false,
"codigo": CODIGO,
"mensagem": MENSAGEM
}
|
200 |
{
"sucesso": false,
"codigo": 5001,
"mensagem": "JSON com erros nos campos",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
200 |
{
"sucesso": false,
"codigo": 5002,
"mensagem": "Erros na geração do XML.",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
POST/nfse/preview
Gera a pré-visualização do PDF do documento fiscal
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"numero": 1,
"serie": "0",
"tipo": "3",
"emissor_rps": 1,
"natureza_operacao": "1",
"data_emissao": "2017-12-27T17:43:14-03:00",
"data_competencia": "2017-12-27",
"regime_tributacao": "5",
"incentivador_cultural": "true",
"incentivo_fiscal": "true",
"status": "1",
"substituicao": true,
"nfse_substituido": 1234,
"tomador": {
"cnpj": "28586684000174",
"cpf": null,
"documento_estrangeiro": null,
"tipo_documento_estrangeiro": null,
"im": null,
"ie": null,
"razao_social": "EMPRESA DE TESTE",
"telefone": "1111111111111",
"email": "contato@minhaempresa.com.br",
"endereco": {
"bairro": "Jardim America",
"cep": "81530900",
"codigo_municipio": "4119905",
"nome_municipio": "MUNICIPIO DE TESTE",
"nome_pais": "BRASIL",
"logradouro": "Rua ABC",
"numero": "16",
"uf": "PR"
}
},
"servico": {
"codigo": "11.01",
"codigo_tributacao_municipio": "10500",
"codigo_cnae": "6319400",
"discriminacao": "Exemplo Serviço",
"codigo_municipio": "4119905",
"valor_servicos": "1.00",
"valor_deducoes": "1.00",
"justificativa_deducoes": "justificativa",
"aliquota_pis": "1.00",
"valor_pis": "1.00",
"aliquota_cofins": "1.00",
"valor_cofins": "1.00",
"aliquota_inss": "1.00",
"valor_inss": "1.00",
"aliquota_ir": "1.00",
"valor_ir": "1.00",
"aliquota_csll": "1.00",
"valor_csll": "1.00",
"valor_iss": "1.00",
"iss_retido": "false",
"valor_iss_retido": "1.00",
"exigibilidade_iss": "1",
"valor_base_calculo": "1.00",
"valor_outras": "1.00",
"valor_aliquota": "1.00",
"valor_liquido": "1.00",
"valor_previdencia_social": "0.00",
"valor_desconto_condicionado": "1.00",
"valor_desconto_incondicionado": "1.00",
"tipo_deducao": "1",
"descricao_deducao": "descricao",
"valor_carga_tributaria": "1.00",
"percentual_carga_tributaria": "0.20",
"fonte_carga_tributaria": "IBPT"
},
"intermediario": {
"cnpj": "28586684000174",
"im": "00000000",
"razao_social": "EMPRESA DE TESTE",
"iss_retido": "false",
"email": "contato@minhaempresa.com.br"
},
"obra": {
"codigo": "2222",
"art": "1111",
"numero_matricula": "123456",
"numero_encapsulamento": "002244"
},
"orgaogerador": {
"codigom_unicipio": "41222567",
"uf": "PR"
},
"informacoes_complementares": "informe aqui"
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 1001,
"mensagem": "Sucesso.",
"pdf": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYA+...GCg==" // BASE 64
}
|
200 |
{
"sucesso": false,
"codigo": CODIGO,
"mensagem": MENSAGEM
}
|
200 |
{
"sucesso": false,
"codigo": 5001,
"mensagem": "JSON com erros nos campos",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|
200 |
{
"sucesso": false,
"codigo": 5002,
"mensagem": "Erros na geração do XML.",
"erros": [
{
"campo": "numero",
"erro": "NULL encontrado, mas uma string é obrigatório",
"descricao": "Número da nota fiscal. (nNF)",
"detalhes": "1 a 9 digitos"
}
]
}
|