Saltar al contenido principal
POST
Close a short retained instalment from the desk

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency
string
requerido

Canonical idempotency request ID. Required: this request moves money, and without a key a retry cannot be told apart from a second instruction.

Parámetros de ruta

id
string<uuid>
requerido

The retained instalment.

Cuerpo

application/json
reason
string
requerido

Why the rest is the client's loss, kept with the close.

Required string length: 1 - 512

Respuesta

Created

carvedOutAt
string<date-time>
requerido

RFC 3339 instant the instalment was carved out at the sale.

cash
string
requerido

The cash on the desk the close applies to it (2 d.p. string).

Ejemplo:

"187.40"

closedAt
string<date-time>
requerido

RFC 3339 instant of the close, which dates the posting.

competencia
string
requerido

YYYYMM payroll cycle of the instalment.

currency
string
requerido

ISO 4217 currency code.

id
string<uuid>
requerido

The retained instalment; the id the close route takes.

numeroContrato
string
requerido

Consignado contract number.

owed
string
requerido

What the instalment owes the client (2 d.p. string).

Ejemplo:

"250.00"

rest
string
requerido

What the close books as the client's credit loss (2 d.p. string).

Ejemplo:

"62.60"