Através do serviço de evento de cobrança de excesso de bagagem é possível informar a cobrança do excesso de bagagem no BP-e.
Obs.: Este evento possui regras e prazos definidos pela Secretaria da Fazenda que devem ser consideradas e respeitadas. Para maiores informações clique aqui e verifique a versão mais atualizada o Manual de Orientações do Contribuinte da Sefaz.
URL
Produção: POST https://bpe.ns.eti.br/v1/bpe/excessobag
Dados de entrada
Campo | Descrição | Ocorrência | Tipo | Tamanho | Observação |
---|---|---|---|---|---|
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 | 44 | |
tpAmb | Tipo do ambiente de autorização do BP-e 1 - Produção 2 - Homologação | 1-1 | N | 1 | |
dhEvento | Data e hora da ocorrência do evento | 1-1 | D | 25 | Padrão Sefaz AAAA-MM-DDTHH:MM:SS + UTC Ex.: 2016-06-13T15:04:10-02:00 |
nProt | Número do protocolo de autorização do BP-e | 1-1 | N | 15 | |
qBagagem | Quantidade de volumes de bagagem carregados | 1-1 | N | 20 | |
vTotBag | Valor total do serviço | 1-1 | N | 13,2 |
Exemplo de requisição
Requisição de não embarque de BP-e
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
Dados retornados
Campo | Descrição | Tipo | Pai | Observação |
---|---|---|---|---|
status | Código de status do processamento | N | ||
motivo | Descrição literal do status de processamento | A | ||
retEvento | Objeto contendo os dados de processamento do cancelamento na Sefaz | O | Somente em status = 200 | |
cStat | Código de situação do processamento | C | retEvento | |
xMotivo | Descrição literal da situação do processamento na Sefaz | A | retEvento | |
chBPe | Chave de acesso do BP-e | N | retEvento | Somente em cStat = 135 |
dhRegEvento | Data e hora de registro do evento na Sefaz | D | retEvento | Padrão Sefaz AAAA-MM-DDTHH:MM:SS + UTCEx.: 2016-06-13T15:04:10-03:00 Somente em cStat = 135 |
nProt | Número do protocolo de autorização do evento | N | retEvento | Somente em cStat = 135 |
xml | XML de distribuição do evento | S | retEvento | Somente em cStat = 135 |
erro | Objeto contendo as informações de erro caso o cancelamento não possa ser realizado com sucesso | O | Somente em status diferente de 200 | |
cStat | Código de status do erro | N | erro | |
xMotivo | Descrição literal do erro | A | erro |
Exemplos de retorno
Retorno com sucesso
{
"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>"
}
}
Códigos de retorno
Código | Descrição |
---|---|
200 | Evento vinculado com sucesso |
-2 | Chave de acesso inválida |
-3 | Não foi possível vincular o evento. Verifique o objeto erro para maiores informações |
Download do Evento Excesso de Bagagem
Você pode fazer o download das informações completas de distribuição do evento em XML ou JSON. Para isso confira o método Download de Eventos na NS BP-e API.