Este serviço é utilizado para consultar o status de processamento de um BP-e enviado anteriormente para processamento pelo método de Emissão de BP-e
URL
Produção: POST https://bpe.ns.eti.br/v1/bpe/issue/status
Dados de entrada
Campo | Ocorrência | Tipo | Descrição |
---|---|---|---|
X-AUTH-TOKEN | 1-1 | A | Token de acesso da Software House |
CNPJ | 1-1 | N | CNPJ do emitente do BP-e |
nsNRec | 1-1 | N | Número do protocolo de recebimento |
Exemplo de requisição
Requisição de status de processamento
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"X-AUTH-TOKEN":"SEU_TOKEN",
"CNPJ": "11111111111111",
"nsNRec": 1
}' \
https://bpe.ns.eti.br/v1/bpe/issue/status
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 | ||
chBPe | Chave do BP-e | 1-1 | N | ||
cStat | Código de status do processamento do BP-e na Sefaz | 0-1 | N | Somente em status = 200 | |
xMotivo | Descrição literal do status de processamento na Sefaz | 0-1 | A | Somente em status = 200 | |
nProt | Número do protocolo de autorização do BP-e na Sefaz | 0-1 | N | Somente em cStat = 100 | |
dhRecbto | Data e hora do recebimento do BP-e pela Sefaz | 0-1 | D | Somente em status = 200 | |
xml | XML de distribuição do BP-e | 0-1 | A | Somente em cStat = 100 | |
Erro | Objeto contendo as informações de erro caso a consulta não possa ser realizada com sucesso Detalhamento no Quadro Abaixo | 0-1 | 0 | Somente em status diferente de 200 | |
cStat | Código de status do erro | 1-1 | N | erro | |
xMotivo | Descrição literal do erro | 1-1 | A | erro |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"chBPe": "43180107364617000135630000000000101000000085",
"cStat": "100",
"xMotivo": "Autorizado o uso do BP-e",
"nProt": "143180000001887",
"dhRecbto": "2018-01-31T19:46:20-02:00",
"xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><bpeProc versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/bpe\"><BPe>...</bpeProc>"
}
Retorno com erro
{
"status": -2,
"motivo": "Nao foi possivel carregar o status do BP-e",
"erro": {
"cStat": 997,
"xMotivo": "Documento não Localizado em Nosso Banco de Dados"
}
}
Códigos de retorno
Código | Descrição |
---|---|
200 | Consulta realizada com sucesso |
-2 | Não foi possível carregar o status de processamento do BP-e Verifique o objeto erro para maiores informações |