> ## 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.

# Gerar Cobrança de Parcela(s)

Este endpoint permite a emissão individual de cobranças para contratos ou parcelas específicas.

Ele facilita a criação de uma cobrança, onde são fornecidos parâmetros como quantidade de parcelas e data de vencimento. Possibilitando a escolha da data e das parcelas que desejam ser liquidadas.

A funcionalidade do endpoint abrange apenas a modalidade de cobrança:

* PIX Cobrança: geração de cobrança exclusivamente via chave PIX.

<Warning>O campo `codigoLiquidacao`, gerado na resposta deste endpoint, precisa ser salvo. Esse valor é necessário para solicitar o cancelamento das cobranças emitidas para as parcelas, no endpoint [Cancelar Cobranças de Parcela](https://bmpdocs.moneyp.com.br/fgts/api-reference/liquidacao-antecipada/cancelar-cobranca).</Warning>


## OpenAPI

````yaml post /FGTS/GerarUnicaCobranca
openapi: 3.0.1
info:
  title: BMPDigitalCore.ApiExterna.FGTS.API
  version: '1.0'
servers:
  - url: https://api.bmpdigital.moneyp.dev.br
security:
  - Bearer: []
paths:
  /FGTS/GerarUnicaCobranca:
    post:
      tags:
        - FGTS
      parameters:
        - name: IdempotencyKey
          in: header
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgendaRecebivelGerarUnicaCobrancaCommand'
          text/json:
            schema:
              $ref: '#/components/schemas/AgendaRecebivelGerarUnicaCobrancaCommand'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AgendaRecebivelGerarUnicaCobrancaCommand'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AgendaRecebivelInclusaoCobrancaResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/AgendaRecebivelInclusaoCobrancaResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AgendaRecebivelInclusaoCobrancaResponse'
        '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:
    AgendaRecebivelGerarUnicaCobrancaCommand:
      type: object
      properties:
        Dto:
          $ref: '#/components/schemas/InclusaoCobrancaPixDTO'
      additionalProperties: false
    AgendaRecebivelInclusaoCobrancaResponse:
      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
        Cobrancas:
          type: array
          items:
            $ref: '#/components/schemas/CobrancaGeradaDTO'
          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
    InclusaoCobrancaPixDTO:
      required:
        - CodigoProposta
        - DtVencimento
        - QtdeParcelas
      type: object
      properties:
        DescricaoLiquidacao:
          maxLength: 50
          minLength: 0
          type: string
          description: Descrição para Liquidacao na Agenda.
          nullable: true
        CodigoProposta:
          type: string
          description: Código identificador da proposta FGTS na BMP.
          format: uuid
        QtdeParcelas:
          type: integer
          description: Número das parcelas a serem Liquidadas.
          format: int32
        DtVencimento:
          type: string
          description: DtVencimento das parcelas a serem Liquidadas.
          format: date
      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
    CobrancaGeradaDTO:
      type: object
      properties:
        CodigoLiquidacao:
          type: string
          format: uuid
        Parcelas:
          type: array
          items:
            type: integer
            format: int32
          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

````