MODELOS DE IMPRESSÃO

• M1 – Um boleto por página SEM recibo (parte superior em branco);
• M2 – Dois boletos por página COM recibo;
• M3 – Três boletos por página;
• M4 – Não tem;
• M5 – Formato de carta.

PARÂMETROS PARA GERAÇÃO DE BOLETOS

Dados do pagador (sacado / cliente)

• PAGADOR_NOME – Nome do cliente/sacado (Letras);
• PAGADOR_DOCUMENTO – CPF ou CNPJ (Letras);
• PAGADOR_LOGRADOURO – Av. Luis Viana (Letras);
• PAGADOR_NUMERO – 6312 (Letras);
• PAGADOR_COMPLEMENTO– A 803 (Letras);
• PAGADOR_BAIRRO – Paralela (Letras);
• PAGADOR_MUNICIPIO – Ex: Salvador (Letras);
• PAGADOR_UF – Ex: BA (Letras);
• PAGADOR_CEP – 00000-000 (Letras);
• AVALISTA_NOME (Letras) – Se houver, normalmente fica em branco;
• AVALISTA_DOCUMENTO (Inteiro) – CPF ou CNPJ do avalisat a se houver, normalmente fica em branco.

Dados do beneficiário (cedente / cobrador)

• BENEFICIARIO_NOME – (Letras) Nome do beneficiário EX: “EMPRESA DEMONSTRACAO”.
• BENEFICIARIO_DOCUMENTO – CPF ou CNPJ (Letras);
• BENEFICIARIO_LOGRADOURO – (Letras) Endereço do emissor .Ex: “Av Luis Viana”;
• BENEFICIARIO_BAIRRO – Ex: CENTRO (Letras);
• BENEFICIARIO_CEP – Ex: 44.640-000 (Letras);
• BENEFICIARIO_UF – Ex: BA (Letras);
• BENEFICIARIO_MUNICIPIO – Ex: Salvador (Letras);
• BENEFICIARIO_EMAIL – (Letras);
• BENEFICIARIO_SITE – Site do emissor do boleto (Letras), não aparece em todos os modelos;
• BENEFICIARIO_COD_CLIENTE – Ver. documentação do banco se necessário (Santander) (Letras);
• BENEFICIARIO_LOGOMARCA – Caminho do arquivo de imagem JPEG ou PNG (Letras);
• BENEFICIARIO_TELEFONE – (Letras);

Dados da carteira

• BANCO – Código do banco na FEBRABAN (Ex: “033” – Santander);
• AGENCIA_NUMERO – (Letras);
• AGENCIA_DV – (Letras);
• CONTA_CORRENTE_NUMERO – (Letras);
• CONTA_CORRENTE_DV – (Letras);
• CARTEIRA – Código da carteira usada no calculo Ex: “006” (Letras);
• CARTEIRA_VARIACAO – Variação da carteira (vide cada banco);
• CARTEIRA_MODALIDADE – Variação/Modalidade da carteira;
• CARTEIRA_TIPO –
  • Caixa usar: SICOB ou SIGCB: 14 ou 24
• CARTEIRA_CONVENIO
• CARTEIRA_CONVENIO_DV
• CARTEIRA_FORMATADA – Descrição da carteira para impressão no boleto;
• IOS – Ex: “000” (Usado pelo Santander) (Letras);

Descontinuado

• NUMERO_CONTRATO – (Letras) Usar CARTEIRA_CONVENIO;
• NUMERO_CONTRATO_DV – (Letras) Usar CARTEIRA_CONVENIO_DV;
• NUMERO_CONVENIO – (Letras) Usar CARTEIRA_CONVENIO e CARTEIRA_CONVENIO_DV.

Dados do documento que gerou a cobrança

• DOCUMENTO_ACEITE – “S” ou “N” (Letras);
• DOCUMENTO_DATA – Data do documento gerador do boleto (Ex: “22/05/2015”) (Data);
• DOCUMENTO_DESCRICAO – (Letras) Identificação interna do titulo na empresa (Seu número);
• DOCUMENTO_ESPECIE – “DS”, “DM” (Letras);
• DOCUMENTO_NUMERO – (Letras) – O número do documento (NF, O.S, Contrato…) que originou o boleto;

Dados do boleto

• NOSSO_NUMERO – Número único do boleto (Letras);
• VALOR_BOLETO – Valor do boleto, valor a ser cobrado (Numérico);
• VALOR_DESCONTOS – (Fracionado) Retornado no arquivo de retorno (Nas carteiras compatíveis);
• VALOR_RECEBIDO – (Fracionado) Retornado no arquivo de retorno (Nas carteiras compatíveis);
• DATA_VENCIMENTO (Data) – (EX: “30/06/2015”) (Data);
• DATA_PROCESSAMENTO (Data) – (Ex: “23/06/2015”) (Data);
• DATA_EMISSAO – Data da emissão do documento que gerou o boleto (Data);
• MOEDA – Padrão “R$” (Letras);
• INSTRUCOES – Instruções ao agente bancário (o caixa), pode ter várias linhas (3 ou mais de acordo com o modelo) (Letras);
• LOCAL_PAGAMENTO1 – Primeira inicial do local de pagamento (Letras);
• LOCAL_PAGAMENTO2 – Segunda linha do local de pagamento (Letras);
• NOSSO_NUMERO_DV – Opcional, basta não informar que a API calcula automaticamente, ou informe para forçar um valor (Letras);
• BOLETO_CODIGO – Identificador do boleto no sistema de origem (Letras). É opcional e normalmente só utilizado nos WebServices.
• BOLETO_GERAR_PDF (Lógico) – Indica se o PDF do boleto deve ser gerado. É opcional e normalmente só utilizado nos WebServices.
• BOLETO_GERAR_PIX (Lógico) – Indica se o boleto gerado deve vir acompanhado do PIX correspondente. Se retornado pelo banco, o arquivo será informado no item ‘ARQUIVO_PDF‘;
• PIX_QRCODE (Letras) – Imagem do QR Code do PIX em Base64. Quando informada será adicionada a imagem do QR Code no boleto. (OBS: Não disponível em todos os modelos de impressão, testar se o modelo desejado já tem espaço para imagem do PIX.)

Arquivo de remessa

As rotinas de geração de arquivos de remessa exigem alguns dados adicionais:

• ARQUIVO_NUM_SEQUENCIAL – Número sequencial do arquivo enviado para o banco (Usado na CEF e SICOOB);
• BENEFICIARIO_CODIGO – Código identificador da empresa no banco; (Santander “SCCM”);
• ARQUIVO_DATA_GERACAO – Data de geração do arquivo de remessa (Opcional), vazio para hoje
• OCORRENCIA – “INCLUSAO” para inclusão (padrão), “EXCLUSAO” para código de baixa, ou o código da ocorrência no banco (ver manual do banco);
• JUROS_VALOR_DIARIO (Fracionado) – Valor dos juros diário;
• JUROS_PERCENTUAL_MENSAL (Fracionado) – Valor percentual dos juros por mês;
• MULTA_ATRASO_PERCENTUAL (Fracionado): Percentual de multa por atraso, informar 2,00 para 2,00% ou 0,15 para 0,15%…;
• – (Inteiro) Número de dias para protesto;
• DESCONTO_VALOR – Valor em R$ do desconto a ser aplicado para pagamento até a data limite (Fracionado);
• DESCONTO_DATA_LIMITE – Data limite para concessão do desconto (Data). (Opcional, e não suportado por todas as carteira);
• PROTESTO_DIAS_CORRIDOS antigo DIAS_PROTESTO ou PROTESTO_DIAS (Inteiro) – Números de dias para protesto após vencimento;
• PROTESTO_DIAS_UTEIS (Inteiro) – Números de dias úteis para protesto após vencimento;
• NEGATIVAR_DIAS_UTEIS (Inteiro) – Números de dias úteis para negativação após vencimento;
• NEGATIVAR_DIAS_CORRIDOS (Inteiro) – Números de dias corridos para negativação após vencimento;
• INSTRUCAO_COBRANCA1 (Letras) – Texto/Código da primeira instrução de cobrança;
• INSTRUCAO_COBRANCA2 (Letras) – Texto/Código da segunda instrução de cobrança;
• DATA_INSTRUCAO (Data).

• C000–999 – Campos personalizados podem ser informados passando parâmetros no seguinte formato:
  • “C” + “POSICAO INICIAL” + “-” + “POSICAO FINAL” – O valor desta chave será utilizado para substituir o texto da linha nas colunas especificadas do inicio (inclusive) ao fim (inclusive), começando em 1 e indo até 400.
  • Exemplos:
    • “C15-25” – Substitui a posição 15 a 25 da linha;
    • “C135-139” – Substitui a posição 135 a 139 da linha;

OBSERVAÇÕES

1. Nem todos os parâmetros são obrigatórios;
2. Nem todos os dados são impressos nos boletos, de acordo com o modelo de impressão selecionado;
3. Cada instituição financeira requer parâmetros diferentes, vide documentação do banco e da carteira para maiores detalhes.

PARÂMETROS DE RETORNO

A função retorna uma lista de mapas (Variante), cada mapa corresponde a um boleto, com os seguintes dados:

• CODIGO_BARRAS – Código de barras do boleto (Letras);
• LINHA_DIGITAVEL – Linha digitável (parte superior) completa do boleto(Letras);
• CAMPO_LIVRE – Campo com os dados específicos do banco / carteira(Letras);
• NOSSO_NUMERO_COMPLETO – Como impresso no boleto (Letras);
• NOSSO_NUMERO – Código único que identifica o boleto (Letras);
• NOSSO_NUMERO_DV – Dígito verificar do nosso número do boleto (Letras);
• ARQUIVO_PDF – Nome completo do arquivo PDF gerado (Letras);

WEBSERVICES

Os bancos que suportam chamadas via WebServices retornam adicionalmente:

• SUCESSO (Lógico) – Indica se a operação foi concluída com sucesso;
• ERRO_MENSAGEM (Letras) – Texto descritivo do erro;
• BOLETO_SITUACAO (Letras) – Retorna uma dessas situações se disponível no WebService “EM ABERTO“, “BAIXADO“, “LIQUIDADO“.
• BOLETO_URL (Letras) – URL para exibição do boleto gerado.

Utilize as funções de lista (‘Tamanho da Lista’, ‘Obter Objeto da Lista’, ..) e Mapeamento (‘Obter Elemento’, …) para ler os dados de retorno.