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

> Esse serviço é utilizado para gerar uma cobrança para uma ou mais parcelas de um empréstimo, criando um registro que permitirá ao cliente efetuar o pagamento (Via boleto ou PIX). Ele é acionado quando se deseja formalizar a cobrança de parcelas específicas.

<RequestExample>
  ```shellscript Exemplo de requisição theme={null}
  curl --location --request POST 'https://econsignadotrabalhador.moneyp.dev.br/contrato/parcela/gerar-cobranca' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {token}' \
  --data '{
  	"NumeroContrato": "5075328",
  	"NroParcelas": [
  		3
  	],
  	"DataVencimento": "2025-12-01",
  	"DataExpiracao": "2025-12-01",
  	"Liquidacao": true,
  	"PagamentoViaBoleto": true,
  	"DescricaoLiquidacao": "PAGAMENTO",
  	"PagamentoViaPIX": false,
  	"ValorLiquidacao": null,
  	"ValorDesconto": 0,
  	"PermiteDescapitalizacao": true,
  	"motivoLancamentoCobranca": 0
  }'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
  	"CodigoRequisicao": "0be241b2-9508-4679-88ca-d53f5c7420ac",
  	"Origem": "/contrato/parcela/gerar-cobranca",
  	"Conteudo": {
  		"cobrancas": [
  			{
  				"codigoLiquidacao": "f70e58c7-0eca-451a-a725-28ba4c0ad51c",
  				"parcelas": [
  					3
  				]
  			}
  		]
  	},
  	"Erros": []
  }
  ```
</ResponseExample>

<AccordionGroup>
  <Accordion title="Descrição dos campos da requisição">
    <ParamField path="numeroContrato" type="number" required>
      Número do contrato que será gerada a cobrança.
    </ParamField>

    <ParamField path="NroParcelas" type="number[]" required>
      Números das parcelas do contrato que serão incluídas na cobrança.
    </ParamField>

    <ParamField path="DataVencimento" type="string<date>" required>
      Data de vencimento da cobrança em formato `aaaa-mm-dd`.
    </ParamField>

    <ParamField path="DataExpiracao" type="string<date>" required>
      Data de expiração da cobrança em formato `aaaa-mm-dd`.
    </ParamField>

    <ParamField path="Liquidacao" type="boolean" required>
      Se verdadeiro, indica que é uma cobrança total e não há necessidade de preencher o campo ValorLiquidacao.
    </ParamField>

    <ParamField path="PagamentoViaBoleto" type="boolean" required>
      Indica se é um pagamento por boleto. Se a cobrança for boleto híbrido(com pix), apenas PagamentoViaBoleto deve estar com verdadeiro.
    </ParamField>

    <ParamField path="PagamentoViaPIX" type="boolean" required>
      Indica se é um pagamento por pix cobrança. Se a cobrança for boleto híbrido(com pix), apenas PagamentoViaBoleto deve estar com verdadeiro.
    </ParamField>

    <ParamField path="DescricaoLiquidacao" type="string" required>
      Descrição que será preenchida quanto houver o pagamento na parcela.
    </ParamField>

    <ParamField path="ValorLiquidacao" type="number">
      Valor da cobrança. Não é necessário preencher este campo de `liquidacao` for verdadeiro.
    </ParamField>

    <ParamField path="ValorDesconto" type="number">
      Valor de desconto aplicado.
    </ParamField>

    <ParamField path="permiteDescapitalizacao" type="boolean">
      Indica se o cálculo das parcelas nesta consulta deve ser aplicado descapitalização e  encargos.
    </ParamField>

    <ParamField path="motivoLancamentoCobranca" type="number">
      Motivo que será preenchida a baixa da parcela.

      * 0 - Liquidação Parcial
      * 1 - Liquidação Total
      * 2 - Liquidação por Cancelamento
      * 3 - Liquidação por Fraude
      * 4 - Liquidação por Óbito
      * 5 - Liquidação por Pré-Pagamento/Antecipação FGTS
      * 6 - Liquidação por Renegociação
      * 7 - Liquidação por Recompra/Troca de titularidade/Alienação a Terceiros
      * 8 - Liquidação por Antecipação Parcial
      * 9 - Liquidação por Antecipação Total
    </ParamField>
  </Accordion>

  <Accordion title="Descrição dos campos do retorno">
    <ParamField path="cobrancas" type="object[]">
      Lista das cobranças.

      <ParamField path="cobrancas.codigoLiquidacao" type="string">
        Identificador da cobrança gerada.
      </ParamField>

      <ParamField path="cobrancas.parcelas" type="number">
        Parcelas cobertas por essa cobrança.
      </ParamField>
    </ParamField>
  </Accordion>
</AccordionGroup>
