Obtendo o Boleto de uma Parcela de Contrato

O boleto de uma parcela específica de contratos gerados com este meio de pagamento pode ser obtido em formato PDF, de acordo com modelos no layout padrão do CobranSaaS ou em layouts personalizados para contratos (dívidas), através do método Parcelas API - Gerar boleto parcela.

A identificação (id) da parcela do contrato e o nome do arquivo em formato PDF a ser retornado com o boleto devem ser informados na URL de chamada do método.

Através do parâmetro de entrada modelo, opcional, pode ou não ser informado o id (identificador) do modelo a ser utilizado na geração do boleto, que pode ser obtido conforme descrito em Obtendo os Modelos de Boletos e pode ser do layout PADRAO ou PERSONALIZADO. Quando não é informado o parâmetro de entrada modelo, o boleto é gerado conforme o modelo padrão do CobranSaaS.

Quando é informado, o modelo obrigatoriamente precisa ser do tipo BOLETO. Caso contrário, um código de erro 400 (Tratamento de Erros) é retornado com a mensagem "O modelo informado não é do tipo boleto".

Quando é informado, o modelo obrigatoriamente também precisa ser da categoria CONTRATO_PARCELA. Caso contrário, um código de erro 400 (Tratamento de Erros) é retornado com a mensagem "O modelo informado não é da categoria esperada".

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