# @balancer-team/quickbooks 中文文档

规范地址：https://npmcn.com/package/%40balancer-team/quickbooks/

版本：0\.0\.18
npm 元数据更新时间：2026-04-30T20:01:55.441Z
中文译文更新时间：2026-11-07T15:49:26.838Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40balancer-team/quickbooks
原文对照：https://npmcn.com/package/%40balancer-team/quickbooks/?lang=original
项目主页：https://www.balancer.team/
源码仓库：https://github.com/balancer-team/quickbooks-js

弃用说明：This package has moved to @nextform/quickbooks\. Please update your dependencies\.

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

- 包体积（解压后）：34.1 kB，7 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2024-08-30T22:59:14.008Z
- 最新版本发布：2025-05-28T14:33:26.690Z
- 近 30 天下载量：6339（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：18（近 12 个月 0 个）

## 中文简介

快书 JavaScript 客户端

## 安装

```sh
npm install @balancer-team/quickbooks
```

也可以使用：`pnpm add @balancer-team/quickbooks`、`yarn add @balancer-team/quickbooks`、`bun add @balancer-team/quickbooks`

## README

# 快书 JavaScript 客户端

QuickBooks的JavaScript客户端. 方便地连接到快取 Books API. 进行查询并创建对象。 TypeScript定义被构建在其中.

### 安装

```
npm i @balancer-team/quickbooks
```

### 配置

```js
import { QuickBooks } from '@balancer-team/quickbooks'

export const qb = new QuickBooks({
  clientId: 'YOUR_CLIENT_ID',
  clientSecret: 'YOUR_CLIENT_SECRET',
  redirectUri: 'YOUR_REDIRECT_URI',
  environment: 'SANDBOX_OR_PRODUCTION',
})
```

### 获取 Auth URL

启动 OAuth 2.0 流量, 获取 aut url .

```js
const authUrl = qb.getAuthUrl()
```

### 从 Grant 获取访问托肯

通过使用赠款细节取回访问符来完成 OAuth 2.0 流量.

```js
const token = await qb.getTokenFromGrant({
  code: 'GRANT_CODE',
  state: 'STATE_STRING',
  realmId: 'REALM_ID',
})
```

### 访问并刷新托肯

这个 `token` 是一个对象,包括访问和刷新令牌、域ID、过期和其他元数据。 托肯没有储存在 `qb` 举个例子 您必须写自己的应用程序逻辑来管理符号 。 这使得创建多租户应用程序更加容易,不同代号必须用于不同的用户.

因图伊特的访问符有效1小时,刷新符有效100天. 您应该通过调用以下函数来保证您正在使用主动访问符 。 如果访问令牌仍然有效,它会简单地返回令牌. 如果需要刷新,它会将请求发送到因图伊特并获得刷新的代号.

```js
const validToken = await qb.getValidToken(staleToken) // -->
// {
//   access_token: 'eyJlbmMiOiJBMTI4...',
//   refresh_token: 'AB11734177244q21...',
//   token_type: 'bearer',
//   realm_id: '8241451349686734',
//   expires_in: 3600,
//   expires_at: 1725454384,
//   x_refresh_token_expires_in: 8726400,
//   x_refresh_token_expires_at: 1733918044,
// }
```

### 通用查询请求

QuickBooks API使用查询访问资源. 和大多数API不同, 获取资源时不需要指定终点 。 相反,资源是以类似SQL的查询语言指定的. 参见 [API 浏览器](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/account) 用于构建您的询问.

```js
const vendors = await qb.query({
  token: token,
  query: 'select * from Vendor',
})
```

### 普通用途员额请求

使用任何端点并使用一般用途后台请求创建任何对象. 参见 [API 浏览器](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/account) 用于结束点和对象结构.

```js
const createdJournalEntry = await qb.post({
  token: token,
  endpoint: '/journalentry',
  body: newJournalEntry,
})
```

## 常见问题

### @balancer-team/quickbooks 是什么？

快书 JavaScript 客户端注意：该包已被作者标记为弃用——This package has moved to @nextform/quickbooks\. Please update your dependencies\.

### 如何安装 @balancer-team/quickbooks？

在项目目录运行 npm install @balancer-team/quickbooks，或使用 pnpm add / yarn add / bun add。

### @balancer-team/quickbooks 支持 TypeScript 吗？

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

### @balancer-team/quickbooks 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @balancer-team/quickbooks 可以商用吗？

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

### @balancer-team/quickbooks 的下载量有多少？

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

### @balancer-team/quickbooks 还在维护吗？

最新版本 0\.0\.18 发布于 2025/05/28（1\.4 年前）；至今共发布 18 个版本，其中过去 12 个月发布了 0 个；首次发布于 2024/08/31。作者已将其标记为弃用，新项目建议寻找替代方案。