Função ConsultarCancelamentoNfse ( )
POST/ConsultarCancelamentoNfse/
O parametro necessário para consultar o cancelamento da nota é o searchkey.
| Campo | Tipo | Obrigatório | Descrição |
| searchkey | Numérico | 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 530 são associados a função: ConsultarCancelamentoNfse| Código | Campo | Mensagem de retorno |
|---|---|---|
| 5301 | searchkey |
- É preciso informar a Searckey da nota fiscal para consulta - Não foi localizada nenhuma nota através da Searchkey informada |
| 5302 | Retorno com erro | |
| 5303 | 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": "5302", "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": "5303", "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": "5303", "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" } } |