> ## 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.

# Movimento financeiro report

> Returns, per (messageType, direction), the SUM of the declared amount + a COUNT over outbound and inbound messages created within the date range, plus a grand total per direction. The decimal sum is accumulated in integer centavos (never float). This sums Lerian SPB's OWN transmitted/received amounts — a derived report view, not a held position. BACEN-supplied reserve balances are NOT projected here (use GET /v1/str/reserve-statement-queries/{id}); movement never rolls movements up into an opening/closing balance.



## OpenAPI

````yaml /pt/openapi/v3-current/spb.yaml get /v1/str/reports/movement
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    OpenAPI 3.1 surface for Lerian SPB, the direct integration between the
    institution and the Brazilian Payment System (SPB) over the National
    Financial System Network (RSFN). It covers the Reserve Transfer System
    (STR): message registry and capability catalog, operation lifecycle (bank
    transfers, IBS repasses, liquidity transfers, returns and cancellations),
    reserve-account and schedule queries, alçada governance, SME and LDL
    operations, inbound quarantine triage, reconciliation, and event delivery.
  license:
    name: Lerian Studio General License
  title: Lerian SPB API
  version: 1.0.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security: []
tags:
  - description: Immutable audit-record trails for STR operations and lifecycle events.
    name: Audit
  - description: >-
      STR capability catalog describing supported message types and their
      constraints.
    name: Capabilities
  - description: >-
      ICP-Brasil certificate inventory with hot-reloadable rotation and
      activation.
    name: Certificates
  - description: >-
      STR compulsory-movement (RCO) family: the movements BACEN orders on a
      participant's reserve account, their answers and the periods they belong
      to.
    name: Compulsory
  - description: >-
      Maker-checker approval queue for emissions parked above their alçada band:
      list pending, sign (approve), and deny.
    name: EmissionApprovals
  - description: Operation event catalog enumerating the emitted domain event types.
    name: Events
  - description: >-
      Inbound GEN-family notice log (GEN0001 connectivity echo, GEN0004
      transmission error, GEN0005 administrative notice).
    name: GenNotices
  - description: >-
      SPB alçada governance config: value-band table + per-message-type
      signature requirements, hot-reloaded at runtime.
    name: Governance
  - description: >-
      Read raw STR message status: list messages and read a single message by
      NUOp.
    name: Messages
  - description: Aggregated operational summaries and metrics across STR operations.
    name: OperationalIntelligence
  - description: >-
      STR operation lifecycle for bank transfers and IBS repasses, including
      returns and cancellations.
    name: Operations
  - description: >-
      Service readiness state covering startup self-probes and dependency
      health.
    name: Readiness
  - description: Reconciliation cases and the actions that resolve operation discrepancies.
    name: Reconciliation
  - description: >-
      Redesconto do Banco Central: collateralised intraday and one-business-day
      BCB lending against Selic-registered federal securities. One create door
      derives the nine RDC commands from four operator-facing kinds (contract,
      payment, conversion, cancellation), plus the two consultas over
      eligible-security prices and open positions. An accepted rediscount is not
      necessarily a settled one — Selic may hold the request for want of
      securities, and that middle state is reported as its own.
    name: Rediscounts
  - description: >-
      STR Relatórios suite: synchronous, date-ranged aggregate reports
      (movimento financeiro, transações rejeitadas, volumetria) over Lerian
      SPB's own transmission record.
    name: Reports
  - description: >-
      STR0013 reserve-account balance and STR0014 statement (extrato,
      message-mode) queries and their async results.
    name: ReserveQueries
  - description: >-
      GEN0019 participant responsável roster: full-replacement updates announced
      to BACEN.
    name: Responsibles
  - description: STR operating-window schedule governing when operations may be sent.
    name: Schedule
  - description: >-
      STR0001 single-party schedule queries (consulta de horários do STR) and
      their async STR0001R1 grid results.
    name: ScheduleQueries
  - description: >-
      STR lançamentos (SLB) family: the charges BACEN raises against this
      participant, the payments that settle them, payments to BACEN it never
      demanded, and the entry consultas over them.
    name: SLB
  - description: >-
      Reads over an IEME's conta correspondente a moeda eletrônica (CCME):
      SME0003 statement (extrato) queries and their async SME0003R1 results,
      plus the log of SME0001R2/SME0002R2/SME0004R2 movement advices the STR
      delivered about movements this rail did not command.
    name: SMEQueries
  - description: Runtime SPB configuration settings for the STR integration.
    name: Settings
  - description: >-
      Flow (mandatory order): certificate → readiness → connectivity-test →
      submit. Activate a certificate, confirm the rail reports ready, pass a
      connectivity test, then submit an operation. Each step is its own
      resource; a submit must not be attempted before readiness passes.
    name: onboarding
  - description: >-
      Flow (mandatory order): parent operation SETTLED → return/cancel. A return
      or cancellation is a sub-resource of a settled parent operation; the
      {operationId}/{endToEndID} path segment enforces the parent structurally.
    name: lifecycle
paths:
  /v1/str/reports/movement:
    get:
      tags:
        - Reports
      summary: Movimento financeiro report
      description: >-
        Returns, per (messageType, direction), the SUM of the declared amount +
        a COUNT over outbound and inbound messages created within the date
        range, plus a grand total per direction. The decimal sum is accumulated
        in integer centavos (never float). This sums Lerian SPB's OWN
        transmitted/received amounts — a derived report view, not a held
        position. BACEN-supplied reserve balances are NOT projected here (use
        GET /v1/str/reserve-statement-queries/{id}); movement never rolls
        movements up into an opening/closing balance.
      operationId: getReportMovement
      parameters:
        - description: Inclusive range start (RFC3339 timestamp or YYYY-MM-DD).
          explode: false
          in: query
          name: fromDate
          required: true
          schema:
            description: Inclusive range start (RFC3339 timestamp or YYYY-MM-DD).
            examples:
              - '2026-05-01'
            type: string
        - description: >-
            Inclusive range end (RFC3339 timestamp or YYYY-MM-DD). A bare date
            snaps to end-of-day.
          explode: false
          in: query
          name: toDate
          required: true
          schema:
            description: >-
              Inclusive range end (RFC3339 timestamp or YYYY-MM-DD). A bare date
              snaps to end-of-day.
            examples:
              - '2026-05-31'
            type: string
        - description: Optional STR/LPI message-code filter (e.g. STR0008).
          explode: false
          in: query
          name: messageType
          schema:
            description: Optional STR/LPI message-code filter (e.g. STR0008).
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportMovementResponse'
          description: OK
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Forbidden
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '429':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Too Many Requests
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Service Unavailable
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    ReportMovementResponse:
      additionalProperties: false
      properties:
        correlationId:
          description: Request-scoped correlation identifier echoing X-Request-ID.
          examples:
            - req-7a3f9c2e
          type: string
        fromDate:
          description: RFC3339 UTC inclusive lower bound of the queried range.
          examples:
            - '2026-05-01T00:00:00Z'
          type: string
        rows:
          description: >-
            Per (messageType, direction) SUM(amount) + COUNT, ordered by
            messageType then direction.
          items:
            $ref: '#/components/schemas/ReportMovementRowResponse'
          type: array
        toDate:
          description: RFC3339 UTC inclusive upper bound of the queried range.
          examples:
            - '2026-05-31T23:59:59Z'
          type: string
        totals:
          description: Grand total (SUM + COUNT) per direction across every messageType.
          items:
            $ref: '#/components/schemas/ReportMovementDirectionTotalResponse'
          type: array
      required:
        - fromDate
        - toDate
        - rows
        - totals
        - correlationId
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          type: string
        correlationId:
          description: Request-scoped correlation identifier echoing X-Request-ID.
          examples:
            - req-7a3f9c2e
          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.
      required:
        - correlationId
      type: object
    ReportMovementRowResponse:
      additionalProperties: false
      properties:
        amountTotal:
          description: >-
            SUM of the declared amount over the group, decimal reais,
            accumulated in centavos (never float). "0.00" when no row in the
            group carried an amount.
          examples:
            - '1234567.89'
          type: string
        count:
          description: Number of messages in the group.
          examples:
            - 42
          format: int64
          type: integer
        direction:
          description: 'Message direction: OUTBOUND (sent) or INBOUND (received).'
          examples:
            - OUTBOUND
          type: string
        messageType:
          description: STR/LPI message code this aggregate groups.
          examples:
            - STR0008
          type: string
      required:
        - messageType
        - direction
        - amountTotal
        - count
      type: object
    ReportMovementDirectionTotalResponse:
      additionalProperties: false
      properties:
        amountTotal:
          description: >-
            SUM of the declared amount across every messageType for this
            direction, decimal reais (centavos-exact).
          examples:
            - '9876543.21'
          type: string
        count:
          description: Total message count across every messageType for this direction.
          examples:
            - 128
          format: int64
          type: integer
        direction:
          description: Message direction the grand total covers.
          examples:
            - OUTBOUND
          type: string
      required:
        - direction
        - amountTotal
        - count
      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

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.