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 PHP para otimizar o processo de integração, assim ira ganhar tempo e mais praticidade
POST/nfse
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": "07504505000132",
"cpf": null,
"documento_estrangeiro": null,
"tipo_documento_estrangeiro": null,
"im": null,
"ie": null,
"razao_social": "Acras Tecnologia da Informação LTDA",
"telefone": "1111111111111",
"email": "contato@acras.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": "07504505000132",
"im": "00000000",
"razao_social": "Acras Tecnologia da Informação LTDA",
"iss_retido": "false",
"email": "contato@acras.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-30T11:25:22-04:00",
"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"
}
]
}
|
GET/nfse/{chave}
Consulta NFSe na base 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-30T11:25:22-04:00",
"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"
}
]
}
|
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"
}
]
}
|
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",
"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-16T17:18:48-03:00",
"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-30T11:25:22-04:00",
"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": "07504505000132",
"cpf": null,
"documento_estrangeiro": null,
"tipo_documento_estrangeiro": null,
"im": null,
"ie": null,
"razao_social": "Acras Tecnologia da Informação LTDA",
"telefone": "1111111111111",
"email": "contato@acras.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": "07504505000132",
"im": "00000000",
"razao_social": "Acras Tecnologia da Informação LTDA",
"iss_retido": "false",
"email": "contato@acras.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"
}
]
}
|