Como emitir um evento fiscal?
Neste artigo você encontra os detalhes para a emissão de eventos fiscais via API REST Oobj.
Pré-requisitos
Tenha em mãos:
- Conteúdo do evento, correspondente ao layout de integração utilizado;
- Informações de ano, série e número do DFe que receberá o evento.
Emitir um evento para um DFe
Para enviar para a Sefaz um novo evento para um determinado DFe, siga estes passos:
Para começar, faça uma requisição tipo POST ao endpoint de emitir evento;
[URL_BASE]/api/empresas/{empresa}/docs/{ambiente}/{codModelo}/{ano}/{serie}/{numero}/eventos
Preencha as seguintes informações (
path parameters
):{empresa}
*: CNPJ da empresa;{ambiente}
*: hom ou prod;{codModelo}
*: 55 (NFe), 57 (CTe), 58 (MDFe), 59 (CFe-SAT), 65 (NFCe), 66 (NF3e) ou 99 (NFSe);{ano}
*: ano de emissão no formato AAAA (quatro dígitos);{serie}
*: série do DFe;{numero}
*: número do DFe;{layoutDFe}
opcional: Valores aceitos: oobj, sefaz, txtsp, txt abrasf, json oobj, xmldatasul, txtndd, xmldatasulInfse. Valor default: oobj;
No cabeçalho da requisição Accept, informe o tipo de conteúdo (
content-type
) a ser retornado:{application/xml}
;{application/json;charset=UTF-8}
.
No corpo da requisição (
request body
), informe o conteúdo do evento, correspondente ao layout de integração utilizado;Informe o x-auth-token no cabeçalho (
header parameters
) da requisição.
Exemplo de requisição
Exemplo de requisição para emissão de evento de cancelamento de NFe.
O XML contém dados fictícios, somente para demonstração.
curl -L -X POST 'https://rest-teste.oobj.com.br/api/empresas/07385111000102/docs/hom/55/2023/503/741567/eventos?layout=oobj' \
-H 'Content-Type: application/xml' \
-H 'Accept: application/json;charset=UTF-8' \
-H 'x-auth-token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI3Yjc2OTg1ZGQ2MTNhOWVlYTFiN2RmZTNiZjRhMTRiZiIsImF1ZCI6IndlYiIsImV4cCI6MTYyOTI5MDcwNiwiaWF0IjoxNjI5Mjg4OTA2fQ.-Dj91d6fBZYcZpy1-zKzohAWd5dgW2CAS5BBfwGilemUYcOVDm8CnrDJHbwsFyixI5ohphy-65fqeobXkimtCg' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<envEvento xmlns="http://www.oobj.com.br/nfe"><idLote>1681912600880</idLote><tpAmb>2</tpAmb><evento><infEvento><cOrgao>43</cOrgao><CNPJ>07385111000102</CNPJ><chNFe>43230407385111000102555030007488731191841103</chNFe><dhEvento>2023-04-19T10:56:40-03:00</dhEvento><tpEvento>110111</tpEvento><nSeqEvento>1</nSeqEvento><verEvento>1.00</verEvento><detEvento><descEvento>Cancelamento</descEvento><xJust>justificativa de cancelamento</xJust></detEvento></infEvento></evento></envEvento>'
Exemplo de retorno
{
"mensagem": "/api/empresas/07385111000102/docs/hom/55/2023/503/000741567/eventos/110111",
"tempoMedioMs": 1000,
"timestamp": 1682456792160
}
Pronto! Você acaba de completar a emissão um novo evento para um determinado DFe.