Pular para o conteúdo principal
Consulta detalhes de contrato/vínculo associado a uma parcela.
curl --request POST \
  --url https://api.example.com/contrato/parcela/consultar-detalhes \
  --header 'Content-Type: application/json' \
  --data '
{
  "NumeroContrato": 123,
  "NroParcelas": [
    0
  ]
}
'
{
  "NumeroProposta": 123,
  "DtInclusao": "<string>",
  "SituacaoAgenda": 123,
  "DescricaoSituacaoAgenda": "<string>",
  "NomeCliente": "<string>",
  "NomeEmpresa": "<string>",
  "VlrFinanciado": 123,
  "SituacaoProposta": 123,
  "DtCancelamento": "<string>",
  "DtLiquidacao": "<string>",
  "DocumentoFederalCliente": "<string>",
  "EcCliente": "<string>",
  "VlrRetencaoDiarioAprox": 123,
  "VlrTotalPago": 123,
  "QtdeParcelas": 123,
  "DescricaoTipoContrato": "<string>"
}

Corpo

application/json
NumeroContrato
integer<int64>
obrigatório

Número do contrato.

NroParcelas
integer<int32>[]

Lista de números de parcelas a obter detalhes (opcional).

Exemplo:
[0]

Resposta

OK

NumeroProposta
integer<int64>
obrigatório

Número da proposta/contrato.

DtInclusao
string
obrigatório

Data de inclusão do contrato (ISO 8601).

SituacaoAgenda
integer<int32>
obrigatório

Código da situação da agenda (cronograma).

DescricaoSituacaoAgenda
string
obrigatório

Descrição da situação da agenda.

NomeCliente
string
obrigatório

Nome do cliente (trabalhador).

NomeEmpresa
string
obrigatório

Nome do empregador.

VlrFinanciado
number<double>
obrigatório

Valor financiado (liberado) no contrato.

SituacaoProposta
integer<int32>
obrigatório

Código da situação atual do contrato.

DtCancelamento
string

Data de cancelamento, se o contrato foi cancelado.

DtLiquidacao
string

Data de liquidação, se o contrato foi totalmente liquidado.

DocumentoFederalCliente
string

CPF do cliente (trabalhador).

EcCliente
string

Estado civil do cliente (pode ser nulo).

VlrRetencaoDiarioAprox
number<double>

Valor de retenção diária aproximado (se aplicável).

VlrTotalPago
number<double>

Valor total já pago (se houver).

QtdeParcelas
integer<int32>

Quantidade total de parcelas do contrato.

DescricaoTipoContrato
string

Descrição do tipo de contrato (se houver).