@fayz-ai/plugin-financial

中文文档
0.33.10发布于 2026/11/11MITTypeScriptES Module近 30 天下载 1.3万

Fayz SDK — plugin-financial plugin

原始使用文档
文档目录5 节
  1. What's inside
  2. Install
  3. Usage
  4. Part of the Fayz SDK
  5. Roadmap & contributing

@fayz-ai/plugin-financial

Order-to-cash for your SaaS — invoices, payables, cash, and commissions in one plugin.

npm license

Status: beta — pre-1.0. Core surface is stable; some backend facets (see PLUGIN_PATTERNS.md) are still landing. APIs may change before 1.0.

Most vertical SaaS bolts on finance as an afterthought: a "total" field, a spreadsheet export, and a prayer. plugin-financial makes money a first-class part of the app. It models the full order-to-cash loop — receivables, payables, cash registers, statements, card reconciliation, and commission rules — as composable modules you toggle per business.

It's built to be the financial spine other plugins lean on. Agenda creates orders against it, reports read from it, and the dashboard surfaces balance, cash flow, and overdue alerts without bespoke glue. Every module is optional, every label and currency is configurable, and item lines can resolve products and services from other plugins via entity lookups. Compose a real, money-aware SaaS instead of stitching one together.

What's inside

  • Financial page (/financial) — summary, accounts receivable & payable (with recurring), cash registers, statements, and cards. Commissions is opt-in (modules.commissions) and today only stores rules — nothing computes a commission yet.
  • Invoice flow — list, detail, and form views with configurable item types (service / product / other) and optional service-execution tracking.
  • Dashboard widgets — total-balance / receivable / payable KPIs, a cash-flow chart, breakdown and overdue-alert panels, and a recent-transactions table.
  • AI tools — getRevenue, listPayables, and markPaymentReceived (server-plane RPC) for natural-language finance.
  • Cross-plugin hooks — entityLookups and contactLookup to wire product/service/contact selectors, plus onBookingClick to jump from an invoice back to its booking.
  • createSafeFinancialProvider (Supabase-or-mock) so the same provider can back both the plugin and a cross-plugin bridge; settings tab and i18n included.

Install

npm install @fayz-ai/plugin-financial

Peer deps: react, react-dom. Runtime deps include @fayz-ai/core, @fayz-ai/ui, and @fayz-ai/admin.

Usage

import { defineSaas } from '@fayz-ai/admin'
import { createFinancialPlugin } from '@fayz-ai/plugin-financial'

export const app = defineSaas({
  // ...
  plugins: [
    createFinancialPlugin({
      currency: { code: 'BRL', locale: 'pt-BR', symbol: 'R$' },
      modules: { commissions: true, cards: false },
      itemTypes: [
        { value: 'service', label: 'Service', icon: 'Briefcase' },
        { value: 'product', label: 'Product', icon: 'Package' },
      ],
    }),
  ],
})

Part of the Fayz SDK

plugin-financial is the money layer of the SDK. It pairs with @fayz-ai/plugin-agenda (bookings auto-create orders via the financial bridge) and feeds @fayz-ai/plugin-reports for revenue and commission reporting.

Roadmap & contributing

Built and evolving in the open. See the Fayz SDK roadmap for current gaps, missing features, and good first issues.

版本与发布记录

@fayz-ai/plugin-financial 共发布 122 个版本,首次发布于 2026/06/18;过去 12 个月发布了 122 个版本。

版本发布日期距今
0.33.10latest2026/11/112 天前
0.33.92026/11/113 天前
0.33.82026/11/113 天前
0.33.72026/11/104 天前
0.33.62026/11/067 天前
0.33.52026/11/068 天前

其他发布通道:next → 0.9.0-next.1,canary → 0.30.3-canary.20261028153856。

关于 @fayz-ai/plugin-financial 的常见问题

@fayz-ai/plugin-financial 是什么?

Fayz SDK — plugin-financial plugin

如何安装 @fayz-ai/plugin-financial?

在项目目录运行 npm install @fayz-ai/plugin-financial,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0 || ^19.0.0)、zustand(^4.5.0 || ^5.0.0)、react-dom(^18.0.0 || ^19.0.0)、lucide-react(>=0.400.0 <1.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@fayz-ai/plugin-financial 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@fayz-ai/plugin-financial 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@fayz-ai/plugin-financial 可以商用吗?

@fayz-ai/plugin-financial 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@fayz-ai/plugin-financial 的下载量有多少?

根据 npm 官方下载统计,@fayz-ai/plugin-financial 在 2026/10/15 – 2026/11/13 这 30 天内被下载 13,180 次,日均约 439 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@fayz-ai/plugin-financial 还在维护吗?

最新版本 0.33.10 发布于 2026/11/11(2 天前);至今共发布 122 个版本,其中过去 12 个月发布了 122 个;首次发布于 2026/06/18。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。