予算が必要です (独立した発行元)

予算が必要な場合 (YNAB) を使用すると、独自の予算とやり取りする個人用アプリケーションを構築したり、他の YNABer が承認して使用できるアプリケーションを構築したりできます。

このコネクタは、次の製品とリージョンで使用できます。

サービス	クラス	リージョン
コピロット スタジオ	Premium	次を除くすべての Power Automate リージョン :      - 米国政府 (GCC)      - 米国政府 (GCC High)      - 21Vianet が運営する China Cloud      - 米国国防総省 (DoD)
ロジック アプリ	Standard	次を除くすべての Logic Apps リージョン :      - Azure Government リージョン      - Azure China リージョン      - 米国国防総省 (DoD)
Power Apps	Premium	次を除くすべての Power Apps リージョン :      - 米国政府 (GCC)      - 米国政府 (GCC High)      - 21Vianet が運営する China Cloud      - 米国国防総省 (DoD)
Power Automate	Premium	次を除くすべての Power Automate リージョン :      - 米国政府 (GCC)      - 米国政府 (GCC High)      - 21Vianet が運営する China Cloud      - 米国国防総省 (DoD)

お問い合わせ
名前	トロイ・テイラー
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

コネクタ メタデータ
Publisher	トロイ・テイラー
Website	https://www.youneedabudget.com/
プライバシー ポリシー	https://www.youneedabudget.com/privacy-policy/
カテゴリ	ファイナンス

接続を作成する

コネクタでは、次の認証の種類がサポートされています。

デフォルト	接続を作成するためのパラメーター。	すべてのリージョン	共有不可

デフォルト

適用対象: すべてのリージョン

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

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

名前	タイプ	Description	必須
アクセス トークン ('Bearer AccessToken' の形式)	securestring	この API のアクセス トークン ('Bearer AccessToken 形式)	正しい

調整制限

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

アクション

ID でアカウントを取得する	1 つのアカウントを返します。
ID でカテゴリを取得する	1 つのカテゴリを返します。 金額 (予算、活動、残高など) は、現在の予算月 (UTC) に固有です。
ID でトランザクションを取得する	1 つのトランザクションを返します。
ID で予算を取得する	すべての関連エンティティを含む 1 つの予算を返します。 このリソースは実質的に完全な予算のエクスポートです。
ID で予算設定を取得する	予算の設定を返します
ID で支払い先の場所を取得する	単一の支払い先の場所を返します。
ID で支払い先を取得する	1 人の支払者を返します。
ID で月カテゴリを取得する	特定の予算月の 1 つのカテゴリを返します。 金額 (予算、活動、残高など) は、現在の予算月 (UTC) に固有です。
アカウントでトランザクションを取得する	指定したアカウントのすべてのトランザクションを返します。
アカウントを作成する	新しいアカウントを作成します。
アカウントを取得する	すべてのアカウントを返します。
カテゴリを取得する	カテゴリ グループ別にグループ化されたすべてのカテゴリを返します。 金額 (予算、活動、残高など) は、現在の予算月 (UTC) に固有です。
カテゴリ別にトランザクションを取得する	指定したカテゴリのすべてのトランザクションを返します。
スケジュールされたトランザクションを ID で取得する	スケジュールされた 1 つのトランザクションを返します。
スケジュールされたトランザクションを取得する	スケジュールされたすべてのトランザクションを返します。
トランザクションのインポート	特定の予算に対して、リンクされているすべてのアカウントで使用可能なトランザクションをインポートします。 リンクされたアカウントを使用すると、トランザクションを指定された金融機関から直接インポートでき、このエンドポイントはそのインポートを開始します。 このエンドポイントへの要求の送信は、Web アプリケーションの各アカウントで [インポート] をクリックするか、モバイル アプリケーションで [新しいトランザクション] バナーをタップすることと同じです。 このエンドポイントの応答には、インポートされたトランザクション ID が含まれています。
トランザクションの作成	1 つのトランザクションまたは複数のトランザクションを作成します。 transaction オブジェクトを含む本文を指定すると、1 つのトランザクションが作成され、transactions配列を含む本文を指定すると、複数のトランザクションが作成されます。 スケジュールされたトランザクションは、このエンドポイントに作成できません。
トランザクションの更新	1 つのトランザクションを更新します。
トランザクションを一括作成する	複数のトランザクションを作成します。 このエンドポイントはまだサポートされていますが、"POST /budgets/{budget_id}/transactions" を使用して複数のトランザクションを作成することをお勧めします。
トランザクションを取得する	予算トランザクションを返します。
トランザクションを更新する	idまたはimport_idによって、複数のトランザクションを更新します。
ユーザーを取得する	認証されたユーザー情報を返します。
予算を取得する	概要情報を含む予算一覧を返します。
予算月を取得する	1 つの予算月を返します。
予算月を取得する	すべての予算月を返します。
支払い先によるトランザクションの取得	指定した支払者のすべてのトランザクションを返します。
支払い先の場所を取得する	すべての支払い先の場所を返します。
支払い先別に支払い先の場所を取得する	指定した支払先のすべての支払先の場所を返します。
支払い者を取得する	すべての支払い者を返します。
月カテゴリの更新	特定の月のカテゴリを更新します。 更新できるのは budgeted 量だけです。

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

操作 ID:

GetAccountById

1 つのアカウントを返します。

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
アカウント ID	account_id	True	uuid	アカウントの識別子。

戻り値

アカウントの応答

AccountResponse

ID でカテゴリを取得する

操作 ID:

GetCategoryById

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

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
カテゴリ ID	category_id	True	string	カテゴリの識別子。

戻り値

カテゴリの応答

CategoryResponse

ID でトランザクションを取得する

操作 ID:

GetTransactionById

1 つのトランザクションを返します。

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
トランザクション ID	transaction_id	True	string	トランザクションの識別子。

戻り値

トランザクションの応答

TransactionResponse

ID で予算を取得する

操作 ID:

GetBudgetById

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

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。
サーバーの最後の知識	last_knowledge_of_server		integer	開始サーバーの知識。 指定した場合、 last_knowledge_of_server 以降に変更されたエンティティのみが含まれます。

戻り値

予算詳細応答

BudgetDetailResponse

ID で予算設定を取得する

操作 ID:

GetBudgetSettingsById

予算の設定を返します

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。

戻り値

予算設定の応答

BudgetSettingsResponse

ID で支払い先の場所を取得する

操作 ID:

GetPayeeLocationById

単一の支払い先の場所を返します。

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
支払先の場所 ID	payee_location_id	True	string	支払先の場所の識別子。

戻り値

支払先の場所の応答

PayeeLocationResponse

ID で支払い先を取得する

操作 ID:

GetPayeeById

1 人の支払者を返します。

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
支払い先 ID	payee_id	True	string	支払い先の識別子。

戻り値

支払い先の応答

PayeeResponse

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

操作 ID:

GetMonthCategoryById

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

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
月	month	True	date	ISO 形式の予算月 (例: 2016-12-01)。 ("current" を使用して、現在のカレンダー月 (UTC) を指定することもできます)
カテゴリ ID	category_id	True	string	カテゴリの識別子。

戻り値

カテゴリの応答

CategoryResponse

アカウントでトランザクションを取得する

操作 ID:

GetTransactionsByAccount

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

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
アカウント ID	account_id	True	string	アカウントの識別子。
Since Date	since_date		date	指定した場合、この日付以降のトランザクションのみが含まれます。 日付は ISO 形式にする必要があります (例: 2016-12-30)。
タイプ	type		string	指定した場合、指定した種類のトランザクションのみが含まれます。 現在、"未分類" と "未承認" がサポートされています。
サーバーの最後の知識	last_knowledge_of_server		integer	開始サーバーの知識。 指定した場合、 last_knowledge_of_server 以降に変更されたエンティティのみが含まれます。

戻り値

Transactions Response

TransactionsResponse

アカウントを作成する

操作 ID:

CreateAccount

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

パラメーター

名前	キー	必須	型	説明
予算 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	アカウントの現在の残高 (ミリ単位形式)。

戻り値

アカウントの応答

AccountResponse

アカウントを取得する

操作 ID:

GetAccounts

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

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
サーバーの最後の知識	last_knowledge_of_server		integer	開始サーバーの知識。 指定した場合、 last_knowledge_of_server 以降に変更されたエンティティのみが含まれます。

戻り値

Accounts Response

AccountsResponse

カテゴリを取得する

操作 ID:

GetCategories

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

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
サーバーの最後の知識	last_knowledge_of_server		integer	開始サーバーの知識。 指定した場合、 last_knowledge_of_server 以降に変更されたエンティティのみが含まれます。

戻り値

Categories Response

CategoriesResponse

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

操作 ID:

GetTransactionsByCategory

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

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
カテゴリ ID	category_id	True	string	カテゴリの識別子。
Since Date	since_date		date	指定した場合、この日付以降のトランザクションのみが含まれます。 日付は ISO 形式にする必要があります (例: 2016-12-30)。
タイプ	type		string	指定した場合、指定した種類のトランザクションのみが含まれます。 現在、"未分類" と "未承認" がサポートされています。
サーバーの最後の知識	last_knowledge_of_server		integer	開始サーバーの知識。 指定した場合、 last_knowledge_of_server 以降に変更されたエンティティのみが含まれます。

戻り値

ハイブリッド トランザクションの応答

HybridTransactionsResponse

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

操作 ID:

GetScheduledTransactionById

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

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
スケジュールされたトランザクション ID	scheduled_transaction_id	True	string	スケジュールされたトランザクションの識別子。

戻り値

スケジュールされたトランザクション応答

ScheduledTransactionResponse

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

操作 ID:

GetScheduledTransactions

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

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
サーバーの最後の知識	last_knowledge_of_server		integer	開始サーバーの知識。 指定した場合、 last_knowledge_of_server 以降に変更されたエンティティのみが含まれます。

戻り値

スケジュールされたトランザクションの応答

ScheduledTransactionsResponse

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

操作 ID:

ImportTransactions

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

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。

戻り値

Transactions Import Response

TransactionsImportResponse

トランザクションの作成

操作 ID:

CreateTransaction

1 つのトランザクションまたは複数のトランザクションを作成します。 transaction オブジェクトを含む本文を指定すると、1 つのトランザクションが作成され、transactions配列を含む本文を指定すると、複数のトランザクションが作成されます。 スケジュールされたトランザクションは、このエンドポイントに作成できません。

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
アカウント ID	account_id	True	string	アカウント識別子。
日付	date	True	date	ISO 形式のトランザクション日付 (例: 2016-12-01)。 将来の日付 (スケジュールされたトランザクション) は許可されません。 分割トランザクションの日付は変更できず、別の日付が指定されている場合は無視されます。
金額	amount	True	integer	ミリユニット形式のトランザクション量。 分割トランザクションの金額は変更できず、別の金額が指定されている場合は無視されます。
支払い先 ID	payee_id		uuid	トランザクションの支払者。 2 つのアカウント間で譲渡を作成するには、対象のアカウントを指すアカウント転送支払先を使用します。 口座振替の支払者は、アカウント リソースの transfer_payee_id として指定されます。
受取 人	payee_name		string	支払い先の名前。 payee_name値が指定され、payee_idに null 値がある場合、payee_name値は、(1) 一致する支払人の名前変更ルール (import_idも指定されている場合のみ) または (2) 同じ名前の支払先または (3) 新しい支払先の作成のいずれかによって、支払人を解決するために使用されます。
カテゴリ ID	category_id		uuid	トランザクションのカテゴリ。 分割トランザクションを構成するには、 category_id に null を指定し、トランザクション オブジェクトの一部として subtransactions 配列を指定します。 既存のトランザクションが分割されている場合、 category_id は変更できません。 クレジット カードの支払いカテゴリは許可されず、指定された場合は無視されます。
メモ	memo		string	メモ。
クリア	cleared		string	トランザクションのクリアされた状態。
承認済み	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 USD の取引では、"YNAB:-294230:2015-12-30:1" のimport_idが発生します。 同じアカウントの 2 つ目のトランザクションがインポートされ、同じ日付と同じ金額の場合、そのimport_idは 'YNAB:-294230:2015-12-30:2' になります。 一貫性のある形式を使用すると、直接インポートとファイル ベースのインポートによる重複を防ぐことができます。 import_idを省略するか、null として指定すると、トランザクションは "ユーザー入力" トランザクションとして扱われます。 そのため、後で (DI、FBI、または API 経由で) インポートされるトランザクションと照合される資格があります。
金額	amount	True	integer	サブトランザクションの量 (ミリユニット形式)。
支払い先 ID	payee_id		uuid	サブトランザクションの支払先。
受取 人	payee_name		string	支払い先の名前。 payee_name値が指定され、payee_idに null 値がある場合、payee_name値は、(1) 一致する支払人の名前変更ルール (親トランザクションでもimport_idが指定されている場合のみ) または (2) 同じ名前の支払先または (3) 新しい支払先の作成のいずれかによって、支払人を解決するために使用されます。
カテゴリ ID	category_id		uuid	サブトランザクションのカテゴリ。 クレジット カードの支払いカテゴリは許可されず、指定された場合は無視されます。
メモ	memo		string	メモ。
アカウント ID	account_id	True	string	アカウント識別子。
日付	date	True	date	ISO 形式のトランザクション日付 (例: 2016-12-01)。 将来の日付 (スケジュールされたトランザクション) は許可されません。 分割トランザクションの日付は変更できず、別の日付が指定されている場合は無視されます。
金額	amount	True	integer	ミリユニット形式のトランザクション量。 分割トランザクションの金額は変更できず、別の金額が指定されている場合は無視されます。
支払い先 ID	payee_id		uuid	トランザクションの支払者。 2 つのアカウント間で譲渡を作成するには、対象のアカウントを指すアカウント転送支払先を使用します。 口座振替の支払者は、アカウント リソースの transfer_payee_id として指定されます。
受取 人	payee_name		string	支払い先の名前。 payee_name値が指定され、payee_idに null 値がある場合、payee_name値は、(1) 一致する支払人の名前変更ルール (import_idも指定されている場合のみ) または (2) 同じ名前の支払先または (3) 新しい支払先の作成のいずれかによって、支払人を解決するために使用されます。
カテゴリ ID	category_id		uuid	トランザクションのカテゴリ。 分割トランザクションを構成するには、 category_id に null を指定し、トランザクション オブジェクトの一部として subtransactions 配列を指定します。 既存のトランザクションが分割されている場合、 category_id は変更できません。 クレジット カードの支払いカテゴリは許可されず、指定された場合は無視されます。
メモ	memo		string	メモ。
クリア	cleared		string	トランザクションのクリアされた状態。
承認済み	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 USD の取引では、"YNAB:-294230:2015-12-30:1" のimport_idが発生します。 同じアカウントの 2 つ目のトランザクションがインポートされ、同じ日付と同じ金額の場合、そのimport_idは 'YNAB:-294230:2015-12-30:2' になります。 一貫性のある形式を使用すると、直接インポートとファイル ベースのインポートによる重複を防ぐことができます。 import_idを省略するか、null として指定すると、トランザクションは "ユーザー入力" トランザクションとして扱われます。 そのため、後で (DI、FBI、または API 経由で) インポートされるトランザクションと照合される資格があります。
金額	amount	True	integer	サブトランザクションの量 (ミリユニット形式)。
支払い先 ID	payee_id		uuid	サブトランザクションの支払先。
受取 人	payee_name		string	支払い先の名前。 payee_name値が指定され、payee_idに null 値がある場合、payee_name値は、(1) 一致する支払人の名前変更ルール (親トランザクションでもimport_idが指定されている場合のみ) または (2) 同じ名前の支払先または (3) 新しい支払先の作成のいずれかによって、支払人を解決するために使用されます。
カテゴリ ID	category_id		uuid	サブトランザクションのカテゴリ。 クレジット カードの支払いカテゴリは許可されず、指定された場合は無視されます。
メモ	memo		string	メモ。

戻り値

トランザクションの保存応答

SaveTransactionsResponse

トランザクションの更新

操作 ID:

UpdateTransaction

1 つのトランザクションを更新します。

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
トランザクション ID	transaction_id	True	string	トランザクションの識別子。
アカウント ID	account_id	True	string	アカウント識別子。
日付	date	True	date	ISO 形式のトランザクション日付 (例: 2016-12-01)。 将来の日付 (スケジュールされたトランザクション) は許可されません。 分割トランザクションの日付は変更できず、別の日付が指定されている場合は無視されます。
金額	amount	True	integer	ミリユニット形式のトランザクション量。 分割トランザクションの金額は変更できず、別の金額が指定されている場合は無視されます。
支払い先 ID	payee_id		uuid	トランザクションの支払者。 2 つのアカウント間で譲渡を作成するには、対象のアカウントを指すアカウント転送支払先を使用します。 口座振替の支払者は、アカウント リソースの transfer_payee_id として指定されます。
受取 人	payee_name		string	支払い先の名前。 payee_name値が指定され、payee_idに null 値がある場合、payee_name値は、(1) 一致する支払人の名前変更ルール (import_idも指定されている場合のみ) または (2) 同じ名前の支払先または (3) 新しい支払先の作成のいずれかによって、支払人を解決するために使用されます。
カテゴリ ID	category_id		uuid	トランザクションのカテゴリ。 分割トランザクションを構成するには、 category_id に null を指定し、トランザクション オブジェクトの一部として subtransactions 配列を指定します。 既存のトランザクションが分割されている場合、 category_id は変更できません。 クレジット カードの支払いカテゴリは許可されず、指定された場合は無視されます。
メモ	memo		string	メモ。
クリア	cleared		string	トランザクションのクリアされた状態。
承認済み	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 USD の取引では、"YNAB:-294230:2015-12-30:1" のimport_idが発生します。 同じアカウントの 2 つ目のトランザクションがインポートされ、同じ日付と同じ金額の場合、そのimport_idは 'YNAB:-294230:2015-12-30:2' になります。 一貫性のある形式を使用すると、直接インポートとファイル ベースのインポートによる重複を防ぐことができます。 import_idを省略するか、null として指定すると、トランザクションは "ユーザー入力" トランザクションとして扱われます。 そのため、後で (DI、FBI、または API 経由で) インポートされるトランザクションと照合される資格があります。
金額	amount	True	integer	サブトランザクションの量 (ミリユニット形式)。
支払い先 ID	payee_id		uuid	サブトランザクションの支払先。
受取 人	payee_name		string	支払い先の名前。 payee_name値が指定され、payee_idに null 値がある場合、payee_name値は、(1) 一致する支払人の名前変更ルール (親トランザクションでもimport_idが指定されている場合のみ) または (2) 同じ名前の支払先または (3) 新しい支払先の作成のいずれかによって、支払人を解決するために使用されます。
カテゴリ ID	category_id		uuid	サブトランザクションのカテゴリ。 クレジット カードの支払いカテゴリは許可されず、指定された場合は無視されます。
メモ	memo		string	メモ。

戻り値

トランザクションの応答

TransactionResponse

トランザクションを一括作成する

操作 ID:

BulkCreateTransactions

複数のトランザクションを作成します。 このエンドポイントはまだサポートされていますが、"POST /budgets/{budget_id}/transactions" を使用して複数のトランザクションを作成することをお勧めします。

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
アカウント ID	account_id	True	string	アカウント識別子。
日付	date	True	date	ISO 形式のトランザクション日付 (例: 2016-12-01)。 将来の日付 (スケジュールされたトランザクション) は許可されません。 分割トランザクションの日付は変更できず、別の日付が指定されている場合は無視されます。
金額	amount	True	integer	ミリユニット形式のトランザクション量。 分割トランザクションの金額は変更できず、別の金額が指定されている場合は無視されます。
支払い先 ID	payee_id		uuid	トランザクションの支払者。 2 つのアカウント間で譲渡を作成するには、対象のアカウントを指すアカウント転送支払先を使用します。 口座振替の支払者は、アカウント リソースの transfer_payee_id として指定されます。
受取 人	payee_name		string	支払い先の名前。 payee_name値が指定され、payee_idに null 値がある場合、payee_name値は、(1) 一致する支払人の名前変更ルール (import_idも指定されている場合のみ) または (2) 同じ名前の支払先または (3) 新しい支払先の作成のいずれかによって、支払人を解決するために使用されます。
カテゴリ ID	category_id		uuid	トランザクションのカテゴリ。 分割トランザクションを構成するには、 category_id に null を指定し、トランザクション オブジェクトの一部として subtransactions 配列を指定します。 既存のトランザクションが分割されている場合、 category_id は変更できません。 クレジット カードの支払いカテゴリは許可されず、指定された場合は無視されます。
メモ	memo		string	メモ。
クリア	cleared		string	トランザクションのクリアされた状態。
承認済み	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 USD の取引では、"YNAB:-294230:2015-12-30:1" のimport_idが発生します。 同じアカウントの 2 つ目のトランザクションがインポートされ、同じ日付と同じ金額の場合、そのimport_idは 'YNAB:-294230:2015-12-30:2' になります。 一貫性のある形式を使用すると、直接インポートとファイル ベースのインポートによる重複を防ぐことができます。 import_idを省略するか、null として指定すると、トランザクションは "ユーザー入力" トランザクションとして扱われます。 そのため、後で (DI、FBI、または API 経由で) インポートされるトランザクションと照合される資格があります。
金額	amount	True	integer	サブトランザクションの量 (ミリユニット形式)。
支払い先 ID	payee_id		uuid	サブトランザクションの支払先。
受取 人	payee_name		string	支払い先の名前。 payee_name値が指定され、payee_idに null 値がある場合、payee_name値は、(1) 一致する支払人の名前変更ルール (親トランザクションでもimport_idが指定されている場合のみ) または (2) 同じ名前の支払先または (3) 新しい支払先の作成のいずれかによって、支払人を解決するために使用されます。
カテゴリ ID	category_id		uuid	サブトランザクションのカテゴリ。 クレジット カードの支払いカテゴリは許可されず、指定された場合は無視されます。
メモ	memo		string	メモ。

戻り値

一括応答

BulkResponse

トランザクションを取得する

操作 ID:

GetTransactions

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

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "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		integer	開始サーバーの知識。 指定した場合、 last_knowledge_of_server 以降に変更されたエンティティのみが含まれます。

戻り値

Transactions Response

TransactionsResponse

トランザクションを更新する

操作 ID:

UpdateTransactions

idまたはimport_idによって、複数のトランザクションを更新します。

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
ID	id	True	string	識別子。
アカウント ID	account_id	True	string	アカウント識別子。
日付	date	True	date	ISO 形式のトランザクション日付 (例: 2016-12-01)。 将来の日付 (スケジュールされたトランザクション) は許可されません。 分割トランザクションの日付は変更できず、別の日付が指定されている場合は無視されます。
金額	amount	True	integer	ミリユニット形式のトランザクション量。 分割トランザクションの金額は変更できず、別の金額が指定されている場合は無視されます。
支払い先 ID	payee_id		uuid	トランザクションの支払者。 2 つのアカウント間で譲渡を作成するには、対象のアカウントを指すアカウント転送支払先を使用します。 口座振替の支払者は、アカウント リソースの transfer_payee_id として指定されます。
受取 人	payee_name		string	支払い先の名前。 payee_name値が指定され、payee_idに null 値がある場合、payee_name値は、(1) 一致する支払人の名前変更ルール (import_idも指定されている場合のみ) または (2) 同じ名前の支払先または (3) 新しい支払先の作成のいずれかによって、支払人を解決するために使用されます。
カテゴリ ID	category_id		uuid	トランザクションのカテゴリ。 分割トランザクションを構成するには、 category_id に null を指定し、トランザクション オブジェクトの一部として subtransactions 配列を指定します。 既存のトランザクションが分割されている場合、 category_id は変更できません。 クレジット カードの支払いカテゴリは許可されず、指定された場合は無視されます。
メモ	memo		string	メモ。
クリア	cleared		string	トランザクションのクリアされた状態。
承認済み	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 USD の取引では、"YNAB:-294230:2015-12-30:1" のimport_idが発生します。 同じアカウントの 2 つ目のトランザクションがインポートされ、同じ日付と同じ金額の場合、そのimport_idは 'YNAB:-294230:2015-12-30:2' になります。 一貫性のある形式を使用すると、直接インポートとファイル ベースのインポートによる重複を防ぐことができます。 import_idを省略するか、null として指定すると、トランザクションは "ユーザー入力" トランザクションとして扱われます。 そのため、後で (DI、FBI、または API 経由で) インポートされるトランザクションと照合される資格があります。
金額	amount	True	integer	サブトランザクションの量 (ミリユニット形式)。
支払い先 ID	payee_id		uuid	サブトランザクションの支払先。
受取 人	payee_name		string	支払い先の名前。 payee_name値が指定され、payee_idに null 値がある場合、payee_name値は、(1) 一致する支払人の名前変更ルール (親トランザクションでもimport_idが指定されている場合のみ) または (2) 同じ名前の支払先または (3) 新しい支払先の作成のいずれかによって、支払人を解決するために使用されます。
カテゴリ ID	category_id		uuid	サブトランザクションのカテゴリ。 クレジット カードの支払いカテゴリは許可されず、指定された場合は無視されます。
メモ	memo		string	メモ。

戻り値

トランザクションの保存応答

SaveTransactionsResponse

ユーザーを取得する

操作 ID:

GetUser

認証されたユーザー情報を返します。

戻り値

ユーザー応答

UserResponse

予算を取得する

操作 ID:

GetBudgets

概要情報を含む予算一覧を返します。

パラメーター

名前	キー	必須	型	説明
アカウントを含める	include_accounts		boolean	予算勘定の一覧を含めるかどうか。

戻り値

予算の概要の応答

BudgetSummaryResponse

予算月を取得する

操作 ID:

GetBudgetMonth

1 つの予算月を返します。

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
月	month	True	date	ISO 形式の予算月 (例: 2016-12-01)。 ("current" を使用して、現在のカレンダー月 (UTC) を指定することもできます)

戻り値

月の詳細応答

MonthDetailResponse

予算月を取得する

操作 ID:

GetBudgetMonths

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

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
サーバーの最後の知識	last_knowledge_of_server		integer	開始サーバーの知識。 指定した場合、 last_knowledge_of_server 以降に変更されたエンティティのみが含まれます。

戻り値

月の概要の応答

MonthSummariesResponse

支払い先によるトランザクションの取得

操作 ID:

GetTransactionsByPayee

指定した支払者のすべてのトランザクションを返します。

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
支払い先 ID	payee_id	True	string	支払い先の識別子。
Since Date	since_date		date	指定した場合、この日付以降のトランザクションのみが含まれます。 日付は ISO 形式にする必要があります (例: 2016-12-30)。
タイプ	type		string	指定した場合、指定した種類のトランザクションのみが含まれます。 現在、"未分類" と "未承認" がサポートされています。
サーバーの最後の知識	last_knowledge_of_server		integer	開始サーバーの知識。 指定した場合、 last_knowledge_of_server 以降に変更されたエンティティのみが含まれます。

戻り値

ハイブリッド トランザクションの応答

HybridTransactionsResponse

支払い先の場所を取得する

操作 ID:

GetPayeeLocations

すべての支払い先の場所を返します。

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。

戻り値

支払い先の場所の応答

PayeeLocationsResponse

支払い先別に支払い先の場所を取得する

操作 ID:

GetPayeeLocationsByPayee

指定した支払先のすべての支払先の場所を返します。

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
支払い先 ID	payee_id	True	string	支払い先の識別子。

戻り値

支払い先の場所の応答

PayeeLocationsResponse

支払い者を取得する

操作 ID:

GetPayees

すべての支払い者を返します。

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
サーバーの最後の知識	last_knowledge_of_server		integer	開始サーバーの知識。 指定した場合、 last_knowledge_of_server 以降に変更されたエンティティのみが含まれます。

戻り値

Payees Response

PayeesResponse

月カテゴリの更新

操作 ID:

UpdateMonthCategory

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

パラメーター

名前	キー	必須	型	説明
予算 ID	budget_id	True	string	予算の識別子。 "last-used" を使用して最後に使用した予算を指定し、既定の予算選択が有効になっている場合は "default" を使用できます (「 https://api.youneedabudget.com/#oauth-default-budget」を参照)。
月	month	True	date	ISO 形式の予算月 (例: 2016-12-01)。 ("current" を使用して、現在のカレンダー月 (UTC) を指定することもできます)
カテゴリ ID	category_id	True	string	カテゴリの識別子。
予算	budgeted	True	integer	予算金額 (ミリ単位形式)。

戻り値

[Save Category Response]\(カテゴリの保存\

SaveCategoryResponse

定義

UserResponse

名前	パス	型	説明
データ	data	Data

User

名前	パス	型	説明
ID	id	string	識別子。

DateFormat

予算の日付形式の設定。 場合によっては、形式が使用できなく、null として指定されます。

名前	パス	型	説明
Format	format	string	形式。

CurrencyFormat

予算の通貨書式の設定。 場合によっては、形式が使用できなく、null として指定されます。

名前	パス	型	説明
ISO コード	iso_code	string	ISO コード。
書式の例	example_format	string	形式の例。
10 進数字	decimal_digits	integer	10 進数。
小数点区切り記号	decimal_separator	string	小数点区切り記号。
最初の記号	symbol_first	boolean	シンボルが最初かどうか。
グループ区切り記号	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	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	date	最も早い予算月。
先月	last_month	date	最新の予算月。
日付形式	date_format	DateFormat	予算の日付形式の設定。 場合によっては、形式が使用できなく、null として指定されます。
通貨形式	currency_format	CurrencyFormat	予算の通貨書式の設定。 場合によっては、形式が使用できなく、null として指定されます。
Accounts	accounts	array of Account	予算勘定 (クエリ パラメーターとして指定 include_accounts=true 場合にのみ含まれます)。
受取 人	payees	array of Payee
支払い先の場所	payee_locations	array of PayeeLocation
カテゴリ グループ	category_groups	array of CategoryGroup
カテゴリ	categories	array of Category
月	months	array of MonthDetail
Transactions	transactions	array of TransactionSummary
サブトランザクション	subtransactions	array of SubTransaction
スケジュールされたトランザクション	scheduled_transactions	array of ScheduledTransactionSummary
スケジュールされたサブトランザクション	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

Account

名前	パス	型	説明
ID	id	string	識別子。
名前	name	string	名前。
タイプ	type	Type	アカウントの種類。 注: PayPal、merchantAccount、investmentAccount、および住宅ローンの種類は非推奨となり、今後削除される予定です。
予算内	on_budget	boolean	このアカウントが予算内にあるかどうか
クローズド	closed	boolean	このアカウントが閉じているかどうか
注	note	string	メモ。
残高	balance	integer	アカウントの現在の残高 (ミリ単位形式)。
未消込残高	cleared_balance	integer	アカウントの現在のクリアされた残高 (ミリ単位形式)。
不明確な残高	uncleared_balance	integer	アカウントの現在の不明確な残高 (ミリユニット形式)。
譲渡先 ID	transfer_payee_id	string	このアカウントに転送するときに使用する支払先識別子。
リンクされた直接インポート	direct_import_linked	boolean	自動取引インポートのために口座が金融機関にリンクされているかどうか。
エラーが発生した直接インポート	direct_import_in_error	boolean	金融機関にリンクされているアカウント (direct_import_linked=true) で、リンクされた接続が正常な状態でない場合、これは true になります。
削除	deleted	boolean	アカウントが削除されているかどうか。 削除されたアカウントは差分要求にのみ含まれます。

CategoriesResponse

名前	パス	型	説明
Data6	data	Data6

CategoryResponse

名前	パス	型	説明
Data7	data	Data7

CategoryGroupWithCategories

名前	パス	型	説明
ID	id	string	識別子。
名前	name	string	名前。
隠れた	hidden	boolean	カテゴリ グループが非表示かどうか。
削除	deleted	boolean	カテゴリ グループが削除されているかどうか。 削除されたカテゴリ グループは、差分要求にのみ含まれます。
カテゴリ	categories	array of Category	カテゴリ グループのカテゴリ。 金額 (予算、活動、残高など) は、現在の予算月 (UTC) に固有です。

CategoryGroup

名前	パス	型	説明
ID	id	string	識別子。
名前	name	string	名前。
隠れた	hidden	boolean	カテゴリ グループが非表示かどうか。
削除	deleted	boolean	カテゴリ グループが削除されているかどうか。 削除されたカテゴリ グループは、差分要求にのみ含まれます。

カテゴリ

名前	パス	型	説明
ID	id	string	識別子。
カテゴリ グループ ID	category_group_id	string	カテゴリ グループ識別子。
名前	name	string	名前。
隠れた	hidden	boolean	カテゴリが非表示かどうか。
元のカテゴリ グループ ID	original_category_group_id	uuid	カテゴリが非表示の場合、これは、非表示になる前に最初に属していたカテゴリ グループの識別子です。
注	note	string	メモ。
予算	budgeted	integer	予算金額 (ミリ単位形式)。
Activity	activity	integer	アクティビティの量 (ミリユニット形式)。
残高	balance	integer	ミリ単位形式のバランス。
目標の種類	goal_type	GoalType	カテゴリに目標がある場合の目標の種類 (TB='Target Category Balance'、TBD='Target Category Balance by Date'、MF='Monthly Funding'、NEED='Plan Your Spending')
ゴール作成月	goal_creation_month	date	目標が作成された月。
目標ターゲット	goal_target	integer	目標目標量 (ミリ単位)。
目標目標月	goal_target_month	date	目標が完了する元の目標月。 この日付を指定するのは、一部の目標の種類のみです。
目標達成率	goal_percentage_complete	integer	目標の達成率。
目標の月から予算へ	goal_months_to_budget	integer	現在の目標期間に残された月数 (当月を含む)。
資金の下の目標	goal_under_funded	integer	現在の目標期間内に目標を達成するために、現在の月に必要な資金の量。 この金額は、通常、将来の月に [支出目標に必要] のカテゴリを表示する場合を除き、Web クライアントとモバイル クライアントの "不足している" 金額に対応します。 Web クライアントとモバイル クライアントは、今後 1 か月の支出目標に必要なカテゴリを表示するときに、前の目標期間からの資金を無視します。
目標の全体的な資金	goal_overall_funded	integer	現在の目標期間内に目標に向けて資金を調達した合計金額。
ゴール全体左	goal_overall_left	integer	現在の目標期間内に目標を達成するために必要な資金の量。
削除	deleted	boolean	カテゴリが削除されているかどうか。 削除されたカテゴリは、差分要求にのみ含まれます。

SaveCategoryResponse

名前	パス	型	説明
Data8	data	Data8

PayeesResponse

名前	パス	型	説明
Data9	data	Data9

PayeeResponse

名前	パス	型	説明
Data10	data	Data10

受取 人

名前	パス	型	説明
ID	id	string	識別子。
名前	name	string	名前。
アカウント ID の譲渡	transfer_account_id	string	譲渡先の場合、この支払人の転送先となる account_id 。
削除	deleted	boolean	支払者が削除されたかどうか。 削除された支払い者は差分要求にのみ含まれます。

PayeeLocationsResponse

名前	パス	型	説明
Data11	data	Data11

PayeeLocationResponse

名前	パス	型	説明
Data12	data	Data12

PayeeLocation

名前	パス	型	説明
ID	id	string	識別子。
支払い先 ID	payee_id	string	支払い先識別子。
緯度	latitude	string	緯度。
緯度	longitude	string	経度。
削除	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 形式のトランザクション日付 (例: 2016-12-01)。
金額	amount	integer	ミリユニット形式のトランザクション量。
メモ	memo	string	メモ。
クリア	cleared	Cleared	トランザクションのクリアされた状態。
承認済み	approved	boolean	トランザクションが承認されているかどうか。
フラグの色	flag_color	FlagColor	トランザクション フラグ。
アカウント ID	account_id	string	アカウント識別子。
支払い先 ID	payee_id	string	支払い先識別子。
カテゴリ ID	category_id	string	カテゴリ識別子。
アカウント ID の譲渡	transfer_account_id	uuid	転送トランザクションの場合、転送先のアカウント。
トランザクション ID の転送	transfer_transaction_id	string	転送トランザクションの場合、転送の反対側のトランザクションの識別子。
一致したトランザクション ID	matched_transaction_id	string	トランザクションが一致する場合は、一致したトランザクションの識別子。
インポート ID	import_id	string	トランザクションがインポートされた場合、このフィールドは一意の (アカウント別) インポート識別子です。 このトランザクションがファイル ベースのインポートまたは直接インポートによってインポートされ、API を介してインポートされた場合、import_idの形式は 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]' になります。 たとえば、2015 年 12 月 30 日の -$294.23 USD の取引では、"YNAB:-294230:2015-12-30:1" のimport_idが発生します。 同じアカウントの 2 つ目のトランザクションがインポートされ、同じ日付と同じ金額の場合、そのimport_idは 'YNAB:-294230:2015-12-30:2' になります。
削除	deleted	boolean	トランザクションが削除されたかどうか。 削除されたトランザクションは、差分要求にのみ含まれます。

TransactionDetail

名前	パス	型	説明
ID	id	string	識別子。
日付	date	date	ISO 形式のトランザクション日付 (例: 2016-12-01)。
金額	amount	integer	ミリユニット形式のトランザクション量。
メモ	memo	string	メモ。
クリア	cleared	Cleared	トランザクションのクリアされた状態。
承認済み	approved	boolean	トランザクションが承認されているかどうか。
フラグの色	flag_color	FlagColor	トランザクション フラグ。
アカウント ID	account_id	string	アカウント識別子。
支払い先 ID	payee_id	string	支払い先識別子。
カテゴリ ID	category_id	string	カテゴリ識別子。
アカウント ID の譲渡	transfer_account_id	uuid	転送トランザクションの場合、転送先のアカウント。
トランザクション ID の転送	transfer_transaction_id	string	転送トランザクションの場合、転送の反対側のトランザクションの識別子。
一致したトランザクション ID	matched_transaction_id	string	トランザクションが一致する場合は、一致したトランザクションの識別子。
インポート ID	import_id	string	トランザクションがインポートされた場合、このフィールドは一意の (アカウント別) インポート識別子です。 このトランザクションがファイル ベースのインポートまたは直接インポートによってインポートされ、API を介してインポートされた場合、import_idの形式は 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]' になります。 たとえば、2015 年 12 月 30 日の -$294.23 USD の取引では、"YNAB:-294230:2015-12-30:1" のimport_idが発生します。 同じアカウントの 2 つ目のトランザクションがインポートされ、同じ日付と同じ金額の場合、そのimport_idは 'YNAB:-294230:2015-12-30:2' になります。
削除	deleted	boolean	トランザクションが削除されたかどうか。 削除されたトランザクションは、差分要求にのみ含まれます。
アカウント名	account_name	string	アカウント名。
受取 人	payee_name	string	支払い先の名前。
カテゴリ	category_name	string	カテゴリ名。
サブトランザクション	subtransactions	array of SubTransaction	分割トランザクションの場合、サブトランザクション。

HybridTransaction

名前	パス	型	説明
ID	id	string	識別子。
日付	date	date	ISO 形式のトランザクション日付 (例: 2016-12-01)。
金額	amount	integer	ミリユニット形式のトランザクション量。
メモ	memo	string	メモ。
クリア	cleared	Cleared	トランザクションのクリアされた状態。
承認済み	approved	boolean	トランザクションが承認されているかどうか。
フラグの色	flag_color	FlagColor	トランザクション フラグ。
アカウント ID	account_id	string	アカウント識別子。
支払い先 ID	payee_id	string	支払い先識別子。
カテゴリ ID	category_id	string	カテゴリ識別子。
アカウント ID の譲渡	transfer_account_id	uuid	転送トランザクションの場合、転送先のアカウント。
トランザクション ID の転送	transfer_transaction_id	string	転送トランザクションの場合、転送の反対側のトランザクションの識別子。
一致したトランザクション ID	matched_transaction_id	string	トランザクションが一致する場合は、一致したトランザクションの識別子。
インポート ID	import_id	string	トランザクションがインポートされた場合、このフィールドは一意の (アカウント別) インポート識別子です。 このトランザクションがファイル ベースのインポートまたは直接インポートによってインポートされ、API を介してインポートされた場合、import_idの形式は 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]' になります。 たとえば、2015 年 12 月 30 日の -$294.23 USD の取引では、"YNAB:-294230:2015-12-30:1" のimport_idが発生します。 同じアカウントの 2 つ目のトランザクションがインポートされ、同じ日付と同じ金額の場合、そのimport_idは 'YNAB:-294230:2015-12-30:2' になります。
削除	deleted	boolean	トランザクションが削除されたかどうか。 削除されたトランザクションは、差分要求にのみ含まれます。
Type3	type	Type3	ハイブリッド トランザクションが通常のトランザクションとサブトランザクションのどちらを表すか
親トランザクション 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	識別子。
トランザクション ID	transaction_id	string	トランザクション。
金額	amount	integer	サブトランザクションの量 (ミリユニット形式)。
メモ	memo	string	メモ。
支払い先 ID	payee_id	string	支払い先識別子。
受取 人	payee_name	string	支払い先の名前。
カテゴリ ID	category_id	string	カテゴリ識別子。
カテゴリ	category_name	string	カテゴリ名。
アカウント ID の譲渡	transfer_account_id	uuid	転送の場合、サブトランザクションの転送先となるaccount_id。
トランザクション ID の転送	transfer_transaction_id	string	転送の場合、転送の反対側のトランザクションの識別子。
削除	deleted	boolean	サブトランザクションが削除されたかどうか。 削除されたサブトランザクションは、デルタ要求にのみ含まれます。

ScheduledTransactionsResponse

名前	パス	型	説明
Data19	data	Data19

ScheduledTransactionResponse

名前	パス	型	説明
Data20	data	Data20

ScheduledTransactionSummary

名前	パス	型	説明
ID	id	string	識別子。
最初の日付	date_first	date	スケジュールされたトランザクションがスケジュールされた最初の日付。
次の日付	date_next	date	スケジュールされたトランザクションがスケジュールされている次の日付。
頻度	frequency	Frequency	頻度。
金額	amount	integer	ミリユニット形式のスケジュールされたトランザクション量。
メモ	memo	string	メモ。
FlagColor1	flag_color	FlagColor1	スケジュールされたトランザクション フラグ。
アカウント ID	account_id	string	アカウント識別子。
支払い先 ID	payee_id	string	支払い先識別子。
カテゴリ ID	category_id	string	カテゴリ識別子。
アカウント ID の譲渡	transfer_account_id	uuid	転送の場合、スケジュールされたトランザクションの転送先となるaccount_id。
削除	deleted	boolean	スケジュールされたトランザクションが削除されたかどうか。 削除されたスケジュールされたトランザクションは、差分要求にのみ含まれます。

ScheduledTransactionDetail

名前	パス	型	説明
ID	id	string	識別子。
最初の日付	date_first	date	スケジュールされたトランザクションがスケジュールされた最初の日付。
次の日付	date_next	date	スケジュールされたトランザクションがスケジュールされている次の日付。
頻度	frequency	Frequency	頻度。
金額	amount	integer	ミリユニット形式のスケジュールされたトランザクション量。
メモ	memo	string	メモ。
FlagColor1	flag_color	FlagColor1	スケジュールされたトランザクション フラグ。
アカウント ID	account_id	string	アカウント識別子。
支払い先 ID	payee_id	string	支払い先識別子。
カテゴリ ID	category_id	string	カテゴリ識別子。
アカウント ID の譲渡	transfer_account_id	uuid	転送の場合、スケジュールされたトランザクションの転送先となるaccount_id。
削除	deleted	boolean	スケジュールされたトランザクションが削除されたかどうか。 削除されたスケジュールされたトランザクションは、差分要求にのみ含まれます。
アカウント名	account_name	string	アカウント名。
受取 人	payee_name	string	支払い先の名前。
カテゴリ	category_name	string	カテゴリ名。
subtransactions	subtransactions	array of ScheduledSubTransaction	分割スケジュールされたトランザクションの場合、サブトランザクション。

ScheduledSubTransaction

名前	パス	型	説明
ID	id	string	識別子。
スケジュールされたトランザクション ID	scheduled_transaction_id	string	スケジュールされたトランザクション識別子。
金額	amount	integer	スケジュールされたサブトランザクションの量 (ミリユニット形式)。
メモ	memo	string	メモ。
支払い先 ID	payee_id	string	支払い先識別子。
カテゴリ ID	category_id	string	カテゴリ識別子。
アカウント ID の譲渡	transfer_account_id	uuid	転送の場合、スケジュールされたサブトランザクションの転送先となるaccount_id。
削除	deleted	boolean	スケジュールされたサブトランザクションが削除されたかどうか。 削除されたスケジュールされたサブトランザクションは、デルタ要求にのみ含まれます。

MonthSummariesResponse

名前	パス	型	説明
Data21	data	Data21

MonthDetailResponse

名前	パス	型	説明
Data22	data	Data22

MonthSummary

名前	パス	型	説明
月	month	date	月。
注	note	string	メモ。
収入	income	integer	1 か月の "インフロー: 割り当て準備完了" に分類されたトランザクションの合計量。
予算	budgeted	integer	月に予算が設定された合計金額。
Activity	activity	integer	"インフロー: 割り当て準備完了" に分類されたトランザクションを除く、月のトランザクションの合計量。
予算を設定する	to_be_budgeted	integer	[割り当て準備完了] に使用できる金額。
お金の年齢	age_of_money	integer	月の時点のお金の年齢。
削除	deleted	boolean	月が削除されたかどうか。 削除された月は、差分要求にのみ含まれます。

MonthDetail

名前	パス	型	説明
月	month	date	月。
注	note	string	メモ。
収入	income	integer	1 か月の "インフロー: 割り当て準備完了" に分類されたトランザクションの合計量。
予算	budgeted	integer	月に予算が設定された合計金額。
Activity	activity	integer	"インフロー: 割り当て準備完了" に分類されたトランザクションを除く、月のトランザクションの合計量。
予算を設定する	to_be_budgeted	integer	[割り当て準備完了] に使用できる金額。
お金の年齢	age_of_money	integer	月の時点のお金の年齢。
削除	deleted	boolean	月が削除されたかどうか。 削除された月は、差分要求にのみ含まれます。
カテゴリ	categories	array of Category	予算月のカテゴリ。 金額 (予算、アクティビティ、残高など) は、指定された {month} パラメーターに固有です。

バルク

名前	パス	型	説明
トランザクション ID	transaction_ids	array of string	作成されたトランザクション ID の一覧。
インポート ID の重複	duplicate_import_ids	array of string	既に同じアカウント上のトランザクションに一致する import_id があるためにトランザクションが作成されなかった場合、指定したimport_idがこの一覧に含まれます。

クリア

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

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

クリア

string

データ

名前	パス	型	説明
User	user	User

Data1

名前	パス	型	説明
予算	budgets	array of BudgetSummary
予算の概要	default_budget	BudgetSummary

Data2

名前	パス	型	説明
予算の詳細	budget	BudgetDetail
サーバーの知識	server_knowledge	integer	サーバーの知識。

Data3

名前	パス	型	説明
予算の設定	settings	BudgetSettings

Data4

名前	パス	型	説明
Accounts	accounts	array of Account
サーバーの知識	server_knowledge	integer	サーバーの知識。

Data5

名前	パス	型	説明
Account	account	Account

Data6

名前	パス	型	説明
カテゴリ グループ	category_groups	array of CategoryGroupWithCategories	カテゴリ グループ。
サーバーの知識	server_knowledge	integer	サーバーの知識。

Data7

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

Data8

名前	パス	型	説明
カテゴリ	category	Category
サーバーの知識	server_knowledge	integer	サーバーの知識。

Data9

名前	パス	型	説明
受取 人	payees	array of Payee	支払者。
サーバーの知識	server_knowledge	integer	サーバーの知識。

Data10

名前	パス	型	説明
受取 人	payee	Payee

Data11

名前	パス	型	説明
支払い先の場所	payee_locations	array of PayeeLocation	支払い先の場所。

Data12

名前	パス	型	説明
支払い先の場所	payee_location	PayeeLocation

Data13

名前	パス	型	説明
Transactions	transactions	array of TransactionDetail	トランザクション。
サーバーの知識	server_knowledge	integer	サーバーの知識。

Data14

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

Data15

名前	パス	型	説明
トランザクション ID	transaction_ids	array of string	保存されたトランザクション ID。
トランザクションの詳細	transaction	TransactionDetail
トランザクション	transactions	array of TransactionDetail	複数のトランザクションが指定された場合、保存されたトランザクション。
インポート ID の重複	duplicate_import_ids	array of string	複数のトランザクションが指定された場合、同じアカウントで既存の import_id が見つかったために作成されなかったimport_idsの一覧。
サーバーの知識	server_knowledge	integer	サーバーの知識。

Data16

名前	パス	型	説明
トランザクションの詳細	transaction	TransactionDetail

Data17

名前	パス	型	説明
トランザクション ID	transaction_ids	array of string	インポートされたトランザクション ID の一覧。

Data18

名前	パス	型	説明
バルク	bulk	Bulk

Data19

名前	パス	型	説明
scheduled_transactions	scheduled_transactions	array of ScheduledTransactionDetail
サーバーの知識	server_knowledge	integer	サーバーの知識。

Data20

名前	パス	型	説明
スケジュールされたトランザクションの詳細	scheduled_transaction	ScheduledTransactionDetail

Data21

名前	パス	型	説明
月	months	array of MonthSummary
サーバーの知識	server_knowledge	integer	サーバーの知識。

Data22

名前	パス	型	説明
月の詳細	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')

目標の種類

string

タイプ

アカウントの種類。 注: PayPal、merchantAccount、investmentAccount、および住宅ローンの種類は非推奨となり、今後削除される予定です。

アカウントの種類。 注: PayPal、merchantAccount、investmentAccount、および住宅ローンの種類は非推奨となり、今後削除される予定です。

タイプ

string

Type3

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

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

Type3

string