Função ConsultarXMLNfse ( )
Para consultar o XML da Nota Fiscal de Serviço basta utilizar a função com os parametros abaixo:
POST/ConsultarXMLNfse/
Campo | Tipo | Obrigatório | 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 570 são associados a função: ConsultarXMLNfseCódigo | Campo | Mensagem de retorno |
---|---|---|
5701 | searchkey |
- É preciso informar a Searckey da nota fiscal para consulta - Não foi localizada nenhuma nota através da Searchkey informada! |
5702 | Retorno com erro | |
5703 | 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": "5702", "descricao": "mensagem_de_erro" } |
Retorno com sucesso |
---|
{ "status": "OK", "codigo": "5703", "descricao": "Consulta realizada com sucesso!" "resultado":{ "status":"status_nfse", "numero":"numero_nfse", "codigo_verificador":"codigo_verificador_nfse", "tomador":"nome_tomador_nfse", "link_xml":"link_xml_nfse" } } |