> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Preflight the accounting routes of a ledger > Reports whether the plugin can post against one (organization, ledger) of the caller's tenant, and the state of each canonical flow there: BOLETO_IN, PAYMENT_OUT and DARF_OUT, each complete, absent, incomplete (with the missing route codes), ambiguous (with the repeated codes) or malformed (with the code and the reason). READ-ONLY. It reads the ledger live, with GET requests only, and bypasses the accounting routes cache: nothing is posted, cached or stored, so it is safe to run right after provisioning and as often as needed. `ready` is the verdict on the WHOLE ledger: a flow reported complete in a ledger that is not ready still does not post. `reason` uses the vocabulary of the accounting_routes check of /readyz/tenant. The ACCOUNTING_ROUTES_ENABLED knob is REPORTED, NOT OBEYED: the verdict is judged as if it were on, because this is what runs before it is turned on, and its current value is in `accountingRoutesEnabled`. The organization comes from the X-Organization-Id header (400 PBP-0025) and the ledger from the ledgerId query parameter (400 PBP-0026). An organization or ledger the ledger does not know, for this tenant, is answered 404 without saying which. ## OpenAPI ````yaml /en/openapi/v3-current/payments.yaml get /v1/admin/accounting-routes/preflight openapi: 3.1.0 info: description: >- API for the Lerian Payments interface via BTG. It covers boleto issuance, cancellation, installments, and queries; bill payments (bankslip, utilities, and DARF), cancellation, and queries; aggregated boleto and payment dashboards; provider connection and outbound webhook configuration; and the provider webhook receiver for settlement events. ERROR BODIES. A failed request arrives in one of two shapes, and which one you get depends on where the service catches the failure. A failure that the request pipeline catches before the API layer sees it answers a flat JSON body on application/json; the idempotency check is the pipeline rule you meet most often. Authentication and authorization refusals follow the response contract documented by the operation. Everything the API layer catches answers an RFC 9457 problem document on application/problem+json. Read the media type to tell the two apart. The code member holds the same PBP-NNNN value in both, so branch on it. One pipeline refusal is not listed on the operations below: while a first request under the same idempotency key is still in flight, a retry is answered 409 with code PBP-0007 and the flat body. title: Payments — via BTG API version: 1.0.0 servers: - url: https://payments.sandbox.lerian.net security: [] tags: - description: >- Tenant-level setup: connecting the banking provider and configuring where status notifications are delivered. name: Admin - description: >- Issuing, querying and cancelling boletos, including installment series and the rendered PDF. name: Boletos - description: >- Aggregated counts, amounts and breakdowns over a period, for boletos and for payments. name: Dashboards - description: >- Paying bankslips, utility bills and DARF tax slips, and querying or cancelling those payments. name: Payments - description: >- The webhook the payment provider posts settlement events to. Authenticated with a credential agreed with the provider, not with the platform identity used by the rest of this API. name: Settlement paths: /v1/admin/accounting-routes/preflight: get: tags: - Admin summary: Preflight the accounting routes of a ledger description: >- Reports whether the plugin can post against one (organization, ledger) of the caller's tenant, and the state of each canonical flow there: BOLETO_IN, PAYMENT_OUT and DARF_OUT, each complete, absent, incomplete (with the missing route codes), ambiguous (with the repeated codes) or malformed (with the code and the reason). READ-ONLY. It reads the ledger live, with GET requests only, and bypasses the accounting routes cache: nothing is posted, cached or stored, so it is safe to run right after provisioning and as often as needed. `ready` is the verdict on the WHOLE ledger: a flow reported complete in a ledger that is not ready still does not post. `reason` uses the vocabulary of the accounting_routes check of /readyz/tenant. The ACCOUNTING_ROUTES_ENABLED knob is REPORTED, NOT OBEYED: the verdict is judged as if it were on, because this is what runs before it is turned on, and its current value is in `accountingRoutesEnabled`. The organization comes from the X-Organization-Id header (400 PBP-0025) and the ledger from the ledgerId query parameter (400 PBP-0026). An organization or ledger the ledger does not know, for this tenant, is answered 404 without saying which. operationId: preflightAccountingRoutes parameters: - description: >- 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. in: header name: X-Organization-Id schema: description: >- 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. type: string - description: >- 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. explode: false in: query name: ledgerId schema: description: >- 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. type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/PreflightAccountingRoutesResponse' description: OK '400': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' application/problem+json: schema: $ref: '#/components/schemas/Detail' text/plain: schema: type: string description: >- Authentication failed. Read the `Content-Type`: the authentication middleware answers `application/json` carrying error code `PBP-0003`, and the in-service identity gate further down the chain answers `application/problem+json` (RFC 9457). The content map also declares `text/plain`, which NOTHING in this service produces. Do not write a client branch for it. '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' text/plain: schema: type: string description: >- The authenticated principal is not permitted to perform this action. Read the `Content-Type`: the authorization middleware answers `application/json` carrying error code `PBP-0004`, meaning the principal may not perform this ACTION at all. On POST /v1/payments and POST /v1/payments/darf a second shape is reachable — `application/problem+json` (RFC 9457) carrying `PBP-0209` — and it means the opposite thing about the action: the principal MAY perform it, and the signed-in end user is not the registered holder of the account the request names. Every other operation still has the single `PBP-0004` shape. The content map also declares `text/plain`, which NOTHING in this service produces. Do not write a client branch for it. '404': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Not Found '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' application/json: schema: $ref: '#/components/schemas/PipelineError' description: Internal Server Error security: - BearerAuth: [] components: schemas: PreflightAccountingRoutesResponse: additionalProperties: false properties: accountingRoutesEnabled: description: >- Whether ACCOUNTING_ROUTES_ENABLED is on in this deployment. Reported, not obeyed: the verdict is judged as if it were on. type: boolean flows: description: >- One entry per canonical flow, in the order BOLETO_IN, PAYMENT_OUT, DARF_OUT. Empty when the route inventory could not be read. items: $ref: '#/components/schemas/PreflightAccountingFlowResponse' type: array ledgerId: description: Ledger the preflight read, in canonical form. type: string organizationId: description: Organization the preflight read, in canonical form. type: string ready: description: >- 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. type: boolean reason: description: >- Class of the verdict, in the vocabulary of the accounting_routes check of /readyz/tenant. type: string unrecognisedMarkers: description: Ledger routes carrying a plugin marker the contract does not know. format: int64 type: integer validateRoutes: description: >- The ledger's validateRoutes setting, or null when the settings could not be read. type: - boolean - 'null' required: - organizationId - ledgerId - accountingRoutesEnabled - ready - validateRoutes - unrecognisedMarkers - flows type: object Detail: additionalProperties: true properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object ErrorResponse: additionalProperties: false properties: code: type: string details: additionalProperties: {} type: object message: type: string title: type: string required: - code - title - message type: object PipelineError: additionalProperties: false description: >- The flat error body. A failure caught before the API layer sees the request answers this shape on the application/json media type, instead of the RFC 9457 problem document. Read the media type to tell the two apart. The idempotency check is the rule that answers this way most often. properties: code: description: >- Stable, machine-readable error code, in the form PBP-NNNN. Branch on this value. It carries the same meaning as the code member of the problem document. examples: - PBP-0013 type: string details: additionalProperties: true description: Optional object carrying further facts about this occurrence. type: - object - 'null' message: description: A human-readable explanation specific to this occurrence. examples: - >- The request body does not match the original request for this idempotency key. type: string title: description: Short label for the condition. examples: - Idempotency Key Conflict type: string required: - code - title - message type: object PreflightAccountingFlowResponse: additionalProperties: false properties: ambiguousRoutes: description: >- Route codes of the flow carried by more than one ledger route, when the flow is ambiguous. items: type: string type: array flow: description: Canonical flow code. examples: - BOLETO_IN type: string malformedReason: description: Which part of that route diverges, when the flow is malformed. type: string malformedRoute: description: >- First route code of the flow that diverges from the contract, when the flow is malformed. type: string missingActions: description: >- Actions the malformed route does not declare, when the reason is action_coverage. items: type: string type: array missingRoutes: description: >- Route codes of the flow absent from the ledger, when the flow is incomplete. items: type: string type: array status: description: complete, absent, incomplete, ambiguous or malformed. examples: - complete type: string required: - flow - status - missingRoutes - ambiguousRoutes - missingActions type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ````