Boleto Bancário . com
Desde 2000 no mercado de emissão de boletos!
Manual de Customização do Boleto Service
Introdução
O Boleto Service permite a customização da parte superior do boleto tanto no formato HTML quanto no formato PDF de acordo com suas necessidades.
Para o formato HTML o campo de customização é livre permitindo o uso de qualquer elemento HTML. Neste caso a customização ficará dentro de um elemento div.
Para customização de boletos em formato PDF disponibilizamos uma linguagem simples, conforme descrito nos tópicos abaixo.
Com apenas 4 instruções é possível inserir imagens e texto de forma simples e ao mesmo
tempo bastante flexível.
Caso deseje utilizar esta funcionalidade, é imprescindível a leitura e entendimento
deste documento.
Formato
O campo customizado consiste de uma série de instruções separadas pelo caractere "|".
Atenção:
- Todos os campos de todas as instruções são obrigatórios.
- Com exceção da "nl", todas as insturções fazem com que a posição do "cursor" fique a direita do elemento inserido. Chamamos esta posição de "esquerda atual".
1 - Instrução Image: Insere uma imagem no documento
- Formato:
image[L|C|R][ScalePercentage]:[Filename.[jpg|png|gif]] - * [L|C|R] - Posição da Imagem: L (Left/Esquerda) - C (Center/Centro) - R (Right/Direita)
- * [ScalePercentage] - Dimensionamento da imagem em relação ao seu tamanho original. Este campo é numérico e representa a porcentagem do tamanho.
- * [Filename.[jpg|png|gif]] - O nome do arquivo cuja imagem se deseja inserir.
- Exemplos:
imageC63:http://www.empresa.com/imagens/cabecalho.png- Insere a imagem cabecalho.png centralizada na linha atual. A imagem terá 63% de seu tamanho original.imageL100:http://www.empresa.com/imagens/logotipo.jpg- Insere a imagem logotipo.jpg na esquerda atual. O tamanho original será preservado.imageR100:http://www.boletobancario.com/imagens/home/logo.gif- Insere a imagem logo.gif na margem direita.
- Atenção:
- Caso não seja possível ler a imagem da URL informada, o boleto NÃO será gerado e um erro será retornado.
2 - Instrução Text: Insere um texto no documento.
- Formato:
text[B|N][L|C|R][FontSize]:[Texto] - * [B|N] - Tipo de Fonte: B (Bold/Negrito) - N (Normal)
- * [L|C|R] - Posição do Texto: L (Left/Esquerda) - C (Center/Centro) - R (Right/Direita)
- * [FontSize] - Tamanho da Fonte: Campo numérico.
- * [Texto] - O texto que se deseja inserir.
- Exemplos:
textBC16:Fatura Mensal- Insere o texto "Fatura Mensal" em negrito, centralizado, com tamanho de fonte 16.textNL10:Desconto: 15%- Insere o texto "Desconto: 15%" com fonte normal, na esquerda atual e tamanho de fonte 10.
3 - Instrução New Line: Modifica a posição do cursor para uma nova linha e a margem esquerda.
- Formato:
nl:[Lines] - * [Lines] - Número de linhas que se deseja "pular".
- Exemplos:
nl:1- Move o cursor para a linha diretamente abaixo do último elemento inserido.nl:3- Move o cursor para 3 linhas abaixo do último elemento inserido.
O tamanho do espaçamento será o tamanho do maior elemento inserido na linha.
4 - Instrução Tab: Move a esquerda atual N posições.
- Formato:
tab:[N] - * [N] - Número de posições que se deseja mover. Cada posição tem um espaçamento de 30 pontos.
- Exemplos:
tab:1- Move a esquerda atual 30 pontos em direção a margem direita.tab:3- Move a esquerda atual 90 pontos em direção a margem direita.
Exemplo completo
imageC63:http://www.boletobancario.com/imagens/home/logo.gif|nl:1|textBC20: |nl:1|textBC16:Fatura mensal de serviços|nl:3|textBL12:Descritivo dos serviços|nl:2|tab:2|textNL11:* Quantidade contratada: 100 - |textBL11: R$ 20,00|nl:1|tab:2|textNL11:* Quantidade excedente: 150 - |textBL11: R$ 40,00|nl:2|tab:2|textNL11:* Desconto fidelidade: 14 Meses - |textBL11: 10% - (R$ 6,00)|nl:3|textNL12:Total desta fatura:|textBL12: R$ 54,00|nl:4|textNL10:Prezado cliente, verificamos que seu consumo excedeu em mais de 20% o plano contratado.|nl:1|textNL10:Você pode alterar seu plano na área restrita de nosso site: |textBL10:www.boletobancario.com
Considerações Finais
A customização deve ser programada com cautela, pois erros neste campo podem descaracterizar ou inviabilizar a geração do boleto.
Utilize sempre a funcionalidade de testes do Boleto Service para validar sua customização.
Em caso de dúvidas entre em contato através do endereço https://www.boletobancario.com/home/contato.