Skip to main content
POST
Criar execução de accrual

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Corpo

application/json
businessDate
string<date>
obrigatório

Business date (YYYY-MM-DD) the accrual batch is queued for.

Exemplo:

"2026-06-14"

mode
string
obrigatório

Accrual run cadence. The scheduled driver sends monthly, one competencia per loan.

Required string length: 1 - 32
Exemplo:

"monthly"

loanProductIds
string<uuid>[] | null

Optional loan product identifiers to scope the run.

Maximum array length: 100

Resposta

Created

businessDate
string
obrigatório

Business date (YYYY-MM-DD, UTC) the run was queued for.

Exemplo:

"2026-06-14"

correlationId
string
obrigatório

Correlation identifier linking the run to its journal/outbox lineage and downstream events.

Exemplo:

"550e8400-e29b-41d4-a716-446655440002"

id
string
obrigatório

Server-assigned UUID of the queued accrual run.

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

journalReferenceId
string
obrigatório

UUID of the journal reference recording this run's posting lineage.

Exemplo:

"550e8400-e29b-41d4-a716-446655440001"

status
string
obrigatório

Lifecycle status of the queued run (e.g. queued).

Exemplo:

"queued"

outboxEventId
string

UUID of the emitted outbox event; omitted when no outbox event was recorded.

Exemplo:

"550e8400-e29b-41d4-a716-446655440003"