Fluxo

 

Para realizar o descarte de um evento pela rota da API, alguns passos precisam ser feitos para conseguir obter todos os parâmetros necessários para o descarte.

Primeiramente é necessário o envio de um evento como o CCe ou o Cancelamento e o mesmo precisa ser rejeitado.

Após a rejeição, fazer a consulta de todos os eventos de uma chave filtrando pelo parâmetro "visão", a tabela de "TspdVWEventos", uma tabela do banco de dados responsável pelo armazenamento apenas dos eventos.

Nessa consulta, deverá ser passado na tag campos ao menos o a tag "handle" (que será usado para fazer o descarte do evento).

Após obter o handle, basta usar a rota de descarte passando esse handle, siga a restante da documentação: 

 

1 - Enviar Evento

  1.1 - Envia CCe

       Para fazer o envio do CCe segue o link da documentação, clicando aqui 

 

   1.2 - Envia Cancelamento

 

        Para fazer o cancelamento de uma nota, segue o link da documentação, clicando aqui

 

2 - Consultar eventos

 

Para fazer a consulta de todos os eventos de uma nota e obter o handle de cada evento, é necessário passarmos alguns campos específicos, como o campo "visão", "campos" e "filtro"

Para mais informações da rota consulta, clique aqui

GET

 

 

 

Headers

 

Nome	Descrição	Exemplo
Authorization	Este usuário e senha são os seus dados para logar como administrador em um grupo do SaaS	Basic YWRtaW46MTIzbXVkYXI=

 

 

Querystring

 

Nome	Descrição
Grupo	Nome do grupo
CNPJ	CNPJ que está vinculado ao grupo que será usado para realizar a consulta, apenas números
Filtro	Aqui você vai informar como filtro a chave da nota que tem os eventos vinculados Exemplo: chavenota=4125000000000000000550010000052921346771000
Campos	Aqui você vai informar todos os campos que deseja obter da consulta, eles são separados por vírgula, por exemplo: handle, chave, situacao Atenção! É necessário passar o campo "handle" para poder realizar o descarte mais para frente
Limite	Limite de registros que a consulta deve retornar. Atenção! O valor máximo e também padrão é de 100 registros. (Opcional)
Inicio	Define a partir de qual registro do resultado da consulta deve ser retornado. O Inicio refere-se a posição do registro dentro do resultado da consulta e não faz referência ao handle (id) do registro em si. (Opcional)
Ordem	Ordena a consulta (Opcional)
Visao	TspdVWEventos (Obrigatório)
Encode	Quando valor é true, evita que o retorno traga caracteres inválidos. (Opcional)
FormatarXML	Quando valor é true, determina se o campo do tipo XML virá sem CDATA (Opcional)

Retorno

 

Exemplo de retorno: 

 

010900030,CCe,2025-02-27T08:50:00-03:00,135,AUTORIZADA,41,2,2,Evento registrado e vinculado a
NF-e,101250000000000,2025-02-27-13-21-24-631-1-rec.xml,,110110|100080000,CCe,2025-02-27T08:50:00-03:00,573,REJEITADA,41,2,1,Duplicidade
de
Evento,,2025-02-27-13-21-19-320-1-rec.xml,,110110

 

3 - Descartar evento

 

POST

 

 

 

Headers

 

Nome	Descrição	Exemplo
Authorization	Este usuário e senha são os seus dados para logar como administrador em um grupo do SaaS	Basic YWRtaW46MTIzbXVkYXI=
referer	https://managersaas.tecnospeed.com.br:8081/spdNewGUI/

 

 

Querystring

 

Nome	Descrição
Grupo	Nome do grupo
CNPJ	CNPJ que está vinculado ao grupo que será usado para realizar a consulta, apenas números
Documento	Aqui você vai informar o tipo de evento Exemplo: CCe
sequencia	Campo referente à sequência registrada do evento à ser descartado
handleeventonota	Identificador único do registro na base de dados do Manager Saas que identifica qual evento excluir. É obtido ao seguir os últimos passos
Encode	Quando valor é true, evita que o retorno traga caracteres inválidos. (Opcional)

Retorno

 

Exemplo de retorno: 

Em caso de sucesso

Documento=CCe
cnpj=00062009000100
encode=true
grupo=09062009000000
sequencia=1
handleeventonota=111111111
idgrupo=111111

Em caso de rejeição:

EXCEPTION,EspdManNFeDescartarEventosException,Problema ao descartar evento . Exception: syntax error at end of input (3 attepts)

 

EXCEPTION,EspdConnectionError,Tempo limite de comunicação com a SEFAZ/PREFEITURA atingido. Utilize a rota consulta para obter a situação do documento.

cURLs de exemplo