> ## Documentation Index
> Fetch the complete documentation index at: https://bmpdocs.moneyp.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# 9 - Gerar Único Boleto

Permite gerar um único boleto para as parcelas informadas definindo data de vencimento e valor de desconto, podendo ou não notificar o cliente.

## Mensagens de erro

A tabela abaixo representa as mensagens de erro que podem ser retornadas ao tentar realizar uma requisição.

<Expandable title="Mensagens de requisições com erro">
  O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:

  <Note>No exemplo de retorno ao lado, o campo `code` representa a coluna **Código** desta tabela; o campo `context` representa a coluna **Contexto**; e o campo `description` representa a coluna **Erro**.</Note>

  | Contexto | Código | Erro                                                                                |
  | -------- | ------ | ----------------------------------------------------------------------------------- |
  | C0159    | V0001  | Informe as parcelas                                                                 |
  | C0159    | V0002  | Para boleto parcial, deve ser informado apenas uma parcela                          |
  | C0159    | V0003  | Para boleto de liquidação, o valor do boleto não deve ser informado                 |
  | C0159    | V0004  | Para boleto parcial, o valor do boleto deve ser informado                           |
  | C0159    | V0005  | Informe a data de vencimento do boleto                                              |
  | C0159    | V0006  | A data de expiração não pode ser anterior à data de vencimento do boleto            |
  | C0156    | V0001  | Nenhuma parcela encontrada                                                          |
  | C0156    | V0002  | Informe o Valor da Liquidação                                                       |
  | C0156    | V0003  | A Descrição do boleto deve ser preenchida                                           |
  | C0156    | V0004  | Parcelas XXXX não localizadas                                                       |
  | C0156    | V0005  | Parcelas XXXX já pagas, não é possível gerar liquidação                             |
  | C0156    | V0006  | Já existe uma cobrança em aberto para a agenda e parcelas em questão: XXXX          |
  | C0156    | V0007  | Parcelas XXXX vencidas                                                              |
  | C0156    | V0008  | Valor de desconto não deve ser igual ou superior ao valor da cobrança gerada        |
  | C0150    | V0001  | Valor de desconto maior ou igual ao valor da parcela                                |
  | C0150    | V0004  | Parceiro não tem permissão para aplicar desconto em boletos na Agenda de Recebíveis |
  | C0150    | V0005  | Descapitalização desabilitada para esta agenda                                      |
  | C0150    | V0006  | Descapitalização desabilitada para esta agenda                                      |
  | C0165    | V0002  | Deve ser enviado pelo menos um boleto                                               |
  | C0165    | V0003  | Data de vencimento deve ser maior que a data atual                                  |
  | C0165    | V0004  | Valor do boleto deve ser informado                                                  |
  | C0165    | V0005  | Cliente não cadastrado                                                              |
  | C0168    | V0001  | Empresa não localizada                                                              |
  | C0168    | V0002  | Produto x Rede não configurado                                                      |
  | C0168    | V0003  | Para gerar Boleto deve existir um endereço cadastrado na empresa                    |
  | C0168    | V0004  | Produto x Rede não possui sequência de boleto avulso definida. Layout \[XXXX]       |
  | C0168    | V0005  | Sequência de Boleto avulso não localizada. Layout \[XXXX]                           |
  | C0168    | V0006  | Layout Bancário não configurado                                                     |
  | C0168    | V0007  | Sequência de Boleto Avulso não localizada                                           |
  | C0267    | V0001  | Sequência inválida                                                                  |
  | C0337    | V0002  | Não foi possível salvar os Boletos para registro automático                         |
  | C0337    | V0003  | Não foi possível salvar os Parâmetros dos Boletos para registro automático          |
  | C0527    | V0001  | Objeto parâmetros da liquidação deve ser informado                                  |
  | C0527    | V0002  | Valor deve ser superior a 0                                                         |
  | C0527    | V0003  | Código de usuário inválido                                                          |
  | C0527    | V0004  | Data de vencimento deve ser informada                                               |
  | C0527    | V0005  | Código da cobrança deve ser informado                                               |
  | C0527    | V0006  | Informe apenas o código do Pix Cobrança ou do Boleto                                |
</Expandable>


## OpenAPI

````yaml post /AgendaRecebivel/GerarUnicoBoleto
openapi: 3.0.1
info:
  title: BMPDigitalCore.ApiExterna.AgendaRecebivel.API
  version: '1.0'
servers:
  - url: https://api.bmpdigital.moneyp.dev.br/
    description: Localhost
security:
  - Bearer: []
paths:
  /AgendaRecebivel/GerarUnicoBoleto:
    post:
      tags:
        - AgendaRecebivel
      parameters:
        - name: IdempotencyKey
          in: header
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgendaRecebivelGeraUnicoBoletoCommand'
          text/json:
            schema:
              $ref: '#/components/schemas/AgendaRecebivelGeraUnicoBoletoCommand'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AgendaRecebivelGeraUnicoBoletoCommand'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ActionResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ActionResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ResponseBase'
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
            text/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
components:
  schemas:
    AgendaRecebivelGeraUnicoBoletoCommand:
      type: object
      properties:
        dto:
          $ref: '#/components/schemas/FindAgendaRecebivelParcelasDTO'
        dtoGerarUnicoBoleto:
          $ref: '#/components/schemas/AgendaRecebivelGerarUnicoBoletoDTO'
      additionalProperties: false
    ActionResponse:
      type: object
      properties:
        msg:
          type: string
          nullable: true
        result:
          type: boolean
          writeOnly: true
        hasError:
          type: boolean
        messages:
          type: array
          items:
            $ref: '#/components/schemas/Message'
          nullable: true
        parametros:
          type: array
          items:
            $ref: '#/components/schemas/ParametroDTO'
          nullable: true
      additionalProperties: false
    ResponseBase:
      type: object
      properties:
        msg:
          type: string
          nullable: true
        result:
          type: boolean
          writeOnly: true
        hasError:
          type: boolean
        messages:
          type: array
          items:
            $ref: '#/components/schemas/Message'
          nullable: true
      additionalProperties: false
    FindAgendaRecebivelParcelasDTO:
      required:
        - nroParcelas
      type: object
      properties:
        codigoProposta:
          type: string
          description: Código identificador da proposta na BMP.
          format: uuid
          nullable: true
        codigoOperacao:
          maxLength: 50
          minLength: 0
          type: string
          description: Código identificador da proposta (valor exclusivo do integrador).
          nullable: true
        nroParcelas:
          type: array
          items:
            type: integer
            format: int32
          description: Array contendo o número das parcelas a serem consultadas.
          nullable: true
      additionalProperties: false
    AgendaRecebivelGerarUnicoBoletoDTO:
      required:
        - descricaoBoleto
        - dtVencimento
      type: object
      properties:
        dtVencimento:
          type: string
          description: Data de vencimento do boleto.
          format: date-time
          nullable: true
        dtExpiracao:
          type: string
          description: Define a data limite de pagamento do boleto.
          format: date-time
          nullable: true
        liquidacao:
          type: boolean
          description: Indica se o boleto deve liquidar a parcela.
        descricaoBoleto:
          maxLength: 200
          minLength: 1
          type: string
          description: Define uma descrição para o boleto gerado.
          nullable: true
        vlrBoleto:
          type: number
          description: >-
            Define o valor do boleto. Obs.: para boletos de liquidação, este
            campo não deve ser informado.
          format: double
          nullable: true
        vlrDesconto:
          type: number
          description: Define um valor de desconto para o boleto.
          format: double
          nullable: true
        permiteDescapitalizacao:
          type: boolean
          description: >-
            Define se o valor da parcela deve ser descapitalizado para a data do
            pagamento.
          nullable: true
        tipoRegistro:
          type: integer
          description: 'Define a modalidade de registro automático: 1 - Online; 2 - Offline.'
          format: int32
          nullable: true
      additionalProperties: false
    Message:
      type: object
      properties:
        messageType:
          $ref: '#/components/schemas/ErrorType'
        code:
          type: string
          nullable: true
        context:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        field:
          type: string
          nullable: true
      additionalProperties: false
    ParametroDTO:
      required:
        - nome
        - valor
      type: object
      properties:
        nome:
          type: string
          nullable: true
        valor:
          type: string
          nullable: true
      additionalProperties: false
    ErrorType:
      enum:
        - 1
        - 2
        - 3
      type: integer
      format: int32
  securitySchemes:
    Bearer:
      type: apiKey
      description: Informe o token
      name: Authorization
      in: header

````