# @fleetbase/ledger-engine 中文文档

规范地址：https://npmcn.com/package/%40fleetbase/ledger-engine/

版本：0\.0\.13
npm 元数据更新时间：2026-10-14T07:37:14.937Z
中文译文更新时间：2026-11-14T22:44:07.179Z
软件包许可：AGPL-3\.0-or-later

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

原始 npm 页面：https://www.npmjs.com/package/%40fleetbase/ledger-engine
原文对照：https://npmcn.com/package/%40fleetbase/ledger-engine/?lang=original
项目主页：https://github.com/fleetbase/ledger#readme
源码仓库：https://github.com/fleetbase/ledger

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

- 包体积（解压后）：2.1 MB，685 个文件
- TypeScript 类型：未声明
- Node.js 要求：\>= 18
- 运行依赖：17 个
- peer 依赖：ember-engines ^0\.9\.0
- 首次发布：2026-03-26T08:46:51.298Z
- 最新版本发布：2026-10-14T07:37:14.748Z
- 近 30 天下载量：2428（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 13 个）

## 中文简介

舰队基地会计和发票延期

## 安装

```sh
npm install @fleetbase/ledger-engine
```

也可以使用：`pnpm add @fleetbase/ledger-engine`、`yarn add @fleetbase/ledger-engine`、`bun add @fleetbase/ledger-engine`

## README

[![Fleetbase Ledger](https://github.com/user-attachments/assets/197c404c-06b1-4fd4-8a26-624f1d481966)](https://fleetbase.io/)

# 舰队基地

为舰队基地进行会计、发票、钱包、付款和财务报告.

[![License: AGPL-3.0-or-later](https://img.shields.io/badge/license-AGPL--3.0--or--later-blue.svg)](https://github.com/fleetbase/ledger/blob/main/LICENSE.md) [![PHP CI](https://github.com/fleetbase/ledger/actions/workflows/server.yml/badge.svg)](https://github.com/fleetbase/ledger/actions/workflows/server.yml) [![Ember CI](https://github.com/fleetbase/ledger/actions/workflows/ember.yml/badge.svg)](https://github.com/fleetbase/ledger/actions/workflows/ember.yml) [![Coverage](https://codecov.io/gh/fleetbase/ledger/branch/main/graph/badge.svg)](https://codecov.io/gh/fleetbase/ledger) [![Packagist version](https://img.shields.io/packagist/v/fleetbase/ledger-api.svg)](https://packagist.org/packages/fleetbase/ledger-api) [![npm version](https://img.shields.io/npm/v/@fleetbase/ledger-engine.svg)](https://www.npmjs.com/package/@fleetbase/ledger-engine) [![Ledger documentation](https://img.shields.io/badge/docs-ledger-111827.svg)](https://www.fleetbase.io/docs/ledger)

[![Fleetbase Ledger dashboard](https://www.fleetbase.io/images/screenshots/ledger/ledger-dashboard.webp)](https://www.fleetbase.io/images/screenshots/ledger/ledger-dashboard.webp)

## 概览

莱德格是Fleet Base的财务和账单扩展。 它为Fleet基地控制台增加了一个完整的财务管理层,包括双入账簿记、客户发票、发票模板、数字钱包、支付网关处理、不可改变的交易历史和标准财务报告.

莱德格船既是Laravel包件,又是Ember发动机. 后端软件包提供会计模型,服务,路线,网关驱动程序,事件,观察者,迁移,以及控制台命令. 前端引擎提供Ledger控制台的经验,用于计费,支付,会计,报告和设置.

编队包括标准舰队基地设施。 见 [舰队基地编队文件](https://www.fleetbase.io/docs/ledger) 对于产品指南,概念,和设置行走.

## 目录

-   [特征](https://npmcn.com/package/%40fleetbase/ledger-engine/#readme-features)
-   [建筑](https://npmcn.com/package/%40fleetbase/ledger-engine/#readme-architecture)
-   [所需资源](https://npmcn.com/package/%40fleetbase/ledger-engine/#readme-requirements)
-   [安装](https://npmcn.com/package/%40fleetbase/ledger-engine/#readme-installation)
-   [发展](https://npmcn.com/package/%40fleetbase/ledger-engine/#readme-development)
-   [API 和扩展点](https://npmcn.com/package/%40fleetbase/ledger-engine/#readme-api-and-extension-points)
-   [文档](https://npmcn.com/package/%40fleetbase/ledger-engine/#readme-documentation)
-   [捐款](https://npmcn.com/package/%40fleetbase/ledger-engine/#readme-contributing)
-   [警卫](https://npmcn.com/package/%40fleetbase/ledger-engine/#readme-security)
-   [许可证](https://npmcn.com/package/%40fleetbase/ledger-engine/#readme-license)

## 特征

### 会计

-   资产,负债,股权,收入,费用等账户的核算图表.
-   双入分录日记分录有借记和贷记账.
-   带有重新计算支持的缓存账户余额.
-   每个账户和整个公司的总分类账浏览.
-   系统创建和人工日记条目,用于业务会计工作流程.

### 账单和发票

-   客户发票,有明细项目,税务,小计,总额,余额,到期日,附注,条款等.
-   发票对发稿的生命周期支持,发送,查看,支付,逾期,注销,退票,无效状态.
-   有公司品牌和注册模板上下文变量的发票模板.
-   发票预览、制作PDF、发票电子邮件和公共客户发票页.
-   人工支付记录和发票交易记录.
-   Fleet-Ops 购入率集成,用于从订单中自动生成发票草稿.

### 钱包和交易

-   用于公司,用户,客户,司机等车队基地主体的数字钱包.
-   仓储业务用于上缴,抵免,转账,支付,冻结,解冻,并进行重新计算.
-   原子平衡的变化通过 `WalletService`。 。 。 .
-   钱包活动、支付活动和业务资金流动的不可移动交易记录.
-   方向意识交易历史,用于信用,借记本科目,存款,支付,转账,退款,倒置等.

### 支付网关

-   用于Frede、QPay和现金/人工付款的内置网关驱动程序.
-   休息时有加密证书的网关配置 .
-   沙盒与活环境.
-   购买、退款、设置意向、支持的标识和网关交易历史.
-   公共网关 Webhook 端点带有驱动程序级签名验证.
-   通过IAPPoten网关处理 `GatewayTransaction` 记录.

### 报告和挂板

-   与KPI、收入趋势、现金流量汇总、发票状况、AR老化、钱包余额和活动有关的财务仪表板.
-   资产负债表,收益表,现金流量表,试算表,AR账龄,钱包汇总和总分类账的标准财务报告.
-   报告服务围绕双入帐数据和Fleetbase交易记录进行.

### 舰队基地整合

-   车队-Ops集成,用于购买率发票的创建和订单核算.
-   存储前期集成,用于直接存储前期销售日记账.
-   自动提供默认账户和钱包的公司和用户观察者.
-   船队基地控制台内的发票、付款和会计设置.

## 建筑

编目分为两个可分配包:

| 软件包 | 运行时间 | 说明 |
| --- | --- | --- |
| [`fleetbase/ledger-api`](https://packagist.org/packages/fleetbase/ledger-api) | 拉威尔/ PHP | 后端模式,路线,服务,迁移,网关驱动,观察,事件,资源,报告,以及控制台命令. |
| [`@fleetbase/ledger-engine`](https://www.npmjs.com/package/@fleetbase/ledger-engine) | 琥珀 | Fleetbase控制台引擎用于Ledger仪表板,计费,支付,会计,报告和设置屏幕. |

后端路由被安装在配置的Ledger API前缀下,默认为 `ledger`。 。 。 .

| 路由组 | 认证 | 目的 |
| --- | --- | --- |
| `POST /ledger/webhooks/{driver}` | 公用,司机核实 | 付费网关Webhook召回. |
| `/ledger/public/invoices/{public_id}` | 公开 | 客户发票视图、网关清单和付款流程. |
| `/ledger/v1/wallet/*` | API 密钥 | 客户和司机钱包API端点. |
| `/ledger/int/v1/*` | 舰队基地会议 | 控制API用于账户,发票,日记,钱包,交易,网关,设置,和报告. |

Ember引擎在舰队基地延伸路线上架 `ledger` 并披露控制台的帐单、付款、会计、报告和设置.

## 所需资源

-   前一頁 `^8.0`
-   作曲家
-   舰队基地
-   舰队基地 舰队Ops API
-   节点.js `>=18`
-   小时
-   Ember 兼容工作空间的 CLI

## 安装

莱德格已经和舰队基地合作了 在标准的Fleetbase实例中,打开控制台侧边栏并通航到莱德格开始. 为新公司和用户自动提供默认账户和钱包.

用于包级安装 :

```bash
composer require fleetbase/ledger-api
```

```bash
pnpm install @fleetbase/ledger-engine
```

如果您在已有的舰队基地安装中添加了Ledger, 请通过正常的舰队基地部署流程进行迁移, 然后为现有记录提供默认:

```bash
php artisan ledger:provision
```

## 发展

### 连接舰队基地的工作空间

在Fleet Base全数取出内进行Ledger操作时,使用Fleet Base从寄存器根取出包链接器,而不是手取编辑器 `console/package.json`, (中文(简体) ), `api/composer.json`,或 `console/pnpm-workspace.yaml`。 。 。 .

从 Fleetbase 仓库根安装一次链接器 :

```bash
npm link
```

启用 Ledger 作为本地开发软件包 :

```bash
flb-package-linker enable ledger
flb-package-linker install ledger
```

使用 `--install` 使链接器立即运行所需的软件包管理命令:

```bash
flb-package-linker enable ledger --install
```

检查链接状态为 :

```bash
flb-package-linker status
flb-package-linker doctor
```

见 [舰队基地开发设置指南](https://www.fleetbase.io/docs/platform/quickstart/development-setup) 用于 Docker 挂载, 本地 Ember dev 服务器设置, 软件包链接细节, 以及未链接/ 重置命令 。 Fleetbase运营Laravel Octane,因此在PHP更改后重新装入API工人:

```bash
docker compose exec application php artisan octane:reload
```

### 软件包一级开发

安装依赖性 :

```bash
composer install
pnpm install
```

本地运行 Ember 引擎 :

```bash
pnpm start
```

前端检查 :

```bash
pnpm lint
pnpm test
pnpm build
```

后端检查 :

```bash
composer test:lint
composer test:types
composer test:unit
composer test
```

编辑器 Artisan 命令 :

```bash
php artisan ledger:provision
php artisan ledger:backfill-direction
php artisan ledger:update-overdue-invoices
```

`ledger:provision` 并且可以瞄准所有公司,一个公司,账户或钱包. `ledger:backfill-direction` 填补旧交易行上缺失的交易指示. `ledger:update-overdue-invoices` 如果发票到期日已过,即视为过期.

## API 和扩展点

Ledger 披露会计、钱包、发票和付款的后端服务:

-   `LedgerService` 创建双条目并授权财务报告.
-   `WalletService` 管理钱包提供和平衡变化操作.
-   `InvoiceService` 创建和管理发票,包括基于订单的发票.
-   `PaymentService` 协调网关收费、退款、设置意图、事件和网关交易的持久性.
-   `PaymentGatewayManager` 解析并初始化已配置的支付网关驱动程序.

自定义支付网关可以扩展 `AbstractGatewayDriver` 执行 `GatewayDriverInterface` 合同。 网关驱动程序提供代码,名称,能力列表,配置计划,购买/退款行为,以及可选的webhook或符号化支持.

Ledger还用Fleetbase的模板渲染系统登记了发票模板上下文变量,因此发票模板可以在渲染过程中参考发票,交易,账户和钱包数据.

## 文档

-   [编目文件](https://www.fleetbase.io/docs/ledger)
-   [核心概念](https://www.fleetbase.io/docs/ledger/getting-started/core-concepts)
-   [支付网关](https://www.fleetbase.io/docs/ledger/payments/gateways)
-   [添加付费网关驱动程序](https://www.fleetbase.io/docs/extension-development/recipes/adding-a-payment-gateway-driver)
-   [舰队基地开发设置](https://www.fleetbase.io/docs/platform/quickstart/development-setup)

## 捐款

欢迎捐款。 请读一下 [贡献指南](https://npmcn.com/package/%40fleetbase/ledger-engine/CONTRIBUTING.md) 在打开拉出请求之前.

对于本地修改,请保持前端和后端检查以您所触及的区域为重点,并在您所请求的拉动中包含相关的测试输出.

## 警卫

请不要公开报告 GitHub 的安全问题。 联系舰队基地 [哈罗 @fleetbase.io](mailto:hello@fleetbase.io) 以及细节,以便团队能够协调一个负责任的修复.

## 许可证

Fleetbase Ledger 是开源软件,根据该软件许可 [AGPL-3.0- 或- 后期](https://npmcn.com/package/%40fleetbase/ledger-engine/LICENSE.md)。 。 。 .

## 常见问题

### @fleetbase/ledger-engine 是什么？

舰队基地会计和发票延期

### 如何安装 @fleetbase/ledger-engine？

在项目目录运行 npm install @fleetbase/ledger-engine，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：ember-engines（^0\.9\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @fleetbase/ledger-engine 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/fleetbase\_\_ledger-engine 是否存在。

### @fleetbase/ledger-engine 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>= 18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @fleetbase/ledger-engine 可以商用吗？

@fleetbase/ledger-engine 使用 AGPL-3\.0-or-later 许可。最严格的 Copyleft：除分发外，通过网络向用户提供基于它的服务也需要开源对应源码。闭源 SaaS 使用前务必评估。以上为概括，不构成法律意见，请以许可原文为准。

### @fleetbase/ledger-engine 的下载量有多少？

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

### @fleetbase/ledger-engine 还在维护吗？

最新版本 0\.0\.13 发布于 2026/10/14（1 个月前）；至今共发布 13 个版本，其中过去 12 个月发布了 13 个；首次发布于 2026/03/26。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。