Skip to content

Latest commit

 

History

History
635 lines (580 loc) · 53.1 KB

README.md

File metadata and controls

635 lines (580 loc) · 53.1 KB
Raw

Rust API client for 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台エラー時のチェックポイントを参照してください

    • type

    • status : HTTPステータスコードの説明
    • validation : エラーの詳細の説明（開発者向け）

レスポンスの例

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

API使用制限

freeeは一定期間に過度のアクセスを検知した場合、APIアクセスをコントロールする場合があります。

その際のhttp status codeは403となります。制限がかかってから10分程度が過ぎると再度使用することができるようになります。

/reportsと/receipts/{id}/downloadエンドポイント

freeeはエンドポイント毎に一定頻度以上のアクセスを検知した場合、APIアクセスをコントロールする場合があります。その際のhttp status codeは429（too many requests）となります。

  • /reports:1秒に10回まで
  • /receipts/{id}/download:1秒に3回まで

http status codeが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 Rate Limit

freee会計プラン名 事業所とアプリケーション毎に1日でのAPIコール数
エンタープライズ 10,000
プロフェッショナル 5,000
ベーシック 3,000
ミニマム 3,000
上記以外 3,000

Webhookについて

詳細は会計Webhook概要を参照してください。

連絡先

ご不明点、ご要望等は freee サポートデスクへのお問い合わせフォーム からご連絡ください。

© Since 2013 freee K.K.

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: v1.0
  • Package version: v1.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:

openapi = { path = "./openapi" }

Documentation for API Endpoints

All URIs are relative to https://api.freee.co.jp

Class Method HTTP request Description
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} 口座の更新

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author