# @codat/accounting 中文文档 规范地址：https://npmcn.com/package/%40codat/accounting/ 版本：0\.42\.0 npm 元数据更新时间：2025-07-28T10:07:49.099Z 中文译文更新时间：2026-11-10T06:17:28.139Z 软件包许可：未声明 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40codat/accounting 原文对照：https://npmcn.com/package/%40codat/accounting/?lang=original 项目主页：https://github.com/codatio/client-sdk-typescript#readme 源码仓库：https://github.com/codatio/client-sdk-typescript ## 关键信息（来自 npm 元数据） - 包体积（解压后）：14.2 MB，1260 个文件 - 模块格式：CommonJS - TypeScript 类型：包内自带 - 运行依赖：5 个 - 首次发布：2023-04-26T15:53:33.705Z - 最新版本发布：2023-12-15T13:01:17.880Z - 近 30 天下载量：3825（2026-10-10 至 2026-11-08，npm 官方下载统计） - 已发布版本数：21（近 12 个月 0 个） ## 中文简介 Codat的会计API是一种灵活的API,用于将最新的会计数据拉入并推进到客户的会计软件. 它为您提供了一个简单的查看、创建、更新adn删除数据的方法,而不包含 ## 安装 ```sh npm install @codat/accounting ``` 也可以使用：`pnpm add @codat/accounting`、`yarn add @codat/accounting`、`bun add @codat/accounting` ## README # 会计 Codat的会计API是一种灵活的API,用于将最新的会计数据拉入并推进到客户的会计软件. 它为您提供了一个简单的查看,创建,更新adn删除数据的方法,而无需担心每个平台的具体复杂性. ## SDK 安装 ### 国家预防机制 ```bash npm add @codat/accounting ``` ### 雅伦 ```bash yarn add @codat/accounting ``` ## 示例使用 ## SDK 示例使用法 ### 示例 ```typescript import { CodatAccounting } from "@codat/accounting"; async function run() { const sdk = new CodatAccounting({ security: { authHeader: "Basic BASE_64_ENCODED(API_KEY)", }, }); const res = await sdk.accountTransactions.get({ accountTransactionId: "string", companyId: "8a210b68-6988-11ed-a1eb-0242ac120002", connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171", }); if (res.statusCode == 200) { // handle response } } run(); ``` ## 现有资源和业务 ### [账户交易](https://npmcn.com/package/%40codat/accounting/docs/sdks/accounttransactions/README.md) - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/accounttransactions/README.md#get) - 获取账户交易 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/accounttransactions/README.md#list) - 清单账户交易 ### [银行账户](https://npmcn.com/package/%40codat/accounting/docs/sdks/bankaccounts/README.md) - [创建](https://npmcn.com/package/%40codat/accounting/docs/sdks/bankaccounts/README.md#create) - 创建银行账户 - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/bankaccounts/README.md#get) - 获取银行账户 - [获取创建更新模式](https://npmcn.com/package/%40codat/accounting/docs/sdks/bankaccounts/README.md#getcreateupdatemodel) - 建立/更新银行账户模式 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/bankaccounts/README.md#list) - 列出银行账户 - [更新](https://npmcn.com/package/%40codat/accounting/docs/sdks/bankaccounts/README.md#update) - 更新银行账户 ### [银行帐户交易](https://npmcn.com/package/%40codat/accounting/docs/sdks/bankaccounttransactions/README.md) - [创建](https://npmcn.com/package/%40codat/accounting/docs/sdks/bankaccounttransactions/README.md#create) - 建立银行账户交易 - [获取创建模式](https://npmcn.com/package/%40codat/accounting/docs/sdks/bankaccounttransactions/README.md#getcreatemodel) - 创建银行账户交易模式 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/bankaccounttransactions/README.md#list) - 银行账户交易清单 ### [账单](https://npmcn.com/package/%40codat/accounting/docs/sdks/bills/README.md) - [创建](https://npmcn.com/package/%40codat/accounting/docs/sdks/bills/README.md#create) - 创建帐单 - [删除](https://npmcn.com/package/%40codat/accounting/docs/sdks/bills/README.md#delete) - 删除帐单 - [下载](https://npmcn.com/package/%40codat/accounting/docs/sdks/bills/README.md#downloadattachment) - 下载帐单附件 - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/bills/README.md#get) - 买单 - [获取附件](https://npmcn.com/package/%40codat/accounting/docs/sdks/bills/README.md#getattachment) - 拿账单附件 - [获取创建更新模式](https://npmcn.com/package/%40codat/accounting/docs/sdks/bills/README.md#getcreateupdatemodel) - 建立/更新法案模式 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/bills/README.md#list) - 法案清单 - [列表选项](https://npmcn.com/package/%40codat/accounting/docs/sdks/bills/README.md#listattachments) - 列出账单附件 - [更新](https://npmcn.com/package/%40codat/accounting/docs/sdks/bills/README.md#update) - 更新法案 - [上传附件](https://npmcn.com/package/%40codat/accounting/docs/sdks/bills/README.md#uploadattachment) - 上传账单附件 ### [客户](https://npmcn.com/package/%40codat/accounting/docs/sdks/customers/README.md) - [创建](https://npmcn.com/package/%40codat/accounting/docs/sdks/customers/README.md#create) - 创建客户 - [下载](https://npmcn.com/package/%40codat/accounting/docs/sdks/customers/README.md#downloadattachment) - 下载客户附件 - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/customers/README.md#get) - 找顾客 - [获取附件](https://npmcn.com/package/%40codat/accounting/docs/sdks/customers/README.md#getattachment) - 获取客户附件 - [获取创建更新模式](https://npmcn.com/package/%40codat/accounting/docs/sdks/customers/README.md#getcreateupdatemodel) - 获得创建/更新客户模式 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/customers/README.md#list) - 名单客户 - [列表选项](https://npmcn.com/package/%40codat/accounting/docs/sdks/customers/README.md#listattachments) - 客户附件清单 - [更新](https://npmcn.com/package/%40codat/accounting/docs/sdks/customers/README.md#update) - 更新客户信息 ### [直接费用](https://npmcn.com/package/%40codat/accounting/docs/sdks/directcosts/README.md) - [创建](https://npmcn.com/package/%40codat/accounting/docs/sdks/directcosts/README.md#create) - 创造直接成本 - [下载](https://npmcn.com/package/%40codat/accounting/docs/sdks/directcosts/README.md#downloadattachment) - 下载直接成本附件 - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/directcosts/README.md#get) - 获得直接成本 - [获取附件](https://npmcn.com/package/%40codat/accounting/docs/sdks/directcosts/README.md#getattachment) - 获取直接成本附件 - [获取创建模式](https://npmcn.com/package/%40codat/accounting/docs/sdks/directcosts/README.md#getcreatemodel) - 创建直接成本模式 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/directcosts/README.md#list) - 列出直接费用 - [列表选项](https://npmcn.com/package/%40codat/accounting/docs/sdks/directcosts/README.md#listattachments) - 列出直接费用附件 - [上传附件](https://npmcn.com/package/%40codat/accounting/docs/sdks/directcosts/README.md#uploadattachment) - 上传直接成本附件 ### [直接收入](https://npmcn.com/package/%40codat/accounting/docs/sdks/directincomes/README.md) - [创建](https://npmcn.com/package/%40codat/accounting/docs/sdks/directincomes/README.md#create) - 创造直接收入 - [下载](https://npmcn.com/package/%40codat/accounting/docs/sdks/directincomes/README.md#downloadattachment) - 下载直接收入附件 - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/directincomes/README.md#get) - 获得直接收入 - [获取附件](https://npmcn.com/package/%40codat/accounting/docs/sdks/directincomes/README.md#getattachment) - 获得直接收入附加 - [获取创建模式](https://npmcn.com/package/%40codat/accounting/docs/sdks/directincomes/README.md#getcreatemodel) - 创造直接收入模式 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/directincomes/README.md#list) - 列出直接收入 - [列表选项](https://npmcn.com/package/%40codat/accounting/docs/sdks/directincomes/README.md#listattachments) - 列出直接收入附件 - [上传附件](https://npmcn.com/package/%40codat/accounting/docs/sdks/directincomes/README.md#uploadattachment) - 建立直接收入附加 ### [发票](https://npmcn.com/package/%40codat/accounting/docs/sdks/invoices/README.md) - [创建](https://npmcn.com/package/%40codat/accounting/docs/sdks/invoices/README.md#create) - 创建发票 - [删除](https://npmcn.com/package/%40codat/accounting/docs/sdks/invoices/README.md#delete) - 删除发票 - [下载](https://npmcn.com/package/%40codat/accounting/docs/sdks/invoices/README.md#downloadattachment) - 下载发票附件 - [下载Pdf](https://npmcn.com/package/%40codat/accounting/docs/sdks/invoices/README.md#downloadpdf) - 把发票作为PDF - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/invoices/README.md#get) - 去拿发票 - [获取附件](https://npmcn.com/package/%40codat/accounting/docs/sdks/invoices/README.md#getattachment) - 获取发票附件 - [获取创建更新模式](https://npmcn.com/package/%40codat/accounting/docs/sdks/invoices/README.md#getcreateupdatemodel) - 获得创建/更新发票模式 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/invoices/README.md#list) - 清单发票 - [列表选项](https://npmcn.com/package/%40codat/accounting/docs/sdks/invoices/README.md#listattachments) - 清单发票附件 - [更新](https://npmcn.com/package/%40codat/accounting/docs/sdks/invoices/README.md#update) - 更新发票 - [上传附件](https://npmcn.com/package/%40codat/accounting/docs/sdks/invoices/README.md#uploadattachment) - 上传发票附件 ### [项目](https://npmcn.com/package/%40codat/accounting/docs/sdks/itemreceipts/README.md) - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/itemreceipts/README.md#get) - 拿到收据 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/itemreceipts/README.md#list) - 清单项目收据 ### [采购订单](https://npmcn.com/package/%40codat/accounting/docs/sdks/purchaseorders/README.md) - [创建](https://npmcn.com/package/%40codat/accounting/docs/sdks/purchaseorders/README.md#create) - 创建定购单 - [下载](https://npmcn.com/package/%40codat/accounting/docs/sdks/purchaseorders/README.md#downloadattachment) - 下载订购单附件 - [下载命令Purchase OrderPdf](https://npmcn.com/package/%40codat/accounting/docs/sdks/purchaseorders/README.md#downloadpurchaseorderpdf) - 作为PDF下载定购单 - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/purchaseorders/README.md#get) - 买单 - [获取附件](https://npmcn.com/package/%40codat/accounting/docs/sdks/purchaseorders/README.md#getattachment) - 获得订购单附件 - [获取创建更新模式](https://npmcn.com/package/%40codat/accounting/docs/sdks/purchaseorders/README.md#getcreateupdatemodel) - 建立/更新定购单模式 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/purchaseorders/README.md#list) - 清单定购单 - [列表选项](https://npmcn.com/package/%40codat/accounting/docs/sdks/purchaseorders/README.md#listattachments) - 清单定购单附件 - [更新](https://npmcn.com/package/%40codat/accounting/docs/sdks/purchaseorders/README.md#update) - 更新定购单 ### [供应商](https://npmcn.com/package/%40codat/accounting/docs/sdks/suppliers/README.md) - [创建](https://npmcn.com/package/%40codat/accounting/docs/sdks/suppliers/README.md#create) - 创建供应商 - [下载](https://npmcn.com/package/%40codat/accounting/docs/sdks/suppliers/README.md#downloadattachment) - 下载供应商附件 - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/suppliers/README.md#get) - 找供应商 - [获取附件](https://npmcn.com/package/%40codat/accounting/docs/sdks/suppliers/README.md#getattachment) - 获取供应商附件 - [获取创建更新模式](https://npmcn.com/package/%40codat/accounting/docs/sdks/suppliers/README.md#getcreateupdatemodel) - 获得创建/更新供应商模式 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/suppliers/README.md#list) - 名单供应商 - [列表选项](https://npmcn.com/package/%40codat/accounting/docs/sdks/suppliers/README.md#listattachments) - 列出供应商附件 - [更新](https://npmcn.com/package/%40codat/accounting/docs/sdks/suppliers/README.md#update) - 更新供应商 ### [转让](https://npmcn.com/package/%40codat/accounting/docs/sdks/transfers/README.md) - [创建](https://npmcn.com/package/%40codat/accounting/docs/sdks/transfers/README.md#create) - 创建传输 - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/transfers/README.md#get) - 调车 - [获取创建模式](https://npmcn.com/package/%40codat/accounting/docs/sdks/transfers/README.md#getcreatemodel) - 获得创建传输模式 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/transfers/README.md#list) - 清单转让 - [上传附件](https://npmcn.com/package/%40codat/accounting/docs/sdks/transfers/README.md#uploadattachment) - 上传发票附件 ### [帐单](https://npmcn.com/package/%40codat/accounting/docs/sdks/billcreditnotes/README.md) - [创建](https://npmcn.com/package/%40codat/accounting/docs/sdks/billcreditnotes/README.md#create) - 创建账单信用票据 - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/billcreditnotes/README.md#get) - 拿到帐单 - [获取创建更新模式](https://npmcn.com/package/%40codat/accounting/docs/sdks/billcreditnotes/README.md#getcreateupdatemodel) - 创建/更新账单信用票据模式 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/billcreditnotes/README.md#list) - 列出账单信用票据 - [更新](https://npmcn.com/package/%40codat/accounting/docs/sdks/billcreditnotes/README.md#update) - 更新账单信用票据 - [上传附件](https://npmcn.com/package/%40codat/accounting/docs/sdks/billcreditnotes/README.md#uploadattachment) - 上传账单信用附注附件 ### [账单](https://npmcn.com/package/%40codat/accounting/docs/sdks/billpayments/README.md) - [创建](https://npmcn.com/package/%40codat/accounting/docs/sdks/billpayments/README.md#create) - 创建账单支付 - [删除](https://npmcn.com/package/%40codat/accounting/docs/sdks/billpayments/README.md#delete) - 删除账单付款 - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/billpayments/README.md#get) - 付帐单 - [获取创建模式](https://npmcn.com/package/%40codat/accounting/docs/sdks/billpayments/README.md#getcreatemodel) - 创建账单支付模式 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/billpayments/README.md#list) - 列出账单付款情况 ### [账户](https://npmcn.com/package/%40codat/accounting/docs/sdks/accounts/README.md) - [创建](https://npmcn.com/package/%40codat/accounting/docs/sdks/accounts/README.md#create) - 创建账户 - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/accounts/README.md#get) - 记账 - [获取创建模式](https://npmcn.com/package/%40codat/accounting/docs/sdks/accounts/README.md#getcreatemodel) - 获得创建账户模式 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/accounts/README.md#list) - 清单账户 ### [贷方说明](https://npmcn.com/package/%40codat/accounting/docs/sdks/creditnotes/README.md) - [创建](https://npmcn.com/package/%40codat/accounting/docs/sdks/creditnotes/README.md#create) - 创建信用记录 - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/creditnotes/README.md#get) - 取得信用记录 - [获取创建更新模式](https://npmcn.com/package/%40codat/accounting/docs/sdks/creditnotes/README.md#getcreateupdatemodel) - 获得创建/更新信用记录模式 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/creditnotes/README.md#list) - 列出信用票据 - [更新](https://npmcn.com/package/%40codat/accounting/docs/sdks/creditnotes/README.md#update) - 更新信用证 ### [项目](https://npmcn.com/package/%40codat/accounting/docs/sdks/items/README.md) - [创建](https://npmcn.com/package/%40codat/accounting/docs/sdks/items/README.md#create) - 创建项目 - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/items/README.md#get) - 拿东西 - [获取创建模式](https://npmcn.com/package/%40codat/accounting/docs/sdks/items/README.md#getcreatemodel) - 获得创建项目模型 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/items/README.md#list) - 清单项目 ### [日记条目](https://npmcn.com/package/%40codat/accounting/docs/sdks/journalentries/README.md) - [创建](https://npmcn.com/package/%40codat/accounting/docs/sdks/journalentries/README.md#create) - 创建日记条目 - [删除](https://npmcn.com/package/%40codat/accounting/docs/sdks/journalentries/README.md#delete) - 删除日记条目 - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/journalentries/README.md#get) - 获取日记条目 - [获取创建模式](https://npmcn.com/package/%40codat/accounting/docs/sdks/journalentries/README.md#getcreatemodel) - 创建日记条目模式 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/journalentries/README.md#list) - 列出日记条目 ### [日记](https://npmcn.com/package/%40codat/accounting/docs/sdks/journals/README.md) - [创建](https://npmcn.com/package/%40codat/accounting/docs/sdks/journals/README.md#create) - 创建日记 - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/journals/README.md#get) - 拿日记 - [获取创建模式](https://npmcn.com/package/%40codat/accounting/docs/sdks/journals/README.md#getcreatemodel) - 获得创建日记模型 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/journals/README.md#list) - 名单期刊 ### [付款](https://npmcn.com/package/%40codat/accounting/docs/sdks/payments/README.md) - [创建](https://npmcn.com/package/%40codat/accounting/docs/sdks/payments/README.md#create) - 创建付款 - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/payments/README.md#get) - 拿钱 - [获取创建模式](https://npmcn.com/package/%40codat/accounting/docs/sdks/payments/README.md#getcreatemodel) - 创建支付模式 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/payments/README.md#list) - 清单付款 ### [报告](https://npmcn.com/package/%40codat/accounting/docs/sdks/reports/README.md) - [编辑器报告](https://npmcn.com/package/%40codat/accounting/docs/sdks/reports/README.md#getagedcreditorsreport) - 老年债权人报告 - [已过时的](https://npmcn.com/package/%40codat/accounting/docs/sdks/reports/README.md#getageddebtorsreport) - 老年债务人报告 - [获取巴朗谢特](https://npmcn.com/package/%40codat/accounting/docs/sdks/reports/README.md#getbalancesheet) - 获得资产负债表 - [获取卡什窗体](https://npmcn.com/package/%40codat/accounting/docs/sdks/reports/README.md#getcashflowstatement) - 获取现金流量表 - [获得利润和损失](https://npmcn.com/package/%40codat/accounting/docs/sdks/reports/README.md#getprofitandloss) - 获得损益 - [可报告](https://npmcn.com/package/%40codat/accounting/docs/sdks/reports/README.md#isagedcreditorsreportavailable) - 老年债权人报告 - [可报告已过时](https://npmcn.com/package/%40codat/accounting/docs/sdks/reports/README.md#isageddebtorreportavailable) - 已有的老年债务人报告 ### [公司信息](https://npmcn.com/package/%40codat/accounting/docs/sdks/companyinfo/README.md) - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/companyinfo/README.md#get) - 获取公司信息 - [刷新](https://npmcn.com/package/%40codat/accounting/docs/sdks/companyinfo/README.md#refresh) - 更新公司信息 ### [支付方法](https://npmcn.com/package/%40codat/accounting/docs/sdks/paymentmethods/README.md) - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/paymentmethods/README.md#get) - 获得支付方法 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/paymentmethods/README.md#list) - 清单支付方法 ### [销售订单](https://npmcn.com/package/%40codat/accounting/docs/sdks/salesorders/README.md) - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/salesorders/README.md#get) - 拿到销售订单 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/salesorders/README.md#list) - 清单销售订单 ### [税额](https://npmcn.com/package/%40codat/accounting/docs/sdks/taxrates/README.md) - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/taxrates/README.md#get) - 获得税率 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/taxrates/README.md#list) - 列出所有税率 ### [跟踪 类别](https://npmcn.com/package/%40codat/accounting/docs/sdks/trackingcategories/README.md) - [起来](https://npmcn.com/package/%40codat/accounting/docs/sdks/trackingcategories/README.md#get) - 获取跟踪类别 - [列表](https://npmcn.com/package/%40codat/accounting/docs/sdks/trackingcategories/README.md#list) - 清单追踪类别 ## 检索 此 SDK 中的一些端点支持重试. 如果在没有任何配置的情况下使用SDK,则会回落到API提供的默认重试策略. 然而,默认的重试策略可以在一次操作的基础上被推翻,或者在整个SDK中被推翻. 更改单个 API 调用默认重试策略, 只需为调用提供重试 Config 对象 : ```typescript import { CodatAccounting } from "@codat/accounting"; async function run() { const sdk = new CodatAccounting({ security: { authHeader: "Basic BASE_64_ENCODED(API_KEY)", }, }); const res = await sdk.accountTransactions.get( { accountTransactionId: "string", companyId: "8a210b68-6988-11ed-a1eb-0242ac120002", connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171", }, { strategy: "backoff", backoff: { initialInterval: 1, maxInterval: 50, exponent: 1.1, maxElapsedTime: 100, }, retryConnectionErrors: false, } ); if (res.statusCode == 200) { // handle response } } run(); ``` 如果您想要覆盖所有支持重试的操作的默认重试策略, 您可以在 SDK 初始化时提供重试Config : ```typescript import { CodatAccounting } from "@codat/accounting"; async function run() { const sdk = new CodatAccounting({ retry_config: { strategy: "backoff", backoff: { initialInterval: 1, maxInterval: 50, exponent: 1.1, maxElapsedTime: 100, }, retryConnectionErrors: false, }, security: { authHeader: "Basic BASE_64_ENCODED(API_KEY)", }, }); const res = await sdk.accountTransactions.get({ accountTransactionId: "string", companyId: "8a210b68-6988-11ed-a1eb-0242ac120002", connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171", }); if (res.statusCode == 200) { // handle response } } run(); ``` ## 处理错误 处理 SDK 中的错误, 大体上应该符合你的预期 。 所有操作返回一个响应对象或扔出一个错误. 如果您在 OpenAPI Spec 中指定了出错对象, SDK 会丢弃相应的出错类型 . | 错误对象 | 身份代码 | 内容类型 | | --- | --- | --- | | 错误。 SDKEROR | 400-600 (英语) | _编号 :_ | 示例 ```typescript import { CodatAccounting } from "@codat/accounting"; async function run() { const sdk = new CodatAccounting({ security: { authHeader: "Basic BASE_64_ENCODED(API_KEY)", }, }); let res; try { res = await sdk.accountTransactions.get({ accountTransactionId: "string", companyId: "8a210b68-6988-11ed-a1eb-0242ac120002", connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171", }); } catch (err) { if (err instanceof errors.SDKError) { console.error(err); // handle exception throw err; } } if (res.statusCode == 200) { // handle response } } run(); ``` ## 服务器选择 ### 通过索引选择服务器 通过将服务器索引传递到 `serverIdx: number` 初始化 SDK 客户端实例时的可选参数 。 然后,选定服务器将作为使用它的操作的默认值. 本表列出与可用服务器相关的索引: | {\\fn方正粗倩简体\\fs12\\an8\\1cHFFFF00\\b0} | 服务器 | 变量 | | --- | --- | --- | | 0 个 | `https://api.codat.io` | 无 | #### 示例 ```typescript import { CodatAccounting } from "@codat/accounting"; async function run() { const sdk = new CodatAccounting({ serverIdx: 0, security: { authHeader: "Basic BASE_64_ENCODED(API_KEY)", }, }); const res = await sdk.accountTransactions.get({ accountTransactionId: "string", companyId: "8a210b68-6988-11ed-a1eb-0242ac120002", connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171", }); if (res.statusCode == 200) { // handle response } } run(); ``` ### 覆盖服务器 URL / 客户端 默认服务器也可以通过将 URL 传递到 `serverURL: str` 初始化 SDK 客户端实例时的可选参数 。 例如: ```typescript import { CodatAccounting } from "@codat/accounting"; async function run() { const sdk = new CodatAccounting({ serverURL: "https://api.codat.io", security: { authHeader: "Basic BASE_64_ENCODED(API_KEY)", }, }); const res = await sdk.accountTransactions.get({ accountTransactionId: "string", companyId: "8a210b68-6988-11ed-a1eb-0242ac120002", connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171", }); if (res.statusCode == 200) { // handle response } } run(); ``` ## 自定义 HTTP 客户端 Typescript SDK 使用 [轴](https://axios-http.com/docs/intro) HTTP 库. 为了提供一个方便的配置超时, cookie, 代理,自定义头等低等配置的方法, 您可以用自定义初始化 SDK 客户端 `AxiosInstance` 对象. 例如,您可以为您 sdk 提出的每个请求指定一个标题 : ```typescript import { @codat/accounting } from "CodatAccounting"; import axios from "axios"; const httpClient = axios.create({ headers: {'x-custom-header': 'someValue'} }) const sdk = new CodatAccounting({defaultClient: httpClient}); ``` ## 认证 ### 常客安全计划 这个SDK在全球支持以下安全计划: | 名称 | 类型 | 计划 | | --- | --- | --- | | `authHeader` | 键 | API 密钥 | 您可以通过 `security` 初始化 SDK 客户端实例时的可选参数 。 例如: ```typescript import { CodatAccounting } from "@codat/accounting"; async function run() { const sdk = new CodatAccounting({ security: { authHeader: "Basic BASE_64_ENCODED(API_KEY)", }, }); const res = await sdk.accountTransactions.get({ accountTransactionId: "string", companyId: "8a210b68-6988-11ed-a1eb-0242ac120002", connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171", }); if (res.statusCode == 200) { // handle response } } run(); ``` ### 支助 如果你在使用我们的SDK时遇到任何挑战 请不要犹豫寻求援助. 你可以通过联系你敬业的Codat代表 或联系我们 [支助小组](mailto:support@codat.io)。 。 。 . 我们是来帮助确保你顺利体验的. ### 生成的库 [说话方便](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks) ## 常见问题 ### @codat/accounting 是什么？ Codat的会计API是一种灵活的API,用于将最新的会计数据拉入并推进到客户的会计软件\. 它为您提供了一个简单的查看、创建、更新adn删除数据的方法,而不包含 ### 如何安装 @codat/accounting？ 在项目目录运行 npm install @codat/accounting，或使用 pnpm add / yarn add / bun add。 ### @codat/accounting 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @codat/accounting 支持 ESM 还是 CommonJS？ 以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。 ### @codat/accounting 可以商用吗？ @codat/accounting 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。 ### @codat/accounting 的下载量有多少？ 根据 npm 官方下载统计，@codat/accounting 在 2026/10/10 – 2026/11/08 这 30 天内被下载 3,825 次，日均约 128 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @codat/accounting 还在维护吗？ 最新版本 0\.42\.0 发布于 2023/12/15（2 年前）；至今共发布 21 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/04/26。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。