コンテンツへスキップ

取引一覧 - list-transactions

接続されている銀行口座、クレジットカード、電子マネー、ポイントカードの取引を返します。投資取引は含まれません。投資取引には list-investments を使用してください。

プロンプトの例

  • 「取引履歴を教えて」
  • 「ファミリーマートで毎月どれくらい使っているか教えて」
  • 「楽天カードの直近10件の取引を教えて」
  • 「先週何にお金を使った?」

スキーマ

入力パラメータ

名前任意デフォルト説明
localestringはいja名称のローカライズに使用する言語。指定可能な値: ja, en。ゲストが英語で会話している場合は明示的に en を指定してください。
outputarray<string>はいcontent応答の返却方法を指定します。content はモデル向けのコンパクトなテキストペイロードを返します。structuredContent はプログラムから扱いやすい生の型付きデータを返します。両方を同時に指定することも可能です。指定可能な値: content, structuredContent
accountarray<object>はい全アカウント取引を特定のアカウントに絞り込みます。各項目は list-accounts の出力にある institution_account_nameinstitution_entity_key の両方に一致する必要があります。
start_datestringはいend_date の3ヶ月前日付範囲の開始日(YYYY-MM-DD 形式、含む)。取得可能な最大履歴: 120ヶ月。
end_datestringはい今日日付範囲の終了日(YYYY-MM-DD 形式、含む)。start_dateend_date の間の最大期間は6ヶ月で、超えた場合は end_date が調整されます。
category_namesarray<string>はい全カテゴリカテゴリ名で取引を絞り込みます。list-categories の出力にある category_name と一致する値を指定します。
transaction_typestringはい全てincome(正の金額)または expense(負の金額)。
sort_keystringはいdate並び替えの基準。指定可能な値: date, amount
sort_orderstringはいdesc並び替えの方向。指定可能な値: asc, desc
limitnumberはい全結果返す結果の最大件数。フィルタと並び替えの後に適用されます。
enriched_metricsarray<string>はいなしフィルタと件数制限の後に適用される追加情報。指定可能な値: merchant_identifier, marketplace_identifier(マーチャント・マーケットプレイスのキーを追加)、unusual_transaction_detection(異常検知シグナルを追加)。

出力構造

名前任意説明
transaction_total_countnumberいいえ条件に一致した取引の総数。
accounts_queriedarray<object>いいえこのクエリに含まれたアカウントと、アカウントごとの取引件数。
accounts_queried[].institution_account_namestringいいえ金融機関に登録されているアカウント名。アカウントフィルタに一致します。
accounts_queried[].institution_entity_keystringいいえ金融機関の安定した識別子。
accounts_queried[].transaction_countnumberいいえこのアカウントについて返された取引件数。
transactionsarray<object>いいえ指定した条件に一致する取引の一覧。
transactions[].transaction_datestringいいえ取引が発生した日付。
transactions[].transaction_amountnumberいいえ取引金額。支出は負数、収入は正数。
transactions[].transaction_descriptionstringいいえ取引の説明。Moneytreeが可能な範囲で整形しています。
transactions[].account_nicknamestringいいえゲストが設定したアカウントのニックネーム。未設定の場合は institution_account_name が使用されます。
transactions[].institution_namestringいいえ金融機関の表示名。
transactions[].institution_account_namestringいいえ金融機関に登録されているアカウント名。account_nickname とは異なります。
transactions[].category_namestring | nullいいえカテゴリ名。未分類の場合は null。
transactions[].category_typestring | nullいいえexpense(支出)または income(収入)。未分類の場合は null。
transactions[].category_parent_namestring | nullいいえサブカテゴリの場合、その親カテゴリ名。トップレベルのカテゴリ、または未分類の場合は null。
transactions[].category_entity_keystring | nullいいえカテゴリの安定した識別子。ゲスト定義カテゴリ、または未分類の場合は null。
transactions[].account_currencystringいいえアカウントの ISO 4217 通貨コード(例: JPY, USD)。
transactions[].account_balance_after_transactionnumber | nullいいえ金融機関が報告している場合の、この取引直後のアカウント残高。取得できない場合は null。
transactions[].merchant_identifierstring | nullはい安定したマーチャント識別子。enriched_metrics で指定した場合のみ存在します。
transactions[].marketplace_identifierstring | nullはい安定したマーケットプレイス識別子。enriched_metrics で指定した場合のみ存在します。
transactions[].is_unusualbooleanはいこの取引が異常として検出された場合に true。enriched_metrics で指定した場合のみ存在します。
transactions[].unusual_transaction_explanation_titlestring | nullはいこの取引が異常として検出された理由を説明する短いタイトル。enriched_metricsis_unusual が指定された場合のみ存在します。
transactions[].unusual_transaction_explanationstring | nullはいこの取引が異常として検出された理由の詳細な説明。enriched_metricsis_unusual が指定された場合のみ存在します。

注記

  • 1回のリクエストで最大6ヶ月分、デフォルトでは3ヶ月分(最大120ヶ月分の履歴が利用可能)を取得できます。
  • アカウントの絞り込みは institution_account_nameinstitution_entity_key の両方の一致で行われます。絞り込みたいアカウントの正確な値は、まず list-accounts で確認してください。
  • 公共料金(電気、ガス、水道)の支出パターンや比較には、代わりに list-utilities-insights を使用してください。