Consulta de NFS-e retroativa API

Índice

1. Índice
1.1. Parâmetros para Agendamento
1.2. Pontos Importantes

O InvoiCy agora permite o agendamento de Consulta de NFS-e Retroativa via API para documentos recebidos. Caso o cliente identifique a ausência de algum documento no processo de importação automática ou precise realizar uma consulta retroativa por outro motivo, é possível agendar essa busca diretamente via API.

Para realizar essa configuração, utilize a API “consultaretroativamunicipio”, disponível em nossa biblioteca no Postman. Acesse-a clicando aqui.

Parâmetros para Agendamento

Para configurar o agendamento, basta fornecer os seguintes parâmetros:

tpAmb: Versão do ambiente (1 = Produção; 2 = Homologação)
Versao: Versão do layout do documento (1.00)
CodMunicipio: Código do município para a consulta (obrigatório para notas recebidas; opcional para notas emitidas)
CnpjEmissor: CNPJ da empresa que realizará a consulta
DataInicial: Data de início do período de consulta (AAAA-MM-DD)
DataFinal: Data de término do período de consulta (AAAA-MM-DD)
ModeloDocumento: NFSe
EmitidoRecebido: E = Emitida; R = Recebida

Após o agendamento, o InvoiCy encaminha a Consulta de NFS-e Retroativa via API ao WebService da prefeitura especificada no campo CodMunicipio, buscando importar documentos retroativos disponíveis para o município.

Em casos onde houver mais de uma consulta agendada para o mesmo município com períodos de datas que se sobrepõem, o InvoiCy ignora o intervalo já consultado, agendando apenas para o período ainda não informado.

Pontos Importantes

É importante lembrar que essa consulta não substitui completamente a importação automática de documentos recebidos. Algumas prefeituras podem ter requisitos específicos, como o cadastro de uma caixa de e-mail para consulta de documentos retroativos e o registro dos prestadores na plataforma.

Para mais informações:

Caso o município exija essas configurações e elas não estejam implementadas, a consulta retroativa pode não resolver problemas com documentos ausentes.