Integra Notas - Documentação - Nota Fiscal Eletronica de Serviço

Nota Fiscal Eletronica de Serviço

Solicita o backup dos XML do período solicitado

NFS-e Nacional

Estado

Cidade

Provedor

Comunicação

Você pode usar nosso SDK feito em PHP para otimizar o processo de integração, assim ira ganhar tempo e mais praticidade

SDK PHP

Homologação

Produção

GET

Token de homologação

Request

Response

Parameters

Veja a relação completa de codigo de erros/alertas

Request

{
    "ano": 2019,
    "mes": 12,
    "emails": [
        "contato@cloud-dfe.com.br"
    ]
}

Responses - HTTP Code 200

{
    "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"
}

{
    "sucesso": false,
    "codigo": CODIGO,
    "mensagem": MENSAGEM
}

{
    "sucesso": false,
    "codigo": 5001,
    "mensagem": "JSON com erros nos campos, para mais detalhes verifique a propriedade erros",
    "erros": [
        {
            "campo": "ano",
            "erro": "NULL encontrado, mas uma string é integer",
            "descricao": "Ano ex. 2020, que deseja baixar o backup",
            "detalhes": "Somente valores maiores que 2000 serão aceitos."
        }
    ]
}

Mensagem: 2	Emissão offline.
Correção	Para fazer o processamento dos documentos offline junto a receita deve ser utilizado a rota /offline
Mensagem: 100	Documento fiscal autorizado com sucesso.
Mensagem: 101	Documento fiscal cancelado com sucesso.
Mensagem: 103	Documento fiscal encerrado com sucesso.
Mensagem: 135	Evento registrado com sucesso.
Mensagem: 205	Documento fiscal denagado.
Correção	Verifique junto a receita se existe alguma pendencia no emitente ou destinatario.
Mensagem: 110	Documento fiscal denagado.
Correção	Verifique junto a receita se existe alguma pendencia no emitente ou destinatario.
Mensagem: 301	Documento fiscal denagado.
Correção	Verifique junto a receita se existe alguma pendencia no emitente ou destinatario.
Mensagem: 302	Documento fiscal denagado.
Correção	Verifique junto a receita se existe alguma pendencia no emitente ou destinatario.
Mensagem: 0000	Estamos em manutenção. Por favor aguarde, voltamos a operar em breve.
Mensagem: 1000	Encontrou os dados solicitados.
Mensagem: 1001	Solicitação processada com sucesso.
Mensagem: 4302	Falta de permissão de redirecionamento
Correção	Entre em contato com o suporte.
Mensagem: 4400	Solicitação inválida
Correção	Requisição mal formatada, caracteres ilegais, arquivo muito grande, etc...
Mensagem: 4404	URL não encontrada
Correção	Entre em contato com o suporte.
Mensagem: 4405	Método não permitido
Correção	Entre em contato com o suporte.
Mensagem: 4406	Não aceitavel
Correção	Entre em contato com o suporte.
Mensagem: 4407	Erro na autorização de proxy
Correção	Entre em contato com o suporte.
Mensagem: 4408	Tempo limite da solicitação foi atingido
Correção	Entre em contato com o suporte.
Mensagem: 4409	Solitiação incompativel
Correção	Entre em contato com o suporte.
Mensagem: 4500	Erro interno no servidor
Correção	Entre em contato com o suporte.
Mensagem: 4503	Serviço indisponivel
Correção	Entre em contato com o suporte.
Mensagem: 4505	Versão do HTTP não suportada
Correção	Entre em contato com o suporte.
Mensagem: 4525	Falha no handshake SSL
Correção	Entre em contato com o suporte.
Mensagem: 5000	Não foi passado JSON válido. Provável erro de formatação.
Correção	Verifique o JSON pois o mesmo possui erros de estrutura.
Mensagem: 5001	JSON com erros nos dados: Mensagem invalidada. Violações:[numero_inicial] Deve ter no minimo 1
Correção	Verifique os dados que estão sendo passados pois não estão compativeis com o manual.
Mensagem: 5002	Erros durante a geração do XML
Correção	Verifique a variavel 'erros' para identificar os campos não preenchidos.
Mensagem: 5003	Certificado com falha na abertura.
Correção	O certificado pode estar corrompido ou com senha inválida.
Mensagem: 5004	Acesso Indevido! Não tem acesso a essa rota.
Correção	Voce não tem acesso ao recurso solicitado.
Mensagem: 5005	É obrigatório informar um CNPJ ou CPF
Correção	Não foi informado o campo solicitado.
Mensagem: 5006	Não encontrado(s) nenhum Certificado na base de dados.
Correção	O recurso solicitado não foi encontrado para ser processado, neste exemplo o certificado do emitente não foi configurado, pode ser qualquer outro recurso, por exemplo buscar um emitente que não exista ou um documento fiscal que não exista
Mensagem: 5007	O número da NFSe inicial incorreto(s) deve ser menor que do o número da NFSe Final!
Correção	O parâmetro informado não atende aos requisitos.
Mensagem: 5008	Esse NFC-e 'CHAVE' já existe e esta autorizada.
Correção	O documento já esta processo conforme solicitação.
Mensagem: 5009	Esse emitente 'CNPJ' já esta deletado.
Correção	O recurso já esta processo conforme solicitação.
Mensagem: 5010	Seu plano já atingiu o limite de emissoes.
Correção	Verifique o numero de emissões do seu plano.
Mensagem: 5011	Certificado com validade expirada em 12/10/2020 22:03:14
Correção	Não deixe seu certificado expirar para continuar emitindo.
Mensagem: 5014	Acesso Negado! Foi atingido o limite de emissões para o período.
Correção	Verifique o plano para continuar emitindo.
Mensagem: 5015	NF-e está cancelado.
Correção	Não é possivel fazer a ação solicitada com um documento cancelado.
Mensagem: 5017	Filtro 'X' não disponível para NFSe modelo X.
Correção	O filtro esclhido não esta disponivel para o modelo solicitado.
Mensagem: 5018	Dados incompleto(s) para para a realização de buscas
Correção	Não foi passado nenhum dado suficiente para a busca, verifique o manual.
Mensagem: 5019	Não existe o serviço de consulta de NFS-e para o provedor AMTEC
Correção	O servico solicitado não existe para esse modelo.
Mensagem: 5020	O Municipio de 'X' ainda não é atendido pelo nosso serviço. Entre em contato com o suporte.
Correção	O municipio informado não é atentido pela API.
Mensagem: 5021	Falha no envio de email
Correção	Ocorreu um erro ao fazer o envio do email.
Mensagem: 5022	Somente o resumo está disponível
Correção	Entre em contato com o suporte.
Mensagem: 5023	X - Lote em processamento, aguarde e tente novamente mais tarde.
Correção	Tente fazer a consulta pela chave de acesso novamente mais tarde.
Mensagem: 5024	MDF-e está encerrado.
Correção	Não é possivel fazer a ação solicitada com um documento encerrado.
Mensagem: 5025	NF-e está denegado.
Correção	Não é possivel fazer a ação solicitada com um documento denegado.
Mensagem: 5026	Erro ao emitir a carta de correção.
Correção	Verifique legistação da NF-e para obter mais detalhes.
Mensagem: 5027	NFS-e em CONFLITO! Não é possivel determinar se a NFS-e foi gerada. Consulte a pagina da prefeitura.
Mensagem: 5028	Nota fiscal com valor incorreto
Correção	Consulte o manual de erros deste provedor ou entre em contato com a prefeitura. Esses retornos sao exclusivos da nota fiscal de serviço e representa uma rejeição na prefeitura.
Mensagem: 5029	Certificado não pertence ao CNPJ/CPF do emitente.
Correção	Verifique se realmente esse certificado pertence a esse emiente.
Mensagem: 5030	NF-e está pendente de autorização.
Correção	Faça a consulta pela chave para sincronizar o documento.
Mensagem: 5031	Falha ao gerar o PDF.
Correção	Entre em contato com o suporte.
Mensagem: 5032	Erros durante a validação com o XSD
Correção	Mostram os erros de validação do xml na receita.
Mensagem: 5033	Documento gerado com erro! Recusado pelo autorizador.
Correção	Corrija o erro e envie novamente.
Mensagem: 5034	Autorizador não respondeu em 5 tentativas, aguardando mais 1 hora para tentar novamente.
Correção	O processo é automático.
Mensagem: 5500	Acesso Incorreto! Método não existe nessa rota
Correção	Método solicitado não existe ou verbo http inválido.
Mensagem: 5501	Voce esta tentando fazer acesso a uma rota que não existe.
Correção	Verifique na documentação as rotas e seu verbo http.
Mensagem: 6000	Falha de Autenticação! Token não informado!
Correção	Verifique o token ou entre em contato com o suporte.
Mensagem: 6001	Falha de Autenticação! Falha ao abrir o token. Possivelmente corrompido, ou copiado incorretamente.
Correção	Verifique o token ou entre em contato com o suporte.
Mensagem: 6002	Falha de Autenticação! Token inválido ou não corresponde a nenhum acesso autorizado.
Correção	Verifique o token ou entre em contato com o suporte.
Mensagem: 6003	O acesso do usuário foi bloqueado. Entre em contato com o suporte!
Correção	Verifique o token ou entre em contato com o suporte.
Mensagem: 7001	Falha de Comunicação! Protocolo não suportado
Correção	Entre em contato com o suporte.
Mensagem: 7002	Falha Interna! cURL não inicializou.
Correção	Entre em contato com o suporte.
Mensagem: 7003	Falha Interna! URL mal formada.
Correção	Entre em contato com o suporte.
Mensagem: 7004	Falha Interna! protocolo ou opção cURL não encontrada.
Correção	Entre em contato com o suporte.
Mensagem: 7005	Falha Interna! Proxy não pode ser resolvido.
Correção	Entre em contato com o suporte.
Mensagem: 7006	Falha de Comunicação! Host não encontrado.
Correção	Entre em contato com o suporte.
Mensagem: 7007	Falha de Comunicação! Falhou ao conectar.
Correção	Entre em contato com o suporte.
Mensagem: 7008	Falha de Comunicação! O servidor respondeu de forma inesperada.
Correção	Entre em contato com o suporte.
Mensagem: 7009	Falha de Comunicação! Acesso remoto negado.
Correção	Entre em contato com o suporte.
Mensagem: 7010	Falha de Comunicação! FTP não aceito.
Correção	Entre em contato com o suporte.
Mensagem: 7011	Falha de Comunicação! FTP servidor não retornou o codigo correto.
Correção	Entre em contato com o suporte.
Mensagem: 7012	Falha de Comunicação! FTP TimeOUT
Correção	Entre em contato com o suporte.
Mensagem: 7013	Falha de Comunicação! FTP servidor falho.
Correção	Entre em contato com o suporte.
Mensagem: 7014	Falha de Comunicação! FTP servidor retornou de forma incorreta.
Correção	Entre em contato com o suporte.
Mensagem: 7015	Falha Interna! host usado para a nova conexão.
Correção	Entre em contato com o suporte.
Mensagem: 7016	Falha de Comunicação! Erro genêrico HTTP2
Correção	Entre em contato com o suporte.
Mensagem: 7017	Falha de Comunicação! FTP Ao tentar modo binario ou ASCII
Correção	Entre em contato com o suporte.
Mensagem: 7018	Falha Interna! Transferência de arquivos incompleta.
Correção	Entre em contato com o suporte.
Mensagem: 7019	Falha de Comunicação! FTP resposta estranha.
Correção	Entre em contato com o suporte.
Mensagem: 7021	Falha de Comunicação! Erro ao enviar QUOTE
Correção	Entre em contato com o suporte.
Mensagem: 7022	Falha de Comunicação! Http erro >= 400
Correção	Entre em contato com o suporte.
Mensagem: 7023	Falha Interna! Erro ao gravar localmente.
Correção	Entre em contato com o suporte.
Mensagem: 7025	Falha de Comunicação! Erro no upload
Correção	Entre em contato com o suporte.
Mensagem: 7026	Falha Interna! Erro ao ler arquivo local.
Correção	Entre em contato com o suporte.
Mensagem: 7027	Falha Interna! Erro de alocação de memória. Ferrou!
Correção	Entre em contato com o suporte.
Mensagem: 7028	Falha de Comunicação! TimeOut.
Correção	Entre em contato com o suporte.
Mensagem: 7030	Falha de Comunicação! Porta FTP incorreta.
Correção	Entre em contato com o suporte.
Mensagem: 7031	Falha de Comunicação! FTP REST problemas no servidor.
Correção	Entre em contato com o suporte.
Mensagem: 7033	Falha de Comunicação! O servidor não suporta faixa de portas
Correção	Entre em contato com o suporte.
Mensagem: 7034	Falha de Comunicação! Confusão no servidor.
Correção	Entre em contato com o suporte.
Mensagem: 7035	Falha de Comunicação! Handshake SSL/TLS
Correção	Entre em contato com o suporte.
Mensagem: 7036	Falha de Comunicação! Falha de download, fora dos limites.
Correção	Entre em contato com o suporte.
Mensagem: 7037	Falha de Comunicação! Caminho nçao encontrado do arquivo.
Correção	Entre em contato com o suporte.
Mensagem: 7038	Falha de Comunicação! LDAP não pode ligar.
Correção	Entre em contato com o suporte.
Mensagem: 7039	Falha de Comunicação! LDAP pesquisa falhou.
Correção	Entre em contato com o suporte.
Mensagem: 7041	Falha Interna! função não encontrada.
Correção	Entre em contato com o suporte.
Mensagem: 7042	Falha de Comunicação! Abortada por callback
Correção	Entre em contato com o suporte.
Mensagem: 7043	Falha Interna! função com argumento incorreto.
Correção	Entre em contato com o suporte.
Mensagem: 7045	Falha Interna! Erro de interface.
Correção	Entre em contato com o suporte.
Mensagem: 7047	Falha de Comunicação! Excesso de redirecionamentos.
Correção	Entre em contato com o suporte.
Mensagem: 7048	Falha Interna! Opção desconhecida.
Correção	Entre em contato com o suporte.
Mensagem: 7049	Falha Interna! TELNET formação ilegal.
Correção	Entre em contato com o suporte.
Mensagem: 7052	Falha de Comunicação! Nada retornou do servidor.
Correção	Entre em contato com o suporte.
Mensagem: 7053	Falha de Comunicação! Modo de criptografia não encontrado.
Correção	Entre em contato com o suporte.
Mensagem: 7054	Falha Interna! Falha no modo padrão de criptografia.
Correção	Entre em contato com o suporte.
Mensagem: 7055	Falha de Comunicação! Falha no envio de dados da rede.
Correção	Entre em contato com o suporte.
Mensagem: 7056	Falha de Comunicação! Falha ao receber dados da rede.
Correção	Entre em contato com o suporte.
Mensagem: 7058	Falha Interna! Problemas com o certificado do cliente.
Correção	Entre em contato com o suporte.
Mensagem: 7059	Falha de Comunicação! Impossivel usar a cifra especificada.
Correção	Entre em contato com o suporte.
Mensagem: 7060	Falha de Comunicação! Certificado do servidor inseguro.
Correção	Entre em contato com o suporte.
Mensagem: 7061	Falha de Comunicação! Codificação de tranferência não reconhecida.
Correção	Entre em contato com o suporte.
Mensagem: 7062	Falha de Comunicação! LDAP invalido.
Correção	Entre em contato com o suporte.
Mensagem: 7063	Falha de Comunicação! Tamanho máximo excedido.
Correção	Entre em contato com o suporte.
Mensagem: 7064	Falha de Comunicação! FTP SSL falhou.
Correção	Entre em contato com o suporte.
Mensagem: 7065	Falha de Comunicação! Retranmissão falhou.
Correção	Entre em contato com o suporte.
Mensagem: 7066	Falha Interna! Erro ao inicializar SSL engine
Correção	Entre em contato com o suporte.
Mensagem: 7067	Falha de Comunicação! Login negado.
Correção	Entre em contato com o suporte.
Mensagem: 7068	Falha de Comunicação! TFTP Arquivo não encontrado.
Correção	Entre em contato com o suporte.
Mensagem: 7069	Falha de Comunicação! TFTP sem permissão.
Correção	Entre em contato com o suporte.
Mensagem: 7070	Falha de Comunicação! Sem espaço no servidor.
Correção	Entre em contato com o suporte.
Mensagem: 7071	Falha de Comunicação! TFTP operação ilegal.
Correção	Entre em contato com o suporte.
Mensagem: 7072	Falha de Comunicação! TFTP id desconhecido.
Correção	Entre em contato com o suporte.
Mensagem: 7073	Falha de Comunicação! Arquivo remoto já existe.
Correção	Entre em contato com o suporte.
Mensagem: 7074	Falha de Comunicação! TFTP nosuchuser
Correção	Entre em contato com o suporte.
Mensagem: 7075	Falha Interna! Conversão de caracter falhou
Correção	Entre em contato com o suporte.
Mensagem: 7076	Falha Interna! O chamador deve registrar os retornos na conversão.
Correção	Entre em contato com o suporte.
Mensagem: 7077	Falha Interna! CACERT BAD
Correção	Entre em contato com o suporte.
Mensagem: 7078	Falha de Comunicação! URL não existe.
Correção	Entre em contato com o suporte.
Mensagem: 7079	Falha de Comunicação! SSH erro genérico.
Correção	Entre em contato com o suporte.
Mensagem: 7080	Falha de Comunicação! SSL falhou ao desconectar.
Correção	Entre em contato com o suporte.
Mensagem: 7081	Falha de Comunicação! Socket não está pronto.
Correção	Entre em contato com o suporte.
Mensagem: 7082	Falha Interna! ao carregar CRL
Correção	Entre em contato com o suporte.
Mensagem: 7083	Falha de Comunicação! Verificação do emissor
Correção	Entre em contato com o suporte.
Mensagem: 7084	Falha de Comunicação! FTP não responde.
Correção	Entre em contato com o suporte.
Mensagem: 7085	Falha de Comunicação! Incompatibilidade RTSP CSeq
Correção	Entre em contato com o suporte.
Mensagem: 7086	Falha de Comunicação! Incompatibilidade de identificadores de sessão RTSP
Correção	Entre em contato com o suporte.
Mensagem: 7087	Falha de Comunicação! FTP lista falhou.
Correção	Entre em contato com o suporte.
Mensagem: 7088	Falha de Comunicação! Erro retorno chamada de bloco.
Correção	Entre em contato com o suporte.
Mensagem: 7089	Falha Interna! Nenhuma conexão disponivel.
Correção	Entre em contato com o suporte.
Mensagem: 7090	Falha de Comunicação! PINNEDPUBLICKE
Correção	Entre em contato com o suporte.
Mensagem: 7091	Falha de Comunicação! Status retornou falha.
Correção	Entre em contato com o suporte.
Mensagem: 7092	Falha de Comunicação! Erro de stream HPPT/2
Correção	Entre em contato com o suporte.
Mensagem: 7093	Falha Interna! API função chamada dentro de callback
Correção	Entre em contato com o suporte.
Mensagem: 7094	Falha de Comunicação! Autenticação retornou com erro.
Correção	Entre em contato com o suporte.
Mensagem: 7095	Falha de Comunicação! Erro generico HTTP/3
Correção	Entre em contato com o suporte.
Mensagem: 7096	Falha de Comunicação! HTTP/3 protocolo QUIC
Correção	Entre em contato com o suporte.
Mensagem: 7099	O retorno não é um XML
Correção	Entre em contato com o suporte.
Mensagem: 8000	O tamanho da mensagem ultrapassou o limite aceitável <= 1200000 kB
Correção	Qualquer mensagem deve ter no máximo 1.2 MB, se for uma imagem reduzo o tamanho da mesma.
Mensagem: 8429	Bloqueio devido ao excesso de requisições. Seja comedido ou será bloqueado por um tempo maior!
Correção	Entre em contato com o suporte.
Mensagem: 8430	Erro ao enviar webhook
Correção	Verifique se a url do webhook configurada no emitente é valida
Mensagem: 9000	Falha interna na operação com a base de dados.
Correção	Entre em contato com o suporte.
Mensagem: 9001	Prefeitura retornou um XML vázio.
Correção	Entre em contato com o suporte.
Mensagem: 9002	Prefeitura retornou um XML inválido.
Correção	Entre em contato com o suporte.
Mensagem: 9003	Prefeitura retornou um XML fora do padrão.
Correção	Entre em contato com o suporte.

Tabela de erros e alertas

Primeiros passos

Nota Fiscal Eletronica de Serviço

Detalhes da Cidade

Comunicação

Parameters

Request

Responses - HTTP Code 200

Processamento com sucesso

Processamento com erro

Processamento com erro