Lib.rs

›
#id #accounting #api-client #rest #open-api #rest-client #specification

freee

freee会计的REST API客户端实现，由OpenAPI规范自动生成

作者：Natsuki Ikeguchi

11个版本 (6个破坏性更新)

0.7.0 2023年3月1日
0.5.0 2022年11月2日
0.4.0 2022年7月31日

#13 in #accounting

每月29次下载

MIT许可证

5MB
27K SLoC

Rust API客户端用于OpenAPI

freee API

入门指南

对于刚开始使用freee API的开发者，请参考freee API入门指南。

规格

API端点

https://api.freee.co.jp/ (仅支持https)

关于认证

使用OAuth2.0进行认证。有关详细信息，请参阅参考中关于认证的说明。

数据格式

请求和响应都支持JSON格式，但具体请参阅每个API说明中的格式（application/json等）。

具有向后兼容性的更改

freee有时会进行以下更改，以改善API，并且不会通知这些更改。应用程序实现者应在以下方面进行开发。

  • 添加新的API资源端点
  • 为现有API添加新的请求参数，这些参数不是必需的
  • 为现有API响应添加新的属性
  • 更改现有API响应中属性的顺序
  • 更改作为key的id或code的长度（变长）

通用响应头

所有API的响应都包含以下HTTP头。

  • X-Freee-Request-ID

    • 每个请求都会分配一个ID

通用错误响应

  • 除了包含在JSON响应内的状态码之外，HTTP头也包含状态码

  • 一些错误响应包含错误代码。
    有关详细信息，请参阅HTTP状态码400错误时的检查点。

    • 类型

    • status : HTTP状态码的解释
    • validation : 错误的详细信息说明（面向开发者）

响应示例

  {
    "status_code" : 400,
    "errors" : [
      {
        "type" : "status",
        "messages" : ["不正なリクエストです。"]
      },
      {
        "type" : "validation",
        "messages" : ["Date は不正な日付フォーマットです。入力例：2019-12-17"]
      }
    ]
  }

API使用限制

当freee检测到一定时间内的过度访问时，可能会对API访问进行控制。

此时http状态码为403。限制解除后大约10分钟，可以再次使用。

/reports和/receipts/{id}/download端点

当freee检测到每个端点的访问频率超过一定频率时，可能会对API访问进行控制。此时http状态码为429（请求过多）。

  • /reports：每秒最多10次
  • /receipts/{id}/download：每秒最多3次

当http状态码为429时，API使用状态将附加到响应头中。

x-ratelimit-limit:10
x-ratelimit-remaining:1
x-ratelimit-reset:2023-01-13T10:22:29+09:00


各头的意义如下。

头名称 说明
x-ratelimit-limit使用次数上限
x-ratelimit-remaining剩余使用次数
x-ratelimit-reset使用次数重置的时间

计划特定的API速率限制

freee会计计划名称 每个事业所和应用程序每天API调用的次数
企业版 10,000
专业版 5,000
基本版 3,000
最小版 3,000
其他 3,000

关于Webhook

有关详细信息，请参阅会计Webhook概述。

联系方式

如有疑问或建议，请通过freee 支持台联系表格联系。

© 自2013年 freee K.K.

概述

此API客户端由OpenAPI Generator项目生成。通过使用来自远程服务器的openapi-spec，您可以轻松生成API客户端。

  • API版本：v1.0
  • 包版本：v1.0
  • 构建包：org.openapitools.codegen.languages.RustClientCodegen

安装

将包放入名为openapi的目录中，并将以下内容添加到Cargo.toml中的[dependencies]

openapi = { path = "./openapi" }

API端点文档

所有URI相对于https://api.freee.co.jp

类 方法 HTTP请求 描述
AccountItemsApi create_account_item POST /api/1/account_items 创建会计科目
AccountItemsApi destroy_account_item DELETE /api/1/account_items/{id} 删除会计科目
AccountItemsApi get_account_item GET /api/1/account_items/{id} 获取会计科目
AccountItemsApi get_account_items GET /api/1/account_items 获取会计科目列表
AccountItemsApi update_account_item PUT /api/1/account_items/{id} 更新会计科目
ApprovalFlowRoutesApi get_approval_flow_route GET /api/1/approval_flow_routes/{id} 获取申请路径
ApprovalFlowRoutesApi get_approval_flow_routes GET /api/1/approval_flow_routes 获取申请路径列表
ApprovalRequestsApi create_approval_request POST /api/1/approval_requests 创建各种申请
ApprovalRequestsApi destroy_approval_request DELETE /api/1/approval_requests/{id} 删除各种申请
ApprovalRequestsApi get_approval_request GET /api/1/approval_requests/{id} 获取各种申请
ApprovalRequestsApi get_approval_request_form GET /api/1/approval_requests/forms/{id} 获取各种申请的申请表
ApprovalRequestsApi get_approval_request_forms GET /api/1/approval_requests/forms 获取各种申请的申请表列表
ApprovalRequestsApi get_approval_requests GET /api/1/approval_requests 获取各种申请列表
ApprovalRequestsApi update_approval_request PUT /api/1/approval_requests/{id} 更新各种申请
ApprovalRequestsApi update_approval_request_action POST /api/1/approval_requests/{id}/actions 各种申请的批准操作
BanksApi get_bank GET /api/1/banks/{id} 获取关联服务
BanksApi get_banks GET /api/1/banks 获取关联服务列表
CompaniesApi get_companies GET /api/1/companies 获取营业场所列表
CompaniesApi get_company GET /api/1/companies/{id} 获取营业场所
DealsApi create_deal POST /api/1/deals 创建交易（收入/支出）
DealsApi destroy_deal DELETE /api/1/deals/{id} 删除交易（收入/支出）
DealsApi get_deal GET /api/1/deals/{id} 获取交易（收入/支出）
DealsApi get_deals GET /api/1/deals 获取交易（收入/支出）列表
DealsApi update_deal PUT /api/1/deals/{id} 更新交易（收入/支出）
ExpenseApplicationLineTemplatesApi create_expense_application_line_template POST /api/1/expense_application_line_templates 创建经费科目
ExpenseApplicationLineTemplatesApi destroy_expense_application_line_template DELETE /api/1/expense_application_line_templates/{id} 删除经费科目
ExpenseApplicationLineTemplatesApi get_expense_application_line_template GET /api/1/expense_application_line_templates/{id} 获取经费科目
ExpenseApplicationLineTemplatesApi get_expense_application_line_templates GET /api/1/expense_application_line_templates 获取经费科目列表
ExpenseApplicationLineTemplatesApi update_expense_application_line_template PUT /api/1/expense_application_line_templates/{id} 更新经费科目
ExpenseApplicationsApi create_expense_application POST /api/1/expense_applications 创建经费申请
ExpenseApplicationsApi destroy_expense_application DELETE /api/1/expense_applications/{id} 删除经费申请
ExpenseApplicationsApi get_expense_application GET /api/1/expense_applications/{id} 获取经费申请详情
ExpenseApplicationsApi get_expense_applications GET /api/1/expense_applications 获取经费申请列表
ExpenseApplicationsApi update_expense_application PUT /api/1/expense_applications/{id} 更新经费申请
ExpenseApplicationsApi update_expense_application_action POST /api/1/expense_applications/{id}/actions 经费申请的批准操作
InvoicesApi create_invoice POST /api/1/invoices 创建发票
InvoicesApi destroy_invoice DELETE /api/1/invoices/{id} 删除发票
InvoicesApi get_invoice GET /api/1/invoices/{id} 获取发票
InvoicesApi get_invoices GET /api/1/invoices 获取发票列表
InvoicesApi update_invoice PUT /api/1/invoices/{id} 更新发票
ItemsApi create_item POST /api/1/items 创建项目
ItemsApi destroy_item DELETE /api/1/items/{id} 删除项目
ItemsApi get_item GET /api/1/items/{id} 获取商品
ItemsApi get_items GET /api/1/items 获取商品列表
ItemsApi update_item PUT /api/1/items/{id} 更新商品
JournalsApi download_journal GET /api/1/journals/reports/{id}/download 下载日记账
JournalsApi get_journal_status GET /api/1/journals/reports/{id}/status 获取日记账状态
JournalsApi get_journals GET /api/1/journals 获取日记账请求
ManualJournalsApi create_manual_journal POST /api/1/manual_journals 创建转账凭证
ManualJournalsApi destroy_manual_journal DELETE /api/1/manual_journals/{id} 删除转账凭证
ManualJournalsApi get_manual_journal GET /api/1/manual_journals/{id} 获取转账凭证
ManualJournalsApi get_manual_journals GET /api/1/manual_journals 获取转账凭证列表
ManualJournalsApi update_manual_journal PUT /api/1/manual_journals/{id} 更新转账凭证
PartnersApi create_partner POST /api/1/partners 创建交易伙伴
PartnersApi destroy_partner DELETE /api/1/partners/{id} 删除交易伙伴
PartnersApi get_partner GET /api/1/partners/{id} 获取交易伙伴
PartnersApi get_partners GET /api/1/partners 获取交易伙伴列表
PartnersApi update_partner PUT /api/1/partners/{id} 更新交易伙伴
PartnersApi update_partner_by_code PUT /api/1/partners/code/{code} 更新交易伙伴
PaymentRequestsApi create_payment_request POST /api/1/payment_requests 创建支付请求
PaymentRequestsApi destroy_payment_request DELETE /api/1/payment_requests/{id} 删除支付请求
PaymentRequestsApi get_payment_request GET /api/1/payment_requests/{id} 获取支付请求
PaymentRequestsApi get_payment_requests GET /api/1/payment_requests 获取支付请求列表
PaymentRequestsApi update_payment_request PUT /api/1/payment_requests/{id} 更新支付请求
PaymentRequestsApi update_payment_request_action POST /api/1/payment_requests/{id}/actions 支付请求的批准操作
PaymentsApi create_deal_payment POST /api/1/deals/{id}/payments 创建交易（收入/支出）的付款行
PaymentsApi destroy_deal_payment DELETE /api/1/deals/{id}/payments/{payment_id} 删除交易（收入/支出）的付款行
PaymentsApi update_deal_payment PUT /api/1/deals/{id}/payments/{payment_id} 更新交易（收入/支出）的付款行
QuotationsApi create_quotation POST /api/1/quotations 创建报价单
QuotationsApi destroy_quotation DELETE /api/1/quotations/{id} 删除报价单
QuotationsApi get_quotation GET /api/1/quotations/{id} 获取报价单
QuotationsApi get_quotations GET /api/1/quotations 获取报价单列表
QuotationsApi update_quotation PUT /api/1/quotations/{id} 更新报价单
ReceiptsApi create_receipt POST /api/1/receipts 上传文件箱（凭证文件）
ReceiptsApi destroy_receipt DELETE /api/1/receipts/{id} 删除文件箱（凭证文件）
ReceiptsApi download_receipt GET /api/1/receipts/{id}/download 下载文件箱（凭证文件）
ReceiptsApi get_receipt GET /api/1/receipts/{id} 获取文件箱（凭证文件）
ReceiptsApi get_receipts GET /api/1/receipts 获取文件箱（凭证文件）列表
ReceiptsApi update_receipt PUT /api/1/receipts/{id} 更新文件箱（凭证文件）
RenewsApi create_deal_renew POST /api/1/deals/{id}/renews 创建交易（收入/支出）的更新
RenewsApi delete_deal_renew DELETE /api/1/deals/{id}/renews/{renew_id} 删除交易（收入/支出）的更新
RenewsApi update_deal_renew PUT /api/1/deals/{id}/renews/{renew_id} 更新交易（收入/支出）的更新
SectionsApi create_section POST /api/1/sections 创建部门
SectionsApi destroy_section DELETE /api/1/sections/{id} 删除部门
SectionsApi get_section GET /api/1/sections/{id} 获取部门
SectionsApi get_sections GET /api/1/sections 获取部门列表
SectionsApi update_section PUT /api/1/sections/{id} 更新部门
SegmentTagsApi create_segment_tag POST /api/1/segments/{segment_id}/tags 创建段标签
SegmentTagsApi destroy_segments_tag DELETE /api/1/segments/{segment_id}/tags/{id} 删除段标签
SegmentTagsApi get_segment_tags GET /api/1/segments/{segment_id}/tags 获取段标签列表
SegmentTagsApi update_segment_tag PUT /api/1/segments/{segment_id}/tags/{id} 更新段落实体タグ
SelectablesApi get_forms_selectables GET /api/1/forms/selectables 获取表单选择项信息
TagsApi create_tag POST /api/1/tags 创建备忘录标签
TagsApi destroy_tag DELETE /api/1/tags/{id} 删除备忘录标签
TagsApi get_tag GET /api/1/tags/{id} 获取备忘录标签
TagsApi get_tags GET /api/1/tags 获取备忘录标签列表
TagsApi update_tag PUT /api/1/tags/{id} 更新备忘录标签
TaxesApi get_tax_code GET /api/1/taxes/codes/{code} 获取税分类
TaxesApi get_tax_codes GET /api/1/taxes/codes 获取税分类列表
TaxesApi get_taxes_companies GET /api/1/taxes/companies/{company_id} 获取指定事务所的税分类列表
TransfersApi create_transfer POST /api/1/transfers 创建交易（转帐）
TransfersApi destroy_transfer DELETE /api/1/transfers/{id} 删除交易（转帐）
TransfersApi get_transfer GET /api/1/transfers/{id} 获取交易（转帐）
TransfersApi get_transfers GET /api/1/transfers 获取交易（转帐）列表
TransfersApi update_transfer PUT /api/1/transfers/{id} 更新交易（转帐）
TrialBalanceApi get_trial_bs GET /api/1/reports/trial_bs 获取资产负债表
TrialBalanceApi get_trial_bs_three_years GET /api/1/reports/trial_bs_three_years 获取资产负债表（三年比较）
TrialBalanceApi get_trial_bs_two_years GET /api/1/reports/trial_bs_two_years 获取资产负债表（去年比较）
TrialBalanceApi get_trial_cr GET /api/1/reports/trial_cr 获取制造原价报告书
TrialBalanceApi get_trial_cr_sections GET /api/1/reports/trial_cr_sections 获取制造原价报告书（部门比较）
TrialBalanceApi get_trial_cr_segment1_tags GET /api/1/reports/trial_cr_segment_1_tags 获取制造原价报告书（段1比较）
TrialBalanceApi get_trial_cr_segment2_tags GET /api/1/reports/trial_cr_segment_2_tags 获取制造原价报告书（段2比较）
TrialBalanceApi get_trial_cr_segment3_tags GET /api/1/reports/trial_cr_segment_3_tags 获取制造原价报告书（段3比较）
TrialBalanceApi get_trial_cr_three_years GET /api/1/reports/trial_cr_three_years 获取制造原价报告书（三年比较）
TrialBalanceApi get_trial_cr_two_years GET /api/1/reports/trial_cr_two_years 获取制造原价报告书（去年比较）
TrialBalanceApi get_trial_pl GET /api/1/reports/trial_pl 获取损益计算书
TrialBalanceApi get_trial_pl_sections GET /api/1/reports/trial_pl_sections 获取损益计算书（部门比较）
TrialBalanceApi get_trial_pl_segment1_tags GET /api/1/reports/trial_pl_segment_1_tags 获取损益计算书（段1比较）
TrialBalanceApi get_trial_pl_segment2_tags GET /api/1/reports/trial_pl_segment_2_tags 获取损益计算书（段2比较）
TrialBalanceApi get_trial_pl_segment3_tags GET /api/1/reports/trial_pl_segment_3_tags 获取损益计算书（段3比较）
TrialBalanceApi get_trial_pl_three_years GET /api/1/reports/trial_pl_three_years 获取损益计算书（三年比较）
TrialBalanceApi get_trial_pl_two_years GET /api/1/reports/trial_pl_two_years 获取损益计算书（去年比较）
UsersApi get_users GET /api/1/users 获取事务所所属用户列表
UsersApi get_users_capabilities GET /api/1/users/capabilities 获取登录用户的权限
UsersApi get_users_me GET /api/1/users/me 获取登录用户
UsersApi update_user PUT /api/1/users/me 更新登录用户
WalletTxnsApi create_wallet_txn POST /api/1/wallet_txns 创建账户明细
WalletTxnsApi destroy_wallet_txn DELETE /api/1/wallet_txns/{id} 删除账户明细
WalletTxnsApi get_wallet_txn GET /api/1/wallet_txns/{id} 获取账户明细
WalletTxnsApi get_wallet_txns GET /api/1/wallet_txns 获取账户明细列表
WalletablesApi create_walletable POST /api/1/walletables 创建账户
WalletablesApi destroy_walletable DELETE /api/1/walletables/{type}/{id} 删除账户
WalletablesApi get_walletable GET /api/1/walletables/{type}/{id} 获取账户
WalletablesApi get_walletables GET /api/1/walletables 获取账户列表
WalletablesApi update_walletable PUT /api/1/walletables/{type}/{id} 更新账户

模型文档说明

要获取crate生成的文档的访问权限，请使用

cargo doc --open

作者

依赖关系

~4–16MB
~246K SLoC