Esta rota é utilizada para solicitar o cancelamento de eventos da Reforma Tributária do Consumo que já foram autorizados.
O cancelamento é enviado para o mesmo endpoint de eventos do PlugStorage, utilizando um código de evento de cancelamento no campo type.
POST
Utilize o método POST para enviar a solicitação de cancelamento ao PlugStorage.
https://app.plugstorage.com.br/api/v2/eventos
Headers
| Nome | Valor |
| authorization | Basic encode64(token da software house : senha da software house)== |
| Content-Type | application/x-www-form-urlencoded ou application/json |
Body
Todos os cancelamentos utilizam a mesma estrutura de body. Os campos abaixo identificam o evento autorizado que deve ser cancelado.
| Nome | Descrição | Obrigatório | Detalhes |
| type | Código do evento que deseja cancelar | Sim | Deve ser informado com o prefixo CANCELAR seguido do código do evento autorizado. Exemplo: CANCELARE211110. |
| invoice_key | Chave da NF-e na qual será adicionado ao evento | Sim | Informe a chave de acesso da NF-e. |
environment |
Informe como 1 caso se tratar de um evento de produção e 2 para eventos de homologação | Sim |
|
sequence |
Informar o número da sequência que foi autorizado o evento. | Sim | Informe a mesma sequência utilizada no evento que deseja cancelar. |
| protocol | Informar o protocolo do evento que deseja cancelar. | Sim | Informe o protocolo retornado na autorização do evento original. |
| cnpj_cpf | CNPJ do emissor do evento. | Sim | Informe o CNPJ/CPF que está enviando o evento. Deve ser o mesmo utilizado na autorização do evento a ser cancelado. |
Exemplo de envio
{
"type": "CANCELARE211110",
"invoice_key": "41260200000000000000550000000000000000000000",
"environment": "2",
"sequence": 14,
"protocol": "341260000035320"
}
Eventos de cancelamento disponíveis
Informe no campo type o código correspondente ao evento que será cancelado.
| Código de cancelamento | Evento original |
CANCELARE211110 |
E211110 |
CANCELARE211124 |
E211124 |
CANCELARE211128 |
E211128 |
CANCELARE211130 |
E211130 |
CANCELARE211140 |
E211140 |
CANCELARE211150 |
E211150 |
CANCELARE212110 |
E212110 |
CANCELARE212120 |
E212120 |
Retorno da API
Exemplo de retorno após o envio da solicitação de cancelamento:
{
"error": false,
"status": "success",
"message": "Seu pedido foi realizado com sucesso, estamos processando o evento.",
"data": {
"invoice_key": "41260200000000000000550000000000000000000000"
}
}
Documentações de apoio:
- Rota V2 para enviar Eventos da Reforma Tributária do Consumo
- Consultar o retorno de um Evento da Reforma Tributária v2
- Nota Técnica 2025.002
Comentários
0 comentário
Por favor, entre para comentar.