Os boletos de negociações geradas ou de parcelas de dívidas com este meio de pagamento podem ser gerados em formato PDF conforme modelos no layout padrão do CobranSaaS ou em layouts personalizados para os tipos de modalidade de negociação.
A lista dos modelos de boletos disponíveis pode ser obtida através do método Modelos API - Listar modelos e, por poder retornar múltiplos registros, é importante observar as questões relativas à Paginação ao fazer chamadas a este método.
Conforme consta na documentação deste método, estão disponíveis parâmetros de entrada que podem ser informados na chamada do método para restringir a lista de modelos retornados. Primeiramente, o parâmetro tipo (BOLETO, CARTA, DOCUMENTO, EMAIL, SMS) deve ser informado com a opção BOLETO, de forma que somente modelos deste tipo sejam retornados. É recomentado que o parâmetro situacao seja informado como ATIVO para que somente os modelos que estiverem ativos sejam retornados. Através do parâmetro categoria também podem ser retornados somente modelos de uma ou mais categorias específicas de modelo como, por exemplo, ACORDO, ACORDO_PARCELA, CONTRATO, CONTRATO_PARCELA, PAGAMENTO_AVULSO, PROPOSTA, PROPOSTA_CONDICAO e RENEGOCIACAO, sendo importante observar que, para cada categoria, podem estar disponíveis mais de um modelos diferentes de boletos. O parâmetro nome pode ser utilizado para pesquisar modelos cujo nome inicie com um determinado conteúdo e também para pesquisar modelos específicos através do nome completo.
Entre outras informações, os modelos de boletos são retornados com o id que, por sua vez, é utilizado para identificar o modelo na geração dos boletos, e com o layout (PADRAO e PERSONALIZADO), que indica se o modelo utiliza o layout padrão do CobranSaaS ou algum layout personalizado.
Também está disponível o método Modelos API - Buscar modelo que retorna as informações de apenas um modelo específico, cuja identificação (id) deve ser informada na URL de chamada do método.
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.
0 Comentários