Luggage Excess

Through the excess baggage charge event service, it is possible to inform the excess baggage charge at the BP-e.

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/excessobag

Input Data

Field	Description	Occurrence	Data Type	Size	Notes
X-AUTH-TOKEN	Software Access Token	0-1	String		Can also 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 - Approval	1-1	Int	1
dhEvento	Date and time the event 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
qBagagem	Number of luggage volumes loaded	1-1	Int	20
vTotBag	Total value of the service	1-1	Int	13 + 2 decimals ( Ex: 9999999999999,99

Request Example

Luggage Excess Request Event

curl -X POST \
-H "Content-Type: application/json" \
-d '{
      "chBPe":"43200807364617000135630060000001011000000089", 
      "tpAmb": "2", 
      "dhEvento": "2020-08-19T17:32:00-03:00", 
      "nProt": "143200000264094", 
      "qBagagem": "10", 
      "vTotBag": "10000.00"
     }'\
https://bpe.ns.eti.br/v1/bpe/naoemb

Returned Data

Filed	Description	Data Type	Parent	Notes
status	Processing status code	Int
motivo	Literal description of processing status	String
retEvento	Object containing the cancellation processing data 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

Response 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 Codes

Code	Description
200	Successfully linked event
-2	Invalid access key
-3	The event could not be linked. Check the error object for more information

Luggage Excess 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.

NS BPe (English)

URL