Nota Fiscal Eletronica de Consumidor Final
API para geração e emissão de NFC-e.
Veja a relação completa dos campos
Ambiente
|
https://api.cloud-dfe.com.br/v1
https://hom.api.cloud-dfe.com.br/v1
|
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/nfce
Criação/Envio
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"natureza_operacao": "VENDA DENTRO DO ESTADO",
"serie": "1",
"numero": "1035",
"data_emissao": "2020-10-15T03:00:00-03:00",
"presenca_comprador": "9",
"destinatario": {
"cnpj": "15493535500128",
"nome": "EMPRESA MODELO",
"indicador_inscricao_estadual": "1",
"inscricao_estadual": "212055510",
"endereco": {
"logradouro": "AVENIDA TESTE",
"numero": "444",
"bairro": "CENTRO",
"codigo_municipio": "2408003",
"nome_municipio": "Mossoro",
"uf": "RN",
"cep": "59653120",
"codigo_pais": "1058",
"nome_pais": "BRASIL",
"telefone": "8499995555"
}
},
"itens": [
{
"numero_item": "1",
"codigo_produto": "000297",
"descricao": "SAL GROSSO 50KGS",
"codigo_ncm": "55110011",
"cfop": "5102",
"unidade_comercial": "SC",
"quantidade_comercial": 10,
"valor_unitario_comercial": "22.45",
"valor_bruto": "224.50",
"unidade_tributavel": "SC",
"quantidade_tributavel": "10.00",
"valor_unitario_tributavel": "22.45",
"origem": "0",
"inclui_no_total": "1",
"imposto": {
"valor_aproximado_tributos": 9.43,
"icms": {
"situacao_tributaria": "102",
"modalidade_base_calculo": "3",
"valor_base_calculo": "0.00",
"modalidade_base_calculo_st": "4",
"aliquota_reducao_base_calculo": "0.00",
"aliquota": "0.00",
"aliquota_final": "0.00",
"valor": "0.00",
"aliquota_margem_valor_adicionado_st": "0.00",
"aliquota_reducao_base_calculo_st": "0.00",
"valor_base_calculo_st": "0.00",
"aliquota_st": "0.00",
"valor_st": "0.00"
},
"pis": {
"situacao_tributaria": "01",
"valor_base_calculo": 224.5,
"aliquota": "1.65",
"valor": "3.70"
},
"cofins": {
"situacao_tributaria": "01",
"valor_base_calculo": 224.5,
"aliquota": "7.60",
"valor": "17.06"
}
},
"valor_desconto": 0,
"valor_frete": 0,
"valor_seguro": 0,
"valor_outras_despesas": 0,
"informacoes_adicionais_item": "Valor aproximado tributos R$: 9,43 (4,20%) Fonte: IBPT"
}
],
"frete": {
"modalidade_frete": "0",
"volumes": [
{
"quantidade": "10",
"especie": null,
"marca": "TESTE",
"numero": null,
"peso_liquido": 500,
"peso_bruto": 500
}
]
},
"pagamento": {
"formas_pagamento": [
{
"meio_pagamento": "01",
"valor": "224.50",
"tipo_integracao": "2"
}
]
},
"informacoes_adicionais_contribuinte": "PV: 3325 * Rep: DIRETO * Motorista: * Forma Pagto: 04 DIAS * teste de observação para a nota fiscal * Valor aproximado tributos R$9,43 (4,20%) Fonte: IBPT",
"pessoas_autorizadas": [
{
"cnpj": "96256273000170"
}, {
"cnpj": "80681257000195"
}
]
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 100,
"mensagem": "Autorizado o uso do NF-e",
"chave": "50190813188739000110650010000012001581978549",
"xml": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ...VByb2M+", // BASE 64
"pdf": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYA+...GCg==", // BASE 64
"data_hora_evento": "2019-08-30 11:25:22",
"protocolo": "150190003925457",
"status": "autorizado", // autorizado ou cancelado
"numero": "1200",
"serie": "1"
}
|
200 |
{
"sucesso": false,
"codigo": CODIGO,
"mensagem": MENSAGEM,
"chave": "50190813188739000110650010000012001581978549"
}
|
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/nfce/{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 do NF-e",
"chave": "50190813188739000110650010000012001581978549",
"xml": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ...VByb2M+", // BASE 64
"pdf": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYA+...GCg==", // BASE 64
"data_hora_evento": "2019-08-30 11:25:22",
"protocolo": "150190003925457",
"status": "autorizado", // autorizado ou cancelado
"numero": "1200",
"serie": "1",
"xml_carta_correcao": "PHByb2NFdmVudG9ORmUgeG1sbnM9...b05GZT4=", // BASE 64
"pdf_carta_correcao":"JVBERi0xLjMKMyAwIG9iago8PC9Ue...RU9GCg==" // 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/nfce/pdf/{chave}
Gera o DANFCe
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/nfce/status
Status do Serviço
Parameters
Name | Description |
---|---|
body
(body)
|
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": "107",
"mensagem": "Servico em Operacao",
"tempo_medio": 1
}
|
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/nfce/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/nfce/busca
Busca um NFCe
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"numero_inicial": 1210,
"numero_final": 1210,
"serie": 1,
"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": [
"50191113188739000110650010000012141581978541"
]
}
|
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/nfce/cancela
Cancelamento
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"chave": "50191213188739000110650010000012151581978542",
"justificativa": "Teste de cancelamento de nfce"
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": "101",
"mensagem": "Homologado o cancelamento da NF-e",
"data_hora_evento": "2019-09-16 17:18:48",
"protocolo": "141190000844226",
"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/nfce/inutiliza
Inutilização
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"serie": "10",
"justificativa": "Teste de inutilizacao de nfce",
"numero_inicial": "50",
"numero_final": "50"
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": "135",
"mensagem": "Inutilizacao de numero homologado",
"protocolo": "141190000844206",
"serie": "10",
"numero_inicial": "50",
"numero_final": "50",
"xml": "PGVudjpFbnZlbG9wZSB4bWxuczplbnY...bG9wZT4=" // 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/nfce/offline
Solicita o processamente de envio de documentos emitidos offline
Parameters
Name | Description |
---|---|
body
(body)
|
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": "1001",
"mensagem": "Total de 1 documentos processados.",
"docs": [
{
"sucesso": true,
"codigo": 100,
"mensagem": "Autorizado o uso da NF-e",
"chave": "41190822545265000108650000000000011175078536"
}
]
}
|
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/nfce/substitui
Cancelamento por substituição
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"chave": "50191213188739000110650010000012151581978542",
"justificativa": "Teste de cancelamento de nfce",
"protocolo": "150190003925457",
"chave_referenciada": "50191213188739000110650010000012161581978549"
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": "101",
"mensagem": "Homologado o cancelamento da NF-e",
"data_hora_evento": "2019-09-16 17:18:48",
"protocolo": "141190000844226",
"xml": "PGVudjpFbnZlbG9wZSB4bWxuczplbnY9J2h...cGU+" // 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/nfce/preview
Gera a pré-visualização do PDF do documento fiscal
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"natureza_operacao": "VENDA DENTRO DO ESTADO",
"serie": "1",
"numero": "1035",
"data_emissao": "2020-10-15T03:00:00-03:00",
"presenca_comprador": "9",
"destinatario": {
"cnpj": "15493535500128",
"nome": "EMPRESA MODELO",
"indicador_inscricao_estadual": "1",
"inscricao_estadual": "212055510",
"endereco": {
"logradouro": "AVENIDA TESTE",
"numero": "444",
"bairro": "CENTRO",
"codigo_municipio": "2408003",
"nome_municipio": "Mossoro",
"uf": "RN",
"cep": "59653120",
"codigo_pais": "1058",
"nome_pais": "BRASIL",
"telefone": "8499995555"
}
},
"itens": [
{
"numero_item": "1",
"codigo_produto": "000297",
"descricao": "SAL GROSSO 50KGS",
"codigo_ncm": "55110011",
"cfop": "5102",
"unidade_comercial": "SC",
"quantidade_comercial": 10,
"valor_unitario_comercial": "22.45",
"valor_bruto": "224.50",
"unidade_tributavel": "SC",
"quantidade_tributavel": "10.00",
"valor_unitario_tributavel": "22.45",
"origem": "0",
"inclui_no_total": "1",
"imposto": {
"valor_aproximado_tributos": 9.43,
"icms": {
"situacao_tributaria": "102",
"modalidade_base_calculo": "3",
"valor_base_calculo": "0.00",
"modalidade_base_calculo_st": "4",
"aliquota_reducao_base_calculo": "0.00",
"aliquota": "0.00",
"aliquota_final": "0.00",
"valor": "0.00",
"aliquota_margem_valor_adicionado_st": "0.00",
"aliquota_reducao_base_calculo_st": "0.00",
"valor_base_calculo_st": "0.00",
"aliquota_st": "0.00",
"valor_st": "0.00"
},
"pis": {
"situacao_tributaria": "01",
"valor_base_calculo": 224.5,
"aliquota": "1.65",
"valor": "3.70"
},
"cofins": {
"situacao_tributaria": "01",
"valor_base_calculo": 224.5,
"aliquota": "7.60",
"valor": "17.06"
}
},
"valor_desconto": 0,
"valor_frete": 0,
"valor_seguro": 0,
"valor_outras_despesas": 0,
"informacoes_adicionais_item": "Valor aproximado tributos R$: 9,43 (4,20%) Fonte: IBPT"
}
],
"frete": {
"modalidade_frete": "0",
"volumes": [
{
"quantidade": "10",
"especie": null,
"marca": "TESTE",
"numero": null,
"peso_liquido": 500,
"peso_bruto": 500
}
]
},
"pagamento": {
"formas_pagamento": [
{
"meio_pagamento": "01",
"valor": "224.50",
"tipo_integracao": "2"
}
]
},
"informacoes_adicionais_contribuinte": "PV: 3325 * Rep: DIRETO * Motorista: * Forma Pagto: 04 DIAS * teste de observação para a nota fiscal * Valor aproximado tributos R$9,43 (4,20%) Fonte: IBPT",
"pessoas_autorizadas": [
{
"cnpj": "96256273000170"
}, {
"cnpj": "80681257000195"
}
]
}
|
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/nfce/importa
Importa para a API o documento fiscal
Parameters
Name | Description |
---|---|
body *
(body)
|
{
"xml": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYA+...GCg==" // BASE 64
}
|
Responses
Code | Description |
200 |
Sucesso {
"sucesso": true,
"codigo": 1001,
"mensagem": "Sucesso. A NFC-e chave: 50191213188739000110650010000012151581978542 foi inserida na base de dados."
}
|
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"
}
]
}
|