--- agentTools: projectIndex: https://docs.link.getmoneytree.com/llms.txt --- # 法人口座の残高 > 📘 必要なOAuthスコープ: `accounts_read` 法人口座の履歴残高。各残高には `balance_type` が付与され、合計・未確定・確定・長期債務のいずれかを示します。 # OpenAPI definition ```json { "openapi": "3.0.2", "info": { "title": "法人口座", "version": "1.0.0", "description": "", "contact": { "name": "Moneytree Link Support", "email": "link-support@moneytree.jp" } }, "servers": [ { "url": "https://jp-api-staging.getmoneytree.com", "description": "日本の検証環境" }, { "url": "https://jp-api.getmoneytree.com", "description": "日本の本番環境" } ], "tags": [ { "name": "法人口座", "description": "法人口座" } ], "paths": { "/link/corporate/accounts/{account_id}/balances.json": { "summary": "法人口座の残高", "parameters": [ { "name": "account_id", "in": "path", "required": true, "description": "アカウントID", "schema": { "type": "integer", "format": "int64" }, "example": 1048 } ], "get": { "tags": [ "法人口座" ], "summary": "法人口座の残高", "description": "> 📘 必要なOAuthスコープ: `accounts_read`\n\n法人口座の履歴残高。各残高には `balance_type` が付与され、合計・未確定・確定・長期債務のいずれかを示します。\n", "security": [ { "oauth2": [ "accounts_read" ] } ], "operationId": "get-link-corporate-account-balances", "parameters": [ { "name": "page", "in": "query", "required": false, "description": "ページネーション用のページ番号です。\n返された結果のページオフセットを設定します。ページ番号は、1 から始まります。\n", "schema": { "type": "integer", "default": 1, "minimum": 1, "maximum": 100000 } }, { "name": "per_page", "in": "query", "required": false, "description": "1ページあたりの件数。", "schema": { "type": "integer", "default": 500, "minimum": 1, "maximum": 500 } }, { "name": "sort_key", "in": "query", "required": false, "description": "取引明細のソート順のキー\n`sort_key`の値が渡されない場合、デフォルトでデータベースの`id`キーが使用される。\n`sort_key`の使用はレスポンスタイムに影響を与える可能性があるため、必要なときだけ使用することを推奨する。\nソート順のキーに`date`を指定すると、データベースは取引の`date`でソートされます（Moneytree が取得した日付ではなく、実際の取引の日付です）。\n", "schema": { "type": "string", "default": "id" }, "example": "date" }, { "name": "sort_by", "in": "query", "required": false, "description": "ソート順は、昇順と降順で指定できます。\n`asc` → 昇順（指定がない場合、昇順になります）。\n`desc` → 降順。\n", "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "example": "desc" }, { "name": "since", "in": "query", "required": false, "description": "入力した値以降に更新された（`updated_at`）レコードを取得します。\n", "schema": { "type": "string", "format": "date", "example": "2020-11-28", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "start_date", "in": "query", "required": false, "description": "取引明細の開始日。指定する場合、`end_date`も必須です。\n`since`パラメータと同時に指定した場合、`since`パラメータが優先されます。\n[`since`と`start_date`/`end_date`の使い分けについて。](https://docs.link.getmoneytree.com/docs/api-notes-api#start%E3%80%81end%E3%81%A8since%E3%81%AE%E5%BC%95%E6%95%B0%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)\n", "schema": { "type": "string", "format": "date", "example": "2020-11-28", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "end_date", "in": "query", "required": false, "description": "取引明細の終了日。指定する場合、`start_date`も必須です。\n`since`パラメータと同時に指定した場合、`since`パラメータが優先されます。\n[`since`と`start_date`/`end_date`の使い分けについて。](https://docs.link.getmoneytree.com/docs/api-notes-api#start%E3%80%81end%E3%81%A8since%E3%81%AE%E5%BC%95%E6%95%B0%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)\n", "schema": { "type": "string", "format": "date", "example": "2020-11-28", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } ], "responses": { "200": { "description": "口座の残高履歴", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "account_balances" ], "properties": { "account_balances": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "id": { "type": "integer", "description": "残高レコードID", "format": "int64" }, "account_id": { "type": "integer", "description": "アカウントID", "format": "int64" }, "date": { "allOf": [ { "type": "string", "format": "date", "example": "2020-11-28", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, { "description": "金融機関のWebサイトで残高を確認した日" } ] }, "updated_at": { "type": "string", "format": "date-time", "description": "マネーツリーにおける最終更新時刻（通常、金融サービスで確認した時刻）", "example": "2023-06-01T03:15:00+09:00" } }, "required": [ "id", "account_id", "date", "updated_at" ] }, { "type": "object", "properties": { "balance": { "type": "number", "format": "double", "description": "アカウント残高" }, "balance_in_base": { "type": "number", "format": "double", "description": "アカウント残高の円換算額。\n金融サービスが外貨の換算額を提供している場合は、その換算額を保管し、このフィールドで返されます。\n対応していない場合は、Moneytreeが利用している換算レートで計算します。\n" }, "balance_type": { "type": "integer", "enum": [ 0, 1, 2, 3 ], "description": "0 = クレジットカードの合計金額。負債でない口座において、普通の残高のこと。\n1 = クレジットカードなどの未確定金額\n2 = クレジットカードなどの確定金額\n3 = クレジットカードなどの長期債務（リボルビング、ボーナス払い、分割払いなど）金額", "nullable": true } }, "required": [ "balance", "balance_in_base", "balance_type" ] } ] } } } }, "examples": { "Example": { "value": { "account_balances": [ { "id": 123456, "date": "2016-03-31", "updated_at": "2016-03-31T12:00:00+09:00", "balance": -79780, "balance_type": 0, "balance_in_base": -79780, "account_id": 13741 }, { "id": 123457, "date": "2016-03-31", "updated_at": "2016-03-31T12:00:00+09:00", "balance": -69768, "balance_type": 1, "balance_in_base": -69768, "account_id": 13741 }, { "id": 123458, "date": "2016-03-31", "updated_at": "2016-03-31T12:00:00+09:00", "balance": -10012, "balance_type": 2, "balance_in_base": -10012, "account_id": 13741 }, { "id": 123459, "date": "2016-03-31", "updated_at": "2016-03-31T12:00:00+09:00", "balance": 0, "balance_type": 3, "balance_in_base": 0, "account_id": 13741 } ] } } } } } }, "400": { "description": "APIに対して行われたリクエストが無効である場合に返されます。\nこれは通常、送信されたデータが検証を通過しなかったことが原因です。\n" }, "401": { "description": "有効なアクセストークンを持っていない場合に返されます。" }, "403": { "description": "持っているアクセストークンが有効であるものの、本APIで必要とされるスコープが付与されていない時に返却されます。" }, "404": { "description": "要求されたエンティティが見つからない場合に返されます。" }, "429": { "description": "アプリケーションが多くのリクエストを送信し、レート制限を受けている場合に返されます。\n[APIレート制限は何か、どのように対処するのか？](https://docs.link.getmoneytree.com/docs/faq-rate-limiting)もご覧ください。\n" }, "500": { "description": "原因不明の内部サーバーエラーが発生した場合に返されます。" }, "503": { "description": "Moneytreeサービスがメンテナンス中の場合に返されます。" } } } } }, "components": { "securitySchemes": { "oauth2": { "type": "oauth2", "description": "MT LINK APIは、OAuth 2.0のスコープ機能（アクセスが可能な範囲を制限機能）により、利用者のデータへのアクセスを制限しております。\n", "flows": { "authorizationCode": { "authorizationUrl": "/oauth/authorize", "tokenUrl": "/oauth/token", "scopes": { "guest_read": "Moneytreeアカウントの基本情報（メールアドレス、言語、地域）の閲覧", "accounts_read": "Moneytreeに登録している銀行口座、クレジットカード、デビットカード、電子マネーの名称、口座の種別、残高の閲覧", "transactions_read": "Moneytreeに登録している銀行口座、クレジットカード、デビットカード、電子マネーの明細の閲覧", "transactions_write": "Moneytreeに登録している銀行口座、クレジットカード、デビットカード、電子マネーの明細のカテゴリやメモの編集", "request_refresh": "Moneytreeに登録している金融サービスの資産情報の取得", "investment_accounts_read": "Moneytreeに登録している投資用口座（投資信託、株式、確定拠出年金）の名称、口座の種別、残高の閲覧", "investment_transactions_read": "Moneytreeに登録している保有銘柄の明細の閲覧", "points_read": "Moneytreeに登録しているポイントの名称、残高、明細の閲覧", "life_insurance_read": "Moneytreeに登録している生命保険の契約内容の閲覧" } }, "clientCredentials": { "tokenUrl": "/oauth/token", "scopes": { "guest_read": "Moneytreeアカウントの基本情報（メールアドレス、言語、地域）の閲覧", "accounts_read": "Moneytreeに登録している銀行口座、クレジットカード、デビットカード、電子マネーの名称、口座の種別、残高の閲覧", "transactions_read": "Moneytreeに登録している銀行口座、クレジットカード、デビットカード、電子マネーの明細の閲覧", "transactions_write": "Moneytreeに登録している銀行口座、クレジットカード、デビットカード、電子マネーの明細のカテゴリやメモの編集", "request_refresh": "Moneytreeに登録している金融サービスの資産情報の取得", "investment_accounts_read": "Moneytreeに登録している投資用口座（投資信託、株式、確定拠出年金）の名称、口座の種別、残高の閲覧", "investment_transactions_read": "Moneytreeに登録している保有銘柄の明細の閲覧", "points_read": "Moneytreeに登録しているポイントの名称、残高、明細の閲覧", "life_insurance_read": "Moneytreeに登録している生命保険の契約内容の閲覧" } } } } } }, "x-readme": { "explorer-enabled": false, "proxy-enabled": true }, "_id": { "buffer": { "0": 106, "1": 152, "2": 222, "3": 177, "4": 149, "5": 242, "6": 192, "7": 24, "8": 245, "9": 247, "10": 161, "11": 54 } } } ```