Boleto com Balancete

Este modelo de boleto é muito utilizado por condomínios e contabilidades e tem como objetivo proporcionar a demonstração prévia das movimentações financeiras do mês para condôminos e clientes. São disponibilizados dados como receitas, despesas e contas a receber. Veja aqui como é um boleto balancete.

Para gerar um boleto bancário do tipo balancete é bem simples e requer apenas três passos:

  1. Crie a transação
  2. Defina a transação gerada como do tipo boleto balancete
  3. Por fim, associe à forma de pagamento via boleto, informando o charge_id da transação.

O restante desta página apresenta os procedimentos detalhados, mas você precisa instalar uma de nossas bibliotecas em seu servidor para executar os códigos de exemplo. Certifique-se de que a SDK da Gerencianet foi instalada.


1. Criar transação

Primeiramente, precisamos gerar a transação (também chamada de "cobrança"). É neste momento que será informado o nome do item/produto/serviço, valor da transação, quantidade, dentre outras informações possíveis.

Após criá-la, será retornado o charge_id, que é o identificador único da transação e que será utilizado para associar à forma de pagamento.

Assim que essa transação é criada, ela recebe o status new, que significa que a cobrança foi gerada e está aguardando definição da forma de pagamento. Essa cobrança somente terá seu status alterado quando o integrador definir sua forma de pagamento.

Para gerar uma transação, você deve enviar uma requisição POST para a rota /v1/charge.

Caso queira, pode explorar e conhecer mais sobre este recurso usando nosso Playground.

O exemplo abaixo mostra como isto pode ser feito, utilizando as SDK's disponíveis:

<?php
require __DIR__.'/../../vendor/autoload.php'; // caminho relacionado a SDK
use Gerencianet\Exception\GerencianetException;
use Gerencianet\Gerencianet;
$clientId = 'informe_seu_client_id'; // insira seu Client_Id, conforme o ambiente (Des ou Prod)
$clientSecret = 'informe_seu_client_secret'; // insira seu Client_Secret, conforme o ambiente (Des ou Prod)
$options = [
'client_id' => $clientId,
'client_secret' => $clientSecret,
'sandbox' => true // altere conforme o ambiente (true = desenvolvimento e false = producao)
];
$item_1 = [
'name' => 'Item 1', // nome do item, produto ou serviço
'amount' => 1, // quantidade
'value' => 1000 // valor (1000 = R$ 10,00)
];
$item_2 = [
'name' => 'Item 2', // nome do item, produto ou serviço
'amount' => 2, // quantidade
'value' => 2000 // valor (2000 = R$ 20,00)
];
$items = [
$item_1,
$item_2
];
// Exemplo para receber notificações da alteração do status da transação.
// $metadata = ['notification_url'=>'sua_url_de_notificacao_.com.br']
// Como enviar seu $body com o $metadata
// $body = [
// 'items' => $items,
// 'metadata' => $metadata
// ];
$body = [
'items' => $items
];
try {
$api = new Gerencianet($options);
$charge = $api->createCharge([], $body);
print_r($charge);
} catch (GerencianetException $e) {
print_r($e->code);
print_r($e->error);
print_r($e->errorDescription);
} catch (Exception $e) {
print_r($e->getMessage());
}

a) Estrutura hierárquica dos atributos do Schema que podem ser utilizados:

"id": "/Charge"
"items"
"name"
"value"
"amount"
"marketplace"
"payee_code"
"percentage"
"shippings"
"name"
"value"
"payee_code"
"metadata"
"custom_id"
"notification_url"

Para verificar mais detalhes, acesse aqui e explore em nosso Playground.

b) Atributos que podem ser utilizados:

AtributoDescriçãoObrigatórioTipo
itemsitem que está sendo vendido. Uma mesma transação pode possuir ilimitados itens.

Atributos de items:
name*// Nome do item, produto ou serviço. Mínimo de 1 caractere e máximo de 255 caracteres (String).

value*// Valor, em centavos. Ex: R$ 10,00 = 1000. Integer

amount// Quantidade. Integer		SimArray
shippingsDetermina o(s) valor(es) de frete(s) de uma transação. Uma mesma transação pode possuir ilimitados valores de frete.

Atributos de shippings:
name*// Rótulo do frete. Máximo de 255 caracteres. String.

value*// Valor do frete, em centavos (1990 equivale a R$19,90). Integer		NãoArray
metadataDefine dados específicos da transação

Atributos de metadata:
custom_id// Permite associar uma transação Gerencianet a uma ID específica de seu sistema ou aplicação, permitindo identificá-la caso você possua uma identificação específica e queira mantê-la. Máximo de 255 caracteres. String/null.

notification_url// Endereço de sua URL válida que receberá as notificações de mudanças de status das transações. Máximo de 255 caracteres. String/null.		NãoObject

Os campos com * representam valores obrigatórios


2. Defina a transação gerada como do tipo boleto balancete

pós a criação da transação, será o momento de definirmos que o boleto a ser gerado será do tipo balancete.

Para isso, você deve enviar uma requisição POST para a rota /v1/charge/:id/balance-sheet, onde :id é o charge_id da transação desejada.

Caso queira, você pode explorar e conhecer mais sobre este recurso usando nosso Playground e utilizar como base o JSON abaixo:

NOTA

Cabe frisar que não há um padrão nos itens que serão exibidos, no sentido que o próprio integrador irá definir, através dos atributos devidos, a quantidade de colunas (até 4), linhas, textos e valores a serem exibidos no boleto do tipo balancete.

Em suma, é como se o integrador estivesse trabalhando com uma tabela construída em HTML, mas em formato JSON.

A seguir, um JSON de exemplo que pode ser utilizado para criar um boleto do tipo balancete:

{
"title": "Balancete Demonstrativo - Periodo 25/06/2018 a 25/07/2018",
"body": [{
"header": "Demonstrativo de Consumo",
"tables": [{
"rows": [[{
"align": "left",
"color": "#000000",
"style": "bold",
"text": "Despesa de condomínio:",
"colspan": 2
},
{
"align": "left",
"color": "#000000",
"style": "bold",
"text": "Total lançado",
"colspan": 1
},
{
"align": "right",
"color": "#000000",
"style": "bold",
"text": "Rateio",
"colspan": 1
}],
[{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Serviço de Vigilância Contratado:",
"colspan": 2
},
{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "R$ 300,00",
"colspan": 1
},
{
"align": "right",
"color": "#000000",
"style": "normal",
"text": "R$ 75,00",
"colspan": 1
}],
[{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Serviço de Zeladoria Contratado:",
"colspan": 2
},
{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "R$ 130,00",
"colspan": 1
},
{
"align": "right",
"color": "#000000",
"style": "normal",
"text": "R$ 32,00",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Serviço de Jardinagem:",
"colspan": 2
},
{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "R$ 80,00",
"colspan": 1
},
{
"align": "right",
"color": "#000000",
"style": "normal",
"text": "R$ 20,00",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Tarifa Bancária:",
"colspan": 2
},
{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "R$ 10,00",
"colspan": 1
},
{
"align": "right",
"color": "#000000",
"style": "normal",
"text": "R$ 2,50",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Despesa condomínio:",
"colspan": 2
},
{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "R$ 800,00",
"colspan": 1
},
{
"align": "right",
"color": "#000000",
"style": "normal",
"text": "R$ 320,00",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Reforma de prédio:",
"colspan": 2
},
{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "R$ 350,00",
"colspan": 1
},
{
"align": "right",
"color": "#000000",
"style": "normal",
"text": "R$ 140,00",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Investimentos:",
"colspan": 1
},
{
"align": "center",
"color": "#000000",
"style": "bold",
"text": "Total:",
"colspan": 1
},
{
"align": "left",
"color": "#000000",
"style": "bold",
"text": "R$ 1320,00",
"colspan": 1
},
{
"align": "right",
"color": "#000000",
"style": "bold",
"text": "R$ 450,00",
"colspan": 1
}], [{
"align": "center",
"color": "#000000",
"style": "bold",
"text": " ",
"colspan": 1
},{
"align": "center",
"color": "#000000",
"style": "bold",
"text": "Total:",
"colspan": 1
}, {
"align": "left",
"color": "#000000",
"style": "bold",
"text": "R$ 350,00",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "bold",
"text": "R$ 140,00",
"colspan": 1
}]]
},
{
"rows": [[{
"align": "left",
"color": "#000000",
"style": "bold",
"text": "Despesas de Consumo",
"colspan": 4
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Leitura de gás:",
"colspan": 1
}, {
"align": "left",
"color": "#000000",
"style": "bold",
"text": "Data: 25/11/2017",
"colspan": 3
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Anterior",
"colspan": 1
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Atual Consumo",
"colspan": 1
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "g/l",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "normal",
"text": "Total",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "bold",
"text": "49,000000",
"colspan": 1
}, {
"align": "left",
"color": "#000000",
"style": "bold",
"text": "63,000000",
"colspan": 1
}, {
"align": "left",
"color": "#000000",
"style": "bold",
"text": "14,000000",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "bold",
"text": "R$ 53,50",
"colspan": 1
}]]
},
{
"rows": [[{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Leitura de água:",
"colspan": 1
}, {
"align": "left",
"color": "#000000",
"style": "bold",
"text": "Data: 25/11/2017",
"colspan": 3
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Anterior",
"colspan": 1
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Atual Consumo",
"colspan": 1
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "m³",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "normal",
"text": "Total",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "bold",
"text": "112,500000",
"colspan": 1
}, {
"align": "left",
"color": "#000000",
"style": "bold",
"text": "114,900000",
"colspan": 1
}, {
"align": "left",
"color": "#000000",
"style": "bold",
"text": "2,400000",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "bold",
"text": "R$ 43,00",
"colspan": 1
}]]
},
{
"rows": [[{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Leitura de esgoto:",
"colspan": 1
},
{
"align": "left",
"color": "#000000",
"style": "bold",
"text": "Data: 25/11/2017",
"colspan": 3
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Anterior",
"colspan": 1
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Atual Consumo",
"colspan": 1
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "m³",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "normal",
"text": "Total",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "bold",
"text": "0,000000",
"colspan": 1
}, {
"align": "left",
"color": "#000000",
"style": "bold",
"text": "0,000000",
"colspan": 1
}, {
"align": "left",
"color": "#000000",
"style": "bold",
"text": "0,00",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "bold",
"text": "R$ 34,40",
"colspan": 1
}]]
}, {
"rows": [[{
"align": "left",
"color": "#000000",
"style": "bold",
"text": "Resumo do rateio",
"colspan": 4
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Despesas de condomínio",
"colspan": 2
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "R$ 450,00",
"colspan": 2
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Investimento",
"colspan": 2
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "R$ 140,00",
"colspan": 2
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Fundo de reserva 10%",
"colspan": 2
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "R$ 79,59",
"colspan": 2
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Leitura de gás",
"colspan": 2
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "R$ 53,50",
"colspan": 2
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Leitura de água",
"colspan": 2
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "R$ 43,00",
"colspan": 2
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Leitura de esgoto",
"colspan": 2
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "R$ 34,40",
"colspan": 2
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Garagens",
"colspan": 2
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "R$ 5,00",
"colspan": 2
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Taxa de administradora",
"colspan": 2
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "R$ 25,00",
"colspan": 2
}], [{
"align": "right",
"color": "#DC143C",
"style": "bold",
"text": "Total geral:",
"colspan": 2
}, {
"align": "left",
"color": "#DC143C",
"style": "bold",
"text": "R$ 823,49",
"colspan": 2
}]]
}]
},
{
"header": "Balancete Geral",
"tables": [{
"rows": [[{
"align": "left",
"color": "#DC143C",
"style": "bold",
"text": "RECEITAS",
"colspan": 4
}], [{
"align": "left",
"color": "#000000",
"style": "bold",
"text": "RECEITAS DE CONDOMÍNIO",
"colspan": 2
}, {
"align": "center",
"color": "#000000",
"style": "bold",
"text": "R$ 2.090,12",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "bold",
"text": "100,00%",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Taxa de Condominio",
"colspan": 2
}, {
"align": "center",
"color": "#000000",
"style": "normal",
"text": "R$ 1.030,00",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "normal",
"text": "49,28%",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Investimentos",
"colspan": 2
}, {
"align": "center",
"color": "#000000",
"style": "normal",
"text": "R$ 280,00",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "normal",
"text": "13,40%",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Gás",
"colspan": 2
}, {
"align": "center",
"color": "#000000",
"style": "normal",
"text": "R$ 50,73",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "normal",
"text": "2,43%",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Garagens",
"colspan": 2
}, {
"align": "center",
"color": "#000000",
"style": "normal",
"text": "R$ 23,00",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "normal",
"text": "1,10%",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Reserva Técnica",
"colspan": 2
}, {
"align": "center",
"color": "#000000",
"style": "normal",
"text": "R$ 183,19",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "normal",
"text": "8,67%",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Água",
"colspan": 2
}, {
"align": "center",
"color": "#000000",
"style": "normal",
"text": "R$ 249,00",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "normal",
"text": "11,91%",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Esgoto",
"colspan": 2
}, {
"align": "center",
"color": "#000000",
"style": "normal",
"text": "R$ 199,20",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "normal",
"text": "9,53%",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Taxa Administradora",
"colspan": 2
}, {
"align": "center",
"color": "#000000",
"style": "normal",
"text": "R$ 75,00",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "normal",
"text": "3,59%",
"colspan": 1
}]] }, {
"rows": [[{
"align": "left",
"color": "#DC143C",
"style": "bold",
"text": "DESPESAS",
"colspan": 4
}], [{
"align": "left",
"color": "#000000",
"style": "bold",
"text": "DESPESAS DE CONDOMÍNIO",
"colspan": 2
}, {
"align": "center",
"color": "#000000",
"style": "bold",
"text": "R$ 1.670,12",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "bold",
"text": "100,00%",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "bold",
"text": "DESPESAS DE AQUISIÇÕES",
"colspan": 4
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Despesas de condomínio",
"colspan": 2
}, {
"align": "center",
"color": "#000000",
"style": "normal",
"text": "R$ 800,00",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "normal",
"text": "47,90%",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Reformas do prédio",
"colspan": 2
}, {
"align": "center",
"color": "#000000",
"style": "normal",
"text": "R$ 350,00",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "normal",
"text": "20,96%",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": " ",
"colspan": 2
}, {
"align": "center",
"color": "#000000",
"style": "bold",
"text": "R$ 1.150,00",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "bold",
"text": "68,86%",
"colspan": 1
}]] } , {
"rows": [[{
"align": "left",
"color": "#000000",
"style": "bold",
"text": "DESPESAS COM SERVIÇOS",
"colspan": 4
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Serviço de Vigilância Contratado",
"colspan": 2
}, {
"align": "center",
"color": "#000000",
"style": "normal",
"text": "R$ 300,00",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "normal",
"text": "17,96%",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Serviço de Zeladoria Contratado",
"colspan": 2
}, {
"align": "center",
"color": "#000000",
"style": "normal",
"text": "R$ 130,00",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "normal",
"text": "7,78%",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Serviço de Jardinagem",
"colspan": 2
}, {
"align": "center",
"color": "#000000",
"style": "normal",
"text": "R$ 80,00",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "normal",
"text": "4,79%",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": " ",
"colspan": 2
}, {
"align": "center",
"color": "#000000",
"style": "bold",
"text": "R$ 510,00",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "bold",
"text": "30,54%",
"colspan": 1
}]]} , {
"rows": [[{
"align": "left",
"color": "#000000",
"style": "bold",
"text": "DESPESAS BANCÁRIAS",
"colspan": 4
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Tarifa Bancária",
"colspan": 2
}, {
"align": "center",
"color": "#000000",
"style": "normal",
"text": "R$ 10,00",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "normal",
"text": "0,60%",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": " ",
"colspan": 2
}, {
"align": "center",
"color": "#000000",
"style": "bold",
"text": "R$ 10,00",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "bold",
"text": "0,60%",
"colspan": 1
}]] } , {
"rows": [[{
"align": "left",
"color": "#DC143C",
"style": "bold",
"text": "Resumo de Prestação de Contas",
"colspan": 4
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "RECEITAS",
"colspan": 2
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "R$ 2.090,12",
"colspan": 2
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "DESPESAS",
"colspan": 2
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "R$ 1.670,00",
"colspan": 2
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": " ",
"colspan": 2
}, {
"align": "left",
"color": "#000000",
"style": "bold",
"text": "(Receitas - Despesas)R$ 420,12",
"colspan": 2
}]]} , {
"rows": [[{
"align": "left",
"color": "#DC143C",
"style": "bold",
"text": "Resumo de Saldos",
"colspan": 4
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Conta",
"colspan": 1
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Saldo Anterior",
"colspan": 1
},{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Entradas Saídas",
"colspan": 1
}, {
"align": "right",
"color": "#000000",
"style": "normal",
"text": "Saldo Atual",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "BANCOS",
"colspan": 1
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "21.816,28",
"colspan": 1
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "2.090,12 1670,00",
"colspan": 2
}, {
"align": "right",
"color": "#000000",
"style": "normal",
"text": "22.236,40",
"colspan": 2
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Banco do Brasil",
"colspan": 1
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "21.816,28",
"colspan": 1
}, {
"align": "left",
"color": "#000000",
"style": "normal",
"text": "2.090,12 1670,00",
"colspan": 2
}, {
"align": "right",
"color": "#000000",
"style": "normal",
"text": "22.236,40",
"colspan": 2
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": " ",
"colspan": 2
}, {
"align": "left",
"color": "#000000",
"style": "bold",
"text": "(Bancos + Caixa)R$ 22.236,40",
"colspan": 2
}]] } , {
"rows": [[{
"align": "left",
"color": "#DC143C",
"style": "bold",
"text": "Contas a Receber",
"colspan": 4
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Contas a Receber até 30/09/2017",
"colspan": 3
}, {
"align": "left",
"color": "#000000",
"style": "bold",
"text": "R$ 2.271,27",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Contas a Receber no Período de 01/10/17 até 30/10/2017",
"colspan": 3
}, {
"align": "left",
"color": "#000000",
"style": "bold",
"text": "R$ 549,31",
"colspan": 1
}], [{
"align": "left",
"color": "#000000",
"style": "normal",
"text": "Total de Contas a Receber",
"colspan": 3
}, {
"align": "left",
"color": "#000000",
"style": "bold",
"text": "R$ 2.820,58",
"colspan": 1
}]]
}]
}]
}

A seguir um exemplo de utilização, de acordo com as SDKs que disponibilizamos:

<?php
require __DIR__.'/../../vendor/autoload.php'; // caminho relacionado a SDK
use Gerencianet\Exception\GerencianetException;
use Gerencianet\Gerencianet;
$clientId = 'informe_seu_client_id'; // insira seu Client_Id, conforme o ambiente (Des ou Prod)
$clientSecret = 'informe_seu_client_secret'; // insira seu Client_Secret, conforme o ambiente (Des ou Prod)
$options = [
'client_id' => $clientId,
'client_secret' => $clientSecret,
'sandbox' => true // altere conforme o ambiente (true = desenvolvimento e false = producao)
];
// $charge_id refere-se ao ID da transação gerada anteriormente
$params = [
'id' => $charge_id
];
$body = [
'title' => 'Balancete Demonstrativo',
'body' =>
[
0 =>
[
'header' => 'Demonstrativo de Consumo',
'tables' =>
[
0 =>
[
'rows' =>
[
0 =>
[
0 =>
[
'align' => 'left',
'color' => '#000000',
'style' => 'bold',
'text' => 'Exemplo de despesa',
'colspan' => 2,
],
1 =>
[
'align' => 'left',
'color' => '#000000',
'style' => 'bold',
'text' => 'Total lançado',
'colspan' => 2,
],
],
1 =>
[
0 =>
[
'align' => 'left',
'color' => '#000000',
'style' => 'normal',
'text' => 'Instalação',
'colspan' => 2,
],
1 =>
[
'align' => 'left',
'color' => '#000000',
'style' => 'normal',
'text' => 'R$ 100,00',
'colspan' => 2,
],
],
],
],
],
],
1 =>
[
'header' => 'Balancete Geral',
'tables' =>
[
0 =>
[
'rows' =>
[
0 =>
[
0 =>
[
'align' => 'left',
'color' => '#000000',
'style' => 'normal',
'text' => 'Confira na documentação da Gerencianet todas as configurações possíveis de um boleto balancete.',
'colspan' => 4,
],
],
],
],
],
],
],
];
try {
$api = new Gerencianet($options);
$response = $api->createChargeBalanceSheet($params, $body);
print_r($response);
} catch (GerencianetException $e) {
print_r($e->code);
print_r($e->error);
print_r($e->errorDescription);
} catch (Exception $e) {
print_r($e->getMessage());
}

Como resultado do consumo do código do boleto balancete, é possível visualizar um exemplo de layout do boleto do tipo balancete, conforme demonstrado na imagem:

IMPORTANTE

As informações contidas no balancete não serão utilizadas pela Gerencianet. Recebemos o conteúdo da requisição de seu sistema/aplicação e apenas montamos a cobrança da forma que o integrador espera receber, conforme layout de exemplo acima.

Ou seja, a Gerencianet não valida as informações presentes no balancete e nem efetua cálculos de seu balancete, apenas processa e monta os dados dentro do layout conforme a estrutura do código contido em sua requisição à rota POST /charge/:id/balance-sheet.



IMPORTANTE

As requisições para o endpoint de balancete não devem exceder 300 KB (body da requisição).


a) Estrutura hierárquica dos atributos que podem ser utilizados:

"id": "/BalanceSheet"
"title"
"body"
"header"
"tables"
"rows"
"header"
"tables"
"rows"

b) Atributos que podem ser utilizados:

AtributoDescriçãoObrigatórioTipo
titleDefine o título no topo do boleto balancete.
Tamanho: mínimo de 3 caracteres e máximo de 255.		SimString
bodyDefine o corpo do boleto balancete contendo todas as informações a serem montadas.SimArray
headerExibe um texto (título) no cabeçalho. Refere-se ao 1º quadrante do boleto.
Tamanho: mínimo de 3 caracteres e máximo de 255. (String).		SimString
rowsRelacionado às linhas utilizadas. Refere-se ao 1º quadrante do boleto.

Atributos de rows:
align*// alinhamento do texto. Valores possíveis: left, center ou right. (String)

number*// Número (String/Integer)

neighborhood*// Bairro (String)

zipcode*// CEP (sem pontos ou hífen) (String)

city*// Cidade (String)

complement// Complemento (String/null)

state*// Estado (2 caracteres) (Object)		SimArray
headerDxibe um texto (título) no cabeçalho. Refere-se ao 2º quadrante do boleto.
Tamanho: mínimo de 3 caracteres e máximo de 255. (String).		SimString
tablesPropriedade que define a criação da tabela. Refere-se ao 2º quadrante do boleto.SimArray
rowsRelacionado às linhas utilizadas. Refere-se ao 2º quadrante do boleto.

Atributos de rows:
align*// alinhamento do texto. Valores possíveis: left, center ou right. (String)

number*// Número (String/Integer)

neighborhood*// Bairro (String)

zipcode*// CEP (sem pontos ou hífen) (String)

city*// Cidade (String)

complement// Complemento (String/null)

state*// Estado (2 caracteres) (Object)		SimArray

Os campos com * representam valores obrigatórios


3. Associar à forma de pagamento via boleto

Com a transação gerada com sucesso, agora vamos associar com a forma de pagamento desejada - neste caso, será banking_billet (boleto bancário). Para tal, deverá ser informado o charge_id obtido ao criar a transação.

Neste momento, ao definir boleto bancário como forma de pagamento da transação, seu status será alterado de new para waiting. Isso significa que a forma de pagamento foi selecionada e está aguardando a confirmação do pagamento.

Para associar à forma de pagamento, você deve enviar uma requisição POST para a rota /v1/charge/:id/pay, onde :id é o charge_id da transação desejada.

Caso queira, pode explorar e conhecer mais sobre este recurso usando nosso Playground

O exemplo abaixo mostra como isto pode ser feito, utilizando as SDK's disponíveis:

<?php
require __DIR__.'/../../vendor/autoload.php'; // caminho relacionado a SDK
use Gerencianet\Exception\GerencianetException;
use Gerencianet\Gerencianet;
$clientId = 'informe_seu_client_id'; // insira seu Client_Id, conforme o ambiente (Des ou Prod)
$clientSecret = 'informe_seu_client_secret'; // insira seu Client_Secret, conforme o ambiente (Des ou Prod)
$options = [
'client_id' => $clientId,
'client_secret' => $clientSecret,
'sandbox' => true // altere conforme o ambiente (true = desenvolvimento e false = producao)
];
// $charge_id refere-se ao ID da transação gerada anteriormente
$params = [
'id' => $charge_id
];
$customer = [
'name' => 'Gorbadoc Oldbuck', // nome do cliente
'cpf' => '94271564656' , // cpf válido do cliente
'phone_number' => '5144916523' // telefone do cliente
];
$bankingBillet = [
'expire_at' => '2018-12-12', // data de vencimento do boleto (formato: YYYY-MM-DD)
'customer' => $customer
];
$payment = [
'banking_billet' => $bankingBillet // forma de pagamento (banking_billet = boleto)
];
$body = [
'payment' => $payment
];
try {
$api = new Gerencianet($options);
$charge = $api->payCharge($params, $body);
print_r($charge);
} catch (GerencianetException $e) {
print_r($e->code);
print_r($e->error);
print_r($e->errorDescription);
} catch (Exception $e) {
print_r($e->getMessage());
}

a) Estrutura hierárquica dos atributos que podem ser utilizados:

"id": "/Pay",
"payment"
"banking_billet"
"customer"
"name"
"cpf"
"email"
"phone_number"
"birth"
"address"
"street"
"number"
"neighborhood"
"zipcode"
"city"
"complement"
"state"
"juridical_person"
"corporate_name"
"cnpj"
"expire_at"
"discount"
"type"
"percentage",
"currency"
"value"
"conditional_discount"
"type"
"percentage",
"currency"
"value"
"until_date"
"configurations"
"fine"
"interest"
"message"

Para verificar mais detalhes, acesse aqui

b) Atributos que podem ser utilizados:

AtributoDescriçãoObrigatórioTipo
paymentTag raizSimObjeto Payment

Objeto Payment

AtributoDescriçãoObrigatórioTipo
banking_billetForma de pagamento através de "boleto bancário"SimObjeto Banking_Billet

Objeto Banking_Billet

AtributoDescriçãoObrigatórioTipo
nameNome do cliente.
Mínimo de 1 caractere e máximo de 255 caracteres (String).		Sim
Obs: Para Pessoa Jurídica não serão obrigatórios o nome e CPF, apenas os demais dados do cliente.		String
cpfCPF válido do cliente (sem pontos, vírgulas ou hífen).
Tamanho: 11 caracteres.		Sim
Obs: Para Pessoa Jurídica não serão obrigatórios o nome e CPF, apenas os demais dados do cliente.		String
emailEmail do cliente.
Máximo de 255 caracteres. Ex.: email@email.com		NãoString
phone_numberTelefone do cliente.
Formato: sem pontos ou vírgulas, com DDD de 2 caracteres (9º dígito é opcional). Ex.: 11988887777		SimString
birthData de nascimento do cliente.
Formato: YYYY-MM-DD		NãoString
addressEndereço do cliente.

Atributos de address:
street*// Nome da rua (Object)

number*// Número (String/Integer)

neighborhood*// Bairro (String)

zipcode*// CEP (sem pontos ou hífen) (String)

city*// Cidade (String)

complement// Complemento (String/null)

state*// Estado (2 caracteres) (Object)		NãoObject
juridical_personDados de pessoa jurídica.

Atributos de juridical_person:

corporate_name*// Nome da razão social. Mínimo de 1 caractere e máximo de 255. String.

cnpj*// CNPJ da empresa. Tamanho: 14 caracteres. String.		NãoObject
expire_atData de vencimento do boleto.
Formato: YYYY-MM-DD		SimString
discountDefine dados de desconto sobre a cobrança.

Atributos de discount:

type*// Tipo do desconto (String). Valores permitidos:
currency: o desconto será informado em centavos. percentage: o desconto será informado em porcentagem.

cnpj*// CNPJ da empresa. Tamanho: 14 caracteres. String.

value*// Valor do desconto (Integer). Se o tipo do desconto for currency , o valor desta tag deverá ser informada pelo integrador em centavos (ou seja, 500 equivale a R$ 5,00). Caso o tipo do desconto seja percentage, o valor deverá ser multiplicado por 100 (ou seja, 1500 equivale a 15%). Exemplos:
1)currency// deve ser informado em centavos, ou seja, se o desconto será de R$ 5,99, o integrador deve informar 599;
2)percentage // deve ser informado em centavos, ou seja, se o desconto é de 15%, o integrador deve informar 1500.

NãoObject
conditional_discountDefine desconto condicional que é válido até uma data específica. Se o pagamento não for efetuado até aquela data, o desconto é invalidado.

Atributos de conditional_discount:

type*// Tipo do desconto (String). Valores permitidos:
currency: o desconto será informado em centavos. percentage: o desconto será informado em porcentagem.

cnpj*// CNPJ da empresa. Tamanho: 14 caracteres. String.

value*// Valor do desconto (Integer). Se o tipo do desconto for currency , o valor desta tag deverá ser informada pelo integrador em centavos (ou seja, 500 equivale a R$ 5,00). Caso o tipo do desconto seja percentage, o valor deverá ser multiplicado por 100 (ou seja, 1500 equivale a 15%). Exemplos:
1)currency// deve ser informado em centavos, ou seja, se o desconto será de R$ 5,99, o integrador deve informar 599;
2)percentage // deve ser informado em centavos, ou seja, se o desconto é de 15%, o integrador deve informar 1500.

NãoObject
configurationsPermite incluir no boleto multa e juros caso seja pago após o vencimento.

Atributos de configurations:

fine// Valor cobrado de multa após o vencimento. Por exemplo: se você quiser 2%, você deve informar 200.Mínimo de 0 e máximo de 1000. Integer.

Caso você possua configurações de multa ativada na Gerencianet e queira gerar emissões na API sem multa, utilize 0como valor do atributo fine

interest// Valor cobrado de juros por dia após a data de vencimento. Por exemplo: se você quiser 0,033%, você deve informar 33.Mínimo de 0 e máximo de 330. Integer.

Caso você possua configurações de multa ativada na Gerencianet e queira gerar emissões na API sem juros, utilize 0 como valor do atributo interest		NãoObject
messagePermite incluir no boleto uma "observação", ou em outras palavras, uma mensagem para o cliente. Essa mensagem poderá ser vista nos e-mails relacionados à cobrança, no boleto ou carnê.
Até 4 linhas contendo 100 caracteres em cada linha. String.
O operador \né utilizado para efetuar a quebra de linha.		NãoString

Os campos com * representam valores obrigatórios


4. Outros endpoints e métodos

Existem outros endpoints e métodos relacionados a pagamento via boleto bancário do tipo balancete que estão disponíveis na API e podem ser explorados pelo integrador. Confira a relação completa: