Skip to main content
GET
Recuperar detalhes de uma antecipação

Authorizations

X-Client-Id
string
header
required
X-Api-Key
string
header
required

Path Parameters

id
string<uuid>
required

Identificador da antecipação.

Response

Detalhes da antecipação

id
string<uuid>
required

Identificador da antecipação.

Example:

"01964c5a-0001-7000-8000-000000000001"

status
enum<string>
required

Status atual da antecipação:

  • pending: simulação criada, ainda não aceita.
  • committed: aceite confirmado, antecipação em processamento.
  • paid: pagamento da antecipação realizado.
  • expired: simulação expirou (passou de 15h sem aceite) ou aceite recusado porque o conjunto de recebíveis mudou.
Available options:
pending,
committed,
paid,
expired
Example:

"pending"

grossAmount
integer<int64>
required

Soma do valor original dos recebíveis incluídos em items, em centavos.

Example:

20000

netAmount
integer<int64>
required

Valor líquido a ser recebido pelo cliente após o desconto, em centavos.

Example:

19323

markupAmount
integer<int64>
required

Componente do desconto referente ao markup do contrato, em centavos.

Example:

387

feeAmount
integer<int64>
required

Componente do desconto referente à taxa base da Malga, em centavos.

Example:

290

effectiveRate
number<double>
required

Taxa efetiva total da antecipação sobre o valor bruto.

Example:

0.03385

monthlyRate
number<double>
required

Taxa mensal base aplicada no cálculo (decimal).

Example:

0.015

markup
number<double>
required

Markup mensal do contrato aplicado no cálculo (decimal).

Example:

0.02

expiresAt
string<date-time>
required

Data e hora limite para confirmar a antecipação (sempre 15h, horário de Brasília, do dia da simulação).

Example:

"2026-05-27T18:00:00Z"

items
object[]
required

Lista dos recebíveis incluídos na antecipação.

endDate
string<date>

Data-limite (YYYY-MM-DD) considerada na simulação. Todos os recebíveis com data de recebimento até essa data (inclusive) foram incluídos.

Example:

"2026-06-20"

paymentDate
string<date>

Data prevista de pagamento da antecipação (YYYY-MM-DD). Retornada para simulações pendentes (D+1 se criada antes das 15h) e após o aceite.

Example:

"2026-05-28"