Os boletos podem ser customizados para incluir o logotipo de sua empresa, descrição de
serviços/produtos ou qualquer outra informação que desejar.
O Boleto Direto 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.
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 das instruções "nl", "color", "rect" e "box", as demais instruções fazem com que
a posição do "cursor" fique a direita do elemento inserido.
É possível utilizar "|" no texto, para isto o caractere deve ser escapado com "\".
Instruções
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:cabecalho.png - Insere a imagem cabecalho.png centralizada na linha atual. A
imagem terá 63% de seu tamanho original.
imageL100:logotipo.jpg - Insere a imagem logotipo.jpg na posição do cursor. O tamanho
original será preservado.
imageR100:http://www.boletobancario.com/imagens/home/logo.png - Insere a imagem
logo.png na margem direita. A imagem será carregada da URL em questão
Token Images
As imagens também podem ser carregadas a partir de qualquer URL, por exemplo:
http://www.boletobancario.com/imagens/home/logo.png
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: Número decimal separado por "."
● [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.5:Desconto: 15% - Insere o texto "Desconto: 15%" com fonte normal de tamanho
10,5, na posição do cursor.
Instrução New Line: Modifica a posição do cursor para uma nova linha e a margem a 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.
Instrução Box: Cria uma caixa para texto e imagens que se expande verticalmente de acordo com o conteúdo
Formato: box:[LineWidth],[X],[Width],[Padding]|{elementos de texto ou imagem}|endbox
● [LineWidth] - Define a espessura da borda. Número decimal separado por ".".
● [X] - Coordenada X (horizontal). Número decimal separado por ".".
● [Width] - Largura da caixa. Número decimal separado por ".".
● [Padding] - Distância vertical entre a borda e o conteúdo. Número decimal separado
por ".".
Exemplo:
box:0.3,16,563,7|textBC14:Sua Empresa|nl:2|textBC12:Fatura mensal|endbox - Cria uma
caixa de texto com espessura de linha 0.3, iniciando na posição X 16, com largura de 563
pontos e distância vertical entre borda e conteúdo de 7 pontos. A caixa conterá os
elementos de texto especificados entre "box" e "endbox"
Notas:
A caixa se expandirá automaticamente, quando necessário através de múltiplas páginas.
Para fazer com que os cantos fiquem arredondados, utilize boxr ao invés de box
Instrução Pos: Posiciona o cursor em uma coordenada [x, y] específica e altera a margem esquerda para os elementos seguintes
Formato: pos:[X],[Y]
● [X] - Coordenada X (horizontal). Número decimal, separado por ".". A parte esquerda
do documento é a posição zero, sendo que para folhas A4 a borda direita
corresponde a 595.0.
● [Y] - Coordenada Y (vertical). Número decimal, separado por ".". A parte inferior do
documento é a posição zero, sendo que para folhas A4 o topo corresponde a 842.0.
Exemplos:
pos:140,717 - Posiciona o elemento seguinte na coordenada x = 140 e y = 717, e altera a
margem esquerda para 140.
pos:203.5,655.5 - Posiciona o elemento seguinte na coordenada x = 203.5 e y = 655.5, e
altera a margem esquerda para 203.5
Instrução Rect: Desenha um retângulo ou uma linha em uma posição específica
Formato: rect:[LineWidth],[X],[Y],[Width],[Height]
● [LineWidth] - Define a espessura da linha. Número decimal separado por ".".
● [X] - Coordenada X (horizontal) do canto inferior esquerdo do retângulo ou linha.
Número decimal separado por ".".
● [Y] - Coordenada Y (vertical) do canto inferior esquerdo do retângulo ou linha.
Número decimal separado por ".".
● [Width] - Largura do retângulo ou comprimento da linha. Número decimal
separado por ".".
● [Height] - Altura do retângulo ou linha. Caso deseje inserir uma linha o valor deste
parâmetro deve ser igual ao parâmetro [LineWidth].
Exemplos:
rect:0.8,350,500,200,0.8 - Desenha uma linha com espessura 0.8 iniciando na
coordenada x = 350 e y = 500. A linha terá 200 pontos de comprimento.
rectr:0.3,20,500,200,210 - Desenha um retângulo com espessura de linha = 0.3 iniciando
na coordenada x = 20 e y = 500, com 200 pontos de comprimento e 210 pontos de altura. Os
cantos serão arredondados.
Nota:
Para fazer com que os cantos fiquem arredondados, utilize rectr ao invés de rect
Instrução Color: Altera a cor para os elementos seguintes
Formato: color:[Red],[Green],[Blue]
● [Red] - Valor da cor vermelho, entre 0 e 255. Número inteiro.
● [Green] - Valor da cor verde, entre 0 e 255. Número inteiro.
● [Blue] - Valor da cor azul, entre 0 e 255. Número inteiro.
Exemplos:
color:200,10,10 - Altera a cor para vermelho = 200, verde = 10 e azul = 10.
color:0,0,0 - Altera a cor para vermelho = 0, verde = 0 e azul = 0 (preto).
Instrução Tab: Move o cursor 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 o cursor 30 pontos em direção a margem direita.
tab:3 - Move o cursor 90 pontos em direção a margem direita.
Variáveis
É possível utilizar variáveis no campo customizado, estas serão preenchidas
automaticamente pelo sistema com os respectivos dados do boleto.
As variáveis que podem ser utilizadas são as seguintes:
{pagador.nome}
{pagador.primeiro-nome}
{pagador.sobrenome}
{pagador.cpf-cnpj}
{pagador.cep}
{pagador.cidade}
{pagador.estado}
{pagador.endereco}
{pagador.bairro}
{beneficiario.nome}
{beneficiario.cpf-cnpj}
{beneficiario.cep}
{beneficiario.cidade}
{beneficiario.estado}
{beneficiario.endereco}
{beneficiario.codigoformatado}
{especie}
{valor}
{vencimento}
{parcela}
{banco.nome}
{banco.codigo}
{nosso.numero}
{num.doc}
{data.documento}
{local.pagamento}
{linha.digitavel}
{info.adicionais}
Exemplo completo
imageC63:cabecalho.png|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$ {valor}|nl:4|
textNL10:Prezado(a) {pagador.primeiro-nome}, 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|
rect:0.5,10,450,575,0.5|
color:200,10,10|
rect:1,120,557,55,18
Considerações finais
A customização deve ser programada com cautela, pois erros neste campo podem
descaracterizar ou inviabilizar a geração do boleto. O sistema calcula automaticamente o
número de páginas necessárias para a customização. Caso não haja mais espaço na página
para um elemento de texto ou imagem, este elemento não invadirá a área destinada ao
boleto, neste caso o boleto aparecerá em uma nova página.
Comentários
0 comentário
Por favor, entre para comentar.