You Need A Budget (Independent Publisher)

You Need A Budget (YNAB) を使用すると、自分の予算と対話する個人用アプリケーションを構築したり、他の YNABer が承認して使用できるアプリケーションを構築したりできます。

このコネクタは、次の製品および地域で利用可能です:

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Troy Taylor
[URL] https://www.hitachisolutions.com
メール ttaylor@hitachisolutions.com
Connector Metadata
発行者 Troy Taylor
Web サイト https://www.youneedabudget.com/
プライバシー ポリシー https://www.youneedabudget.com/privacy-policy/
カテゴリー Finance

接続を作成する

コネクタは、次の認証タイプをサポートしています:

既定 接続を作成するためのパラメーター。 すべての地域 共有不可

既定

適用できるもの: すべての領域

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 Power App が別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

件名 タイプ 説明設定 Required
アクセス トークン (形式は 'Bearer AccessToken) securestring api 向けのアクセス トークン (形式は 'Bearer AccessToken) True

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

ID ごとにトランザクションを取得する

単一のトランザクションを返します。

ID でアカウントを取得する

単一アカウントを返します。

ID でカテゴリを取得する

単一のカテゴリを返します。 金額 (予算、活動、残高など) は、現在の予算月 (UTC) に固有です。

ID でスケジュールされたトランザクションを取得する

スケジュールされた単一のトランザクションを返します。

ID で予算を取得する

関連するすべてのエンティティを含む 1 つの予算を返します。 このリソースは、実質的に完全な予算のエクスポートです。

ID で予算設定を取得する

予算の設定を返します

ID で受取人の場所を取得する

単一の受取人の場所を返します。

ID で月カテゴリを取得する

特定の予算月の単一のカテゴリを返します。 金額 (予算、活動、残高など) は、現在の予算月 (UTC) に固有です。

ID による受取人を取得する

単一の受取人を返します。

アカウントごとにトランザクションを取得する

指定されたアカウントのすべてのトランザクションを返します。

アカウントの取得

すべてのアカウントを返します。

アカウントを作成する

新しいアカウントを作成します。

カテゴリごとにトランザクションを取得する

指定されたカテゴリのすべてのトランザクションを返します。

カテゴリの取得

カテゴリ グループでグループ化されたすべてのカテゴリを返します。 金額 (予算、活動、残高など) は、現在の予算月 (UTC) に固有です。

スケジュールされたトランザクションを取得する

スケジュールされたすべてのトランザクションを返します。

トランザクションのインポート

指定された予算のすべてのリンクされたアカウントで利用可能なトランザクションをインポートします。 リンクされたアカウントにより、指定された金融機関から取引を直接インポートすることができ、この エンドポイント がそのインポートを開始します。 この エンドポイント にリクエストを送信することは、ウェブ アプリケーションで各アカウントの "インポート" をクリックするか、モバイル アプリケーションで "新しいトランザクション" バナーをタップすることと同じです。 この エンドポイント の応答には、インポートされたトランザクション ID が含まれています。

トランザクションの一括作成

複数のトランザクションを作成します。 この エンドポイント は引き続きサポートされていますが、'POST /budgets/{budget_id}/transactions' を使用して、複数のトランザクションを作成します。

トランザクションの作成

単一のトランザクションまたは複数のトランザクションを作成します。 transaction オブジェクトを含むボディを提供する場合、単一のトランザクションが作成され、transactions 配列を含むボディを提供する場合、複数のトランザクションが作成されます。 このエンドポイントでは、スケジュールされたトランザクションを作成できません。

トランザクションの更新

単一のトランザクションを更新します。

トランザクションの更新

id または import_id ごとの複数のトランザクションを更新します。

トランザクションを取得

予算トランザクションを返します。

ユーザーを取得する

認証を受けたユーザー情報を返します。

予算の取得

概要情報を含む予算リストを返します。

予算月を取得する

単一の予算月を返します。

予算月を取得する

すべての予算月を返します。

受取人ごとにトランザクションを取得する

指定されたアカウントのすべてのトランザクションを返します。

受取人ごとに受取人の場所を取得する

指定された受取人のすべての受取人の所在地を返します。

受取人の場所を取得する

すべての受取人の場所を返します。

受取人を取得する

すべての受取人を返します。

月アイコンの更新

特定の月のカテゴリを更新します。 更新できるのは budgeted の金額です。

ID ごとにトランザクションを取得する

単一のトランザクションを返します。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Transaction ID
transaction_id True string

トランザクションの識別子。

戻り値

Transaction Response
TransactionResponse

ID でアカウントを取得する

単一アカウントを返します。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Account ID
account_id True uuid

アカウントの識別子。

戻り値

Account Response
AccountResponse

ID でカテゴリを取得する

単一のカテゴリを返します。 金額 (予算、活動、残高など) は、現在の予算月 (UTC) に固有です。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Category ID
category_id True string

カテゴリの識別子。

戻り値

Category Response
CategoryResponse

ID でスケジュールされたトランザクションを取得する

スケジュールされた単一のトランザクションを返します。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Scheduled Transaction ID
scheduled_transaction_id True string

スケジュールされたトランザクションの識別子。

戻り値

Scheduled Transaction Response
ScheduledTransactionResponse

ID で予算を取得する

関連するすべてのエンティティを含む 1 つの予算を返します。 このリソースは、実質的に完全な予算のエクスポートです。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。

Last Knowledge of Server
last_knowledge_of_server integer

開始サーバーの知識。 提供されている場合、last_knowledge_of_server 以降に変更されたエンティティのみ含まれます。

戻り値

Budget Detail Response
BudgetDetailResponse

ID で予算設定を取得する

予算の設定を返します

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

戻り値

Budget Settings Response
BudgetSettingsResponse

ID で受取人の場所を取得する

単一の受取人の場所を返します。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Payee Location ID
payee_location_id True string

受取人の場所の識別子。

戻り値

Payee Location Response
PayeeLocationResponse

ID で月カテゴリを取得する

特定の予算月の単一のカテゴリを返します。 金額 (予算、活動、残高など) は、現在の予算月 (UTC) に固有です。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Month
month True date

ISO 形式の予算月 (例: 2016-12-01)。 ("current" は、現在の暦月 (UTC) を指定するためにも使用できます)

Category ID
category_id True string

カテゴリの識別子。

戻り値

Category Response
CategoryResponse

ID による受取人を取得する

単一の受取人を返します。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Payee ID
payee_id True string

受取人の識別子。

戻り値

Payee Response
PayeeResponse

アカウントごとにトランザクションを取得する

指定されたアカウントのすべてのトランザクションを返します。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Account ID
account_id True string

アカウントの識別子。

Since Date
since_date date

指定した場合、この日付以降のトランザクションのみが含まれます。 日付は ISO 形式にする必要があります (例: 2016-12-30)。

タイプ
type string

指定した場合、指定されたタイプのトランザクションのみが含まれます。 "未分類" と "未承認" は現在サポートされています。

Last Knowledge of Server
last_knowledge_of_server integer

開始サーバーの知識。 提供されている場合、last_knowledge_of_server 以降に変更されたエンティティのみ含まれます。

戻り値

Transactions Response
TransactionsResponse

アカウントの取得

すべてのアカウントを返します。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Last Knowledge of Server
last_knowledge_of_server integer

開始サーバーの知識。 提供されている場合、last_knowledge_of_server 以降に変更されたエンティティのみ含まれます。

戻り値

Accounts Response
AccountsResponse

アカウントを作成する

新しいアカウントを作成します。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の識別子 ("last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

件名
name True string

アカウントの名前。

Type2
type True string

アカウントの種類

残高
balance True integer

アカウントの現在の残高 (100 万形式)。

戻り値

Account Response
AccountResponse

カテゴリごとにトランザクションを取得する

指定されたカテゴリのすべてのトランザクションを返します。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Category ID
category_id True string

カテゴリの識別子。

Since Date
since_date date

指定した場合、この日付以降のトランザクションのみが含まれます。 日付は ISO 形式にする必要があります (例: 2016-12-30)。

タイプ
type string

指定した場合、指定されたタイプのトランザクションのみが含まれます。 "未分類" と "未承認" は現在サポートされています。

Last Knowledge of Server
last_knowledge_of_server integer

開始サーバーの知識。 提供されている場合、last_knowledge_of_server 以降に変更されたエンティティのみ含まれます。

戻り値

Hybrid Transactions Response
HybridTransactionsResponse

カテゴリの取得

カテゴリ グループでグループ化されたすべてのカテゴリを返します。 金額 (予算、活動、残高など) は、現在の予算月 (UTC) に固有です。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Last Knowledge of Server
last_knowledge_of_server integer

開始サーバーの知識。 提供されている場合、last_knowledge_of_server 以降に変更されたエンティティのみ含まれます。

戻り値

Categories Response
CategoriesResponse

スケジュールされたトランザクションを取得する

スケジュールされたすべてのトランザクションを返します。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Last Knowledge of Server
last_knowledge_of_server integer

開始サーバーの知識。 提供されている場合、last_knowledge_of_server 以降に変更されたエンティティのみ含まれます。

戻り値

Scheduled Transactions Response
ScheduledTransactionsResponse

トランザクションのインポート

指定された予算のすべてのリンクされたアカウントで利用可能なトランザクションをインポートします。 リンクされたアカウントにより、指定された金融機関から取引を直接インポートすることができ、この エンドポイント がそのインポートを開始します。 この エンドポイント にリクエストを送信することは、ウェブ アプリケーションで各アカウントの "インポート" をクリックするか、モバイル アプリケーションで "新しいトランザクション" バナーをタップすることと同じです。 この エンドポイント の応答には、インポートされたトランザクション ID が含まれています。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

戻り値

Transactions Import Response
TransactionsImportResponse

トランザクションの一括作成

複数のトランザクションを作成します。 この エンドポイント は引き続きサポートされていますが、'POST /budgets/{budget_id}/transactions' を使用して、複数のトランザクションを作成します。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Account ID
account_id True string

アカウントの識別子。

date True date

ISO-MM-DD 形式のトランザクションの日付 (例、2016-12-01)。 将来の日付 (予定された取引) は許可されていません。 分割取引の日付は変更できません。別の日付が指定された場合、それは無視されます。

Amount
amount True integer

100 万形式でのトランザクションの金額。 分割トランザクションの金額は変更できません。別の金額が指定された場合、それは無視されます。

Payee ID
payee_id uuid

トランザクションの受取人。 2 つの口座間の振替を作成するには、対象の口座を指す口座振替受取人を使用します。 口座振替の受取人はアカウント リソースで transfer_payee_id として指定されます。

受取人
payee_name string

受取人名。 もしpayee_name の値が提供され、payee_id が null 値の場合、payee_name 値は、(1) 一致する受取人の名前変更規則 (import_id が指定されている場合のみ)、または (2) 同名の受取人、または (3) 新しい受取人の作成のいずれかによって受取人を解決するために使用されます。

Category ID
category_id uuid

トランザクションのカテゴリ。 分割トランザクションを構成するには、category_id に対して null を指定し、トランザクション オブジェクトの一部として subtransactions の配列を提供します。 既存の取引が分割されている場合、category_id は変えられません。 クレジット カード支払いカテゴリは許可されておらず、提供されても無視されます。

メモ
memo string

メモ。

クリア
cleared string

トランザクションのクリアされた状態。

Approved
approved boolean

トランザクションが承認されたかどうか。 指定しない場合、トランザクションは規定で未承認になります。

フラグの色
flag_color string

トランザクション フラグ。

インポート ID
import_id string

指定した場合、新しいトランザクションにはこの import_id が割り当てられ、"インポートされた" と見なされます。 また、このインポートされた取引を、同じアカウントの既存の "ユーザーが入力した" 取引と、同じ金額で、インポートされた取引日から +/-10 日の日付で照合しようとします。

ファイル ベースのインポートまたは直接インポート (API 経由ではない) によってインポートされたトランザクションには、'YNAB:[milliunit_amount]:[iso_date]:[occurrence]' の形式で import_id が割り当てられます。 たとえば、日付が 2015-12-30 で、-$294.23 米ドルの取引の import_id は 'YNAB:-294230:2015-12-30:1' になります。 同じアカウントの 2 番目のトランザクションがインポートされ、同じ日付で同じ金額だった場合、その import_id は 'YNAB:-294230:2015-12-30:2' になります。 一貫した形式を使用すると、直接インポートとファイル ベースのインポートによる重複を防ぐことができます。

import_id が省略されているか null として指定されている場合、トランザクションは "ユーザーが入力した" トランザクションとして扱われます。 そのため、後で (DI、FBI、または API を介して) インポートされるトランザクションと照合する資格があります。

Amount
amount True integer

100 万形式でのサブトランザクションの金額。

Payee ID
payee_id uuid

サブトランザクションの受取人。

受取人
payee_name string

受取人名。 もし payee_name の値が提供され、payee_id が null 値の場合、payee_name 値は、(1) 一致する受取人の名前変更規則 (親のトランザクションで import_id が指定されている場合のみ)、または (2) 同名の受取人、または (3) 新しい受取人の作成のいずれかによって受取人を解決するために使用されます。

Category ID
category_id uuid

サブトランザクションのカテゴリ。 クレジット カード支払いカテゴリは許可されておらず、提供されても無視されます。

メモ
memo string

メモ。

戻り値

Bulk Response
BulkResponse

トランザクションの作成

単一のトランザクションまたは複数のトランザクションを作成します。 transaction オブジェクトを含むボディを提供する場合、単一のトランザクションが作成され、transactions 配列を含むボディを提供する場合、複数のトランザクションが作成されます。 このエンドポイントでは、スケジュールされたトランザクションを作成できません。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Account ID
account_id True string

アカウントの識別子。

date True date

ISO-MM-DD 形式のトランザクションの日付 (例、2016-12-01)。 将来の日付 (予定された取引) は許可されていません。 分割取引の日付は変更できません。別の日付が指定された場合、それは無視されます。

Amount
amount True integer

100 万形式でのトランザクションの金額。 分割トランザクションの金額は変更できません。別の金額が指定された場合、それは無視されます。

Payee ID
payee_id uuid

トランザクションの受取人。 2 つの口座間の振替を作成するには、対象の口座を指す口座振替受取人を使用します。 口座振替の受取人はアカウント リソースで transfer_payee_id として指定されます。

受取人
payee_name string

受取人名。 もしpayee_name の値が提供され、payee_id が null 値の場合、payee_name 値は、(1) 一致する受取人の名前変更規則 (import_id が指定されている場合のみ)、または (2) 同名の受取人、または (3) 新しい受取人の作成のいずれかによって受取人を解決するために使用されます。

Category ID
category_id uuid

トランザクションのカテゴリ。 分割トランザクションを構成するには、category_id に対して null を指定し、トランザクション オブジェクトの一部として subtransactions の配列を提供します。 既存の取引が分割されている場合、category_id は変えられません。 クレジット カード支払いカテゴリは許可されておらず、提供されても無視されます。

メモ
memo string

メモ。

クリア
cleared string

トランザクションのクリアされた状態。

Approved
approved boolean

トランザクションが承認されたかどうか。 指定しない場合、トランザクションは規定で未承認になります。

フラグの色
flag_color string

トランザクション フラグ。

インポート ID
import_id string

指定した場合、新しいトランザクションにはこの import_id が割り当てられ、"インポートされた" と見なされます。 また、このインポートされた取引を、同じアカウントの既存の "ユーザーが入力した" 取引と、同じ金額で、インポートされた取引日から +/-10 日の日付で照合しようとします。

ファイル ベースのインポートまたは直接インポート (API 経由ではない) によってインポートされたトランザクションには、'YNAB:[milliunit_amount]:[iso_date]:[occurrence]' の形式で import_id が割り当てられます。 たとえば、日付が 2015-12-30 で、-$294.23 米ドルの取引の import_id は 'YNAB:-294230:2015-12-30:1' になります。 同じアカウントの 2 番目のトランザクションがインポートされ、同じ日付で同じ金額だった場合、その import_id は 'YNAB:-294230:2015-12-30:2' になります。 一貫した形式を使用すると、直接インポートとファイル ベースのインポートによる重複を防ぐことができます。

import_id が省略されているか null として指定されている場合、トランザクションは "ユーザーが入力した" トランザクションとして扱われます。 そのため、後で (DI、FBI、または API を介して) インポートされるトランザクションと照合する資格があります。

Amount
amount True integer

100 万形式でのサブトランザクションの金額。

Payee ID
payee_id uuid

サブトランザクションの受取人。

受取人
payee_name string

受取人名。 もし payee_name の値が提供され、payee_id が null 値の場合、payee_name 値は、(1) 一致する受取人の名前変更規則 (親のトランザクションで import_id が指定されている場合のみ)、または (2) 同名の受取人、または (3) 新しい受取人の作成のいずれかによって受取人を解決するために使用されます。

Category ID
category_id uuid

サブトランザクションのカテゴリ。 クレジット カード支払いカテゴリは許可されておらず、提供されても無視されます。

メモ
memo string

メモ。

Account ID
account_id True string

アカウントの識別子。

date True date

ISO-MM-DD 形式のトランザクションの日付 (例、2016-12-01)。 将来の日付 (予定された取引) は許可されていません。 分割取引の日付は変更できません。別の日付が指定された場合、それは無視されます。

Amount
amount True integer

100 万形式でのトランザクションの金額。 分割トランザクションの金額は変更できません。別の金額が指定された場合、それは無視されます。

Payee ID
payee_id uuid

トランザクションの受取人。 2 つの口座間の振替を作成するには、対象の口座を指す口座振替受取人を使用します。 口座振替の受取人はアカウント リソースで transfer_payee_id として指定されます。

受取人
payee_name string

受取人名。 もしpayee_name の値が提供され、payee_id が null 値の場合、payee_name 値は、(1) 一致する受取人の名前変更規則 (import_id が指定されている場合のみ)、または (2) 同名の受取人、または (3) 新しい受取人の作成のいずれかによって受取人を解決するために使用されます。

Category ID
category_id uuid

トランザクションのカテゴリ。 分割トランザクションを構成するには、category_id に対して null を指定し、トランザクション オブジェクトの一部として subtransactions の配列を提供します。 既存の取引が分割されている場合、category_id は変えられません。 クレジット カード支払いカテゴリは許可されておらず、提供されても無視されます。

メモ
memo string

メモ。

クリア
cleared string

トランザクションのクリアされた状態。

Approved
approved boolean

トランザクションが承認されたかどうか。 指定しない場合、トランザクションは規定で未承認になります。

フラグの色
flag_color string

トランザクション フラグ。

インポート ID
import_id string

指定した場合、新しいトランザクションにはこの import_id が割り当てられ、"インポートされた" と見なされます。 また、このインポートされた取引を、同じアカウントの既存の "ユーザーが入力した" 取引と、同じ金額で、インポートされた取引日から +/-10 日の日付で照合しようとします。

ファイル ベースのインポートまたは直接インポート (API 経由ではない) によってインポートされたトランザクションには、'YNAB:[milliunit_amount]:[iso_date]:[occurrence]' の形式で import_id が割り当てられます。 たとえば、日付が 2015-12-30 で、-$294.23 米ドルの取引の import_id は 'YNAB:-294230:2015-12-30:1' になります。 同じアカウントの 2 番目のトランザクションがインポートされ、同じ日付で同じ金額だった場合、その import_id は 'YNAB:-294230:2015-12-30:2' になります。 一貫した形式を使用すると、直接インポートとファイル ベースのインポートによる重複を防ぐことができます。

import_id が省略されているか null として指定されている場合、トランザクションは "ユーザーが入力した" トランザクションとして扱われます。 そのため、後で (DI、FBI、または API を介して) インポートされるトランザクションと照合する資格があります。

Amount
amount True integer

100 万形式でのサブトランザクションの金額。

Payee ID
payee_id uuid

サブトランザクションの受取人。

受取人
payee_name string

受取人名。 もし payee_name の値が提供され、payee_id が null 値の場合、payee_name 値は、(1) 一致する受取人の名前変更規則 (親のトランザクションで import_id が指定されている場合のみ)、または (2) 同名の受取人、または (3) 新しい受取人の作成のいずれかによって受取人を解決するために使用されます。

Category ID
category_id uuid

サブトランザクションのカテゴリ。 クレジット カード支払いカテゴリは許可されておらず、提供されても無視されます。

メモ
memo string

メモ。

戻り値

Save Transactions Response
SaveTransactionsResponse

トランザクションの更新

単一のトランザクションを更新します。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Transaction ID
transaction_id True string

トランザクションの識別子。

Account ID
account_id True string

アカウントの識別子。

date True date

ISO-MM-DD 形式のトランザクションの日付 (例、2016-12-01)。 将来の日付 (予定された取引) は許可されていません。 分割取引の日付は変更できません。別の日付が指定された場合、それは無視されます。

Amount
amount True integer

100 万形式でのトランザクションの金額。 分割トランザクションの金額は変更できません。別の金額が指定された場合、それは無視されます。

Payee ID
payee_id uuid

トランザクションの受取人。 2 つの口座間の振替を作成するには、対象の口座を指す口座振替受取人を使用します。 口座振替の受取人はアカウント リソースで transfer_payee_id として指定されます。

受取人
payee_name string

受取人名。 もしpayee_name の値が提供され、payee_id が null 値の場合、payee_name 値は、(1) 一致する受取人の名前変更規則 (import_id が指定されている場合のみ)、または (2) 同名の受取人、または (3) 新しい受取人の作成のいずれかによって受取人を解決するために使用されます。

Category ID
category_id uuid

トランザクションのカテゴリ。 分割トランザクションを構成するには、category_id に対して null を指定し、トランザクション オブジェクトの一部として subtransactions の配列を提供します。 既存の取引が分割されている場合、category_id は変えられません。 クレジット カード支払いカテゴリは許可されておらず、提供されても無視されます。

メモ
memo string

メモ。

クリア
cleared string

トランザクションのクリアされた状態。

Approved
approved boolean

トランザクションが承認されたかどうか。 指定しない場合、トランザクションは規定で未承認になります。

フラグの色
flag_color string

トランザクション フラグ。

インポート ID
import_id string

指定した場合、新しいトランザクションにはこの import_id が割り当てられ、"インポートされた" と見なされます。 また、このインポートされた取引を、同じアカウントの既存の "ユーザーが入力した" 取引と、同じ金額で、インポートされた取引日から +/-10 日の日付で照合しようとします。

ファイル ベースのインポートまたは直接インポート (API 経由ではない) によってインポートされたトランザクションには、'YNAB:[milliunit_amount]:[iso_date]:[occurrence]' の形式で import_id が割り当てられます。 たとえば、日付が 2015-12-30 で、-$294.23 米ドルの取引の import_id は 'YNAB:-294230:2015-12-30:1' になります。 同じアカウントの 2 番目のトランザクションがインポートされ、同じ日付で同じ金額だった場合、その import_id は 'YNAB:-294230:2015-12-30:2' になります。 一貫した形式を使用すると、直接インポートとファイル ベースのインポートによる重複を防ぐことができます。

import_id が省略されているか null として指定されている場合、トランザクションは "ユーザーが入力した" トランザクションとして扱われます。 そのため、後で (DI、FBI、または API を介して) インポートされるトランザクションと照合する資格があります。

Amount
amount True integer

100 万形式でのサブトランザクションの金額。

Payee ID
payee_id uuid

サブトランザクションの受取人。

受取人
payee_name string

受取人名。 もし payee_name の値が提供され、payee_id が null 値の場合、payee_name 値は、(1) 一致する受取人の名前変更規則 (親のトランザクションで import_id が指定されている場合のみ)、または (2) 同名の受取人、または (3) 新しい受取人の作成のいずれかによって受取人を解決するために使用されます。

Category ID
category_id uuid

サブトランザクションのカテゴリ。 クレジット カード支払いカテゴリは許可されておらず、提供されても無視されます。

メモ
memo string

メモ。

戻り値

Transaction Response
TransactionResponse

トランザクションの更新

id または import_id ごとの複数のトランザクションを更新します。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

ID
id True string

識別子。

Account ID
account_id True string

アカウントの識別子。

date True date

ISO-MM-DD 形式のトランザクションの日付 (例、2016-12-01)。 将来の日付 (予定された取引) は許可されていません。 分割取引の日付は変更できません。別の日付が指定された場合、それは無視されます。

Amount
amount True integer

100 万形式でのトランザクションの金額。 分割トランザクションの金額は変更できません。別の金額が指定された場合、それは無視されます。

Payee ID
payee_id uuid

トランザクションの受取人。 2 つの口座間の振替を作成するには、対象の口座を指す口座振替受取人を使用します。 口座振替の受取人はアカウント リソースで transfer_payee_id として指定されます。

受取人
payee_name string

受取人名。 もしpayee_name の値が提供され、payee_id が null 値の場合、payee_name 値は、(1) 一致する受取人の名前変更規則 (import_id が指定されている場合のみ)、または (2) 同名の受取人、または (3) 新しい受取人の作成のいずれかによって受取人を解決するために使用されます。

Category ID
category_id uuid

トランザクションのカテゴリ。 分割トランザクションを構成するには、category_id に対して null を指定し、トランザクション オブジェクトの一部として subtransactions の配列を提供します。 既存の取引が分割されている場合、category_id は変えられません。 クレジット カード支払いカテゴリは許可されておらず、提供されても無視されます。

メモ
memo string

メモ。

クリア
cleared string

トランザクションのクリアされた状態。

Approved
approved boolean

トランザクションが承認されたかどうか。 指定しない場合、トランザクションは規定で未承認になります。

フラグの色
flag_color string

トランザクション フラグ。

インポート ID
import_id string

指定した場合、新しいトランザクションにはこの import_id が割り当てられ、"インポートされた" と見なされます。 また、このインポートされた取引を、同じアカウントの既存の "ユーザーが入力した" 取引と、同じ金額で、インポートされた取引日から +/-10 日の日付で照合しようとします。

ファイル ベースのインポートまたは直接インポート (API 経由ではない) によってインポートされたトランザクションには、'YNAB:[milliunit_amount]:[iso_date]:[occurrence]' の形式で import_id が割り当てられます。 たとえば、日付が 2015-12-30 で、-$294.23 米ドルの取引の import_id は 'YNAB:-294230:2015-12-30:1' になります。 同じアカウントの 2 番目のトランザクションがインポートされ、同じ日付で同じ金額だった場合、その import_id は 'YNAB:-294230:2015-12-30:2' になります。 一貫した形式を使用すると、直接インポートとファイル ベースのインポートによる重複を防ぐことができます。

import_id が省略されているか null として指定されている場合、トランザクションは "ユーザーが入力した" トランザクションとして扱われます。 そのため、後で (DI、FBI、または API を介して) インポートされるトランザクションと照合する資格があります。

Amount
amount True integer

100 万形式でのサブトランザクションの金額。

Payee ID
payee_id uuid

サブトランザクションの受取人。

受取人
payee_name string

受取人名。 もし payee_name の値が提供され、payee_id が null 値の場合、payee_name 値は、(1) 一致する受取人の名前変更規則 (親のトランザクションで import_id が指定されている場合のみ)、または (2) 同名の受取人、または (3) 新しい受取人の作成のいずれかによって受取人を解決するために使用されます。

Category ID
category_id uuid

サブトランザクションのカテゴリ。 クレジット カード支払いカテゴリは許可されておらず、提供されても無視されます。

メモ
memo string

メモ。

戻り値

Save Transactions Response
SaveTransactionsResponse

トランザクションを取得

予算トランザクションを返します。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Since Date
since_date date

指定した場合、この日付以降のトランザクションのみが含まれます。 日付は ISO 形式にする必要があります (例: 2016-12-30)。

タイプ
type string

指定した場合、指定されたタイプのトランザクションのみが含まれます。 "未分類" と "未承認" は現在サポートされています。

Last Knowledge of Server
last_knowledge_of_server integer

開始サーバーの知識。 提供されている場合、last_knowledge_of_server 以降に変更されたエンティティのみ含まれます。

戻り値

Transactions Response
TransactionsResponse

ユーザーを取得する

認証を受けたユーザー情報を返します。

戻り値

User Response
UserResponse

予算の取得

概要情報を含む予算リストを返します。

パラメーター

名前 キー 必須 説明
Include Accounts
include_accounts boolean

予算勘定のリストを含めるかどうか。

戻り値

Budget Summary Response
BudgetSummaryResponse

予算月を取得する

単一の予算月を返します。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Month
month True date

ISO 形式の予算月 (例: 2016-12-01)。 ("current" は、現在の暦月 (UTC) を指定するためにも使用できます)

戻り値

Month Detail Response
MonthDetailResponse

予算月を取得する

すべての予算月を返します。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Last Knowledge of Server
last_knowledge_of_server integer

開始サーバーの知識。 提供されている場合、last_knowledge_of_server 以降に変更されたエンティティのみ含まれます。

戻り値

Month Summaries Response
MonthSummariesResponse

受取人ごとにトランザクションを取得する

指定されたアカウントのすべてのトランザクションを返します。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Payee ID
payee_id True string

受取人の識別子。

Since Date
since_date date

指定した場合、この日付以降のトランザクションのみが含まれます。 日付は ISO 形式にする必要があります (例: 2016-12-30)。

タイプ
type string

指定した場合、指定されたタイプのトランザクションのみが含まれます。 "未分類" と "未承認" は現在サポートされています。

Last Knowledge of Server
last_knowledge_of_server integer

開始サーバーの知識。 提供されている場合、last_knowledge_of_server 以降に変更されたエンティティのみ含まれます。

戻り値

Hybrid Transactions Response
HybridTransactionsResponse

受取人ごとに受取人の場所を取得する

指定された受取人のすべての受取人の所在地を返します。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Payee ID
payee_id True string

受取人の識別子。

戻り値

Payee Locations Response
PayeeLocationsResponse

受取人の場所を取得する

すべての受取人の場所を返します。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

戻り値

Payee Locations Response
PayeeLocationsResponse

受取人を取得する

すべての受取人を返します。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Last Knowledge of Server
last_knowledge_of_server integer

開始サーバーの知識。 提供されている場合、last_knowledge_of_server 以降に変更されたエンティティのみ含まれます。

戻り値

Payees Response
PayeesResponse

月アイコンの更新

特定の月のカテゴリを更新します。 更新できるのは budgeted の金額です。

パラメーター

名前 キー 必須 説明
Budget ID
budget_id True string

予算の ID。 "last-used" は最後に使用された予算を指定するために使用でき、"default" は規定の予算選択が有効になっている場合に使用できます (参照: https://api.youneedabudget.com/#oauth-default-budget)。

Month
month True date

ISO 形式の予算月 (例: 2016-12-01)。 ("current" は、現在の暦月 (UTC) を指定するためにも使用できます)

Category ID
category_id True string

カテゴリの識別子。

Budgeted
budgeted True integer

ミリ単位形式の予算額。

戻り値

Save Category Response
SaveCategoryResponse

定義

UserResponse

名前 パス 説明
日付
data Data

User

名前 パス 説明
ID
id string

識別子。

DateFormat

予算の日付形式設定。 場合によっては、フォーマットが使用できず、null として指定されます。

名前 パス 説明
形式
format string

形式。

CurrencyFormat

予算の通貨形式設定。 場合によっては、フォーマットが使用できず、null として指定されます。

名前 パス 説明
ISO コード
iso_code string

ISO コードです。

Example Format
example_format string

例の形式。

桁数
decimal_digits integer

桁数。

Decimal Separator
decimal_separator string

小数点。

Symbol First
symbol_first boolean

シンボルが最初かどうか。

Group Separator
group_separator string

グループ区切り。

通貨記号
currency_symbol string

通貨記号。

記号は表示されません
display_symbol boolean

シンボルが表示されているかどうか。

BudgetSummaryResponse

名前 パス 説明
Data1
data Data1

BudgetSummary

名前 パス 説明
ID
id string

識別子。

件名
name string

名前。

最終修正日
last_modified_on date-time

Web クライアントまたはモバイル クライアントから予算が最後に変更された時刻。

First Month
first_month date

一番早い予算月。

前月
last_month date

最新の予算月。

日付の表示形式
date_format DateFormat

予算の日付形式設定。 場合によっては、フォーマットが使用できず、null として指定されます。

通貨の表示形式
currency_format CurrencyFormat

予算の通貨形式設定。 場合によっては、フォーマットが使用できず、null として指定されます。

Accounts
accounts array of Account

予算勘定 (include_accounts=true がクエリ パラメータとして指定された場合にのみ含まれます)。

BudgetDetailResponse

名前 パス 説明
Data2
data Data2

BudgetDetail

名前 パス 説明
ID
id string

識別子。

件名
name string

名前。

最終修正日
last_modified_on date-time

Web クライアントまたはモバイル クライアントから予算が最後に変更された時刻。

First Month
first_month date

一番早い予算月。

前月
last_month date

最新の予算月。

日付の表示形式
date_format DateFormat

予算の日付形式設定。 場合によっては、フォーマットが使用できず、null として指定されます。

通貨の表示形式
currency_format CurrencyFormat

予算の通貨形式設定。 場合によっては、フォーマットが使用できず、null として指定されます。

Accounts
accounts array of Account

予算勘定 (include_accounts=true がクエリ パラメータとして指定された場合にのみ含まれます)。

Payees
payees array of Payee
Payee Locations
payee_locations array of PayeeLocation
Category Groups
category_groups array of CategoryGroup
カテゴリー
categories array of Category
months array of MonthDetail
トランザクション
transactions array of TransactionSummary
Subtransactions
subtransactions array of SubTransaction
Scheduled Transactions
scheduled_transactions array of ScheduledTransactionSummary
Scheduled Subtransactions
scheduled_subtransactions array of ScheduledSubTransaction

BudgetSettingsResponse

名前 パス 説明
Data3
data Data3

BudgetSettings

名前 パス 説明
日付の表示形式
date_format DateFormat

予算の日付形式設定。 場合によっては、フォーマットが使用できず、null として指定されます。

通貨の表示形式
currency_format CurrencyFormat

予算の通貨形式設定。 場合によっては、フォーマットが使用できず、null として指定されます。

AccountsResponse

名前 パス 説明
Data4
data Data4

AccountResponse

名前 パス 説明
Data5
data Data5

勘定科目

名前 パス 説明
ID
id string

識別子。

件名
name string

名前。

タイプ
type Type

アカウントの種類。 注: payPal、merchantAccount、investmentAccount、住宅ローンの種類は廃止されており、将来的に削除される予定です。

予算どおり
on_budget boolean

このアカウントが予算内かどうか

クローズ済みです
closed boolean

このアカウントがクローズされたかどうか

Note
note string

メモです。

残高
balance integer

アカウントの現在の残高 (100 万形式)。

Cleared Balance
cleared_balance integer

アカウントのクリアされた残高 (100 万形式)。

Uncleared Balance
uncleared_balance integer

アカウントのクリアされていない現在の残高 (100 万形式)。

Transfer Payee ID
transfer_payee_id string

この口座への送金時に使用する受取人 ID。

Direct Import Linked
direct_import_linked boolean

自動取引インポートのために口座が金融機関にリンクされているかどうか。

Direct Import In Error
direct_import_in_error boolean

金融機関にリンクされたアカウント (direct_import_linked=true) と、リンクされた接続が正常な状態でない場合、これは true になります。

Deleted
deleted boolean

アカウントが削除されたかどうか。 削除されたアカウントは、デルタ リクエストにのみ含まれます。

CategoriesResponse

名前 パス 説明
Data6
data Data6

CategoryResponse

名前 パス 説明
Data7
data Data7

CategoryGroupWithCategories

名前 パス 説明
ID
id string

識別子。

件名
name string

名前。

非表示
hidden boolean

カテゴリ グループを非表示にするかどうか。

Deleted
deleted boolean

カテゴリ グループが削除されているかどうか。 削除されたカテゴリ グループは、デルタ リクエストにのみ含まれます。

Catagories
categories array of Category

カテゴリ グループのカテゴリ。 金額 (予算、活動、残高など) は、現在の予算月 (UTC) に固有です。

CategoryGroup

名前 パス 説明
ID
id string

識別子。

件名
name string

名前。

非表示
hidden boolean

カテゴリ グループを非表示にするかどうか。

Deleted
deleted boolean

カテゴリ グループが削除されているかどうか。 削除されたカテゴリ グループは、デルタ リクエストにのみ含まれます。

カテゴリー

名前 パス 説明
ID
id string

識別子。

Category Group ID
category_group_id string

カテゴリ グループの識別子。

件名
name string

名前。

非表示
hidden boolean

カテゴリを非表示にするかどうか。

Original Category Group ID
original_category_group_id uuid

カテゴリが非表示の場合、これは非表示になる前に属していたカテゴリ グループの識別子です。

Note
note string

メモです。

Budgeted
budgeted integer

ミリ単位形式の予算額。

活動​
activity integer

ミリ単位形式のアクティブな額。

残高
balance integer

ミリ単位形式の残高。

Goal Type
goal_type GoalType

カテゴリに目標がある場合の目標のタイプ (TB='Target Category Balance'、TBD='Target Category Balance by Date'、MF='Monthly Funding'、NEED='Plan Your Spending')

Goal Creation Month
goal_creation_month date

目標が作成された月。

Goal Target
goal_target integer

ミリ単位の目標 ターゲット。

Goal Target Month
goal_target_month date

目標を完了すべきオリジナルのターゲット月。 この日付を指定するのは、一部の目標 タイプのみです。

Goal Percentage Complete
goal_percentage_complete integer

目標の完了率。

Goal Months to Budget
goal_months_to_budget integer

現在の目標期間の残りの月数 (現在の月を含む)。

Goal Under Funded
goal_under_funded integer

現在の目標期間内に目標を達成するために、今月まだ必要な資金の量。 この金額は、通常、Web およびモバイル クライアントの '資金不足' の金額に対応します。ただし、翌月の支出目標に必要なカテゴリを表示する場合を除きます。 Web およびモバイル クライアントは、将来の月の支出目標に必要なカテゴリを表示する場合、前の目標期間からの資金を無視します。

Goal Overall Funded
goal_overall_funded integer

現在の目標期間内に目標に向けて資金を調達した合計金額。

Goal Overall Left
goal_overall_left integer

現在の目標期間内に目標を達成するためにまだ必要な資金の額。

Deleted
deleted boolean

カテゴリが削除されているかどうか。 削除されたカテゴリは、デルタ リクエストにのみ含まれます。

SaveCategoryResponse

名前 パス 説明
Data8
data Data8

PayeesResponse

名前 パス 説明
Data9
data Data9

PayeeResponse

名前 パス 説明
Data10
data Data10

受取人

名前 パス 説明
ID
id string

識別子。

件名
name string

名前。

Transfer Account ID
transfer_account_id string

受取人の場合は、この受取人の転送先の account_id

Deleted
deleted boolean

受取人が削除されたかどうかを示します。 削除された受取人は、デルタ リクエストにのみ含まれます。

PayeeLocationsResponse

名前 パス 説明
Data11
data Data11

PayeeLocationResponse

名前 パス 説明
Data12
data Data12

PayeeLocation

名前 パス 説明
ID
id string

識別子。

Payee ID
payee_id string

受取人の識別子。

経度
latitude string

緯度。

緯度
longitude string

経度。

Deleted
deleted boolean

受取人の場所が削除されたかどうかを示します。 削除された受取人の場所は、デルタ リクエストにのみ含まれます。

TransactionsResponse

名前 パス 説明
Data13
data Data13

HybridTransactionsResponse

名前 パス 説明
Data14
data Data14

SaveTransactionsResponse

名前 パス 説明
Data15
data Data15

TransactionResponse

名前 パス 説明
Data16
data Data16

TransactionSummary

名前 パス 説明
ID
id string

識別子。

date date

ISO-MM-DD 形式のトランザクションの日付 (例、2016-12-01)。

Amount
amount integer

100 万形式でのトランザクションの金額。

メモ
memo string

メモ。

クリア
cleared Cleared

トランザクションのクリアされた状態。

Approved
approved boolean

トランザクションが承認されたかどうか。

フラグの色
flag_color FlagColor

トランザクション フラグ。

Account ID
account_id string

アカウントの識別子。

Payee ID
payee_id string

受取人の識別子。

Category ID
category_id string

カテゴリの識別子。

Transfer Account ID
transfer_account_id uuid

転送トランザクションの場合は、転送先のアカウント。

Transfer Transaction ID
transfer_transaction_id string

転送トランザクションの場合、転送の反対側のトランザクションの識別子。

Matched Transaction ID
matched_transaction_id string

トランザクションが一致した場合、一致したトランザクションの識別子。

インポート ID
import_id string

トランザクションがインポートされた場合、このフィールドは (アカウントごとの) 一意のインポート識別子です。 このトランザクションがファイル ベースのインポートまたは直接インポート (API 経由ではない) によってインポートされた場合は、import_id は、'YNAB:[milliunit_amount]:[iso_date]:[occurrence]' の形式になります。 たとえば、日付が 2015-12-30 で、-$294.23 米ドルの取引の import_id は 'YNAB:-294230:2015-12-30:1' になります。 同じアカウントの 2 番目のトランザクションがインポートされ、同じ日付で同じ金額だった場合、その import_id は 'YNAB:-294230:2015-12-30:2' になります。

Deleted
deleted boolean

トランザクションが削除されているかどうか。 削除されたトランザクションは、デルタ リクエストにのみ含まれます。

TransactionDetail

名前 パス 説明
ID
id string

識別子。

date date

ISO-MM-DD 形式のトランザクションの日付 (例、2016-12-01)。

Amount
amount integer

100 万形式でのトランザクションの金額。

メモ
memo string

メモ。

クリア
cleared Cleared

トランザクションのクリアされた状態。

Approved
approved boolean

トランザクションが承認されたかどうか。

フラグの色
flag_color FlagColor

トランザクション フラグ。

Account ID
account_id string

アカウントの識別子。

Payee ID
payee_id string

受取人の識別子。

Category ID
category_id string

カテゴリの識別子。

Transfer Account ID
transfer_account_id uuid

転送トランザクションの場合は、転送先のアカウント。

Transfer Transaction ID
transfer_transaction_id string

転送トランザクションの場合、転送の反対側のトランザクションの識別子。

Matched Transaction ID
matched_transaction_id string

トランザクションが一致した場合、一致したトランザクションの識別子。

インポート ID
import_id string

トランザクションがインポートされた場合、このフィールドは (アカウントごとの) 一意のインポート識別子です。 このトランザクションがファイル ベースのインポートまたは直接インポート (API 経由ではない) によってインポートされた場合は、import_id は、'YNAB:[milliunit_amount]:[iso_date]:[occurrence]' の形式になります。 たとえば、日付が 2015-12-30 で、-$294.23 米ドルの取引の import_id は 'YNAB:-294230:2015-12-30:1' になります。 同じアカウントの 2 番目のトランザクションがインポートされ、同じ日付で同じ金額だった場合、その import_id は 'YNAB:-294230:2015-12-30:2' になります。

Deleted
deleted boolean

トランザクションが削除されているかどうか。 削除されたトランザクションは、デルタ リクエストにのみ含まれます。

アカウント名
account_name string

アカウント名。

受取人
payee_name string

受取人名。

カテゴリー
category_name string

カテゴリ名。

Subtransactions
subtransactions array of SubTransaction

分割トランザクションの場合、サブトランザクション。

HybridTransaction

名前 パス 説明
ID
id string

識別子。

date date

ISO-MM-DD 形式のトランザクションの日付 (例、2016-12-01)。

Amount
amount integer

100 万形式でのトランザクションの金額。

メモ
memo string

メモ。

クリア
cleared Cleared

トランザクションのクリアされた状態。

Approved
approved boolean

トランザクションが承認されたかどうか。

フラグの色
flag_color FlagColor

トランザクション フラグ。

Account ID
account_id string

アカウントの識別子。

Payee ID
payee_id string

受取人の識別子。

Category ID
category_id string

カテゴリの識別子。

Transfer Account ID
transfer_account_id uuid

転送トランザクションの場合は、転送先のアカウント。

Transfer Transaction ID
transfer_transaction_id string

転送トランザクションの場合、転送の反対側のトランザクションの識別子。

Matched Transaction ID
matched_transaction_id string

トランザクションが一致した場合、一致したトランザクションの識別子。

インポート ID
import_id string

トランザクションがインポートされた場合、このフィールドは (アカウントごとの) 一意のインポート識別子です。 このトランザクションがファイル ベースのインポートまたは直接インポート (API 経由ではない) によってインポートされた場合は、import_id は、'YNAB:[milliunit_amount]:[iso_date]:[occurrence]' の形式になります。 たとえば、日付が 2015-12-30 で、-$294.23 米ドルの取引の import_id は 'YNAB:-294230:2015-12-30:1' になります。 同じアカウントの 2 番目のトランザクションがインポートされ、同じ日付で同じ金額だった場合、その import_id は 'YNAB:-294230:2015-12-30:2' になります。

Deleted
deleted boolean

トランザクションが削除されているかどうか。 削除されたトランザクションは、デルタ リクエストにのみ含まれます。

Type3
type Type3

ハイブリッド トランザクションが通常のトランザクションとサブトランザクションのどちらを表すか

Parent Transaction ID
parent_transaction_id string

サブトランザクション タイプの場合、これは親トランザクションの識別子です。 トランザクション タイプの場合、この識別子は常に null になります。

アカウント名
account_name string

アカウント名。

受取人
payee_name string

受取人名。

カテゴリー
category_name string

カテゴリ名。

TransactionsImportResponse

名前 パス 説明
Data17
data Data17

BulkResponse

名前 パス 説明
Data18
data Data18

SubTransaction

名前 パス 説明
ID
id string

識別子。

Transaction ID
transaction_id string

トランザクション。

Amount
amount integer

100 万形式でのサブトランザクションの金額。

メモ
memo string

メモ。

Payee ID
payee_id string

受取人の識別子。

受取人
payee_name string

受取人名。

Category ID
category_id string

カテゴリの識別子。

カテゴリー
category_name string

カテゴリ名。

Transfer Account ID
transfer_account_id uuid

転送の場合、サブトランザクションが転送される account_id。

Transfer Transaction ID
transfer_transaction_id string

転送の場合、転送の反対側のトランザクションの識別子。

Deleted
deleted boolean

サブトランザクションが削除されているかどうか。 削除されたサブトランザクションは、デルタ リクエストにのみ含まれます。

ScheduledTransactionsResponse

名前 パス 説明
Data19
data Data19

ScheduledTransactionResponse

名前 パス 説明
Data20
data Data20

ScheduledTransactionSummary

名前 パス 説明
ID
id string

識別子。

First Date
date_first date

スケジュールされたトランザクションがスケジュールされた最初の日付。

次の日付
date_next date

スケジュールされたトランザクションがスケジュールされた翌日。

頻度
frequency Frequency

頻度。

Amount
amount integer

100 万形式でのスケジュールされたトランザクションの金額。

メモ
memo string

メモ。

FlagColor1
flag_color FlagColor1

スケジュールされたトランザクション フラグ。

Account ID
account_id string

アカウントの識別子。

Payee ID
payee_id string

受取人の識別子。

Category ID
category_id string

カテゴリの識別子。

Transfer Account ID
transfer_account_id uuid

転送の場合、スケジュールされたトランザクションが転送される account_id。

Deleted
deleted boolean

スケジュールされたトランザクションが削除されているかどうか。 削除されたスケジュールされたトランザクションは、デルタ リクエストにのみ含まれます。

ScheduledTransactionDetail

名前 パス 説明
ID
id string

識別子。

First Date
date_first date

スケジュールされたトランザクションがスケジュールされた最初の日付。

次の日付
date_next date

スケジュールされたトランザクションがスケジュールされた翌日。

頻度
frequency Frequency

頻度。

Amount
amount integer

100 万形式でのスケジュールされたトランザクションの金額。

メモ
memo string

メモ。

FlagColor1
flag_color FlagColor1

スケジュールされたトランザクション フラグ。

Account ID
account_id string

アカウントの識別子。

Payee ID
payee_id string

受取人の識別子。

Category ID
category_id string

カテゴリの識別子。

Transfer Account ID
transfer_account_id uuid

転送の場合、スケジュールされたトランザクションが転送される account_id。

Deleted
deleted boolean

スケジュールされたトランザクションが削除されているかどうか。 削除されたスケジュールされたトランザクションは、デルタ リクエストにのみ含まれます。

アカウント名
account_name string

アカウント名。

受取人
payee_name string

受取人名。

カテゴリー
category_name string

カテゴリ名。

subtransactions
subtransactions array of ScheduledSubTransaction

分割スケジュールされたトランザクションの場合、サブトランザクション。

ScheduledSubTransaction

名前 パス 説明
ID
id string

識別子。

Scheduled Transaction ID
scheduled_transaction_id string

スケジュールされたトランザクションの識別子。

Amount
amount integer

100 万形式でのスケジュールされたサブトランザクションの金額。

メモ
memo string

メモ。

Payee ID
payee_id string

受取人の識別子。

Category ID
category_id string

カテゴリの識別子。

Transfer Account ID
transfer_account_id uuid

転送の場合、スケジュールされたサブトランザクションが転送される account_id。

Deleted
deleted boolean

スケジュールされたサブトランザクションが削除されているかどうか。 削除されたスケジュールされたサブトランザクションは、デルタ リクエストにのみ含まれます。

MonthSummariesResponse

名前 パス 説明
Data21
data Data21

MonthDetailResponse

名前 パス 説明
Data22
data Data22

MonthSummary

名前 パス 説明
Month
month date

月。

Note
note string

メモです。

収入
income integer

その月に、'流入: 割り当て可能' に分類されたトランザクションの合計金額。

Budgeted
budgeted integer

その月の予算の合計額。

活動​
activity integer

その月のトランザクションの合計額 '流入: 割り当て可能' に分類された者を除く。

To Be Budgeted
to_be_budgeted integer

'割り当て準備完了' の利用可能な金額。

Age of Money
age_of_money integer

その月の Age of Money。

Deleted
deleted boolean

月が削除されたかどうかを示します。 削除された月は、デルタ リクエストにのみ含まれます。

MonthDetail

名前 パス 説明
Month
month date

月。

Note
note string

メモです。

収入
income integer

その月に、'流入: 割り当て可能' に分類されたトランザクションの合計金額。

Budgeted
budgeted integer

その月の予算の合計額。

活動​
activity integer

その月のトランザクションの合計額 '流入: 割り当て可能' に分類された者を除く。

To Be Budgeted
to_be_budgeted integer

'割り当て準備完了' の利用可能な金額。

Age of Money
age_of_money integer

その月の Age of Money。

Deleted
deleted boolean

月が削除されたかどうかを示します。 削除された月は、デルタ リクエストにのみ含まれます。

カテゴリー
categories array of Category

予算月カテゴリ。 金額 (予算、活動、残高など) は、指定した {month} パラメーターに対して固有です。

Bulk

名前 パス 説明
Transaction IDs
transaction_ids array of string

作成されたトランザクション ID のリスト。

Duplicate Import IDs
duplicate_import_ids array of string

トランザクションが、 既に同じアカウントにあるトランザクションと import_id 一致するため作成されなかった場合、、指定された import_id がこのリストに含まれます。

クリア

トランザクションのクリアされた状態。

トランザクションのクリアされた状態。

クリア
string

日付

名前 パス 説明
User
user User

Data1

名前 パス 説明
予算
budgets array of BudgetSummary
Budget Summary
default_budget BudgetSummary

Data2

名前 パス 説明
Budget Detail
budget BudgetDetail
Server Knowledge
server_knowledge integer

サーバーの知識。

Data3

名前 パス 説明
Budget Settings
settings BudgetSettings

Data4

名前 パス 説明
Accounts
accounts array of Account
Server Knowledge
server_knowledge integer

サーバーの知識。

Data5

名前 パス 説明
勘定科目
account Account

Data6

名前 パス 説明
Category Groups
category_groups array of CategoryGroupWithCategories

カテゴリ グループ。

Server Knowledge
server_knowledge integer

サーバーの知識。

Data7

名前 パス 説明
カテゴリー
category Category

Data8

名前 パス 説明
カテゴリー
category Category
Server Knowledge
server_knowledge integer

サーバーの知識。

Data9

名前 パス 説明
Payees
payees array of Payee

受取人。

Server Knowledge
server_knowledge integer

サーバーの知識。

Data10

名前 パス 説明
受取人
payee Payee

Data11

名前 パス 説明
Payee Locations
payee_locations array of PayeeLocation

受取人の場所。

Data12

名前 パス 説明
Payee Location
payee_location PayeeLocation

Data13

名前 パス 説明
トランザクション
transactions array of TransactionDetail

トランザクション。

Server Knowledge
server_knowledge integer

サーバーの知識。

Data14

名前 パス 説明
トランザクション
transactions array of HybridTransaction

トランザクション。

Data15

名前 パス 説明
Transaction IDs
transaction_ids array of string

保存されたトランザクション ID。

Transaction Detail
transaction TransactionDetail
transactions
transactions array of TransactionDetail

複数のトランザクションが指定された場合、保存されたトランザクション。

Duplicate Import IDs
duplicate_import_ids array of string

複数のトランザクションが指定された場合、既存の import_id が同じアカウントで見つかったため、作成されなかった import_ids のリスト。

Server Knowledge
server_knowledge integer

サーバーの知識。

Data16

名前 パス 説明
Transaction Detail
transaction TransactionDetail

Data17

名前 パス 説明
Transaction IDs
transaction_ids array of string

インポートされたトランザクション ID のリスト。

Data18

名前 パス 説明
Bulk
bulk Bulk

Data19

名前 パス 説明
scheduled_transactions
scheduled_transactions array of ScheduledTransactionDetail
Server Knowledge
server_knowledge integer

サーバーの知識。

Data20

名前 パス 説明
Scheduled Transaction Detail
scheduled_transaction ScheduledTransactionDetail

Data21

名前 パス 説明
か月
months array of MonthSummary
Server Knowledge
server_knowledge integer

サーバーの知識。

Data22

名前 パス 説明
Month Detail
month MonthDetail

FlagColor

トランザクション フラグ。

トランザクション フラグ。

フラグの色
string

FlagColor1

スケジュールされたトランザクション フラグ。

スケジュールされたトランザクション フラグ。

FlagColor1
string

頻度

頻度。

頻度。

頻度
string

GoalType

カテゴリに目標がある場合の目標のタイプ (TB='Target Category Balance'、TBD='Target Category Balance by Date'、MF='Monthly Funding'、NEED='Plan Your Spending')

カテゴリに目標がある場合の目標のタイプ (TB='Target Category Balance'、TBD='Target Category Balance by Date'、MF='Monthly Funding'、NEED='Plan Your Spending')

Goal Type
string

タイプ

アカウントの種類。 注: payPal、merchantAccount、investmentAccount、住宅ローンの種類は廃止されており、将来的に削除される予定です。

アカウントの種類。 注: payPal、merchantAccount、investmentAccount、住宅ローンの種類は廃止されており、将来的に削除される予定です。

タイプ
string

Type3

ハイブリッド トランザクションが通常のトランザクションとサブトランザクションのどちらを表すか

ハイブリッド トランザクションが通常のトランザクションとサブトランザクションのどちらを表すか

Type3
string