# @fayz-ai/plugin-financial 中文文档

规范地址：https://npmcn.com/package/%40fayz-ai/plugin-financial/

版本：0\.33\.10
npm 元数据更新时间：2026-11-11T14:53:33.968Z
中文译文更新时间：2026-11-14T12:08:33.250Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40fayz-ai/plugin-financial
原文对照：https://npmcn.com/package/%40fayz-ai/plugin-financial/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：8.5 MB，235 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 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
- 首次发布：2026-06-17T23:02:11.276Z
- 最新版本发布：2026-11-11T14:53:33.730Z
- 近 30 天下载量：13180（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：122（近 12 个月 122 个）

## 中文简介

Fayz SDK — 插件- 财务插件

## 安装

```sh
npm install @fayz-ai/plugin-financial
```

也可以使用：`pnpm add @fayz-ai/plugin-financial`、`yarn add @fayz-ai/plugin-financial`、`bun add @fayz-ai/plugin-financial`

## README

# @fayz-ai/plugin-财务

> 您的 SaaS 的订单换现金—— 一个插件中的发票、应付款项、现金和佣金.

[![npm](https://img.shields.io/npm/v/@fayz-ai/plugin-financial.svg)](https://www.npmjs.com/package/@fayz-ai/plugin-financial) [![license](https://img.shields.io/npm/l/@fayz-ai/plugin-financial.svg)](https://github.com/FayaLabs/fayz-sdk/blob/main/LICENSE)

**状态 :** β-前1.0 (中文(简体) ). 核心表面稳定;一些后端侧面(见 `PLUGIN_PATTERNS.md`)仍在着陆. API在1.0前可能会有变化.

大多数垂直SaaS螺栓在金融上作为后想:一个"总"字段,一个电子表格导出,和一个祈祷. `plugin-financial` 使钱成为应用程序的一流部分. 它把全部的订单对现金循环——应收款、应付款、现金登记册、报表、卡片核对和佣金规则——模拟为每个业务可比较模块.

它的建造是金融脊椎 其他插件倚靠。 议程产生反对它的命令、从它读出的报告、仪表板表面显示平衡、现金流和逾期未发的警报,而无胶水。 每个模块都是可选的,每个标签和货币都是可配置的,项目行可以通过实体查询来解决其他插件的产品和服务. 做一个真实的,有金钱意识的SaaS 而不是缝合一个在一起.

## 里面的东西

-   **财务页** (单位:千美元)`/financial`——汇总,应收账款和应付款(有经常性),现金登记簿,报表和贺卡. 选用佣金(`modules.commissions`而今天只储存规则——还没有计算出佣金.
-   **发票流动** ——列表,细节,并用可配置项目类型(服务/出品/其他)和可选服务-执行跟踪形成视图.
-   **剪贴板部件** ——总余额/应收/应付KPI,现金流量图,明细表和逾期提醒面板,以及最新交易表.
-   **AI 工具** —— 说 `getRevenue`, (中文(简体) ), `listPayables`,以及 `markPaymentReceived` (服务器-飞机RPC)用于自然语言融资.
-   **交叉插座钩** —— 说 `entityLookups` 财务报告和审定财务报表 `contactLookup` 电线产品/服务/接触选择器,加 `onBookingClick` 从发票上跳回预订.
-   `createSafeFinancialProvider` (Supabase-or-mock),所以同一提供者既可以备份插件,也可以备份跨插件桥;包含设置标签和i18n.

## 安装

```bash
npm install @fayz-ai/plugin-financial
```

端点 : `react`, (中文(简体) ), `react-dom`中。运行时解码包括 `@fayz-ai/core`, (中文(简体) ), `@fayz-ai/ui`,以及 `@fayz-ai/admin`。 。 。 .

## 使用量

```tsx
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' },
      ],
    }),
  ],
})
```

## 费兹SDK的一部分

`plugin-financial` 是SDK的钱层 它与对 `@fayz-ai/plugin-agenda` (通过金融桥自动订货) `@fayz-ai/plugin-reports` 收入和佣金报告.

## 路线图贡献( I)

建设并不断发展于开阔. 见 [费兹SDK路线图](https://npmcn.com/package/docs/platform/ROADMAP.md#plugin-financial) 对于当前空白,缺失的特征,以及良好的第一问题.

## 常见问题

### @fayz-ai/plugin-financial 是什么？

Fayz SDK — 插件- 财务插件

### 如何安装 @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 和提交记录判断。