Função ConsultarEmissaoNotaNfse ( )
POST/ConsultarEmissaoNotaNfse/
Essa função tem o carater de verificar o Status da emissão da Nota Fiscal de Serviço. Os status que poderão retornar são:
Aguardando Processamento - A nota está na fila de processamento para o envio para a Sefaz
Em andamento - A nota esta sendo processada Pela Prefeitura
Aprovada - A Nota está aprovada e protocolada pela Sefaz
Cancelada - A NFSe foi cancelada pelo emitente. Ela não possui mais validade fiscal
Reprovada - A nota contem erros que impediram a aprovação pela Prefeitura
Segue abaixo os campos necessários para utilização da Função ConsultarEmissaoNotaNfse/
Campo |
Tipo |
Obrigatóriedade |
Descrição |
---|---|---|---|
searchkey | Texto | Sim | Código gerado pela API ao enviar a NFSE |
Exemplo de JSon
{
"ApiKey":"xxxapikeyhashxxx",
"Cnpj":"00.000.000/0000-00",
"Dados":{
"searchkey":"xxxhashkeyxxxx"
}
}
Retornos e Erros
Todos os códigos de erros com os três primeiros dígitos sendo 510 são associados a função: ConsultarEmissaoNotaNfseCódigo | Campo | Mensagem de retorno |
---|---|---|
5101 | searchkey |
- É preciso informar a Searckey da nota fiscal para consulta - Não foi localizada nenhuma nota através da Searchkey informada |
5102 | Retorno com erro | |
5103 | Retorno com sucesso |
Retornos de JSON
Retorno com erro de parametros |
---|
{ "Status": "Erro", "codigo": "codigo_erro", "campo": "campo_com_erro", "descricao": "descricao_erro" } |
Retorno com erro |
---|
{ "status": "Erro", "codigo": "5102", "descricao": "descricao_erro" } |
Retorno com sucesso Se a Nota Fiscal não estiver com status de: APROVADA, APROVADA COM CORRECAO ou CANCELADA |
---|
{ "status": "OK", "codigo": "5103", "descricao": "Consulta realizada com sucesso!", "resultado": { "status": "status_nfse", "numero": "numero_nfse", "codigo_verificador":"codigo_verificador_nfse", "tomador":"nome_destinatario_nfse" } } |
Retorno com sucesso Se a Nota Fiscal não estiver com status de: APROVADA, APROVADA COM CORRECAO ou CANCELADA |
---|
{ "status": "OK", "codigo": "5103", "descricao": "Consulta realizada com sucesso!", "resultado": { "status": "status_nfse", "numero": "numero_nfse", "codigo_verificador":"codigo_verificador_nfse", "tomador":"nome_destinatario_nfse", "link_pdf": "link_pdf_nfse", "link_xml": "link_xml_nfse" } } |