共用方式為

你需要預算（獨立出版商）

You Need A Budget （YNAB） 允許您構建個人應用程序以與您自己的預算交互，或構建任何其他 YNABer 都可以授權和使用的應用程序。

此連接器適用於以下產品和區域：

服務 Class Regions
副駕駛工作室 進階 除下列區域外的所有 Power Automate 區域 ：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
邏輯應用程式 標準 所有 Logic Apps 區域， 但下列區域除外：
     - Azure Government 區域
     - Azure 中國區域
     - 美國國防部 （DoD）
Power Apps 進階 除下列區域外的所有 Power Apps 區域 ：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
Power Automate（自動化服務） 進階 除下列區域外的所有 Power Automate 區域 ：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
連絡人​​
名稱 特洛伊·泰勒
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
連接器中繼資料
Publisher 特洛伊·泰勒
網站 https://www.youneedabudget.com/
隱私策略 https://www.youneedabudget.com/privacy-policy/
類別 金融

正在建立連線

連接器支援下列驗證類型：
預設值 建立連線的參數。 所有區域 不可共享

預設

適用：所有地區

建立連線的參數。

這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。

名稱 類型 Description 為必填項目
存取權杖 （以「持有人存取權杖」的形式） securestring 此 API 的存取權杖 （格式為「持有人 AccessToken） 」 對

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 100 60 秒

動作

依 ID 取得月份類別

傳回特定預算月份的單一類別。 金額（預算、活動、餘額等）特定於當前預算月 （UTC）。
依 ID 取得預算設定

傳回預算的設定
依類別取得交易

傳回指定類別的所有交易。
匯入交易

匯入指定預算內所有連結帳戶上的可用交易。 連結帳戶允許直接從指定的金融機構匯入交易，而此端點會啟動該匯入。 向此端點發送請求相當於在 Web 應用程序中的每個帳戶上單擊“導入”或點擊移動應用程序中的“新交易”橫幅。 此端點的回應包含已匯入的交易 ID。
取得交易

傳回預算交易。
取得使用者

傳回已驗證的使用者資訊。
取得帳戶

傳回所有帳戶。
取得排程交易

傳回所有排程的交易。
取得收款人

傳回所有收款人。
取得收款人位置

傳回所有收款人位置。
取得預算

傳回包含摘要資訊的預算清單。
取得預算月

傳回單一預算月。
取得預算月份

傳回所有預算月份。
取得類別

傳回依類別群組分組的所有類別。 金額（預算、活動、餘額等）特定於當前預算月 （UTC）。
大量建立交易

建立多個交易。 雖然仍支援此端點，但建議使用「POST /budgets/{budget_id}/transactions」來建立多個交易。
建立交易

建立單一交易或多個交易。 如果您提供包含物件的 transaction 主體，則會建立單一交易，如果您提供包含數組的 transactions 主體，則會建立多個交易。 無法在此端點上建立排程交易。
建立帳戶

建立新帳戶。
按 ID 獲取類別

傳回單一類別。 金額（預算、活動、餘額等）特定於當前預算月 （UTC）。
按帳戶獲取交易

傳回指定帳戶的所有交易。
按收款人獲取交易

傳回指定收款人的所有交易。
按收款人獲取收款人位置

傳回指定收款人的所有收款人位置。
更新交易

更新單一交易。
更新交易

透過 或 id更新import_id多個交易。
更新月份類別

更新特定月份的類別。 只能 budgeted 更新金額。
透過 ID 取得預算

傳回包含所有相關實體的單一預算。 此資源實際上是完整的預算匯出。
透過身分證取得收款人

傳回單一收款人。
通過 ID 獲取交易

傳回單一交易。
通過 ID 獲取帳戶

傳回單一帳戶。
通過 ID 獲取收款人位置

傳回單一收款人位置。
通過 ID 獲取預定交易

傳回單一排程交易。

依 ID 取得月份類別

作業識別碼：
GetMonthCategoryById

傳回特定預算月份的單一類別。 金額（預算、活動、餘額等）特定於當前預算月 （UTC）。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
月
 month True date

ISO 格式的預算月份（例如 2016-12-01）。 （“current”也可用於指定當前日曆月 （UTC））
類別標識碼
 category_id True string

類別的識別碼。

傳回

類別回應
CategoryResponse

依 ID 取得預算設定

作業識別碼：
GetBudgetSettingsById

傳回預算的設定

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。

傳回

預算設定回應
BudgetSettingsResponse

依類別取得交易

作業識別碼：
GetTransactionsByCategory

傳回指定類別的所有交易。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
類別標識碼
 category_id True string

類別的識別碼。
自日期以來
 since_date date

如果指定，則僅包括此日期或之後的交易。 日期應為 ISO 格式（例如 2016-12-30）。
類型
 type string

如果指定，則只會包含指定類型的交易。 目前支援「未分類」和「未核准」。
伺服器的最後知識
 last_knowledge_of_server integer

起始伺服器知識。 如果提供，則只會包含自此之後 last_knowledge_of_server 已變更的實體。

傳回

混合式交易回應
HybridTransactionsResponse

匯入交易

作業識別碼：
ImportTransactions

匯入指定預算內所有連結帳戶上的可用交易。 連結帳戶允許直接從指定的金融機構匯入交易，而此端點會啟動該匯入。 向此端點發送請求相當於在 Web 應用程序中的每個帳戶上單擊“導入”或點擊移動應用程序中的“新交易”橫幅。 此端點的回應包含已匯入的交易 ID。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。

傳回

交易匯入回應
TransactionsImportResponse

取得交易

作業識別碼：
GetTransactions

傳回預算交易。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
自日期以來
 since_date date

如果指定，則僅包括此日期或之後的交易。 日期應為 ISO 格式（例如 2016-12-30）。
類型
 type string

如果指定，則只會包含指定類型的交易。 目前支援「未分類」和「未核准」。
伺服器的最後知識
 last_knowledge_of_server integer

起始伺服器知識。 如果提供，則只會包含自此之後 last_knowledge_of_server 已變更的實體。

傳回

交易回應
TransactionsResponse

取得使用者

作業識別碼：
GetUser

傳回已驗證的使用者資訊。

傳回

使用者回應
UserResponse

取得帳戶

作業識別碼：
GetAccounts

傳回所有帳戶。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
伺服器的最後知識
 last_knowledge_of_server integer

起始伺服器知識。 如果提供，則只會包含自此之後 last_knowledge_of_server 已變更的實體。

傳回

帳戶回應
AccountsResponse

取得排程交易

作業識別碼：
GetScheduledTransactions

傳回所有排程的交易。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
伺服器的最後知識
 last_knowledge_of_server integer

起始伺服器知識。 如果提供，則只會包含自此之後 last_knowledge_of_server 已變更的實體。

傳回

排程交易回應
ScheduledTransactionsResponse

取得收款人

作業識別碼：
GetPayees

傳回所有收款人。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
伺服器的最後知識
 last_knowledge_of_server integer

起始伺服器知識。 如果提供，則只會包含自此之後 last_knowledge_of_server 已變更的實體。

傳回

收款人回應
PayeesResponse

取得收款人位置

作業識別碼：
GetPayeeLocations

傳回所有收款人位置。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。

傳回

收款人位置回應
PayeeLocationsResponse

取得預算

作業識別碼：
GetBudgets

傳回包含摘要資訊的預算清單。

參數

名稱 機碼 必要 類型 Description
包含帳戶
 include_accounts boolean

是否包含預算帳戶清單。

傳回

預算摘要回應
BudgetSummaryResponse

取得預算月

作業識別碼：
GetBudgetMonth

傳回單一預算月。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
月
 month True date

ISO 格式的預算月份（例如 2016-12-01）。 （“current”也可用於指定當前日曆月 （UTC））

傳回

月份詳細資料回應
MonthDetailResponse

取得預算月份

作業識別碼：
GetBudgetMonths

傳回所有預算月份。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
伺服器的最後知識
 last_knowledge_of_server integer

起始伺服器知識。 如果提供，則只會包含自此之後 last_knowledge_of_server 已變更的實體。

傳回

月份摘要回應
MonthSummariesResponse

取得類別

作業識別碼：
GetCategories

傳回依類別群組分組的所有類別。 金額（預算、活動、餘額等）特定於當前預算月 （UTC）。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
伺服器的最後知識
 last_knowledge_of_server integer

起始伺服器知識。 如果提供，則只會包含自此之後 last_knowledge_of_server 已變更的實體。

傳回

分類 回應
CategoriesResponse

大量建立交易

作業識別碼：
BulkCreateTransactions

建立多個交易。 雖然仍支援此端點，但建議使用「POST /budgets/{budget_id}/transactions」來建立多個交易。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
帳戶識別碼
 account_id True string

帳戶識別碼。
Date
 date True date

交易日期為ISO格式（例如2016-12-01）。 不允許未來日期（預定交易）。 分割交易日期無法變更，如果提供不同的日期，則會忽略它。
總數
 amount True integer

以毫單位格式表示的交易金額。 分割交易金額無法變更，如果提供不同的金額，則會忽略它。
收款人編號
 payee_id uuid

交易的收款人。 若要在兩個帳戶之間建立轉帳，請使用指向目標帳戶的帳戶轉帳收款人。 帳戶轉移收款人指定為 transfer_payee_id 帳戶資源。
收款人
 payee_name string

收款人名稱。 如果提供值 payee_name 且 payee_id 值為空值，則該 payee_name 值將用於透過 （1） 相符的收款人重新命名規則 （僅當也指定） import_id 或 （2） 具有相同名稱的收款人或 （3） 建立新收款人來解析收款人。
類別標識碼
 category_id uuid

交易的類別。 若要設定分割交易，您可以指定 null ， category_id 並提供 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 美元，import_id為「YNAB：-294230：2015-12-30：1」。 如果匯入同一帳戶的第二筆交易，且具有相同的日期和相同的金額，則其import_id將為「YNAB：-294230：2015-12-30：2」。 使用一致的格式將防止透過直接匯入和檔案型匯入產生重複。

如果省略import_id或指定為空值，則交易將被視為「使用者輸入」的交易。 因此，它將有資格與稍後匯入的交易進行比對（透過 DI、FBI 或 API）。
總數
 amount True integer

以毫單位格式表示的子交易金額。
收款人編號
 payee_id uuid

子交易的收款人。
收款人
 payee_name string

收款人名稱。 如果提供值 payee_name 且 payee_id 值為空值，則該 payee_name 值將用於透過 （1） 相符的收款人重新命名規則 （僅當父交易上也指定了import_id） 或 （2） 具有相同名稱的收款人或 （3） 建立新收款人來解析收款人。
類別標識碼
 category_id uuid

子交易的類別。 不允許信用卡付款類別，如果提供，將被忽略。
備忘錄
 memo string

備忘錄。

傳回

批量響應
BulkResponse

建立交易

作業識別碼：
CreateTransaction

建立單一交易或多個交易。 如果您提供包含物件的 transaction 主體，則會建立單一交易，如果您提供包含數組的 transactions 主體，則會建立多個交易。 無法在此端點上建立排程交易。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
帳戶識別碼
 account_id True string

帳戶識別碼。
Date
 date True date

交易日期為ISO格式（例如2016-12-01）。 不允許未來日期（預定交易）。 分割交易日期無法變更，如果提供不同的日期，則會忽略它。
總數
 amount True integer

以毫單位格式表示的交易金額。 分割交易金額無法變更，如果提供不同的金額，則會忽略它。
收款人編號
 payee_id uuid

交易的收款人。 若要在兩個帳戶之間建立轉帳，請使用指向目標帳戶的帳戶轉帳收款人。 帳戶轉移收款人指定為 transfer_payee_id 帳戶資源。
收款人
 payee_name string

收款人名稱。 如果提供值 payee_name 且 payee_id 值為空值，則該 payee_name 值將用於透過 （1） 相符的收款人重新命名規則 （僅當也指定） import_id 或 （2） 具有相同名稱的收款人或 （3） 建立新收款人來解析收款人。
類別標識碼
 category_id uuid

交易的類別。 若要設定分割交易，您可以指定 null ， category_id 並提供 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 美元，import_id為「YNAB：-294230：2015-12-30：1」。 如果匯入同一帳戶的第二筆交易，且具有相同的日期和相同的金額，則其import_id將為「YNAB：-294230：2015-12-30：2」。 使用一致的格式將防止透過直接匯入和檔案型匯入產生重複。

如果省略import_id或指定為空值，則交易將被視為「使用者輸入」的交易。 因此，它將有資格與稍後匯入的交易進行比對（透過 DI、FBI 或 API）。
總數
 amount True integer

以毫單位格式表示的子交易金額。
收款人編號
 payee_id uuid

子交易的收款人。
收款人
 payee_name string

收款人名稱。 如果提供值 payee_name 且 payee_id 值為空值，則該 payee_name 值將用於透過 （1） 相符的收款人重新命名規則 （僅當父交易上也指定了import_id） 或 （2） 具有相同名稱的收款人或 （3） 建立新收款人來解析收款人。
類別標識碼
 category_id uuid

子交易的類別。 不允許信用卡付款類別，如果提供，將被忽略。
備忘錄
 memo string

備忘錄。
帳戶識別碼
 account_id True string

帳戶識別碼。
Date
 date True date

交易日期為ISO格式（例如2016-12-01）。 不允許未來日期（預定交易）。 分割交易日期無法變更，如果提供不同的日期，則會忽略它。
總數
 amount True integer

以毫單位格式表示的交易金額。 分割交易金額無法變更，如果提供不同的金額，則會忽略它。
收款人編號
 payee_id uuid

交易的收款人。 若要在兩個帳戶之間建立轉帳，請使用指向目標帳戶的帳戶轉帳收款人。 帳戶轉移收款人指定為 transfer_payee_id 帳戶資源。
收款人
 payee_name string

收款人名稱。 如果提供值 payee_name 且 payee_id 值為空值，則該 payee_name 值將用於透過 （1） 相符的收款人重新命名規則 （僅當也指定） import_id 或 （2） 具有相同名稱的收款人或 （3） 建立新收款人來解析收款人。
類別標識碼
 category_id uuid

交易的類別。 若要設定分割交易，您可以指定 null ， category_id 並提供 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 美元，import_id為「YNAB：-294230：2015-12-30：1」。 如果匯入同一帳戶的第二筆交易，且具有相同的日期和相同的金額，則其import_id將為「YNAB：-294230：2015-12-30：2」。 使用一致的格式將防止透過直接匯入和檔案型匯入產生重複。

如果省略import_id或指定為空值，則交易將被視為「使用者輸入」的交易。 因此，它將有資格與稍後匯入的交易進行比對（透過 DI、FBI 或 API）。
總數
 amount True integer

以毫單位格式表示的子交易金額。
收款人編號
 payee_id uuid

子交易的收款人。
收款人
 payee_name string

收款人名稱。 如果提供值 payee_name 且 payee_id 值為空值，則該 payee_name 值將用於透過 （1） 相符的收款人重新命名規則 （僅當父交易上也指定了import_id） 或 （2） 具有相同名稱的收款人或 （3） 建立新收款人來解析收款人。
類別標識碼
 category_id uuid

子交易的類別。 不允許信用卡付款類別，如果提供，將被忽略。
備忘錄
 memo string

備忘錄。

傳回

儲存交易回應
SaveTransactionsResponse

建立帳戶

作業識別碼：
CreateAccount

建立新帳戶。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼 （「上次使用」可用來指定上次使用的預算，如果啟用預設預算選取，則可以使用「預設」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）
名稱
 name True string

帳戶的名稱。
類型2
 type True string

帳戶類型
秤
 balance True integer

帳戶的當前餘額（以毫單位格式表示）。

傳回

帳戶回應
AccountResponse

按 ID 獲取類別

作業識別碼：
GetCategoryById

傳回單一類別。 金額（預算、活動、餘額等）特定於當前預算月 （UTC）。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
類別標識碼
 category_id True string

類別的識別碼。

傳回

類別回應
CategoryResponse

按帳戶獲取交易

作業識別碼：
GetTransactionsByAccount

傳回指定帳戶的所有交易。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
帳戶識別碼
 account_id True string

帳戶的識別碼。
自日期以來
 since_date date

如果指定，則僅包括此日期或之後的交易。 日期應為 ISO 格式（例如 2016-12-30）。
類型
 type string

如果指定，則只會包含指定類型的交易。 目前支援「未分類」和「未核准」。
伺服器的最後知識
 last_knowledge_of_server integer

起始伺服器知識。 如果提供，則只會包含自此之後 last_knowledge_of_server 已變更的實體。

傳回

交易回應
TransactionsResponse

按收款人獲取交易

作業識別碼：
GetTransactionsByPayee

傳回指定收款人的所有交易。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
收款人編號
 payee_id True string

收款人的識別碼。
自日期以來
 since_date date

如果指定，則僅包括此日期或之後的交易。 日期應為 ISO 格式（例如 2016-12-30）。
類型
 type string

如果指定，則只會包含指定類型的交易。 目前支援「未分類」和「未核准」。
伺服器的最後知識
 last_knowledge_of_server integer

起始伺服器知識。 如果提供，則只會包含自此之後 last_knowledge_of_server 已變更的實體。

傳回

混合式交易回應
HybridTransactionsResponse

按收款人獲取收款人位置

作業識別碼：
GetPayeeLocationsByPayee

傳回指定收款人的所有收款人位置。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
收款人編號
 payee_id True string

收款人的識別碼。

傳回

收款人位置回應
PayeeLocationsResponse

更新交易

作業識別碼：
UpdateTransaction

更新單一交易。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
交易 ID
 transaction_id True string

交易的識別碼。
帳戶識別碼
 account_id True string

帳戶識別碼。
Date
 date True date

交易日期為ISO格式（例如2016-12-01）。 不允許未來日期（預定交易）。 分割交易日期無法變更，如果提供不同的日期，則會忽略它。
總數
 amount True integer

以毫單位格式表示的交易金額。 分割交易金額無法變更，如果提供不同的金額，則會忽略它。
收款人編號
 payee_id uuid

交易的收款人。 若要在兩個帳戶之間建立轉帳，請使用指向目標帳戶的帳戶轉帳收款人。 帳戶轉移收款人指定為 transfer_payee_id 帳戶資源。
收款人
 payee_name string

收款人名稱。 如果提供值 payee_name 且 payee_id 值為空值，則該 payee_name 值將用於透過 （1） 相符的收款人重新命名規則 （僅當也指定） import_id 或 （2） 具有相同名稱的收款人或 （3） 建立新收款人來解析收款人。
類別標識碼
 category_id uuid

交易的類別。 若要設定分割交易，您可以指定 null ， category_id 並提供 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 美元，import_id為「YNAB：-294230：2015-12-30：1」。 如果匯入同一帳戶的第二筆交易，且具有相同的日期和相同的金額，則其import_id將為「YNAB：-294230：2015-12-30：2」。 使用一致的格式將防止透過直接匯入和檔案型匯入產生重複。

如果省略import_id或指定為空值，則交易將被視為「使用者輸入」的交易。 因此，它將有資格與稍後匯入的交易進行比對（透過 DI、FBI 或 API）。
總數
 amount True integer

以毫單位格式表示的子交易金額。
收款人編號
 payee_id uuid

子交易的收款人。
收款人
 payee_name string

收款人名稱。 如果提供值 payee_name 且 payee_id 值為空值，則該 payee_name 值將用於透過 （1） 相符的收款人重新命名規則 （僅當父交易上也指定了import_id） 或 （2） 具有相同名稱的收款人或 （3） 建立新收款人來解析收款人。
類別標識碼
 category_id uuid

子交易的類別。 不允許信用卡付款類別，如果提供，將被忽略。
備忘錄
 memo string

備忘錄。

傳回

交易回應
TransactionResponse

更新交易

作業識別碼：
UpdateTransactions

透過 或 id更新import_id多個交易。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
ID
 id True string

識別碼。
帳戶識別碼
 account_id True string

帳戶識別碼。
Date
 date True date

交易日期為ISO格式（例如2016-12-01）。 不允許未來日期（預定交易）。 分割交易日期無法變更，如果提供不同的日期，則會忽略它。
總數
 amount True integer

以毫單位格式表示的交易金額。 分割交易金額無法變更，如果提供不同的金額，則會忽略它。
收款人編號
 payee_id uuid

交易的收款人。 若要在兩個帳戶之間建立轉帳，請使用指向目標帳戶的帳戶轉帳收款人。 帳戶轉移收款人指定為 transfer_payee_id 帳戶資源。
收款人
 payee_name string

收款人名稱。 如果提供值 payee_name 且 payee_id 值為空值，則該 payee_name 值將用於透過 （1） 相符的收款人重新命名規則 （僅當也指定） import_id 或 （2） 具有相同名稱的收款人或 （3） 建立新收款人來解析收款人。
類別標識碼
 category_id uuid

交易的類別。 若要設定分割交易，您可以指定 null ， category_id 並提供 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 美元，import_id為「YNAB：-294230：2015-12-30：1」。 如果匯入同一帳戶的第二筆交易，且具有相同的日期和相同的金額，則其import_id將為「YNAB：-294230：2015-12-30：2」。 使用一致的格式將防止透過直接匯入和檔案型匯入產生重複。

如果省略import_id或指定為空值，則交易將被視為「使用者輸入」的交易。 因此，它將有資格與稍後匯入的交易進行比對（透過 DI、FBI 或 API）。
總數
 amount True integer

以毫單位格式表示的子交易金額。
收款人編號
 payee_id uuid

子交易的收款人。
收款人
 payee_name string

收款人名稱。 如果提供值 payee_name 且 payee_id 值為空值，則該 payee_name 值將用於透過 （1） 相符的收款人重新命名規則 （僅當父交易上也指定了import_id） 或 （2） 具有相同名稱的收款人或 （3） 建立新收款人來解析收款人。
類別標識碼
 category_id uuid

子交易的類別。 不允許信用卡付款類別，如果提供，將被忽略。
備忘錄
 memo string

備忘錄。

傳回

儲存交易回應
SaveTransactionsResponse

更新月份類別

作業識別碼：
UpdateMonthCategory

更新特定月份的類別。 只能 budgeted 更新金額。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
月
 month True date

ISO 格式的預算月份（例如 2016-12-01）。 （“current”也可用於指定當前日曆月 （UTC））
類別標識碼
 category_id True string

類別的識別碼。
預算
 budgeted True integer

以毫單位格式表示的預算金額。

傳回

儲存類別回應
SaveCategoryResponse

透過 ID 取得預算

作業識別碼：
GetBudgetById

傳回包含所有相關實體的單一預算。 此資源實際上是完整的預算匯出。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。
伺服器的最後知識
 last_knowledge_of_server integer

起始伺服器知識。 如果提供，則只會包含自此之後 last_knowledge_of_server 已變更的實體。

傳回

預算詳細資料回應
BudgetDetailResponse

透過身分證取得收款人

作業識別碼：
GetPayeeById

傳回單一收款人。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
收款人編號
 payee_id True string

收款人的識別碼。

傳回

收款人回應
PayeeResponse

通過 ID 獲取交易

作業識別碼：
GetTransactionById

傳回單一交易。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
交易 ID
 transaction_id True string

交易的識別碼。

傳回

交易回應
TransactionResponse

通過 ID 獲取帳戶

作業識別碼：
GetAccountById

傳回單一帳戶。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
帳戶識別碼
 account_id True uuid

帳戶的識別碼。

傳回

帳戶回應
AccountResponse

通過 ID 獲取收款人位置

作業識別碼：
GetPayeeLocationById

傳回單一收款人位置。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
收款人位置 ID
 payee_location_id True string

收款人位置的標識符。

傳回

收款人位置回應
PayeeLocationResponse

通過 ID 獲取預定交易

作業識別碼：
GetScheduledTransactionById

傳回單一排程交易。

參數

名稱 機碼 必要 類型 Description
預算編號
 budget_id True string

預算的識別碼。 「last-used」可用來指定上次使用的預算，如果啟用預設預算選擇，則可以使用「default」（請參閱： https://api.youneedabudget.com/#oauth-default-budget）。
排程交易ID
 scheduled_transaction_id True string

排程交易的識別碼。

傳回

排程交易回應
ScheduledTransactionResponse

定義

使用者回應

名稱 路徑 類型 Description
資料
 data Data

User

名稱 路徑 類型 Description
ID
 id string

識別碼。

DateFormat

預算的日期格式設定。 在某些情況下，格式將無法使用，並將指定為 Null。

名稱 路徑 類型 Description
格式
 format string

格式。

貨幣格式

預算的貨幣格式設定。 在某些情況下，格式將無法使用，並將指定為 Null。

名稱 路徑 類型 Description
ISO代碼
 iso_code string

ISO 代碼。
範例格式
 example_format string

範例格式。
十進位數
 decimal_digits integer

十進位數。
小數點分隔符
 decimal_separator string

小數點分隔符號。
符號優先
 symbol_first boolean

符號是否在先。
群組分隔符號
 group_separator string

群組分隔符號。
貨幣符號
 currency_symbol string

貨幣符號。
顯示的符號
 display_symbol boolean

是否顯示符號。

BudgetSummary回應

名稱 路徑 類型 Description
資料1
 data Data1

預算摘要

名稱 路徑 類型 Description
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 包含）。

BudgetDetail回應

名稱 路徑 類型 Description
資料2
 data Data2

預算細節

名稱 路徑 類型 Description
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

BudgetSettings回應

名稱 路徑 類型 Description
資料3
 data Data3

預算設定

名稱 路徑 類型 Description
日期格式
 date_format DateFormat

預算的日期格式設定。 在某些情況下，格式將無法使用，並將指定為 Null。
貨幣格式
 currency_format CurrencyFormat

預算的貨幣格式設定。 在某些情況下，格式將無法使用，並將指定為 Null。

帳戶回應

名稱 路徑 類型 Description
數據4
 data Data4

帳戶回應

名稱 路徑 類型 Description
數據5
 data Data5

Account

名稱 路徑 類型 Description
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

帳戶是否已被刪除。 已刪除的帳戶只會包含在差異請求中。

類別回應

名稱 路徑 類型 Description
數據6
 data Data6

類別回應

名稱 路徑 類型 Description
數據7
 data Data7

類別群組與類別

名稱 路徑 類型 Description
ID
 id string

識別碼。
名稱
 name string

名稱。
隱藏
 hidden boolean

是否隱藏類別群組。
已刪除
 deleted boolean

是否已刪除類別群組。 已刪除的類別群組只會包含在差異請求中。
類別
 categories array of Category

類別群組類別。 金額（預算、活動、餘額等）特定於當前預算月 （UTC）。

類別群組

名稱 路徑 類型 Description
ID
 id string

識別碼。
名稱
 name string

名稱。
隱藏
 hidden boolean

是否隱藏類別群組。
已刪除
 deleted boolean

是否已刪除類別群組。 已刪除的類別群組只會包含在差異請求中。

類別

名稱 路徑 類型 Description
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='目標類別餘額'、TBD='依日期劃分的目標類別餘額'、MF='每月資金'、NEED='規劃您的支出'）
目標創造月
 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 和行動用戶端在檢視未來一個月具有「支出需求目標」的類別時，將忽略先前目標期間的任何資金。
目標總體資助
 goal_overall_funded integer

在目前目標期間內為目標提供資金的總金額。
左邊總進球
 goal_overall_left integer

在當前目標期限內完成目標仍需要的資金金額。
已刪除
 deleted boolean

該類別是否已被刪除。 已刪除的類別只會包含在差異請求中。

SaveCategory回應

名稱 路徑 類型 Description
數據8
 data Data8

收款人回應

名稱 路徑 類型 Description
數據9
 data Data9

收款人回應

名稱 路徑 類型 Description
數據10
 data Data10

收款人

名稱 路徑 類型 Description
ID
 id string

識別碼。
名稱
 name string

名稱。
轉賬賬戶 ID
 transfer_account_id string

如果是轉帳收款人，則該收款人會轉帳至的收 account_id 款人。
已刪除
 deleted boolean

收款人是否已被刪除。 已刪除的收款人只會包含在差異請求中。

收款人位置回應

名稱 路徑 類型 Description
數據11
 data Data11

收款人位置回應

名稱 路徑 類型 Description
數據12
 data Data12

收款人地點

名稱 路徑 類型 Description
ID
 id string

識別碼。
收款人編號
 payee_id string

收款人識別碼。
緯度
 latitude string

緯度。
經度
 longitude string

經度。
已刪除
 deleted boolean

收款人位置是否已刪除。 已刪除的收款人位置只會包含在 delta 請求中。

交易回應

名稱 路徑 類型 Description
數據13
 data Data13

混合式交易回應

名稱 路徑 類型 Description
數據14
 data Data14

SaveTransactions回應

名稱 路徑 類型 Description
數據15
 data Data15

交易回應

名稱 路徑 類型 Description
數據16
 data Data16

交易摘要

名稱 路徑 類型 Description
ID
 id string

識別碼。
Date
 date date

交易日期為ISO格式（例如2016-12-01）。
總數
 amount integer

以毫單位格式表示的交易金額。
備忘錄
 memo string

備忘錄。
已結清
 cleared Cleared

交易的已清除狀態。
已核准
 approved boolean

交易是否獲得批准。
旗幟顏色
 flag_color FlagColor

交易旗標。
帳戶識別碼
 account_id string

帳戶識別碼。
收款人編號
 payee_id string

收款人識別碼。
類別標識碼
 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]：[出現]」。 例如，日期為 2015 年 12 月 30 日的交易金額為 -294.23 美元，import_id為「YNAB：-294230：2015-12-30：1」。 如果匯入同一帳戶的第二筆交易，且具有相同的日期和相同的金額，則其import_id將為「YNAB：-294230：2015-12-30：2」。
已刪除
 deleted boolean

交易是否已刪除。 已刪除的交易只會包含在差異要求中。

TransactionDetail

名稱 路徑 類型 Description
ID
 id string

識別碼。
Date
 date date

交易日期為ISO格式（例如2016-12-01）。
總數
 amount integer

以毫單位格式表示的交易金額。
備忘錄
 memo string

備忘錄。
已結清
 cleared Cleared

交易的已清除狀態。
已核准
 approved boolean

交易是否獲得批准。
旗幟顏色
 flag_color FlagColor

交易旗標。
帳戶識別碼
 account_id string

帳戶識別碼。
收款人編號
 payee_id string

收款人識別碼。
類別標識碼
 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]：[出現]」。 例如，日期為 2015 年 12 月 30 日的交易金額為 -294.23 美元，import_id為「YNAB：-294230：2015-12-30：1」。 如果匯入同一帳戶的第二筆交易，且具有相同的日期和相同的金額，則其import_id將為「YNAB：-294230：2015-12-30：2」。
已刪除
 deleted boolean

交易是否已刪除。 已刪除的交易只會包含在差異要求中。
客戶名稱
 account_name string

帳戶名稱。
收款人
 payee_name string

收款人名稱。
類別
 category_name string

類別名稱。
子交易
 subtransactions array of SubTransaction

如果是分割交易，則子交易。

混合交易

名稱 路徑 類型 Description
ID
 id string

識別碼。
Date
 date date

交易日期為ISO格式（例如2016-12-01）。
總數
 amount integer

以毫單位格式表示的交易金額。
備忘錄
 memo string

備忘錄。
已結清
 cleared Cleared

交易的已清除狀態。
已核准
 approved boolean

交易是否獲得批准。
旗幟顏色
 flag_color FlagColor

交易旗標。
帳戶識別碼
 account_id string

帳戶識別碼。
收款人編號
 payee_id string

收款人識別碼。
類別標識碼
 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]：[出現]」。 例如，日期為 2015 年 12 月 30 日的交易金額為 -294.23 美元，import_id為「YNAB：-294230：2015-12-30：1」。 如果匯入同一帳戶的第二筆交易，且具有相同的日期和相同的金額，則其import_id將為「YNAB：-294230：2015-12-30：2」。
已刪除
 deleted boolean

交易是否已刪除。 已刪除的交易只會包含在差異要求中。
類型3
 type Type3

混合式交易代表一般交易還是子交易
父交易 ID
 parent_transaction_id string

對於子交易類型，這是父交易的識別碼。 對於交易類型，此識別碼將始終為 null。
客戶名稱
 account_name string

帳戶名稱。
收款人
 payee_name string

收款人名稱。
類別
 category_name string

類別名稱。

交易匯入回應

名稱 路徑 類型 Description
數據17
 data Data17

批量回應

名稱 路徑 類型 Description
數據18
 data Data18

子交易

名稱 路徑 類型 Description
ID
 id string

識別碼。
交易 ID
 transaction_id string

交易。
總數
 amount integer

以毫單位格式表示的子交易金額。
備忘錄
 memo string

備忘錄。
收款人編號
 payee_id string

收款人識別碼。
收款人
 payee_name string

收款人名稱。
類別標識碼
 category_id string

類別識別碼。
類別
 category_name string

類別名稱。
轉賬賬戶 ID
 transfer_account_id uuid

如果是轉移，則子交易轉移至的account_id。
轉移交易 ID
 transfer_transaction_id string

如果是轉賬，則是轉賬另一端的交易標識符。
已刪除
 deleted boolean

子交易是否已刪除。 已刪除的子交易只會包含在差異請求中。

ScheduledTransactions回應

名稱 路徑 類型 Description
數據19
 data Data19

ScheduledTransactionResponse

名稱 路徑 類型 Description
數據20
 data Data20

ScheduledTransaction摘要

名稱 路徑 類型 Description
ID
 id string

識別碼。
第一次約會
 date_first date

排定排程交易的第一個日期。
下一個日期
 date_next date

排程「排程交易」的下一個日期。
頻率
 frequency Frequency

頻率。
總數
 amount integer

以毫單位格式表示的排程交易金額。
備忘錄
 memo string

備忘錄。
旗幟顏色1
 flag_color FlagColor1

排程的交易旗標。
帳戶識別碼
 account_id string

帳戶識別碼。
收款人編號
 payee_id string

收款人識別碼。
類別標識碼
 category_id string

類別識別碼。
轉賬賬戶 ID
 transfer_account_id uuid

如果是轉移，則排定交易轉移至的account_id。
已刪除
 deleted boolean

排程交易是否已刪除。 已刪除的排程交易只會包含在差異請求中。

ScheduledTransactionDetail

名稱 路徑 類型 Description
ID
 id string

識別碼。
第一次約會
 date_first date

排定排程交易的第一個日期。
下一個日期
 date_next date

排程「排程交易」的下一個日期。
頻率
 frequency Frequency

頻率。
總數
 amount integer

以毫單位格式表示的排程交易金額。
備忘錄
 memo string

備忘錄。
旗幟顏色1
 flag_color FlagColor1

排程的交易旗標。
帳戶識別碼
 account_id string

帳戶識別碼。
收款人編號
 payee_id string

收款人識別碼。
類別標識碼
 category_id string

類別識別碼。
轉賬賬戶 ID
 transfer_account_id uuid

如果是轉移，則排定交易轉移至的account_id。
已刪除
 deleted boolean

排程交易是否已刪除。 已刪除的排程交易只會包含在差異請求中。
客戶名稱
 account_name string

帳戶名稱。
收款人
 payee_name string

收款人名稱。
類別
 category_name string

類別名稱。
子交易
 subtransactions array of ScheduledSubTransaction

如果是分割排程交易，則子交易。

ScheduledSubTransaction

名稱 路徑 類型 Description
ID
 id string

識別碼。
排程交易ID
 scheduled_transaction_id string

排程的交易識別碼。
總數
 amount integer

以毫單位格式表示的排程子交易金額。
備忘錄
 memo string

備忘錄。
收款人編號
 payee_id string

收款人識別碼。
類別標識碼
 category_id string

類別識別碼。
轉賬賬戶 ID
 transfer_account_id uuid

如果是轉移，則排程子交易轉移至的account_id。
已刪除
 deleted boolean

是否已刪除排程的子交易。 已刪除的排程子交易只會包含在差異請求中。

MonthSummaries回應

名稱 路徑 類型 Description
數據21
 data Data21

MonthDetail回應

名稱 路徑 類型 Description
數據22
 data Data22

MonthSummary

名稱 路徑 類型 Description
月
 month date

月份。
備註
 note string

紙條。
收入
 income integer

當月分類為「流入：準備分配」的交易總額。
預算
 budgeted integer

當月預算的總金額。
Activity
 activity integer

當月的交易總額，不包括分類為「流入：準備分配」的交易。
待編列預算
 to_be_budgeted integer

「準備指派」的可用金額。
金錢時代
 age_of_money integer

截至本月的貨幣時代。
已刪除
 deleted boolean

是否已刪除月份。 已刪除的月份只會包含在差異請求中。

月詳情

名稱 路徑 類型 Description
月
 month date

月份。
備註
 note string

紙條。
收入
 income integer

當月分類為「流入：準備分配」的交易總額。
預算
 budgeted integer

當月預算的總金額。
Activity
 activity integer

當月的交易總額，不包括分類為「流入：準備分配」的交易。
待編列預算
 to_be_budgeted integer

「準備指派」的可用金額。
金錢時代
 age_of_money integer

截至本月的貨幣時代。
已刪除
 deleted boolean

是否已刪除月份。 已刪除的月份只會包含在差異請求中。
類別
 categories array of Category

預算月份類別。 金額 （預算、活動、餘額等） 特定於指定的 {month} 參數。

大量

名稱 路徑 類型 Description
交易 ID
 transaction_ids array of string

已建立的交易識別碼清單。
重複的匯入 ID
 duplicate_import_ids array of string

如果任何交易未建立，因為它們已在同一帳戶上有 import_id 相符的交易，則指定的import_id將包含在此清單中。

已結清

交易的已清除狀態。

交易的已清除狀態。

已結清
string

資料

名稱 路徑 類型 Description
User
 user User

資料1

名稱 路徑 類型 Description
Budgets
 budgets array of BudgetSummary
預算摘要
 default_budget BudgetSummary

資料2

名稱 路徑 類型 Description
預算詳情
 budget BudgetDetail
伺服器知識
 server_knowledge integer

服務器的知識。

資料3

名稱 路徑 類型 Description
預算設定
 settings BudgetSettings

數據4

名稱 路徑 類型 Description
Accounts
 accounts array of Account
伺服器知識
 server_knowledge integer

服務器的知識。

數據5

名稱 路徑 類型 Description
Account
 account Account

數據6

名稱 路徑 類型 Description
類別群組
 category_groups array of CategoryGroupWithCategories

類別群組。
伺服器知識
 server_knowledge integer

服務器的知識。

數據7

名稱 路徑 類型 Description
類別
 category Category

數據8

名稱 路徑 類型 Description
類別
 category Category
伺服器知識
 server_knowledge integer

服務器的知識。

數據9

名稱 路徑 類型 Description
收款人
 payees array of Payee

收款人。
伺服器知識
 server_knowledge integer

服務器的知識。

數據10

名稱 路徑 類型 Description
收款人
 payee Payee

數據11

名稱 路徑 類型 Description
收款人地點
 payee_locations array of PayeeLocation

收款人位置。

數據12

名稱 路徑 類型 Description
收款人位置
 payee_location PayeeLocation

數據13

名稱 路徑 類型 Description
Transactions
 transactions array of TransactionDetail

交易。
伺服器知識
 server_knowledge integer

服務器的知識。

數據14

名稱 路徑 類型 Description
Transactions
 transactions array of HybridTransaction

交易。

數據15

名稱 路徑 類型 Description
交易 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

服務器的知識。

數據16

名稱 路徑 類型 Description
交易詳情
 transaction TransactionDetail

數據17

名稱 路徑 類型 Description
交易 ID
 transaction_ids array of string

匯入的交易 ID 清單。

數據18

名稱 路徑 類型 Description
大量
 bulk Bulk

數據19

名稱 路徑 類型 Description
scheduled_transactions
 scheduled_transactions array of ScheduledTransactionDetail
伺服器知識
 server_knowledge integer

服務器的知識。

數據20

名稱 路徑 類型 Description
預定交易詳情
 scheduled_transaction ScheduledTransactionDetail

數據21

名稱 路徑 類型 Description
月份
 months array of MonthSummary
伺服器知識
 server_knowledge integer

服務器的知識。

數據22

名稱 路徑 類型 Description
月份詳情
 month MonthDetail

旗幟顏色

交易旗標。

交易旗標。

旗幟顏色
string

旗幟顏色1

排程的交易旗標。

排程的交易旗標。

旗幟顏色1
string

頻率

頻率。

頻率。

頻率
string

目標類型

目標類型 （如果類別有目標） （TB='目標類別餘額'、TBD='依日期劃分的目標類別餘額'、MF='每月資金'、NEED='規劃您的支出'）

目標類型 （如果類別有目標） （TB='目標類別餘額'、TBD='依日期劃分的目標類別餘額'、MF='每月資金'、NEED='規劃您的支出'）

目標類型
string

類型

帳戶類型。 注意：PayPal、merchantAccount、investmentAccount 和抵押貸款類型已被取代，並將在未來刪除。

帳戶類型。 注意：PayPal、merchantAccount、investmentAccount 和抵押貸款類型已被取代，並將在未來刪除。

類型
string

類型3

混合式交易代表一般交易還是子交易

混合式交易代表一般交易還是子交易

類型3
string