Função ConsultarCancelamentoNfce ( )
Essa função tem o caráter de verificar o Status do cancelamento da Nota Fiscal.
POST/ConsultarCancelamentoNfce/
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| searchkey | Text | Sim | Código gerado pela API ao enviar a NFC-e |
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 330 são associados a função: ConsultarCancelamentoNfce| Código | Campo | Mensagem de retorno |
|---|---|---|
| 3301 | searchkey |
- É preciso informar a Searckey da nota fiscal para consulta - Não foi localizada nenhuma nota através da Searchkey informada |
| 3302 | Retorno com erro | |
| 3303 | 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": "3302", "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": "3303", "descricao": "Consulta realizada com sucesso!", "resultado": { "status": "status_nfce", "numero": "numero_nfce", "serie": "serie_nfce", "destinatario": "nome_destinatario_nfce" } } |
| Retorno com sucesso Se a Nota Fiscal não estiver com status de: APROVADA, APROVADA COM CORRECAO ou CANCELADA |
|---|
| { "status": "OK", "codigo": "3303", "descricao": "Consulta realizada com sucesso!", "resultado": { "status": "status_nfce", "numero": "numero_nfce", "serie": "serie_nfce", "destinatario": "nome_destinatario_nfce", "link_pdf": "link_pdf_nfce", "link_xml": "link_xml_nfce" } } |