Gerar cobrança de parcela(s)

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,
	"ignorarEscrituracao": false,
	"motivoIgnorarEscrituracao": null
}'

{
	"CodigoRequisicao": "0be241b2-9508-4679-88ca-d53f5c7420ac",
	"Origem": "/contrato/parcela/gerar-cobranca",
	"Conteudo": {
		"cobrancas": [
			{
				"codigoLiquidacao": "f70e58c7-0eca-451a-a725-28ba4c0ad51c",
				"parcelas": [
					3
				]
			}
		]
	},
	"Erros": []
}

{
	"CodigoRequisicao": "GUID",
	"Origem": "/contrato/parcela/gerar-cobranca",
	"Conteudo": null,
	"Erros": [
		{
			"Codigo": "CON_002",
			"Message": "Não é possível gerar cobrança da parcela {NroParcela}: a parcela já possui escrituração e deverá ser paga através da guia de FGTS do empregador.",
			"Id": "GUID",
			"Campo": null
		}
	]
}

{
	"CodigoRequisicao": "GUID",
	"Origem": "/contrato/parcela/gerar-cobranca",
	"Conteudo": null,
	"Erros": [
		{
			"Codigo": "CON_003",
			"Message": "Não é possível gerar cobrança da parcela {NroParcela}: a parcela está em período de escrituração e deverá ser paga através da guia de FGTS do empregador.",
			"Id": "GUID",
			"Campo": 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,
	"ignorarEscrituracao": false,
	"motivoIgnorarEscrituracao": null
}'

{
	"CodigoRequisicao": "0be241b2-9508-4679-88ca-d53f5c7420ac",
	"Origem": "/contrato/parcela/gerar-cobranca",
	"Conteudo": {
		"cobrancas": [
			{
				"codigoLiquidacao": "f70e58c7-0eca-451a-a725-28ba4c0ad51c",
				"parcelas": [
					3
				]
			}
		]
	},
	"Erros": []
}

{
	"CodigoRequisicao": "GUID",
	"Origem": "/contrato/parcela/gerar-cobranca",
	"Conteudo": null,
	"Erros": [
		{
			"Codigo": "CON_002",
			"Message": "Não é possível gerar cobrança da parcela {NroParcela}: a parcela já possui escrituração e deverá ser paga através da guia de FGTS do empregador.",
			"Id": "GUID",
			"Campo": null
		}
	]
}

{
	"CodigoRequisicao": "GUID",
	"Origem": "/contrato/parcela/gerar-cobranca",
	"Conteudo": null,
	"Erros": [
		{
			"Codigo": "CON_003",
			"Message": "Não é possível gerar cobrança da parcela {NroParcela}: a parcela está em período de escrituração e deverá ser paga através da guia de FGTS do empregador.",
			"Id": "GUID",
			"Campo": null
		}
	]
}

Antes de gerar a cobrança, o serviço valida se a parcela já possui escrituração ou se está dentro do período de escrituração vigente. Se qualquer uma dessas condições for verdadeira, a geração da cobrança é bloqueada, pois a parcela deverá ser paga através da guia de FGTS do empregador. Para casos em que o parceiro precise seguir com a cobrança mesmo com escrituração identificada, é possível ignorar essa validação através do campo ignorarEscrituracao (ver descrição dos campos abaixo).

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,
	"ignorarEscrituracao": false,
	"motivoIgnorarEscrituracao": null
}'

{
	"CodigoRequisicao": "0be241b2-9508-4679-88ca-d53f5c7420ac",
	"Origem": "/contrato/parcela/gerar-cobranca",
	"Conteudo": {
		"cobrancas": [
			{
				"codigoLiquidacao": "f70e58c7-0eca-451a-a725-28ba4c0ad51c",
				"parcelas": [
					3
				]
			}
		]
	},
	"Erros": []
}

{
	"CodigoRequisicao": "GUID",
	"Origem": "/contrato/parcela/gerar-cobranca",
	"Conteudo": null,
	"Erros": [
		{
			"Codigo": "CON_002",
			"Message": "Não é possível gerar cobrança da parcela {NroParcela}: a parcela já possui escrituração e deverá ser paga através da guia de FGTS do empregador.",
			"Id": "GUID",
			"Campo": null
		}
	]
}

{
	"CodigoRequisicao": "GUID",
	"Origem": "/contrato/parcela/gerar-cobranca",
	"Conteudo": null,
	"Erros": [
		{
			"Codigo": "CON_003",
			"Message": "Não é possível gerar cobrança da parcela {NroParcela}: a parcela está em período de escrituração e deverá ser paga através da guia de FGTS do empregador.",
			"Id": "GUID",
			"Campo": null
		}
	]
}

Descrição dos campos da requisição

number

obrigatório

Número do contrato que será gerada a cobrança.

number[]

obrigatório

Números das parcelas do contrato que serão incluídas na cobrança.

string<date>

obrigatório

Data de vencimento da cobrança em formato aaaa-mm-dd.

string<date>

obrigatório

Data de expiração da cobrança em formato aaaa-mm-dd.

boolean

obrigatório

Se verdadeiro, indica que é uma cobrança total e não há necessidade de preencher o campo ValorLiquidacao.

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.

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.

string

obrigatório

Descrição que será preenchida quanto houver o pagamento na parcela.

number

Valor da cobrança. Não é necessário preencher este campo de liquidacao for verdadeiro.

number

Valor de desconto aplicado.

boolean

Indica se o cálculo das parcelas nesta consulta deve ser aplicado descapitalização e encargos.

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

boolean

Indica se a validação de escrituração da parcela deve ser ignorada. Se verdadeiro, a cobrança será gerada mesmo que a parcela já possua escrituração ou esteja em período de escrituração. Uso recomendado apenas para casos em que o empregador tenha escriturado, mas não tenha descontado o cliente nem pago a guia correspondente.

string

Justificativa para a decisão de ignorar a validação de escrituração. Obrigatório quando ignorarEscrituracao for verdadeiro; não deve ser preenchido quando ignorarEscrituracao for falso ou omitido.

Descrição dos campos do retorno

object[]

Lista das cobranças.

string

Identificador da cobrança gerada.

number

Parcelas cobertas por essa cobrança.

object[]

Lista de erros retornados quando a cobrança não pode ser gerada, incluindo os bloqueios por escrituração já existente ou período de escrituração vigente na parcela.

string

Código identificador do erro (ex: CON_003 para parcela em período de escrituração).

string

Mensagem descritiva do erro, incluindo o número da parcela afetada.

string

Identificador único da ocorrência do erro.

string

Campo da requisição associado ao erro, quando aplicável. Pode ser null.

Guia do Desenvolvedor

Tipos de Contratação

Outros

Portabilidade

Autorregulação

Gerar cobrança de parcela(s)