> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vellaro.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Module Status (/financa5/status)

> Il banner dell'admin e i badge della scheda prodotto, per chi lavora il catalogo (`catalog`) e per chi tiene
le impostazioni (`system`): `{financa5_allowed, installed, mode, writes, locked_fields, run_in_progress,
health}`. Nessun dato della connessione.



## OpenAPI

````yaml https://api.vellaro.io/openapi/admin.json get /api/v1/admin/financa5/status
openapi: 3.1.0
info:
  title: Vellaro Admin API
  description: >-
    Store management under `/api/v1/admin`, for back ends and integrations.
    Every call takes `Authorization: Bearer <token>`: an admin API token or a
    staff user's token. The permissions of its role decide what it can do,
    always in its own store.
  version: 0.1.0
servers:
  - url: https://api.vellaro.io
    description: Produzione
security: []
tags:
  - name: Orders
    description: >-
      Orders and manual orders, payments, refunds, shipments, invoices, returns,
      customer subscriptions.
  - name: Products
    description: Products, variants, images, prices and discounts, product lookups.
  - name: Categories & catalog setup
    description: >-
      Categories, brands, attributes, options, filters, downloadable files,
      recurring profiles.
  - name: Inventory
    description: Stock of the variants and stock statuses.
  - name: Customers
    description: Customers, customer groups, custom fields.
  - name: Reviews & questions
    description: Moderation of product reviews and questions.
  - name: Promotions & coupons
    description: Coupons and gift vouchers.
  - name: Marketing
    description: Campaigns, newsletter subscribers, affiliates and their commissions.
  - name: Content
    description: >-
      CMS pages, menus, banners, information pages, flipbooks, media library,
      SEO URLs, email templates, translations.
  - name: Settings
    description: >-
      Store settings, email delivery, languages, currencies, physical stores,
      social login providers.
  - name: Shipping
    description: Couriers, shipping rates, weight and length classes.
  - name: Taxes & geo
    description: Tax classes, rates and rules; countries, zones and geo zones.
  - name: Integrations & modules
    description: >-
      Integrations, plugins and modules (Iute, extra warranty, Nextera, Financa
      5, WhatsApp, Firebase), outbound webhooks.
  - name: AI
    description: AI content generation and the settings of the AI shopping assistant.
  - name: Imports
    description: 'CSV imports and the universal import: runs, mappings, previews, undo.'
  - name: Reports & dashboard
    description: Dashboard figures and reports.
  - name: Users & API keys
    description: Staff users and roles, publishable keys, admin API tokens.
  - name: Audit
    description: The store's audit log.
paths:
  /api/v1/admin/financa5/status:
    get:
      tags:
        - Integrations & modules
      summary: Module Status (/financa5/status)
      description: >-
        Il banner dell'admin e i badge della scheda prodotto, per chi lavora il
        catalogo (`catalog`) e per chi tiene

        le impostazioni (`system`): `{financa5_allowed, installed, mode, writes,
        locked_fields, run_in_progress,

        health}`. Nessun dato della connessione.
      operationId: module_status_api_v1_admin_financa5_status_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_Financa5ModuleStatusOut_'
      security:
        - HTTPBearer: []
components:
  schemas:
    ApiResponse_Financa5ModuleStatusOut_:
      properties:
        data:
          anyOf:
            - $ref: '#/components/schemas/Financa5ModuleStatusOut'
            - type: 'null'
        meta:
          anyOf:
            - $ref: '#/components/schemas/PaginationMeta'
            - type: 'null'
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        error_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Code
      type: object
      title: ApiResponse[Financa5ModuleStatusOut]
    Financa5ModuleStatusOut:
      properties:
        financa5_allowed:
          type: boolean
          title: Financa5 Allowed
        installed:
          type: boolean
          title: Installed
        mode:
          type: string
          enum:
            - 'off'
            - read_only
            - active
          title: Mode
        writes:
          type: boolean
          title: Writes
        locked_fields:
          items:
            type: string
          type: array
          title: Locked Fields
        run_in_progress:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Run In Progress
        health:
          $ref: '#/components/schemas/Financa5HealthOut'
      type: object
      required:
        - financa5_allowed
        - installed
        - mode
        - writes
        - locked_fields
        - run_in_progress
        - health
      title: Financa5ModuleStatusOut
      description: >-
        GET /admin/financa5/status: il banner dell'admin e i badge della scheda
        prodotto, per chi lavora il catalogo

        (`catalog`) e per chi tiene le impostazioni (`system`). Nessun dato
        della connessione.
    PaginationMeta:
      properties:
        page:
          type: integer
          title: Page
        page_size:
          type: integer
          title: Page Size
        total:
          type: integer
          title: Total
        total_pages:
          type: integer
          title: Total Pages
      type: object
      required:
        - page
        - page_size
        - total
        - total_pages
      title: PaginationMeta
    Financa5HealthOut:
      properties:
        health:
          type: string
          enum:
            - 'off'
            - never
            - running
            - stuck
            - ok
            - held
            - failing
            - overdue
          title: Health
        failures_in_row:
          type: integer
          title: Failures In Row
        failing_since:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Failing Since
        last_error_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Error Code
        alert_open:
          type: boolean
          title: Alert Open
        last_run:
          anyOf:
            - $ref: '#/components/schemas/Financa5RunOut'
            - type: 'null'
        last_ok_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Ok At
        held_run_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Held Run Id
      type: object
      required:
        - health
        - failures_in_row
        - failing_since
        - last_error_code
        - alert_open
        - last_run
        - last_ok_at
        - held_run_id
      title: Financa5HealthOut
      description: >-
        La salute dei giri veri (`alerts.health`), per il banner dell'admin e la
        pagina del modulo.


        `health`: `off` (spento o senza permesso), `never` (acceso, nessun giro
        vero ancora), `running`, `stuck` (in

        corso da oltre 15 minuti), `ok`, `held` (un giro trattenuto aspetta lo
        staff: `held_run_id`), `failing` (l'ultimo

        giro vero è fallito: `failures_in_row`, `last_error_code`; l'email parte
        al terzo), `overdue` (il giro periodico

        non parte da tre intervalli).
    Financa5RunOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        mode:
          type: string
          enum:
            - preview
            - read_only
            - active
          title: Mode
        trigger:
          type: string
          enum:
            - manual
            - schedule
          title: Trigger
        status:
          type: string
          enum:
            - running
            - ok
            - error
            - held
            - discarded
          title: Status
        counts:
          additionalProperties: true
          type: object
          title: Counts
        error_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Code
        error_detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Detail
        created_by:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Created By
        started_at:
          type: string
          format: date-time
          title: Started At
        finished_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Finished At
        matches_config:
          type: boolean
          title: Matches Config
      type: object
      required:
        - id
        - mode
        - trigger
        - status
        - counts
        - error_code
        - error_detail
        - created_by
        - started_at
        - finished_at
        - matches_config
      title: Financa5RunOut
      description: >-
        Un giro: un'anteprima (`mode = preview`) o un giro vero di R1
        (`read_only`, `active`; `trigger` `schedule` per

        il beat, `manual` per «Sincronizza ora»).
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````

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