Through the non-boarding event service, it is possible to inform the non-boarding of a BP-e on a trip.
Note: This event has rules and deadlines defined by the Secretariat of Finance that must be considered and respected. For more information click here and check the most up-to-date version of the Sefaz Taxpayer Guidance Manual.
URL
Production: POST https://bpe.ns.eti.br/v1/bpe/naoemb
Input Data
| FIeld | Description | Occurrence | Data Type | Size | Notes |
|---|---|---|---|---|---|
| X-AUTH-TOKEN | Software House access token | 0-1 | String | Can be sent in the request header | |
| chBPe | BP-e Access Key | 1-1 | Int | 44 | |
| tpAmb | Type of BP-e authorization environment: 1 - Production, 2 - Homologation ( test environment) | 1-1 | Int | 1 | |
| dhEvento | Date and time the cancellation occurred | 1-1 | String ( Date and Time format ) | 25 | Sefaz Standard YYYY-MM-DDTHH: MM: SS + UTC Ex .: 2016-06-13T15: 04: 10-02: 00 |
| nProt | BP-e authorization protocol number | 1-1 | Int | 15 | |
| xJust | Literal description of the reason for not boarding | 1-1 | String | 1-225 |
Request Examples
Non-boarding request example
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"chBPe": "43180207364617000135630000000000311000000089",
"tpAmb": 2,
"dhEvento": "2017-05-15T12:00:00-03:00",
"nProt": "443170000037618",
"xJust": "Nao compareceu"
}'\
https://bpe.ns.eti.br/v1/bpe/naoemb
Returned Data
| FIeld | Description | Data Type | Parent | Notes |
|---|---|---|---|---|
| status | Processing status code | Int | ||
| motivo | Literal description of processing status | String | ||
| retEvento | Object containing the processing data of the non-boarding event at Sefaz | Object | Only when status = 200 | |
| cStat | Processing status code | Int | retEvento | |
| xMotivo | Literal description of the processing situation at Sefaz | String | retEvento | |
| chBPe | BP-e access key | Int | retEvento | Only with cStat = 135 |
| dhRegEvento | Date and time of the event registration at Sefaz | String ( date and time format ) | retEvento | Sefaz Standard YYYY-MM-DDTHH: MM: SS + UTC. Ex .: 2016-06-13T15: 04: 10-03: 00 Only in cStat = 135 |
| nProt | Event authorization protocol number | Int | retEvento | Only with cStat = 135 |
| xml | Event distribution XML | String | retEvento | Only with cStat = 135 |
| erro | Object containing the error information in case the cancellation cannot be carried out successfully | Object | Only when status is different than 200 | |
| cStat | Error status code | Int | erro | |
| xMotivo | Literal description of the error | String | erro |
Responses examples
Successful response
{
"status": 200,
"motivo": "Processamento de evento realizado com sucesso",
"retEvento": {
"cStat": 135,
"xMotivo": "Evento registrado e vinculado a BP-e",
"chBPe": "43180207364617000135630000000000301000000081",
"dhRegEvento": "2018-02-21T14:58:46-03:00",
"nProt": "143180000002623",
"xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><procEventoBPe versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/bpe\">...</procEventoBPe>"
}
}
Returned Data
| Code | Description |
|---|---|
| 200 | Successfully linked event |
| -2 | Invalid access key |
| -3 | It was not possible to link the event. Check the error object for more information |
Non-Boarding Event Download
You can download the complete event distribution information in XML or JSON. To do this, check the Download Events method in the NS BP-e API.