Através deste método é possível realizar a geração e validação dos dados da BP-e em XML processado anteriormente pela SEFAZ e obter o arquivo PDF do bilhete caso nenhum erro seja encontrado.
URL
Produção: POST https://bpe.ns.eti.br/v1/util/generatepdf
Dados de entrada
| Campo | Ocorrência | Tipo | Descrição |
|---|---|---|---|
| X-AUTH-TOKEN | 1-1 | A | Token de acesso do usuário |
| projeto | 1-1 | String | Preencher com: "BPe" |
| xml | 1-1 | String | Xml do BPe processado anteriormente na Sefaz |
Exemplo de requisição
Requisição de cancelamento de NF-e
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"X-AUTH-TOKEN": "SEU_TOKEN",
"xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><nfeProc versao=\"4.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"><NFe>...</NFe><protNFe versao=\"4.00\">...</protNFe></nfeProc>",
"printCEAN": true,
"obsCanhoto": true
}
'\https://bpe.ns.eti.br/v1/util/generatepdf
Dados retornados
| Campo | Descrição | Observação |
|---|---|---|
| status | Código de status do processamento | |
| motivo | Descrição literal do status de processamento | |
| PDF do BP-e em Base64 | Somente em status = 200 |
Exemplos de retorno
Retorno com sucesso
{"status": 200,"motivo": "PDF gerado com Sucesso!","pdf": "JVBERi0xLjQKJeLjz..."}
Retorno com erro
{
"status": -2,
"motivo": "NFe invalido de acordo com a validacao contra schema",
"erros": [
"O campo 'vPIS' e de preenchimento obrigatorio e nao foi preenchido. Este campo deve ser informado antes do campo 'qBCProd' com numeros contendo no maximo 15 casas inteiras e 2 decimais. (cvc-complex-type.2.4.a: Invalid content was found starting with element 'qBCProd'. One of '{\"http://www.portalfiscal.inf.br/nfe\":vPIS}' is expected.)",
"O campo 'vCOFINS' e de preenchimento obrigatorio e nao foi preenchido. Este campo deve ser informado antes do campo 'qBCProd' com numeros contendo no maximo 15 casas inteiras e 2 decimais. (cvc-complex-type.2.4.a: Invalid content was found starting with element 'qBCProd'. One of '{\"http://www.portalfiscal.inf.br/nfe\":vCOFINS}' is expected.)"
]
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | BP-e recebida e pré-visualização do PDF do bilhete gerado com sucesso |
| -2 | Erro de informações de acordo com o tipo de dados.Verifique o campo motivo para identificar os campos incorretos Os erros serão encontrados no objeto erros, que é um array de strings. |
| -3 | Schema de validação inexistente para a versão da BP-e informada em BPe/infBpe/versao |
| -4 | Dados enviados fora do padrão esperado. Verifique o campo motivo para maiores informações. |