Através do serviço de download de eventos é possível obter os dados de um evento vinculado a um BP-e através da NS BP-e API. Os dados do evento podem ser recebidos em XML ou JSON.
URL
Produção: POST https://bpe.ns.eti.br/v1/bpe/get/event
Dados de entrada
| Campo | Descrição | Ocorrência | Tipo | |
|---|---|---|---|---|
| X-AUTH-TOKEN | Token de acesso do usuário | 0-1 | A | Pode ser enviado no cabeçalho da requisição |
| chBPe | Chave de acesso do BP-e | 1-1 | N | |
| tpDown | Tipo do download: X - XML, J - JSON | 1-1 | A | |
| tpEvento | Tipo do evento NAOEMBCANCALTPOL | 1-1 | A | NAOEMB: Não embarque, CANC: Cancelamento, ALTPOL: Alteração de Poltrona |
| nSeqEvento | Número sequencial do evento | 0-1 | N | Valor padrão: 1 |
Exemplo de requisição
Requisição de download de evento
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"X-AUTH-TOKEN": "SEU_TOKEN",
"chBPe": "43170507364617000135580000000003481000033457",
"tpDown": "x",
"tpEvento": "enc"
}'\
https://bpe.ns.eti.br/v1/bpe/get/event
Dados retornados
| Campo | Descrição | Ocorrência | Tipo | Pai | Observação |
|---|---|---|---|---|---|
| status | Código de status do processamento | 1-1 | N | ||
| motivo | Descrição literal do status de processamento | 1-1 | A | ||
| retEvento | Objeto contendo os dados de processamento do cancelamento na Sefaz | 0-1 | O | Somente em status = 200 | |
| cStat | Código de situação do evento na Sefaz | 1-1 | N | ||
| xMotivo | Descrição literal da situação do evento na Sefaz | 1-1 | A | ||
| chBPe | Chave de acesso da BP-e | 1-1 | N | ||
| dhRegEvento | Data e hora de registro do evento na Sefaz | 1-1 | D | Padrão Sefaz AAAA-MM-DDTHH:MM:SS + UTC Ex.: 2016-06-13T15:04:10-03:00 | |
| nProt | Número do protocolo de autorização do evento pela Sefaz | 1-1 | N | ||
| xml | XML do evento | 0-1 | A | Somente quando tpDown = X ou XP, Somente em status = 200 | |
| json | JSON do XML do evento | 0-1 | O | Somente quando tpDown = J ou JP, Somente em status = 200 | |
| erro | Objeto contendo as informações de erro caso o download do evento não possa ser realizado com sucesso | 0-1 | 0 | Somente em status diferente de 200 | |
| erro.cStat | Código de status do erro | 1-1 | N | ||
| erro.xMotivo | Descrição literal do erro | 1-1 | A |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Evento localizado com sucesso",
"retEvento": {
"cStat": "135",
"xMotivo": "Evento registrado e vinculado a BP-e",
"chBPe": "43180207364617000135630000000000311000000089",
"dhRegEvento": "2018-02-21T16:15:16-03:00",
"nProt": "143180000002639"
},
"xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><procEventoBPe versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/bpe\">...</procEventoBPe>"
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Download do evento realizado com sucesso |
| -2 | Chave de acesso inválida |
| -3 | Tipo de evento inválido |
| -4 | Tipo de download inválido |
| -5 | Não foi possível carregar o evento. Verifique o objeto erro para maiores informações |