You Need A Budget (Independent Publisher)

You Need A Budget (YNAB) allows you to build a personal application to interact with your own budget or build an application that any other YNABer can authorize and use.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)

Contact
Name	Troy Taylor
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Connector Metadata
Publisher	Troy Taylor
Website	https://www.youneedabudget.com/
Privacy policy	https://www.youneedabudget.com/privacy-policy/
Categories	Finance

Creating a connection

The connector supports the following authentication types:

Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
Access Token (in the form 'Bearer AccessToken)	securestring	The Access Token (in the form 'Bearer AccessToken) for this api	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Bulk create transactions	Creates multiple transactions. Although this endpoint is still supported, it is recommended to use 'POST /budgets/{budget_id}/transactions' to create multiple transactions.
Create account	Creates a new account.
Create transaction	Creates a single transaction or multiple transactions. If you provide a body containing a transaction object, a single transaction will be created and if you provide a body containing a transactions array, multiple transactions will be created. Scheduled transactions cannot be created on this endpoint.
Get account by ID	Returns a single account.
Get accounts	Returns all accounts.
Get budget by ID	Returns a single budget with all related entities. This resource is effectively a full budget export.
Get budget month	Returns a single budget month.
Get budget months	Returns all budget months.
Get budget settings by ID	Returns settings for a budget
Get budgets	Returns budgets list with summary information.
Get categories	Returns all categories grouped by category group. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
Get Category by ID	Returns a single category. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
Get month category by ID	Returns a single category for a specific budget month. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
Get payee by ID	Returns a single payee.
Get payee location by ID	Returns a single payee location.
Get payee locations	Returns all payee locations.
Get payee locations by payee	Returns all payee locations for a specified payee.
Get payees	Returns all payees.
Get scheduled transaction by ID	Returns a single scheduled transaction.
Get scheduled transactions	Returns all scheduled transactions.
Get transaction by ID	Returns a single transaction.
Get transactions	Returns budget transactions.
Get transactions by account	Returns all transactions for a specified account.
Get transactions by category	Returns all transactions for a specified category.
Get transactions by payee	Returns all transactions for a specified payee.
Get user	Returns authenticated user information.
Import transactions	Imports available transactions on all linked accounts for the given budget. Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import. Sending a request to this endpoint is the equivalent of clicking "Import" on each account in the web application or tapping the "New Transactions" banner in the mobile applications. The response for this endpoint contains the transaction ids that have been imported.
Update month category	Update a category for a specific month. Only budgeted amount can be updated.
Update transaction	Updates a single transaction.
Update transactions	Updates multiple transactions, by id or import_id.

Bulk create transactions

Operation ID:

BulkCreateTransactions

Creates multiple transactions. Although this endpoint is still supported, it is recommended to use 'POST /budgets/{budget_id}/transactions' to create multiple transactions.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Account ID	account_id	True	string	The account identifier.
Date	date	True	date	The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.
Amount	amount	True	integer	The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
Payee ID	payee_id		uuid	The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as transfer_payee_id on the account resource.
Payee	payee_name		string	The payee name. If a payee_name value is provided and payee_id has a null value, the payee_name value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified) or (2) a payee with the same name or (3) creation of a new payee.
Category ID	category_id		uuid	The category for the transaction. To configure a split transaction, you can specify null for category_id and provide a subtransactions array as part of the transaction object. If an existing transaction is a split, the category_id cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.
Memo	memo		string	The memo.
Cleared	cleared		string	The cleared status of the transaction.
Approved	approved		boolean	Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
Flag Color	flag_color		string	The transaction flag.
Import ID	import_id		string	If specified, the new transaction will be assigned this import_id and considered "imported". We will also attempt to match this imported transaction to an existing "user-entered" transaction on the same account, with the same amount, and with a date +/-10 days from the imported transaction date. Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. Using a consistent format will prevent duplicates through Direct Import and File Based Import. If import_id is omitted or specified as null, the transaction will be treated as a "user-entered" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API).
Amount	amount	True	integer	The subtransaction amount in milliunits format.
Payee ID	payee_id		uuid	The payee for the subtransaction.
Payee	payee_name		string	The payee name. If a payee_name value is provided and payee_id has a null value, the payee_name value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified on parent transaction) or (2) a payee with the same name or (3) creation of a new payee.
Category ID	category_id		uuid	The category for the subtransaction. Credit Card Payment categories are not permitted and will be ignored if supplied.
Memo	memo		string	The memo.

Returns

Bulk Response

BulkResponse

Create account

Operation ID:

CreateAccount

Creates a new account.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget ("last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget)
Name	name	True	string	The name of the account.
Type2	type	True	string	The account type
Balance	balance	True	integer	The current balance of the account in milliunits format.

Returns

Account Response

AccountResponse

Create transaction

Operation ID:

CreateTransaction

Creates a single transaction or multiple transactions. If you provide a body containing a transaction object, a single transaction will be created and if you provide a body containing a transactions array, multiple transactions will be created. Scheduled transactions cannot be created on this endpoint.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Account ID	account_id	True	string	The account identifier.
Date	date	True	date	The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.
Amount	amount	True	integer	The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
Payee ID	payee_id		uuid	The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as transfer_payee_id on the account resource.
Payee	payee_name		string	The payee name. If a payee_name value is provided and payee_id has a null value, the payee_name value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified) or (2) a payee with the same name or (3) creation of a new payee.
Category ID	category_id		uuid	The category for the transaction. To configure a split transaction, you can specify null for category_id and provide a subtransactions array as part of the transaction object. If an existing transaction is a split, the category_id cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.
Memo	memo		string	The memo.
Cleared	cleared		string	The cleared status of the transaction.
Approved	approved		boolean	Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
Flag Color	flag_color		string	The transaction flag.
Import ID	import_id		string	If specified, the new transaction will be assigned this import_id and considered "imported". We will also attempt to match this imported transaction to an existing "user-entered" transaction on the same account, with the same amount, and with a date +/-10 days from the imported transaction date. Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. Using a consistent format will prevent duplicates through Direct Import and File Based Import. If import_id is omitted or specified as null, the transaction will be treated as a "user-entered" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API).
Amount	amount	True	integer	The subtransaction amount in milliunits format.
Payee ID	payee_id		uuid	The payee for the subtransaction.
Payee	payee_name		string	The payee name. If a payee_name value is provided and payee_id has a null value, the payee_name value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified on parent transaction) or (2) a payee with the same name or (3) creation of a new payee.
Category ID	category_id		uuid	The category for the subtransaction. Credit Card Payment categories are not permitted and will be ignored if supplied.
Memo	memo		string	The memo.
Account ID	account_id	True	string	The account identifier.
Date	date	True	date	The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.
Amount	amount	True	integer	The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
Payee ID	payee_id		uuid	The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as transfer_payee_id on the account resource.
Payee	payee_name		string	The payee name. If a payee_name value is provided and payee_id has a null value, the payee_name value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified) or (2) a payee with the same name or (3) creation of a new payee.
Category ID	category_id		uuid	The category for the transaction. To configure a split transaction, you can specify null for category_id and provide a subtransactions array as part of the transaction object. If an existing transaction is a split, the category_id cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.
Memo	memo		string	The memo.
Cleared	cleared		string	The cleared status of the transaction.
Approved	approved		boolean	Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
Flag Color	flag_color		string	The transaction flag.
Import ID	import_id		string	If specified, the new transaction will be assigned this import_id and considered "imported". We will also attempt to match this imported transaction to an existing "user-entered" transaction on the same account, with the same amount, and with a date +/-10 days from the imported transaction date. Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. Using a consistent format will prevent duplicates through Direct Import and File Based Import. If import_id is omitted or specified as null, the transaction will be treated as a "user-entered" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API).
Amount	amount	True	integer	The subtransaction amount in milliunits format.
Payee ID	payee_id		uuid	The payee for the subtransaction.
Payee	payee_name		string	The payee name. If a payee_name value is provided and payee_id has a null value, the payee_name value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified on parent transaction) or (2) a payee with the same name or (3) creation of a new payee.
Category ID	category_id		uuid	The category for the subtransaction. Credit Card Payment categories are not permitted and will be ignored if supplied.
Memo	memo		string	The memo.

Returns

Save Transactions Response

SaveTransactionsResponse

Get account by ID

Operation ID:

GetAccountById

Returns a single account.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Account ID	account_id	True	uuid	The identifier of the account.

Returns

Account Response

AccountResponse

Get accounts

Operation ID:

GetAccounts

Returns all accounts.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Last Knowledge of Server	last_knowledge_of_server		integer	The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included.

Returns

Accounts Response

AccountsResponse

Get budget by ID

Operation ID:

GetBudgetById

Returns a single budget with all related entities. This resource is effectively a full budget export.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget.
Last Knowledge of Server	last_knowledge_of_server		integer	The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included.

Returns

Budget Detail Response

BudgetDetailResponse

Get budget month

Operation ID:

GetBudgetMonth

Returns a single budget month.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Month	month	True	date	The budget month in ISO format (e.g. 2016-12-01). ("current" can also be used to specify the current calendar month (UTC))

Returns

Month Detail Response

MonthDetailResponse

Get budget months

Operation ID:

GetBudgetMonths

Returns all budget months.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Last Knowledge of Server	last_knowledge_of_server		integer	The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included.

Returns

Month Summaries Response

MonthSummariesResponse

Get budget settings by ID

Operation ID:

GetBudgetSettingsById

Returns settings for a budget

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).

Returns

Budget Settings Response

BudgetSettingsResponse

Get budgets

Operation ID:

GetBudgets

Returns budgets list with summary information.

Parameters

Name	Key	Required	Type	Description
Include Accounts	include_accounts		boolean	Whether to include the list of budget accounts.

Returns

Budget Summary Response

BudgetSummaryResponse

Get categories

Operation ID:

GetCategories

Returns all categories grouped by category group. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Last Knowledge of Server	last_knowledge_of_server		integer	The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included.

Returns

Categories Response

CategoriesResponse

Get Category by ID

Operation ID:

GetCategoryById

Returns a single category. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Category ID	category_id	True	string	The identifier of the category.

Returns

Category Response

CategoryResponse

Get month category by ID

Operation ID:

GetMonthCategoryById

Returns a single category for a specific budget month. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Month	month	True	date	The budget month in ISO format (e.g. 2016-12-01). ("current" can also be used to specify the current calendar month (UTC))
Category ID	category_id	True	string	The identifier of the category.

Returns

Category Response

CategoryResponse

Get payee by ID

Operation ID:

GetPayeeById

Returns a single payee.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Payee ID	payee_id	True	string	The identifier of the payee.

Returns

Payee Response

PayeeResponse

Get payee location by ID

Operation ID:

GetPayeeLocationById

Returns a single payee location.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Payee Location ID	payee_location_id	True	string	Identifier of payee location.

Returns

Payee Location Response

PayeeLocationResponse

Get payee locations

Operation ID:

GetPayeeLocations

Returns all payee locations.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).

Returns

Payee Locations Response

PayeeLocationsResponse

Get payee locations by payee

Operation ID:

GetPayeeLocationsByPayee

Returns all payee locations for a specified payee.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Payee ID	payee_id	True	string	The identifier of payee.

Returns

Payee Locations Response

PayeeLocationsResponse

Get payees

Operation ID:

GetPayees

Returns all payees.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Last Knowledge of Server	last_knowledge_of_server		integer	The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included.

Returns

Payees Response

PayeesResponse

Get scheduled transaction by ID

Operation ID:

GetScheduledTransactionById

Returns a single scheduled transaction.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Scheduled Transaction ID	scheduled_transaction_id	True	string	The identifier of the scheduled transaction.

Returns

Scheduled Transaction Response

ScheduledTransactionResponse

Get scheduled transactions

Operation ID:

GetScheduledTransactions

Returns all scheduled transactions.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Last Knowledge of Server	last_knowledge_of_server		integer	The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included.

Returns

Scheduled Transactions Response

ScheduledTransactionsResponse

Get transaction by ID

Operation ID:

GetTransactionById

Returns a single transaction.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Transaction ID	transaction_id	True	string	The identifier of the transaction.

Returns

Transaction Response

TransactionResponse

Get transactions

Operation ID:

GetTransactions

Returns budget transactions.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Since Date	since_date		date	If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
Type	type		string	If specified, only transactions of the specified type will be included. "uncategorized" and "unapproved" are currently supported.
Last Knowledge of Server	last_knowledge_of_server		integer	The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included.

Returns

Transactions Response

TransactionsResponse

Get transactions by account

Operation ID:

GetTransactionsByAccount

Returns all transactions for a specified account.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Account ID	account_id	True	string	The identifier of the account.
Since Date	since_date		date	If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
Type	type		string	If specified, only transactions of the specified type will be included. "uncategorized" and "unapproved" are currently supported.
Last Knowledge of Server	last_knowledge_of_server		integer	The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included.

Returns

Transactions Response

TransactionsResponse

Get transactions by category

Operation ID:

GetTransactionsByCategory

Returns all transactions for a specified category.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Category ID	category_id	True	string	The identifier of the category.
Since Date	since_date		date	If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
Type	type		string	If specified, only transactions of the specified type will be included. "uncategorized" and "unapproved" are currently supported.
Last Knowledge of Server	last_knowledge_of_server		integer	The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included.

Returns

Hybrid Transactions Response

HybridTransactionsResponse

Get transactions by payee

Operation ID:

GetTransactionsByPayee

Returns all transactions for a specified payee.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Payee ID	payee_id	True	string	The identifier of the payee.
Since Date	since_date		date	If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
Type	type		string	If specified, only transactions of the specified type will be included. "uncategorized" and "unapproved" are currently supported.
Last Knowledge of Server	last_knowledge_of_server		integer	The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included.

Returns

Hybrid Transactions Response

HybridTransactionsResponse

Get user

Operation ID:

GetUser

Returns authenticated user information.

Returns

User Response

UserResponse

Import transactions

Operation ID:

ImportTransactions

Imports available transactions on all linked accounts for the given budget. Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import. Sending a request to this endpoint is the equivalent of clicking "Import" on each account in the web application or tapping the "New Transactions" banner in the mobile applications. The response for this endpoint contains the transaction ids that have been imported.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).

Returns

Transactions Import Response

TransactionsImportResponse

Update month category

Operation ID:

UpdateMonthCategory

Update a category for a specific month. Only budgeted amount can be updated.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Month	month	True	date	The budget month in ISO format (e.g. 2016-12-01). ("current" can also be used to specify the current calendar month (UTC))
Category ID	category_id	True	string	The identifier of the category.
Budgeted	budgeted	True	integer	Budgeted amount in milliunits format.

Returns

Save Category Response

SaveCategoryResponse

Update transaction

Operation ID:

UpdateTransaction

Updates a single transaction.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
Transaction ID	transaction_id	True	string	The identifier of the transaction.
Account ID	account_id	True	string	The account identifier.
Date	date	True	date	The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.
Amount	amount	True	integer	The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
Payee ID	payee_id		uuid	The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as transfer_payee_id on the account resource.
Payee	payee_name		string	The payee name. If a payee_name value is provided and payee_id has a null value, the payee_name value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified) or (2) a payee with the same name or (3) creation of a new payee.
Category ID	category_id		uuid	The category for the transaction. To configure a split transaction, you can specify null for category_id and provide a subtransactions array as part of the transaction object. If an existing transaction is a split, the category_id cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.
Memo	memo		string	The memo.
Cleared	cleared		string	The cleared status of the transaction.
Approved	approved		boolean	Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
Flag Color	flag_color		string	The transaction flag.
Import ID	import_id		string	If specified, the new transaction will be assigned this import_id and considered "imported". We will also attempt to match this imported transaction to an existing "user-entered" transaction on the same account, with the same amount, and with a date +/-10 days from the imported transaction date. Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. Using a consistent format will prevent duplicates through Direct Import and File Based Import. If import_id is omitted or specified as null, the transaction will be treated as a "user-entered" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API).
Amount	amount	True	integer	The subtransaction amount in milliunits format.
Payee ID	payee_id		uuid	The payee for the subtransaction.
Payee	payee_name		string	The payee name. If a payee_name value is provided and payee_id has a null value, the payee_name value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified on parent transaction) or (2) a payee with the same name or (3) creation of a new payee.
Category ID	category_id		uuid	The category for the subtransaction. Credit Card Payment categories are not permitted and will be ignored if supplied.
Memo	memo		string	The memo.

Returns

Transaction Response

TransactionResponse

Update transactions

Operation ID:

UpdateTransactions

Updates multiple transactions, by id or import_id.

Parameters

Name	Key	Required	Type	Description
Budget ID	budget_id	True	string	The identifier of the budget. "last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
ID	id	True	string	The identifier.
Account ID	account_id	True	string	The account identifier.
Date	date	True	date	The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.
Amount	amount	True	integer	The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
Payee ID	payee_id		uuid	The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as transfer_payee_id on the account resource.
Payee	payee_name		string	The payee name. If a payee_name value is provided and payee_id has a null value, the payee_name value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified) or (2) a payee with the same name or (3) creation of a new payee.
Category ID	category_id		uuid	The category for the transaction. To configure a split transaction, you can specify null for category_id and provide a subtransactions array as part of the transaction object. If an existing transaction is a split, the category_id cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.
Memo	memo		string	The memo.
Cleared	cleared		string	The cleared status of the transaction.
Approved	approved		boolean	Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
Flag Color	flag_color		string	The transaction flag.
Import ID	import_id		string	If specified, the new transaction will be assigned this import_id and considered "imported". We will also attempt to match this imported transaction to an existing "user-entered" transaction on the same account, with the same amount, and with a date +/-10 days from the imported transaction date. Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. Using a consistent format will prevent duplicates through Direct Import and File Based Import. If import_id is omitted or specified as null, the transaction will be treated as a "user-entered" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API).
Amount	amount	True	integer	The subtransaction amount in milliunits format.
Payee ID	payee_id		uuid	The payee for the subtransaction.
Payee	payee_name		string	The payee name. If a payee_name value is provided and payee_id has a null value, the payee_name value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified on parent transaction) or (2) a payee with the same name or (3) creation of a new payee.
Category ID	category_id		uuid	The category for the subtransaction. Credit Card Payment categories are not permitted and will be ignored if supplied.
Memo	memo		string	The memo.

Returns

Save Transactions Response

SaveTransactionsResponse

Definitions

UserResponse

Name	Path	Type	Description
Data	data	Data

User

Name	Path	Type	Description
ID	id	string	The identifier.

DateFormat

The date format setting for the budget. In some cases the format will not be available and will be specified as null.

Name	Path	Type	Description
Format	format	string	The format.

CurrencyFormat

The currency format setting for the budget. In some cases the format will not be available and will be specified as null.

Name	Path	Type	Description
ISO Code	iso_code	string	The ISO code.
Example Format	example_format	string	The example format.
Decimal Digits	decimal_digits	integer	The decimal digits.
Decimal Separator	decimal_separator	string	The decimal separator.
Symbol First	symbol_first	boolean	Whether symbol is first.
Group Separator	group_separator	string	The group separator.
Currency Symbol	currency_symbol	string	The currency symbol.
Symbol Displayed	display_symbol	boolean	Whether symbol is displayed.

BudgetSummaryResponse

Name	Path	Type	Description
Data1	data	Data1

BudgetSummary

Name	Path	Type	Description
ID	id	string	The identifier.
Name	name	string	The name.
Last Modified On	last_modified_on	date-time	The last time any changes were made to the budget from either a web or mobile client.
First Month	first_month	date	The earliest budget month.
Last Month	last_month	date	The latest budget month.
Date Format	date_format	DateFormat	The date format setting for the budget. In some cases the format will not be available and will be specified as null.
Currency Format	currency_format	CurrencyFormat	The currency format setting for the budget. In some cases the format will not be available and will be specified as null.
Accounts	accounts	array of Account	The budget accounts (only included if include_accounts=true specified as query parameter).

BudgetDetailResponse

Name	Path	Type	Description
Data2	data	Data2

BudgetDetail

Name	Path	Type	Description
ID	id	string	The identifier.
Name	name	string	The name.
Last Modified On	last_modified_on	date-time	The last time any changes were made to the budget from either a web or mobile client.
First Month	first_month	date	The earliest budget month.
Last Month	last_month	date	The latest budget month.
Date Format	date_format	DateFormat	The date format setting for the budget. In some cases the format will not be available and will be specified as null.
Currency Format	currency_format	CurrencyFormat	The currency format setting for the budget. In some cases the format will not be available and will be specified as null.
Accounts	accounts	array of Account	The budget accounts (only included if include_accounts=true specified as query parameter).
Payees	payees	array of Payee
Payee Locations	payee_locations	array of PayeeLocation
Category Groups	category_groups	array of CategoryGroup
Categories	categories	array of Category
Months	months	array of MonthDetail
Transactions	transactions	array of TransactionSummary
Subtransactions	subtransactions	array of SubTransaction
Scheduled Transactions	scheduled_transactions	array of ScheduledTransactionSummary
Scheduled Subtransactions	scheduled_subtransactions	array of ScheduledSubTransaction

BudgetSettingsResponse

Name	Path	Type	Description
Data3	data	Data3

BudgetSettings

Name	Path	Type	Description
Date Format	date_format	DateFormat	The date format setting for the budget. In some cases the format will not be available and will be specified as null.
Currency Format	currency_format	CurrencyFormat	The currency format setting for the budget. In some cases the format will not be available and will be specified as null.

AccountsResponse

Name	Path	Type	Description
Data4	data	Data4

AccountResponse

Name	Path	Type	Description
Data5	data	Data5

Account

Name	Path	Type	Description
ID	id	string	The identifier.
Name	name	string	The name.
Type	type	Type	The type of account. Note: payPal, merchantAccount, investmentAccount, and mortgage types have been deprecated and will be removed in the future.
On Budget	on_budget	boolean	Whether this account is on budget or not
Closed	closed	boolean	Whether this account is closed or not
Note	note	string	The note.
Balance	balance	integer	The current balance of the account in milliunits format.
Cleared Balance	cleared_balance	integer	The current cleared balance of the account in milliunits format.
Uncleared Balance	uncleared_balance	integer	The current uncleared balance of the account in milliunits format.
Transfer Payee ID	transfer_payee_id	string	The payee identifier which should be used when transferring to this account.
Direct Import Linked	direct_import_linked	boolean	Whether or not the account is linked to a financial institution for automatic transaction import.
Direct Import In Error	direct_import_in_error	boolean	If an account linked to a financial institution (direct_import_linked=true) and the linked connection is not in a healthy state, this will be true.
Deleted	deleted	boolean	Whether or not the account has been deleted. Deleted accounts will only be included in delta requests.

CategoriesResponse

Name	Path	Type	Description
Data6	data	Data6

CategoryResponse

Name	Path	Type	Description
Data7	data	Data7

CategoryGroupWithCategories

Name	Path	Type	Description
ID	id	string	The identifier.
Name	name	string	The name.
Hidden	hidden	boolean	Whether or not the category group is hidden.
Deleted	deleted	boolean	Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests.
Catagories	categories	array of Category	Category group categories. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).

CategoryGroup

Name	Path	Type	Description
ID	id	string	The identifier.
Name	name	string	The name.
Hidden	hidden	boolean	Whether or not the category group is hidden.
Deleted	deleted	boolean	Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests.

Category

Name	Path	Type	Description
ID	id	string	The identifier.
Category Group ID	category_group_id	string	The category group identifier.
Name	name	string	The name.
Hidden	hidden	boolean	Whether or not the category is hidden.
Original Category Group ID	original_category_group_id	uuid	If category is hidden this is the identifier of the category group it originally belonged to before it was hidden.
Note	note	string	The note.
Budgeted	budgeted	integer	Budgeted amount in milliunits format.
Activity	activity	integer	Activity amount in milliunits format.
Balance	balance	integer	Balance in milliunits format.
Goal Type	goal_type	GoalType	The type of goal, if the category has a goal (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending')
Goal Creation Month	goal_creation_month	date	The month a goal was created.
Goal Target	goal_target	integer	The goal target amount in milliunits.
Goal Target Month	goal_target_month	date	The original target month for the goal to be completed. Only some goal types specify this date.
Goal Percentage Complete	goal_percentage_complete	integer	The percentage completion of the goal.
Goal Months to Budget	goal_months_to_budget	integer	The number of months, including the current month, left in the current goal period.
Goal Under Funded	goal_under_funded	integer	The amount of funding still needed in the current month to stay on track towards completing the goal within the current goal period. This amount will generally correspond to the 'Underfunded' amount in the web and mobile clients except when viewing a category with a Needed for Spending Goal in a future month. The web and mobile clients will ignore any funding from a prior goal period when viewing category with a Needed for Spending Goal in a future month.
Goal Overall Funded	goal_overall_funded	integer	The total amount funded towards the goal within the current goal period.
Goal Overall Left	goal_overall_left	integer	The amount of funding still needed to complete the goal within the current goal period.
Deleted	deleted	boolean	Whether or not the category has been deleted. Deleted categories will only be included in delta requests.

SaveCategoryResponse

Name	Path	Type	Description
Data8	data	Data8

PayeesResponse

Name	Path	Type	Description
Data9	data	Data9

PayeeResponse

Name	Path	Type	Description
Data10	data	Data10

Payee

Name	Path	Type	Description
ID	id	string	The identifier.
Name	name	string	The name.
Transfer Account ID	transfer_account_id	string	If a transfer payee, the account_id to which this payee transfers to.
Deleted	deleted	boolean	Whether or not the payee has been deleted. Deleted payees will only be included in delta requests.

PayeeLocationsResponse

Name	Path	Type	Description
Data11	data	Data11

PayeeLocationResponse

Name	Path	Type	Description
Data12	data	Data12

PayeeLocation

Name	Path	Type	Description
ID	id	string	The identifier.
Payee ID	payee_id	string	The payee identifier.
Latitude	latitude	string	The latitude.
Longitude	longitude	string	The longitude.
Deleted	deleted	boolean	Whether or not the payee location has been deleted. Deleted payee locations will only be included in delta requests.

TransactionsResponse

Name	Path	Type	Description
Data13	data	Data13

HybridTransactionsResponse

Name	Path	Type	Description
Data14	data	Data14

SaveTransactionsResponse

Name	Path	Type	Description
Data15	data	Data15

TransactionResponse

Name	Path	Type	Description
Data16	data	Data16

TransactionSummary

Name	Path	Type	Description
ID	id	string	The identifier.
Date	date	date	The transaction date in ISO format (e.g. 2016-12-01).
Amount	amount	integer	The transaction amount in milliunits format.
Memo	memo	string	The memo.
Cleared	cleared	Cleared	The cleared status of the transaction.
Approved	approved	boolean	Whether or not the transaction is approved.
Flag Color	flag_color	FlagColor	The transaction flag.
Account ID	account_id	string	The account identifier.
Payee ID	payee_id	string	The payee identifier.
Category ID	category_id	string	The category identifier.
Transfer Account ID	transfer_account_id	uuid	If a transfer transaction, the account to which it transfers.
Transfer Transaction ID	transfer_transaction_id	string	If a transfer transaction, the identifier of transaction on the other side of the transfer.
Matched Transaction ID	matched_transaction_id	string	If transaction is matched, the identifier of the matched transaction.
Import ID	import_id	string	If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'.
Deleted	deleted	boolean	Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests.

TransactionDetail

Name	Path	Type	Description
ID	id	string	The identifier.
Date	date	date	The transaction date in ISO format (e.g. 2016-12-01).
Amount	amount	integer	The transaction amount in milliunits format.
Memo	memo	string	The memo.
Cleared	cleared	Cleared	The cleared status of the transaction.
Approved	approved	boolean	Whether or not the transaction is approved.
Flag Color	flag_color	FlagColor	The transaction flag.
Account ID	account_id	string	The account identifier.
Payee ID	payee_id	string	The payee identifier.
Category ID	category_id	string	The category identifier.
Transfer Account ID	transfer_account_id	uuid	If a transfer transaction, the account to which it transfers.
Transfer Transaction ID	transfer_transaction_id	string	If a transfer transaction, the identifier of transaction on the other side of the transfer.
Matched Transaction ID	matched_transaction_id	string	If transaction is matched, the identifier of the matched transaction.
Import ID	import_id	string	If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'.
Deleted	deleted	boolean	Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests.
Account Name	account_name	string	The account name.
Payee	payee_name	string	The payee name.
Category	category_name	string	The category name.
Subtransactions	subtransactions	array of SubTransaction	If a split transaction, the subtransactions.

HybridTransaction

Name	Path	Type	Description
ID	id	string	The identifier.
Date	date	date	The transaction date in ISO format (e.g. 2016-12-01).
Amount	amount	integer	The transaction amount in milliunits format.
Memo	memo	string	The memo.
Cleared	cleared	Cleared	The cleared status of the transaction.
Approved	approved	boolean	Whether or not the transaction is approved.
Flag Color	flag_color	FlagColor	The transaction flag.
Account ID	account_id	string	The account identifier.
Payee ID	payee_id	string	The payee identifier.
Category ID	category_id	string	The category identifier.
Transfer Account ID	transfer_account_id	uuid	If a transfer transaction, the account to which it transfers.
Transfer Transaction ID	transfer_transaction_id	string	If a transfer transaction, the identifier of transaction on the other side of the transfer.
Matched Transaction ID	matched_transaction_id	string	If transaction is matched, the identifier of the matched transaction.
Import ID	import_id	string	If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'.
Deleted	deleted	boolean	Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests.
Type3	type	Type3	Whether the hybrid transaction represents a regular transaction or a subtransaction
Parent Transaction ID	parent_transaction_id	string	For subtransaction types, this is the identifier of the parent transaction. For transaction types, this identifier will be always be null.
Account Name	account_name	string	The account name.
Payee	payee_name	string	The payee name.
Category	category_name	string	The category name.

TransactionsImportResponse

Name	Path	Type	Description
Data17	data	Data17

BulkResponse

Name	Path	Type	Description
Data18	data	Data18

SubTransaction

Name	Path	Type	Description
ID	id	string	The identifier.
Transaction ID	transaction_id	string	The transaction.
Amount	amount	integer	The subtransaction amount in milliunits format.
Memo	memo	string	The memo.
Payee ID	payee_id	string	The payee identifier.
Payee	payee_name	string	The payee name.
Category ID	category_id	string	The category identifier.
Category	category_name	string	The category name.
Transfer Account ID	transfer_account_id	uuid	If a transfer, the account_id which the subtransaction transfers to.
Transfer Transaction ID	transfer_transaction_id	string	If a transfer, the identifier of transaction on the other side of the transfer.
Deleted	deleted	boolean	Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests.

ScheduledTransactionsResponse

Name	Path	Type	Description
Data19	data	Data19

ScheduledTransactionResponse

Name	Path	Type	Description
Data20	data	Data20

ScheduledTransactionSummary

Name	Path	Type	Description
ID	id	string	The identifier.
First Date	date_first	date	The first date for which the Scheduled Transaction was scheduled.
Next Date	date_next	date	The next date for which the Scheduled Transaction is scheduled.
Frequency	frequency	Frequency	The frequency.
Amount	amount	integer	The scheduled transaction amount in milliunits format.
Memo	memo	string	The memo.
FlagColor1	flag_color	FlagColor1	The scheduled transaction flag.
Account ID	account_id	string	The account identifier.
Payee ID	payee_id	string	The payee identifier.
Category ID	category_id	string	The category identifier.
Transfer Account ID	transfer_account_id	uuid	If a transfer, the account_id which the scheduled transaction transfers to.
Deleted	deleted	boolean	Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests.

ScheduledTransactionDetail

Name	Path	Type	Description
ID	id	string	The identifier.
First Date	date_first	date	The first date for which the Scheduled Transaction was scheduled.
Next Date	date_next	date	The next date for which the Scheduled Transaction is scheduled.
Frequency	frequency	Frequency	The frequency.
Amount	amount	integer	The scheduled transaction amount in milliunits format.
Memo	memo	string	The memo.
FlagColor1	flag_color	FlagColor1	The scheduled transaction flag.
Account ID	account_id	string	The account identifier.
Payee ID	payee_id	string	The payee identifier.
Category ID	category_id	string	The category identifier.
Transfer Account ID	transfer_account_id	uuid	If a transfer, the account_id which the scheduled transaction transfers to.
Deleted	deleted	boolean	Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests.
Account Name	account_name	string	The account name.
Payee	payee_name	string	The payee name.
Category	category_name	string	The category name.
subtransactions	subtransactions	array of ScheduledSubTransaction	If a split scheduled transaction, the subtransactions.

ScheduledSubTransaction

Name	Path	Type	Description
ID	id	string	The identifier.
Scheduled Transaction ID	scheduled_transaction_id	string	The scheduled transaction identifier.
Amount	amount	integer	The scheduled subtransaction amount in milliunits format.
Memo	memo	string	The memo.
Payee ID	payee_id	string	The payee identifier.
Category ID	category_id	string	The category identifier.
Transfer Account ID	transfer_account_id	uuid	If a transfer, the account_id which the scheduled subtransaction transfers to.
Deleted	deleted	boolean	Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests.

MonthSummariesResponse

Name	Path	Type	Description
Data21	data	Data21

MonthDetailResponse

Name	Path	Type	Description
Data22	data	Data22

MonthSummary

Name	Path	Type	Description
Month	month	date	The month.
Note	note	string	The note.
Income	income	integer	The total amount of transactions categorized to 'Inflow: Ready to Assign' in the month.
Budgeted	budgeted	integer	The total amount budgeted in the month.
Activity	activity	integer	The total amount of transactions in the month, excluding those categorized to 'Inflow: Ready to Assign'.
To Be Budgeted	to_be_budgeted	integer	The available amount for 'Ready to Assign'.
Age of Money	age_of_money	integer	The Age of Money as of the month.
Deleted	deleted	boolean	Whether or not the month has been deleted. Deleted months will only be included in delta requests.

MonthDetail

Name	Path	Type	Description
Month	month	date	The month.
Note	note	string	The note.
Income	income	integer	The total amount of transactions categorized to 'Inflow: Ready to Assign' in the month.
Budgeted	budgeted	integer	The total amount budgeted in the month.
Activity	activity	integer	The total amount of transactions in the month, excluding those categorized to 'Inflow: Ready to Assign'.
To Be Budgeted	to_be_budgeted	integer	The available amount for 'Ready to Assign'.
Age of Money	age_of_money	integer	The Age of Money as of the month.
Deleted	deleted	boolean	Whether or not the month has been deleted. Deleted months will only be included in delta requests.
Categories	categories	array of Category	The budget month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified.

Bulk

Name	Path	Type	Description
Transaction IDs	transaction_ids	array of string	The list of Transaction ids that were created.
Duplicate Import IDs	duplicate_import_ids	array of string	If any Transactions were not created because they had an import_id matching a transaction already on the same account, the specified import_id(s) will be included in this list.

Cleared

The cleared status of the transaction.

The cleared status of the transaction.

Cleared

string

Data

Name	Path	Type	Description
User	user	User

Data1

Name	Path	Type	Description
Budgets	budgets	array of BudgetSummary
Budget Summary	default_budget	BudgetSummary

Data2

Name	Path	Type	Description
Budget Detail	budget	BudgetDetail
Server Knowledge	server_knowledge	integer	The knowledge of the server.

Data3

Name	Path	Type	Description
Budget Settings	settings	BudgetSettings

Data4

Name	Path	Type	Description
Accounts	accounts	array of Account
Server Knowledge	server_knowledge	integer	The knowledge of the server.

Data5

Name	Path	Type	Description
Account	account	Account

Data6

Name	Path	Type	Description
Category Groups	category_groups	array of CategoryGroupWithCategories	The category groups.
Server Knowledge	server_knowledge	integer	The knowledge of the server.

Data7

Name	Path	Type	Description
Category	category	Category

Data8

Name	Path	Type	Description
Category	category	Category
Server Knowledge	server_knowledge	integer	The knowledge of the server.

Data9

Name	Path	Type	Description
Payees	payees	array of Payee	The payees.
Server Knowledge	server_knowledge	integer	The knowledge of the server.

Data10

Name	Path	Type	Description
Payee	payee	Payee

Data11

Name	Path	Type	Description
Payee Locations	payee_locations	array of PayeeLocation	The payee locations.

Data12

Name	Path	Type	Description
Payee Location	payee_location	PayeeLocation

Data13

Name	Path	Type	Description
Transactions	transactions	array of TransactionDetail	The transactions.
Server Knowledge	server_knowledge	integer	The knowledge of the server.

Data14

Name	Path	Type	Description
Transactions	transactions	array of HybridTransaction	The transactions.

Data15

Name	Path	Type	Description
Transaction IDs	transaction_ids	array of string	The transaction ids that were saved.
Transaction Detail	transaction	TransactionDetail
transactions	transactions	array of TransactionDetail	If multiple transactions were specified, the transactions that were saved.
Duplicate Import IDs	duplicate_import_ids	array of string	If multiple transactions were specified, a list of import_ids that were not created because of an existing import_id found on the same account.
Server Knowledge	server_knowledge	integer	The knowledge of the server.

Data16

Name	Path	Type	Description
Transaction Detail	transaction	TransactionDetail

Data17

Name	Path	Type	Description
Transaction IDs	transaction_ids	array of string	The list of transaction ids that were imported.

Data18

Name	Path	Type	Description
Bulk	bulk	Bulk

Data19

Name	Path	Type	Description
scheduled_transactions	scheduled_transactions	array of ScheduledTransactionDetail
Server Knowledge	server_knowledge	integer	The knowledge of the server.

Data20

Name	Path	Type	Description
Scheduled Transaction Detail	scheduled_transaction	ScheduledTransactionDetail

Data21

Name	Path	Type	Description
months	months	array of MonthSummary
Server Knowledge	server_knowledge	integer	The knowledge of the server.

Data22

Name	Path	Type	Description
Month Detail	month	MonthDetail

FlagColor

The transaction flag.

The transaction flag.

Flag Color

string

FlagColor1

The scheduled transaction flag.

The scheduled transaction flag.

FlagColor1

string

Frequency

The frequency.

The frequency.

Frequency

string

GoalType

The type of goal, if the category has a goal (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending')

The type of goal, if the category has a goal (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending')

Goal Type

string

Type

The type of account. Note: payPal, merchantAccount, investmentAccount, and mortgage types have been deprecated and will be removed in the future.

The type of account. Note: payPal, merchantAccount, investmentAccount, and mortgage types have been deprecated and will be removed in the future.

Type

string

Type3

Whether the hybrid transaction represents a regular transaction or a subtransaction

Whether the hybrid transaction represents a regular transaction or a subtransaction

Type3

string