Função CancelarNfse ( )
POST/CancelarNfse/
Segue abaixo os campos necessários para utilização da Função CancelarNfse/
As prefeituras possuem regras distintas entre elas para motivo e periodo para o cancelamento. Caso de dúvidas consulte o Manual de integração da sua prefeitura.
|
Campo |
Tipo |
Obrigatóriedade |
Descrição |
|---|---|---|---|
| searchkey | Texto | Sim | Código gerado pela API ao enviar a NFSE |
| motivo | Numérico | Sim |
1 - Erro de Emissão 2 - Serviço Não Prestado 3 - Erro de Assinatura 4 - Duplicidade de Nota 5 - Erro de Processamento |
Exemplo de JSon
{
"ApiKey":"xxxapikeyhashxxx",
"Cnpj":"00.000.000/000-00",
"Dados": {
"motivo_cancelamento":"2",
"searchkey":"xxxhashkeyxxxx "
}
}
Retornos e Erros
Todos os códigos de erros com os três primeiros dígitos sendo 520 são associados a função: CancelarNfse| Código | Campo | Mensagem de retorno |
|---|---|---|
| 5201 | searchkey |
- É preciso informar a Searckey da nota fiscal para consulta - Não foi localizada nenhuma nota através da Searchkey informada |
| 5202 | motivo |
- Caso não seja informado o motivo, retornará a Mensagem: “É preciso informar o Motivo para solicitação de cancelamento da Nota Fiscal” - Caso seja informado um motivo invalido, retornará a mensagem: “É preciso informar um motivo válido para o cancelamento da Nota Fiscal!" Obs: (verifique as opções no manual da api) |
| 5203 | Retorno com erro | |
| 5204 | 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": "5203", "descricao": "descricao_erro" } |
| Retorno com sucesso |
|---|
| { "status": "OK", "codigo": "5204", "descricao": "Solicitação de Cancelamento Realizada com Sucesso" } |