Skip to main content
GET
Preflight the accounting routes of a ledger

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Organization-Id
string

Midaz organization of the ledger to inspect. Required: a request without it, or with a value that is not a canonical UUID, is refused with 400 PBP-0025. Declared optional on the schema so that refusal keeps its own code instead of the schema's PBP-0001.

Query Parameters

ledgerId
string

Midaz ledger to inspect. Required: absent, blank or not a canonical UUID is refused with 400 PBP-0026. Declared optional on the schema so that refusal keeps its own code.

Response

OK

accountingRoutesEnabled
boolean
required

Whether ACCOUNTING_ROUTES_ENABLED is on in this deployment. Reported, not obeyed: the verdict is judged as if it were on.

flows
object[]
required

One entry per canonical flow, in the order BOLETO_IN, PAYMENT_OUT, DARF_OUT. Empty when the route inventory could not be read.

ledgerId
string
required

Ledger the preflight read, in canonical form.

organizationId
string
required

Organization the preflight read, in canonical form.

ready
boolean
required

Whether the plugin can post against this ledger as far as accounting routes are concerned. It is the verdict on the whole ledger: a complete flow in a ledger that is not ready does not post.

unrecognisedMarkers
integer<int64>
required

Ledger routes carrying a plugin marker the contract does not know.

validateRoutes
boolean | null
required

The ledger's validateRoutes setting, or null when the settings could not be read.

reason
string

Class of the verdict, in the vocabulary of the accounting_routes check of /readyz/tenant.