Pular para o conteúdo principal

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.

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
}'

{
	"CodigoRequisicao": "0be241b2-9508-4679-88ca-d53f5c7420ac",
	"Origem": "/contrato/parcela/gerar-cobranca",
	"Conteudo": {
		"cobrancas": [
			{
				"codigoLiquidacao": "f70e58c7-0eca-451a-a725-28ba4c0ad51c",
				"parcelas": [
					3
				]
			}
		]
	},
	"Erros": []
}
​
numeroContrato
number
obrigatório
Número do contrato que será gerada a cobrança.
​
NroParcelas
number[]
obrigatório
Números das parcelas do contrato que serão incluídas na cobrança.
​
DataVencimento
string<date>
obrigatório
Data de vencimento da cobrança em formato aaaa-mm-dd.
​
DataExpiracao
string<date>
obrigatório
Data de expiração da cobrança em formato aaaa-mm-dd.
​
Liquidacao
boolean
obrigatório
Se verdadeiro, indica que é uma cobrança total e não há necessidade de preencher o campo ValorLiquidacao.
​
PagamentoViaBoleto
boolean
obrigatório
Indica se é um pagamento por boleto. Se a cobrança for boleto híbrido(com pix), apenas PagamentoViaBoleto deve estar com verdadeiro.
​
PagamentoViaPIX
boolean
obrigatório
Indica se é um pagamento por pix cobrança. Se a cobrança for boleto híbrido(com pix), apenas PagamentoViaBoleto deve estar com verdadeiro.
​
DescricaoLiquidacao
string
obrigatório
Descrição que será preenchida quanto houver o pagamento na parcela.
​
ValorLiquidacao
number
Valor da cobrança. Não é necessário preencher este campo de liquidacao for verdadeiro.
​
ValorDesconto
number
Valor de desconto aplicado.
​
permiteDescapitalizacao
boolean
Indica se o cálculo das parcelas nesta consulta deve ser aplicado descapitalização e encargos.
​
motivoLancamentoCobranca
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
​
cobrancas
object[]
Lista das cobranças.
​
cobrancas.codigoLiquidacao
string
Identificador da cobrança gerada.
​
cobrancas.parcelas
number
Parcelas cobertas por essa cobrança.