Realiza uma solicitação de envio ou consulta de eventos por ID.
Observações:
- Somente é possível realizar envio/consulta de eventos de uma nota com situação CONCLUIDO.
- Quando uma a solicitação de envio/consulta de evento ocorrer com sucesso, o WEBHOOK será acionado, e o evento será atualizado a nota
Rota
POST
Produção
https://api.plugnotas.com.br/nfse/eventos/{idNota}
Sandbox
https://api.sandbox.plugnotas.com.br/nfse/eventos/{idNota}
Headers
Nome | Descrição |
x-api-key | Header utilizado para autenticação. |
Path Parameters;
Nome | Tipo | Descrição |
idNota | string | ID gerado por nossa API, ao enviar ou receber uma nota. |
Body: aplication/json
Nome | Tipo | Descrição |
tipo | string |
Tipo do evento solicitado. Valores aceitos:
Obs.: O tipo consulta irá vincular/registrar um ou mais eventos a nota (eventos ainda não registrados), caso exista no ambiente Nacional. |
modelo | string |
Modelo da manifestação. Obrigatório quando o tipo for manifestação Valores aceitos:
|
codigo | string |
Utilizado somente quando o modelo da manifestação for uma das seguintes:
Valores aceitos:
|
motivo | string |
Descrição para explicitar o motivo indicado neste evento |
Retorno
Exemplo de retorno:
{
"message": "Evento de manifestacao em processamento",
"data": {
"protocolo": "888738ef-e738-427f-a391-44ea7b497644"
}
}
Comentários
0 comentário
Por favor, entre para comentar.