Obtendo os Modelos de Boletos

Boletos de negociações ou parcelas podem ser gerados em PDF no layout padrão do CobranSaaS ou personalizado.

A lista de modelos disponíveis pode ser obtida pelo método Modelos API - Listar modelos. Como pode retornar vários registros, é importante usar a Paginação.

Na chamada, use o parâmetro tipo com valor BOLETO para filtrar apenas modelos de boleto. Recomenda-se usar situacao como ATIVO para listar só modelos ativos. O parâmetro categoria permite filtrar por categorias específicas, como ACORDO, CONTRATO, PAGAMENTO_AVULSO, entre outras, podendo haver múltiplos modelos por categoria. O parâmetro nome serve para buscar modelos pelo início ou nome completo.

Os modelos retornam o id, usado para gerar boletos, e o layout (PADRAO ou PERSONALIZADO), indicando o tipo de layout usado.

Também existe o método Modelos API - Buscar modelo para obter informações de um modelo específico, informando seu id na URL.

Exemplos de chamadas e de retornos destes métodos constam no arquivo Assessorias - Modelos API.postman_collection.json, disponível como anexo em Integrando Assessorias através da API do CobranSaaS.