Cancellation

BPe Cancellation

Through the BP-e cancellation service, it is possible to cancel a previously authorized ticket through the API.

Note: The cancellation of BP-e has rules and deadlines defined by the SEFAZ 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/cancel

Input data

Field	Description	Occurrence	Data Type	Note
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
tpAmb	Type of BP-e authorization environment: 1 - Production, 2 - Homologation	1-1	Int
dhEvento	Date and time the cancellation occurred	1-1	String ( Data and Time fomat )	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
xJust	Literal description of the reason for canceling the BP-e	1-1	String	Minimum 15 characters (there are no API restrictions on special characters)

Request Example

BPe Cancellation 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": "BPe cancelado para teste de integracao"
     }'\
https://bpe.ns.eti.br/v1/bpe/cancel

Returned Data

Field	Description	Data Type	Parent	Note
status	Processing status code	Int
motivo	Literal description of processing status	String
retEvento	Object containing the cancellation processing data at Sefaz	Object		Only when statys = 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	Cancel 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 in status 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 Code

Code	Description
200	BP-e successfully cancelled
-2	Invalid BPe access key
-3	It was not possible to cancel the BP-e. Check the error object for more information

Bpe Cancellation Download

You can download the complete cancellation distribution information in XML or JSON. To do this, check the Download Events method in the NS BP-e API.

NS BPe (English)