Cobrança v2¶
1- Pré-Requisitos
O Add-On e serviços instalados devem ser a partir da versão: 3.13.0.5168:
Dica
Recomendo a utilização do Postman para testar os métodos da API para clientes que ainda não possuem um portal para integração, qualquer dúvida entre em contato através do portal atendimento
2- Métodos disponíveis para BankPlus
Com o serviço em execução é possível realizar algumas integrações do Add-On BankPlus através dos métodos a seguir.
2.1- Gerar Token:
Com o serviço API do BankPlus instalado e o monitor de serviços abertos, selecione a aba API e clique em Gerar Token para gerarmos a chave de autorização que utilizaremos para obter os retornos dos metodos disponiveis:
Importante
Na homologação do processo, utilizamos o Postman para realizar os testes dos métodos.
2.2 – Obter Todas as Empresas:
GET [http://localhost:9992/api/v2/Qualidade/cobranca/empresas], método que retorna todas as empresas cadastradas no Add-On BankPlus. Exige que seja passado no Header como a chave de autorização retornada no Token do serviço:
Dica
Para realizar a criação do URL, insira o IP ou Nome do servidor e o Apelido do banco de dados conforme imagem abaixo:
2.3 – Obter Empresa por Código:
GET [http://localhost:9992/api/v2/Qualidade/cobranca/empresas/1], método que retorna os dados de uma empresa cadastrada no Add-On BankPlus. Exige que seja passado no Header como a chave de autorização retornada no Token do serviço:
2.4 – Obter os Boletos por Empresa, tipo de nota, número do documento:
GET [http://localhost:9992/api/v2/Qualidade/cobranca/1/notafiscal/465/boletos], método que retorna os dados de todos os boletos de uma empresa, para um tipo de documento e número do documento. Exige que seja passado no Header como a chave de autorização retornada no Token do serviço. Esse método exige na URL o código da empresa, O tipo de documento e o DocEntry da nota fiscal e devolve todos os boletos da nota passada na Url:
3. Métodos de busca do boleto utilizando somente o ID do boleto
3.1 - Obter informações do boleto somente pelo ID:
GET [http://localhost:9992/api/v2/Qualidade/cobranca/boletos/351003], método que retorna os dados de um boleto utilizando somente o ID. Exige que seja passado no Header como a chave de autorização retornada no Token do serviço. Esse método exige na URL o código “boletos” seguido pelo ID do boleto na Url:
2.5 - Métodos de busca do CardCode pelo Parceiro de Negócio e Empresa:
POST [http://localhost:9992/api/v2/Qualidade/cobranca/1/C20000/boletos?skipe=3&page=8], método que faz a geração de um ou mais boletos pelo Parceiro de Negócio e Empresa definida.
3.2 - Obter PDF do boleto somente pelo ID:
GET [http://localhost:9992/api/v2/Qualidade/cobranca/boletos/351003/pdf], método que retorna o boleto no formato PDF, exige que seja passado no Header como a chave de autorização retornada no Token do serviço. Esse método exige na URL o código “boleto” seguido pelo ID do boleto + ”.pdf” na Url:
4. Métodos para gerar o boleto através de um método POST
4.1 - Gerar boleto(s) de uma nota sem retorno do PDF:
POST [http://localhost:9992/api/empresas/1/notafiscal/465/boletos], método que faz a geração de um ou mais boletos de uma nota sem retornar o(s) PDF(s) dos boleto(s). Exige que seja passado no Header como a chave de autorização retornada no Token do serviço. É necessário passar os dados do documento como filial, tipo de documento, DocEntry e o código “boletos”:
4.2 - Gerar boleto(s) de uma nota com retorno do PDF:
POST [http://localhost:9992/api/empresas/1/notafiscal/465/boletos?parcela=2&impresso=s], método que faz a geração de um ou mais boletos de uma nota com o retorno do(s) PDF(s) dos boleto(s). Exige que seja passado no Header como a chave de autorização retornada no Token do serviço. É necessário passar os dados do documento como filial, tipo de documento, DocEntry, código “boletos” e impresso=s:
4.3 - Gerar boleto da parcela de uma nota sem o retorno do PDF:
POST [http://localhost:9992/api/empresas/1/notafiscal/471/boletos?parcela=2], método que faz a geração de um boleto referente a uma parcela da nota sem retornar o PDF. Exige que seja passado no Header como a chave de autorização retornada no Token do serviço. É necessário passar os dados do documento como filial, tipo de documento, DocEntry, código “boletos” e o número da parcela:
4.4 - Gerar boleto da parcela de uma nota com retorno do PDF:
POST [http://localhost:9992/api/empresas/1/notafiscal/471/boletos?parcela=1&impresso=s], método que faz a geração de um boleto referente a uma parcela da nota com o retorno do PDF. Exige que seja passado no Header como a chave de autorização retornada no Token do serviço. É necessário passar os dados do documento como filial, tipo de documento, DocEntry, código “boletos”, número da parcela e impresso=s:
4.5 - Cancelar boleto por ID do boleto:
POST: [http://localhost:9992/api/v2/Qualidade/cobranca/boletos/351030/cancelar], método faz com que é realizado o concelamento do boleto:
- Boleto Status: Gerado:
Após o processo Status Cancelado:
Atenção
Boleto Gerado: cancela direto;
Boleto com status diferente: Retorna mensagem que o boleto não pode ser cancelado;
Boleto com Status Remesa/Confirmado/Parâmetro de permitir alterar para aguardando cancelamento habilitado: Atualiza o Status do boleto para aguardando cancelamento.
Tipos de documento:
Tipos de Documento Parâmetro Nota Fiscal de Saída notafiscal Adiantamento adiantamento Lançamento Contábil Manual lcm