Skip to content

Latest commit

 

History

History
171 lines (97 loc) · 7.13 KB

WalletablesApi.md

File metadata and controls

171 lines (97 loc) · 7.13 KB
Raw

\WalletablesApi

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

Method HTTP request Description
create_walletable POST /api/1/walletables 口座の作成
destroy_walletable DELETE /api/1/walletables/{type}/{id} 口座の削除
get_walletable GET /api/1/walletables/{type}/{id} 口座の取得
get_walletables GET /api/1/walletables 口座一覧の取得
update_walletable PUT /api/1/walletables/{type}/{id} 口座の更新

create_walletable

crate::models::WalletableCreateResponse create_walletable(walletable_create_params) 口座の作成

概要

指定した事業所の口座を作成する

注意点

  • 同期に対応した口座はこのAPIでは作成できません

定義

  • type

    • bank_account : 銀行口座
    • credit_card : クレジットカード
    • wallet : その他の決済口座

  • name : 口座名

  • bank_id : 連携サービスID

  • is_asset : type:wallet指定時に口座を資産口座とするか負債口座とするか（true: 資産口座 (デフォルト), false: 負債口座）

Parameters

Name Type Description Required Notes
walletable_create_params Option<WalletableCreateParams> 口座の作成

Return type

crate::models::WalletableCreateResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

destroy_walletable

destroy_walletable(id, r#type, company_id) 口座の削除

概要

指定した事業所の口座を削除する

注意点

  • 削除を実行するには、当該口座に関連する仕訳データを事前に削除する必要があります。
  • 当該口座に仕訳が残っていないか確認するには、レポートの「仕訳帳」等を参照し、必要に応じて、「取引」や「口座振替」も削除します。

Parameters

Name Type Description Required Notes
id i32 口座ID [required]
r#type String 口座種別（bank_account : 銀行口座, credit_card : クレジットカード, wallet : その他の決済口座） [required]
company_id i32 事業所ID [required]

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_walletable

crate::models::GetWalletable200Response get_walletable(id, r#type, company_id) 口座の取得

概要

指定した事業所の口座を取得する

定義

  • type
    • bank_account : 銀行口座
    • credit_card : クレジットカード
    • wallet : その他の決済口座
  • walletable_balance : 登録残高
  • last_balance : 同期残高

Parameters

Name Type Description Required Notes
id i32 口座ID [required]
r#type String 口座種別（bank_account : 銀行口座, credit_card : クレジットカード, wallet : その他の決済口座） [required]
company_id i32 事業所ID [required]

Return type

crate::models::GetWalletable200Response

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_walletables

crate::models::GetWalletables200Response get_walletables(company_id, with_balance, r#type) 口座一覧の取得

概要

指定した事業所の口座一覧を取得する

定義

  • type
    • bank_account : 銀行口座
    • credit_card : クレジットカード
    • wallet : その他の決済口座
  • walletable_balance : 登録残高
  • last_balance : 同期残高

Parameters

Name Type Description Required Notes
company_id i32 事業所ID [required]
with_balance Option<bool> 残高情報を含める
r#type Option<String> 口座種別（bank_account : 銀行口座, credit_card : クレジットカード, wallet : その他の決済口座）

Return type

crate::models::GetWalletables200Response

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_walletable

crate::models::GetWalletable200Response update_walletable(id, r#type, walletable_update_params) 口座の更新

概要

指定した事業所の口座を更新する

Parameters

Name Type Description Required Notes
id i32 [required]
r#type String 口座種別（bank_account : 銀行口座, credit_card : クレジットカード, wallet : その他の決済口座） [required]
walletable_update_params Option<WalletableUpdateParams> 口座の更新

Return type

crate::models::GetWalletable200Response

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]