Module ynab
API
Definitions
ballerinax/ynab Ballerina library
Overview
YNAB (You Need A Budget) is a personal budgeting platform built around giving every dollar a job. This connector wraps version 1.87.0 of the YNAB REST API and lets Ballerina applications read and manage budget plans, accounts, categories, payees, months, money movements, transactions and scheduled transactions.
Key features
- Read plans and plan settings, with delta requests based on server knowledge
- Manage accounts, categories and category groups, including monthly category budgets
- Create, update, import and delete transactions and scheduled transactions
- Browse payees and payee locations, and create or rename payees
- Review monthly budget summaries and money movements
Setup guide
To use the connector you need a YNAB account and a personal access token.
- Sign in to YNAB.
- Open Account Settings and go to Developer Settings.
- Under Personal Access Tokens, choose New Token, enter your password and copy the generated token. It is shown only once.
Quickstart
To use the ynab connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module
import ballerinax/ynab;
Step 2: Instantiate a new connector
Create a Config.toml file with your access token:
accessToken = "<your-personal-access-token>"
Then create a client in your .bal file:
configurable string accessToken = ?; final ynab:Client ynabClient = check new ({ auth: { token: accessToken } });
Step 3: Invoke the connector operation
public function main() returns error? { ynab:PlanSummaryResponse _ = check ynabClient->getPlans(); }
Step 4: Run the Ballerina application
bal run
Examples
The YNAB connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Monthly budget summary - lists open accounts and balances, summarises a month and flags overspent categories.
- Expense recording workflow - resolves an account and category by name and optionally records an expense.
Clients
ynab: Client
The YNAB API provides access to your You Need A Budget data, including plans, accounts, categories, payees, and transactions. See the API Documentation for details.
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.ynab.com/v1" - URL of the target service
getUser
function getUser(map<string|string[]> headers) returns UserResponse|errorGet user
Return Type
- UserResponse|error - The user info
getPlans
function getPlans(map<string|string[]> headers, *GetPlansQueries queries) returns PlanSummaryResponse|errorGet all plans
Parameters
- queries *GetPlansQueries - Queries to be sent with the request
Return Type
- PlanSummaryResponse|error - The list of plans
getPlanById
function getPlanById(string planId, map<string|string[]> headers, *GetPlanByIdQueries queries) returns PlanDetailResponse|errorGet a plan
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- queries *GetPlanByIdQueries - Queries to be sent with the request
Return Type
- PlanDetailResponse|error - The requested plan
getPlanSettingsById
function getPlanSettingsById(string planId, map<string|string[]> headers) returns PlanSettingsResponse|errorGet plan settings
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
Return Type
- PlanSettingsResponse|error - The requested plan settings
getAccounts
function getAccounts(string planId, map<string|string[]> headers, *GetAccountsQueries queries) returns AccountsResponse|errorGet all accounts
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- queries *GetAccountsQueries - Queries to be sent with the request
Return Type
- AccountsResponse|error - The list of requested accounts
createAccount
function createAccount(string planId, PostAccountWrapper payload, map<string|string[]> headers) returns AccountResponse|errorCreate an account
Parameters
- planId string - The id of the plan ("last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- payload PostAccountWrapper - The account to create
Return Type
- AccountResponse|error - The account was successfully created
getAccountById
function getAccountById(string planId, string accountId, map<string|string[]> headers) returns AccountResponse|errorGet an account
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- accountId string - The id of the account
Return Type
- AccountResponse|error - The requested account
getCategories
function getCategories(string planId, map<string|string[]> headers, *GetCategoriesQueries queries) returns CategoriesResponse|errorGet all categories
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- queries *GetCategoriesQueries - Queries to be sent with the request
Return Type
- CategoriesResponse|error - The categories grouped by category group
createCategory
function createCategory(string planId, PostCategoryWrapper payload, map<string|string[]> headers) returns SaveCategoryResponse|errorCreate a category
Parameters
- planId string - The id of the plan ("last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- payload PostCategoryWrapper - The category to create
Return Type
- SaveCategoryResponse|error - The category was successfully created
getCategoryById
function getCategoryById(string planId, string categoryId, map<string|string[]> headers) returns CategoryResponse|errorGet a category
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- categoryId string - The id of the category
Return Type
- CategoryResponse|error - The requested category
updateCategory
function updateCategory(string planId, string categoryId, PatchCategoryWrapper payload, map<string|string[]> headers) returns SaveCategoryResponse|errorUpdate a category
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- categoryId string - The id of the category
- payload PatchCategoryWrapper - The category to update
Return Type
- SaveCategoryResponse|error - The category was successfully updated
getMonthCategoryById
function getMonthCategoryById(string planId, string month, string categoryId, map<string|string[]> headers) returns CategoryResponse|errorGet a category for a specific plan month
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- month string - The plan month in ISO format (e.g. 2016-12-01) ("current" can also be used to specify the current calendar month (UTC))
- categoryId string - The id of the category
Return Type
- CategoryResponse|error - The requested month category
updateMonthCategory
function updateMonthCategory(string planId, string month, string categoryId, PatchMonthCategoryWrapper payload, map<string|string[]> headers) returns SaveCategoryResponse|errorUpdate a category for a specific month
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- month string - The plan month in ISO format (e.g. 2016-12-01) ("current" can also be used to specify the current calendar month (UTC))
- categoryId string - The id of the category
- payload PatchMonthCategoryWrapper - The category to update. Only
budgeted(assigned) amount can be updated and any other fields specified will be ignored
Return Type
- SaveCategoryResponse|error - The month category was successfully updated
createCategoryGroup
function createCategoryGroup(string planId, PostCategoryGroupWrapper payload, map<string|string[]> headers) returns SaveCategoryGroupResponse|errorCreate a category group
Parameters
- planId string - The id of the plan ("last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- payload PostCategoryGroupWrapper - The category group to create
Return Type
- SaveCategoryGroupResponse|error - The category group was successfully created
updateCategoryGroup
function updateCategoryGroup(string planId, string categoryGroupId, PatchCategoryGroupWrapper payload, map<string|string[]> headers) returns SaveCategoryGroupResponse|errorUpdate a category group
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- categoryGroupId string - The id of the category group
- payload PatchCategoryGroupWrapper - The category group to update
Return Type
- SaveCategoryGroupResponse|error - The category group was successfully updated
getPayees
function getPayees(string planId, map<string|string[]> headers, *GetPayeesQueries queries) returns PayeesResponse|errorGet all payees
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- queries *GetPayeesQueries - Queries to be sent with the request
Return Type
- PayeesResponse|error - The requested list of payees
createPayee
function createPayee(string planId, PostPayeeWrapper payload, map<string|string[]> headers) returns SavePayeeResponse|errorCreate a payee
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- payload PostPayeeWrapper - The payee to create
Return Type
- SavePayeeResponse|error - The payee was successfully created
getPayeeById
function getPayeeById(string planId, string payeeId, map<string|string[]> headers) returns PayeeResponse|errorGet a payee
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- payeeId string - The id of the payee
Return Type
- PayeeResponse|error - The requested payee
updatePayee
function updatePayee(string planId, string payeeId, PatchPayeeWrapper payload, map<string|string[]> headers) returns SavePayeeResponse|errorUpdate a payee
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- payeeId string - The id of the payee
- payload PatchPayeeWrapper - The payee to update
Return Type
- SavePayeeResponse|error - The payee was successfully updated
getPayeeLocations
function getPayeeLocations(string planId, map<string|string[]> headers) returns PayeeLocationsResponse|errorGet all payee locations
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
Return Type
- PayeeLocationsResponse|error - The list of payee locations
getPayeeLocationById
function getPayeeLocationById(string planId, string payeeLocationId, map<string|string[]> headers) returns PayeeLocationResponse|errorGet a payee location
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- payeeLocationId string - id of payee location
Return Type
- PayeeLocationResponse|error - The payee location
getPayeeLocationsByPayee
function getPayeeLocationsByPayee(string planId, string payeeId, map<string|string[]> headers) returns PayeeLocationsResponse|errorGet all locations for a payee
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- payeeId string - id of payee
Return Type
- PayeeLocationsResponse|error - The list of requested payee locations
getPlanMonths
function getPlanMonths(string planId, map<string|string[]> headers, *GetPlanMonthsQueries queries) returns MonthSummariesResponse|errorGet all plan months
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- queries *GetPlanMonthsQueries - Queries to be sent with the request
Return Type
- MonthSummariesResponse|error - The list of plan months
getPlanMonth
function getPlanMonth(string planId, string month, map<string|string[]> headers) returns MonthDetailResponse|errorGet a plan month
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- month string - The plan month in ISO format (e.g. 2016-12-01) ("current" can also be used to specify the current calendar month (UTC))
Return Type
- MonthDetailResponse|error - The plan month detail
getMoneyMovements
function getMoneyMovements(string planId, map<string|string[]> headers) returns MoneyMovementsResponse|errorGet all money movements
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
Return Type
- MoneyMovementsResponse|error - The list of requested money movements
getMoneyMovementsByMonth
function getMoneyMovementsByMonth(string planId, string month, map<string|string[]> headers) returns MoneyMovementsResponse|errorGet money movements for a plan month
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- month string - The plan month in ISO format (e.g. 2016-12-01) ("current" can also be used to specify the current calendar month (UTC))
Return Type
- MoneyMovementsResponse|error - The list of requested money movements
getMoneyMovementGroups
function getMoneyMovementGroups(string planId, map<string|string[]> headers) returns MoneyMovementGroupsResponse|errorGet all money movement groups
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
Return Type
- MoneyMovementGroupsResponse|error - The list of requested money movement groups
getMoneyMovementGroupsByMonth
function getMoneyMovementGroupsByMonth(string planId, string month, map<string|string[]> headers) returns MoneyMovementGroupsResponse|errorGet money movement groups for a plan month
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- month string - The plan month in ISO format (e.g. 2016-12-01) ("current" can also be used to specify the current calendar month (UTC))
Return Type
- MoneyMovementGroupsResponse|error - The list of requested money movement groups
getTransactions
function getTransactions(string planId, map<string|string[]> headers, *GetTransactionsQueries queries) returns TransactionsResponse|errorGet transactions
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- queries *GetTransactionsQueries - Queries to be sent with the request
Return Type
- TransactionsResponse|error - The list of requested transactions
createTransaction
function createTransaction(string planId, PostTransactionsWrapper payload, map<string|string[]> headers) returns SaveTransactionsResponse|errorCreate a single transaction or multiple transactions
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- payload PostTransactionsWrapper - The transaction or transactions to create. To create a single transaction you can specify a value for the
transactionobject and to create multiple transactions you can specify an array oftransactions. It is expected that you will only provide a value for one of these objects
Return Type
- SaveTransactionsResponse|error - The transaction or transactions were successfully created
updateTransactions
function updateTransactions(string planId, PatchTransactionsWrapper payload, map<string|string[]> headers) returns SaveTransactionsResponse|errorUpdate multiple transactions
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- payload PatchTransactionsWrapper - The transactions to update. Each transaction must have either an
idorimport_idspecified. Ifidis specified as null animport_idvalue can be provided which will allow transaction(s) to be updated by itsimport_id. If anidis specified, it will always be used for lookup. You should not specify bothidandimport_id. Updating animport_idon an existing transaction is not allowed; if animport_idis specified, it will only be used to lookup the transaction
Return Type
- SaveTransactionsResponse|error - The transactions were successfully updated
importTransactions
function importTransactions(string planId, map<string|string[]> headers) returns TransactionsImportResponse|errorImport transactions
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
Return Type
- TransactionsImportResponse|error - The request was successful but there were no transactions to import
getTransactionById
function getTransactionById(string planId, string transactionId, map<string|string[]> headers) returns TransactionResponse|errorGet a transaction
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- transactionId string - The id of the transaction
Return Type
- TransactionResponse|error - The requested transaction
updateTransaction
function updateTransaction(string planId, string transactionId, PutTransactionWrapper payload, map<string|string[]> headers) returns TransactionResponse|errorUpdate a transaction
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- transactionId string - The id of the transaction
- payload PutTransactionWrapper - The transaction to update
Return Type
- TransactionResponse|error - The transaction was successfully updated
deleteTransaction
function deleteTransaction(string planId, string transactionId, map<string|string[]> headers) returns TransactionResponse|errorDelete a transaction
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- transactionId string - The id of the transaction
Return Type
- TransactionResponse|error - The transaction was successfully deleted
getTransactionsByAccount
function getTransactionsByAccount(string planId, string accountId, map<string|string[]> headers, *GetTransactionsByAccountQueries queries) returns TransactionsResponse|errorGet account transactions
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- accountId string - The id of the account
- queries *GetTransactionsByAccountQueries - Queries to be sent with the request
Return Type
- TransactionsResponse|error - The list of requested transactions
getTransactionsByCategory
function getTransactionsByCategory(string planId, string categoryId, map<string|string[]> headers, *GetTransactionsByCategoryQueries queries) returns HybridTransactionsResponse|errorGet category transactions
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- categoryId string - The id of the category
- queries *GetTransactionsByCategoryQueries - Queries to be sent with the request
Return Type
- HybridTransactionsResponse|error - The list of requested transactions
getTransactionsByPayee
function getTransactionsByPayee(string planId, string payeeId, map<string|string[]> headers, *GetTransactionsByPayeeQueries queries) returns HybridTransactionsResponse|errorGet payee transactions
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- payeeId string - The id of the payee
- queries *GetTransactionsByPayeeQueries - Queries to be sent with the request
Return Type
- HybridTransactionsResponse|error - The list of requested transactions
getTransactionsByMonth
function getTransactionsByMonth(string planId, string month, map<string|string[]> headers, *GetTransactionsByMonthQueries queries) returns TransactionsResponse|errorGet plan month transactions
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- month string - The plan month in ISO format (e.g. 2016-12-01) ("current" can also be used to specify the current calendar month (UTC))
- queries *GetTransactionsByMonthQueries - Queries to be sent with the request
Return Type
- TransactionsResponse|error - The list of requested transactions
getScheduledTransactions
function getScheduledTransactions(string planId, map<string|string[]> headers, *GetScheduledTransactionsQueries queries) returns ScheduledTransactionsResponse|errorGet all scheduled transactions
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- queries *GetScheduledTransactionsQueries - Queries to be sent with the request
Return Type
- ScheduledTransactionsResponse|error - The list of requested scheduled transactions
createScheduledTransaction
function createScheduledTransaction(string planId, PostScheduledTransactionWrapper payload, map<string|string[]> headers) returns ScheduledTransactionResponse|errorCreate a scheduled transaction
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- payload PostScheduledTransactionWrapper - The scheduled transaction to create
Return Type
- ScheduledTransactionResponse|error - The scheduled transaction was successfully created
getScheduledTransactionById
function getScheduledTransactionById(string planId, string scheduledTransactionId, map<string|string[]> headers) returns ScheduledTransactionResponse|errorGet a scheduled transaction
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- scheduledTransactionId string - The id of the scheduled transaction
Return Type
- ScheduledTransactionResponse|error - The requested Scheduled Transaction
updateScheduledTransaction
function updateScheduledTransaction(string planId, string scheduledTransactionId, PutScheduledTransactionWrapper payload, map<string|string[]> headers) returns ScheduledTransactionResponse|errorUpdate a scheduled transaction
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- scheduledTransactionId string - The id of the scheduled transaction
- payload PutScheduledTransactionWrapper - The scheduled transaction to update
Return Type
- ScheduledTransactionResponse|error - The scheduled transaction was successfully updated
deleteScheduledTransaction
function deleteScheduledTransaction(string planId, string scheduledTransactionId, map<string|string[]> headers) returns ScheduledTransactionResponse|errorDelete a scheduled transaction
Parameters
- planId string - The id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- scheduledTransactionId string - The id of the scheduled transaction
Return Type
- ScheduledTransactionResponse|error - The scheduled transaction was successfully deleted
Records
ynab: Account
Fields
- Fields Included from *AccountBase
- note anydata
- lastReconciledAt anydata
- transferPayeeId anydata
- directImportLinked boolean
- type AccountType
- directImportInError boolean
- debtInterestRates LoanAccountPeriodicValue
- unclearedBalance int
- debtMinimumPayments LoanAccountPeriodicValue
- deleted boolean
- balance int
- name string
- clearedBalance int
- closed boolean
- id string
- debtEscrowAmounts LoanAccountPeriodicValue
- debtOriginalBalance anydata
- onBudget boolean
- anydata...
- clearedBalanceFormatted? string - The current cleared balance of the account formatted in the plan's currency format
- unclearedBalanceCurrency? decimal - The current uncleared balance of the account as a decimal currency amount
- balanceFormatted? string - The current available balance of the account formatted in the plan's currency format
- balanceCurrency? decimal - The current available balance of the account as a decimal currency amount
- clearedBalanceCurrency? decimal - The current cleared balance of the account as a decimal currency amount
- unclearedBalanceFormatted? string - The current uncleared balance of the account formatted in the plan's currency format
ynab: AccountBase
Fields
- note? anydata -
- lastReconciledAt? anydata - A date/time specifying when the account was last reconciled
- transferPayeeId anydata - The payee id which should be used when transferring to this account
- directImportLinked? boolean - Whether or not the account is linked to a financial institution for automatic transaction import
- 'type AccountType - The type of account
- directImportInError? 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
- debtInterestRates? LoanAccountPeriodicValue -
- unclearedBalance int - The current uncleared balance of the account in milliunits format
- debtMinimumPayments? LoanAccountPeriodicValue -
- deleted boolean - Whether or not the account has been deleted. Deleted accounts will only be included in delta requests
- balance int - The current available balance of the account in milliunits format
- name string -
- clearedBalance int - The current cleared balance of the account in milliunits format
- closed boolean - Whether this account is closed or not
- id string -
- debtEscrowAmounts? LoanAccountPeriodicValue -
- debtOriginalBalance? anydata - This field is deprecated and will always be null
- onBudget boolean - Whether this account is "on budget" or not
ynab: AccountResponse
Fields
- data AccountResponseData -
ynab: AccountResponseData
Fields
- account Account -
ynab: AccountsResponse
Fields
- data AccountsResponseData -
ynab: AccountsResponseData
Fields
- serverKnowledge int - The knowledge of the server
- accounts Account[] -
ynab: CategoriesResponse
Fields
- data CategoriesResponseData -
ynab: CategoriesResponseData
Fields
- serverKnowledge int - The knowledge of the server
- categoryGroups CategoryGroupWithCategories[] -
ynab: Category
Fields
- Fields Included from *CategoryBase
- goalCadence anydata
- note anydata
- internal boolean
- goalType "DEBT"|()|"TB"|"TBD"|"MF"|"NEED"
- hidden boolean
- activity int
- goalTarget anydata
- originalCategoryGroupId anydata
- budgeted int
- categoryGroupName string
- balance int
- id string
- goalOverallLeft anydata
- goalDay anydata
- goalPercentageComplete anydata
- goalUnderFunded anydata
- goalOverallFunded anydata
- goalSnoozedAt anydata
- goalCadenceFrequency anydata
- deleted boolean
- goalMonthsToBudget anydata
- goalTargetMonth anydata
- name string
- goalTargetDate anydata
- goalCreationMonth anydata
- categoryGroupId string
- goalNeedsWholeAmount anydata
- anydata...
- budgetedCurrency? decimal - Assigned (budgeted) amount of the category as a decimal currency amount
- balanceFormatted? string - Available balance of the category formatted in the plan's currency format
- budgetedFormatted? string - Assigned (budgeted) amount of the category formatted in the plan's currency format
- goalUnderFundedCurrency? anydata - The goal underfunded amount as a decimal currency amount
- goalOverallFundedFormatted? anydata - The total amount funded towards the goal formatted in the plan's currency format
- goalOverallLeftCurrency? anydata - The amount of funding still needed to complete the goal as a decimal currency amount
- goalUnderFundedFormatted? anydata - The goal underfunded amount formatted in the plan's currency format
- balanceCurrency? decimal - Available balance of the category as a decimal currency amount
- activityCurrency? decimal - Activity of the category as a decimal currency amount
- activityFormatted? string - Activity of the category formatted in the plan's currency format
- goalOverallFundedCurrency? anydata - The total amount funded towards the goal as a decimal currency amount
- goalTargetCurrency? anydata - The goal target amount as a decimal currency amount
- goalOverallLeftFormatted? anydata - The amount of funding still needed to complete the goal formatted in the plan's currency format
- goalTargetFormatted? anydata - The goal target amount formatted in the plan's currency format
ynab: CategoryBase
Fields
- goalCadence? anydata - The goal cadence. Value in range 0-14. There are two subsets of these values which behave differently. For values 0, 1, 2, and 13, the goal's due date repeats every goal_cadence * goal_cadence_frequency, where 0 = None, 1 = Monthly, 2 = Weekly, and 13 = Yearly. For example, goal_cadence 1 with goal_cadence_frequency 2 means the goal is due every other month. For values 3-12 and 14, goal_cadence_frequency is ignored and the goal's due date repeats every goal_cadence, where 3 = Every 2 Months, 4 = Every 3 Months, ..., 12 = Every 11 Months, and 14 = Every 2 Years
- note? anydata -
- internal boolean - Whether or not the category is internal
- goalType? "TB"|"TBD"|"MF"|"NEED"|"DEBT"? - 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')
- hidden boolean - Whether or not the category is hidden
- activity int - Activity amount in milliunits format
- goalTarget? anydata - The goal target amount in milliunits
- originalCategoryGroupId? anydata - DEPRECATED: No longer used. Value will always be null
- budgeted int - Assigned (budgeted) amount in milliunits format
- categoryGroupName? string -
- balance int - Available balance in milliunits format
- id string -
- goalOverallLeft? anydata - The amount of funding still needed to complete the goal within the current goal period
- goalDay? anydata - A day offset modifier for the goal's due date. When goal_cadence is 2 (Weekly), this value specifies which day of the week the goal is due (0 = Sunday, 6 = Saturday). Otherwise, this value specifies which day of the month the goal is due (1 = 1st, 31 = 31st, null = Last day of Month)
- goalPercentageComplete? anydata - The percentage completion of the goal
- goalUnderFunded? anydata - 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
- goalOverallFunded? anydata - The total amount funded towards the goal within the current goal period
- goalSnoozedAt? anydata - The date/time the goal was snoozed. If the goal is not snoozed, this will be null
- goalCadenceFrequency? anydata - The goal cadence frequency. When goal_cadence is 0, 1, 2, or 13, a goal's due date repeats every goal_cadence * goal_cadence_frequency. For example, goal_cadence 1 with goal_cadence_frequency 2 means the goal is due every other month. When goal_cadence is 3-12 or 14, goal_cadence_frequency is ignored
- deleted boolean - Whether or not the category has been deleted. Deleted categories will only be included in delta requests
- goalMonthsToBudget? anydata - The number of months, including the current month, left in the current goal period
- goalTargetMonth? anydata - DEPRECATED: No longer used. Use
goal_target_dateinstead
- name string -
- goalTargetDate? anydata - The target date for the goal to be completed. Only some goal types specify this date
- goalCreationMonth? anydata - The month a goal was created
- categoryGroupId string -
- goalNeedsWholeAmount anydata(default ()) - Indicates the monthly rollover behavior for "NEED"-type goals. When "true", the goal will always ask for the target amount in the new month ("Set Aside"). When "false", previous month category funding is used ("Refill"). For other goal types, this field will be null
ynab: CategoryGroup
Fields
- internal boolean - Whether or not the category group is internal
- deleted boolean - Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests
- hidden boolean - Whether or not the category group is hidden
- name string -
- id string -
ynab: CategoryGroupWithCategories
Fields
- Fields Included from *CategoryGroup
- categories Category[] - Category group categories. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC)
ynab: CategoryResponse
Fields
- data CategoryResponseData -
ynab: CategoryResponseData
Fields
- category Category -
ynab: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
ynab: CurrencyFormat
The currency format setting for the plan. In some cases the format will not be available and will be specified as null
Fields
- iso_code string -
- example_format string -
- decimal_digits Signed32 -
- decimal_separator string -
- symbol_first boolean -
- group_separator string -
- currency_symbol string -
- display_symbol boolean -
ynab: DateFormat
The date format setting for the plan. In some cases the format will not be available and will be specified as null
Fields
- format string -
ynab: ExistingCategory
Fields
- Fields Included from *SaveCategory
- note anydata
- name anydata
- goalTargetDate anydata
- goalTarget anydata
- goalFrequency "monthly"|"weekly"|"yearly"
- categoryGroupId string
- goalNeedsWholeAmount anydata
- anydata...
ynab: ExistingTransaction
Fields
- Fields Included from *SaveTransactionWithOptionalFields
- date string
- amount int
- approved boolean
- accountId string
- categoryId anydata
- payeeName anydata
- memo anydata
- flagColor TransactionFlagColor
- subtransactions SaveSubTransaction[]
- payeeId anydata
- cleared TransactionClearedStatus
- anydata...
ynab: GetAccountsQueries
Represents the Queries record for the operation: getAccounts
Fields
- lastKnowledgeOfServer? int - The starting server knowledge. If provided, only entities that have changed since
last_knowledge_of_serverwill be included
ynab: GetCategoriesQueries
Represents the Queries record for the operation: getCategories
Fields
- lastKnowledgeOfServer? int - The starting server knowledge. If provided, only entities that have changed since
last_knowledge_of_serverwill be included
ynab: GetPayeesQueries
Represents the Queries record for the operation: getPayees
Fields
- lastKnowledgeOfServer? int - The starting server knowledge. If provided, only entities that have changed since
last_knowledge_of_serverwill be included
ynab: GetPlanByIdQueries
Represents the Queries record for the operation: getPlanById
Fields
- lastKnowledgeOfServer? int - The starting server knowledge. If provided, only entities that have changed since
last_knowledge_of_serverwill be included
ynab: GetPlanMonthsQueries
Represents the Queries record for the operation: getPlanMonths
Fields
- lastKnowledgeOfServer? int - The starting server knowledge. If provided, only entities that have changed since
last_knowledge_of_serverwill be included
ynab: GetPlansQueries
Represents the Queries record for the operation: getPlans
Fields
- includeAccounts? boolean - Whether to include the list of plan accounts
ynab: GetScheduledTransactionsQueries
Represents the Queries record for the operation: getScheduledTransactions
Fields
- lastKnowledgeOfServer? int - The starting server knowledge. If provided, only entities that have changed since
last_knowledge_of_serverwill be included
ynab: GetTransactionsByAccountQueries
Represents the Queries record for the operation: getTransactionsByAccount
Fields
- untilDate? string - If specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30)
- lastKnowledgeOfServer? int - The starting server knowledge. If provided, only entities that have changed since
last_knowledge_of_serverwill be included
- 'type? "uncategorized"|"unapproved" - If specified, only transactions of the specified type will be included. "uncategorized" and "unapproved" are currently supported
- sinceDate? string - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). Defaults to one year ago when not specified
ynab: GetTransactionsByCategoryQueries
Represents the Queries record for the operation: getTransactionsByCategory
Fields
- untilDate? string - If specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30)
- lastKnowledgeOfServer? int - The starting server knowledge. If provided, only entities that have changed since
last_knowledge_of_serverwill be included
- 'type? "uncategorized"|"unapproved" - If specified, only transactions of the specified type will be included. "uncategorized" and "unapproved" are currently supported
- sinceDate? string - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). Defaults to one year ago when not specified
ynab: GetTransactionsByMonthQueries
Represents the Queries record for the operation: getTransactionsByMonth
Fields
- untilDate? string - If specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30)
- lastKnowledgeOfServer? int - The starting server knowledge. If provided, only entities that have changed since
last_knowledge_of_serverwill be included
- 'type? "uncategorized"|"unapproved" - If specified, only transactions of the specified type will be included. "uncategorized" and "unapproved" are currently supported
- sinceDate? string - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30)
ynab: GetTransactionsByPayeeQueries
Represents the Queries record for the operation: getTransactionsByPayee
Fields
- untilDate? string - If specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30)
- lastKnowledgeOfServer? int - The starting server knowledge. If provided, only entities that have changed since
last_knowledge_of_serverwill be included
- 'type? "uncategorized"|"unapproved" - If specified, only transactions of the specified type will be included. "uncategorized" and "unapproved" are currently supported
- sinceDate? string - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). Defaults to one year ago when not specified
ynab: GetTransactionsQueries
Represents the Queries record for the operation: getTransactions
Fields
- untilDate? string - If specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30)
- lastKnowledgeOfServer? int - The starting server knowledge. If provided, only entities that have changed since
last_knowledge_of_serverwill be included
- 'type? "uncategorized"|"unapproved" - If specified, only transactions of the specified type will be included. "uncategorized" and "unapproved" are currently supported
- sinceDate? string - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). Defaults to one year ago when not specified
ynab: HybridTransaction
Fields
- Fields Included from *TransactionSummary
- amountCurrency decimal
- amountFormatted string
- date string
- transferTransactionId anydata
- amount int
- importId anydata
- memo anydata
- flagColor TransactionFlagColor
- debtTransactionType "charge"|()|"payment"|"refund"|"fee"|"interest"|"escrow"|"balanceAdjustment"|"credit"
- payeeId anydata
- flagName TransactionFlagName
- transferAccountId anydata
- approved boolean
- accountId string
- deleted boolean
- categoryId anydata
- importPayeeNameOriginal anydata
- id string
- cleared TransactionClearedStatus
- matchedTransactionId anydata
- importPayeeName anydata
- anydata...
- categoryName? string - The name of the category. If a split transaction, this will be 'Split'
- accountName string -
- payeeName? anydata -
- parentTransactionId? anydata - For subtransaction types, this is the id of the parent transaction. For transaction types, this id will be always be null
- 'type "transaction"|"subtransaction" - Whether the hybrid transaction represents a regular transaction or a subtransaction
ynab: HybridTransactionsResponse
Fields
ynab: HybridTransactionsResponseData
Fields
- serverKnowledge? int - The knowledge of the server
- transactions HybridTransaction[] -
ynab: LoanAccountPeriodicValue
Fields
- int... - Rest field
ynab: MoneyMovement
Fields
- Fields Included from *MoneyMovementBase
- amountCurrency? decimal - The money movement amount as a decimal currency amount
- amountFormatted? string - The money movement amount formatted in the plan's currency format
ynab: MoneyMovementBase
Fields
- note? anydata -
- movedAt? anydata - The date/time the money movement was processed on the server in ISO format (e.g. 2024-01-01T12:00:00Z)
- moneyMovementGroupId? anydata - The id of the money movement group this movement belongs to
- amount int - The amount of the money movement in milliunits format
- month? anydata - The month of the money movement in ISO format (e.g. 2024-01-01)
- performedByUserId? anydata - The id of the user who performed the money movement
- id string -
- fromCategoryId? anydata - The id of the category the money was moved from
- toCategoryId? anydata - The id of the category the money was moved to
ynab: MoneyMovementGroup
Fields
- note? anydata -
- month string - The month of the money movement group in ISO format (e.g. 2024-01-01)
- performedByUserId? anydata - The id of the user who performed the money movement group
- groupCreatedAt string - When the money movement group was created
- id string -
ynab: MoneyMovementGroupsResponse
Fields
ynab: MoneyMovementGroupsResponseData
Fields
- moneyMovementGroups MoneyMovementGroup[] -
- serverKnowledge int - The knowledge of the server
ynab: MoneyMovementsResponse
Fields
- data MoneyMovementsResponseData -
ynab: MoneyMovementsResponseData
Fields
- serverKnowledge int - The knowledge of the server
- moneyMovements MoneyMovement[] -
ynab: MonthDetail
Fields
- Fields Included from *MonthSummary
- budgetedCurrency decimal
- toBeBudgetedCurrency decimal
- budgetedFormatted string
- activityCurrency decimal
- toBeBudgetedFormatted string
- activityFormatted string
- incomeFormatted string
- incomeCurrency decimal
- income int
- note anydata
- deleted boolean
- month string
- activity int
- ageOfMoney anydata
- toBeBudgeted int
- budgeted int
- anydata...
- categories Category[] - The plan month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified
ynab: MonthDetailBase
Fields
- Fields Included from *MonthSummaryBase
- categories CategoryBase[] - The plan month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified
ynab: MonthDetailResponse
Fields
- data MonthDetailResponseData -
ynab: MonthDetailResponseData
Fields
- month MonthDetail -
ynab: MonthSummariesResponse
Fields
- data MonthSummariesResponseData -
ynab: MonthSummariesResponseData
Fields
- serverKnowledge int - The knowledge of the server
- months MonthSummary[] -
ynab: MonthSummary
Fields
- Fields Included from *MonthSummaryBase
- budgetedCurrency? decimal - The total amount assigned as a decimal currency amount
- toBeBudgetedCurrency? decimal - The available amount for 'Ready to Assign' as a decimal currency amount
- budgetedFormatted? string - The total amount assigned formatted in the plan's currency format
- activityCurrency? decimal - The total activity amount as a decimal currency amount
- toBeBudgetedFormatted? string - The available amount for 'Ready to Assign' formatted in the plan's currency format
- activityFormatted? string - The total activity amount formatted in the plan's currency format
- incomeFormatted? string - The total income formatted in the plan's currency format
- incomeCurrency? decimal - The total income as a decimal currency amount
ynab: MonthSummaryBase
Fields
- income int - The total amount of transactions categorized to 'Inflow: Ready to Assign' in the month
- note? anydata -
- deleted boolean - Whether or not the month has been deleted. Deleted months will only be included in delta requests
- month string -
- activity int - The total amount of transactions in the month, excluding those categorized to 'Inflow: Ready to Assign'
- ageOfMoney? anydata - The Age of Money as of the month
- toBeBudgeted int - The available amount for 'Ready to Assign'
- budgeted int - The total amount assigned (budgeted) in the month
ynab: NewTransaction
Fields
- Fields Included from *SaveTransactionWithOptionalFields
- date string
- amount int
- approved boolean
- accountId string
- categoryId anydata
- payeeName anydata
- memo anydata
- flagColor TransactionFlagColor
- subtransactions SaveSubTransaction[]
- payeeId anydata
- cleared TransactionClearedStatus
- anydata...
- importId? anydata - If specified, a new transaction will be assigned this
import_idand 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.<br><br>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.<br><br>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)
ynab: PatchCategoryGroupWrapper
Fields
- categoryGroup SaveCategoryGroup -
ynab: PatchCategoryWrapper
Fields
- category ExistingCategory -
ynab: PatchMonthCategoryWrapper
Fields
- category SaveMonthCategory -
ynab: PatchPayeeWrapper
Fields
- payee SavePayee -
ynab: PatchTransactionsWrapper
Fields
- transactions SaveTransactionWithIdOrImportId[] -
ynab: Payee
Fields
- deleted boolean - Whether or not the payee has been deleted. Deleted payees will only be included in delta requests
- name string -
- id string -
- transferAccountId? anydata - If a transfer payee, the
account_idto which this payee transfers to
ynab: PayeeLocation
Fields
- deleted boolean - Whether or not the payee location has been deleted. Deleted payee locations will only be included in delta requests
- latitude string -
- id string -
- payeeId string -
- longitude string -
ynab: PayeeLocationResponse
Fields
- data PayeeLocationResponseData -
ynab: PayeeLocationResponseData
Fields
- payeeLocation PayeeLocation -
ynab: PayeeLocationsResponse
Fields
- data PayeeLocationsResponseData -
ynab: PayeeLocationsResponseData
Fields
- payeeLocations PayeeLocation[] -
ynab: PayeeResponse
Fields
- data PayeeResponseData -
ynab: PayeeResponseData
Fields
- payee Payee -
ynab: PayeesResponse
Fields
- data PayeesResponseData -
ynab: PayeesResponseData
Fields
- serverKnowledge int - The knowledge of the server
- payees Payee[] -
ynab: PlanDetail
Fields
- Fields Included from *PlanSummary
- lastModifiedOn string
- firstMonth string
- lastMonth string
- name string
- dateFormat DateFormat
- id string
- accounts Account[]
- currencyFormat CurrencyFormat
- anydata...
- scheduledTransactions? ScheduledTransactionSummaryBase[] -
- months? MonthDetailBase[] -
- payees? Payee[] -
- subtransactions? SubTransactionBase[] -
- accounts? Account[] -
- payeeLocations? PayeeLocation[] -
- categories? CategoryBase[] -
- scheduledSubtransactions? ScheduledSubTransactionBase[] -
- transactions? TransactionSummaryBase[] -
- categoryGroups? CategoryGroup[] -
ynab: PlanDetailResponse
Fields
- data PlanDetailResponseData -
ynab: PlanDetailResponseData
Fields
- serverKnowledge int - The knowledge of the server
- plan PlanDetail -
ynab: PlanSettings
Fields
- dateFormat DateFormat -
- currencyFormat CurrencyFormat -
ynab: PlanSettingsResponse
Fields
- data PlanSettingsResponseData -
ynab: PlanSettingsResponseData
Fields
- settings PlanSettings -
ynab: PlanSummary
Fields
- lastModifiedOn? string - The last time any changes were made to the plan from either a web or mobile client
- firstMonth? string - The earliest plan month
- lastMonth? string - The latest plan month
- name string -
- dateFormat? DateFormat -
- id string -
- accounts? Account[] - The plan accounts (only included if
include_accounts=truespecified as query parameter)
- currencyFormat? CurrencyFormat -
ynab: PlanSummaryResponse
Fields
- data PlanSummaryResponseData -
ynab: PlanSummaryResponseData
Fields
- plans PlanSummary[] -
- defaultPlan? PlanSummary? -
ynab: PostAccountWrapper
Fields
- account SaveAccount -
ynab: PostCategoryGroupWrapper
Fields
- categoryGroup SaveCategoryGroup -
ynab: PostCategoryWrapper
Fields
- category NewCategory -
ynab: PostPayee
Fields
- name string - The name of the payee
ynab: PostPayeeWrapper
Fields
- payee PostPayee -
ynab: PostScheduledTransactionWrapper
Fields
- scheduledTransaction SaveScheduledTransaction -
ynab: PostTransactionsWrapper
Fields
- transactions? NewTransaction[] -
- 'transaction? NewTransaction -
ynab: PutScheduledTransactionWrapper
Fields
- scheduledTransaction SaveScheduledTransaction -
ynab: PutTransactionWrapper
Fields
- 'transaction ExistingTransaction -
ynab: SaveAccount
Fields
- balance int - The current balance of the account in milliunits format
- name string - The name of the account
- 'type SaveAccountType - The type of account to create or update
ynab: SaveCategory
Fields
- note? anydata -
- name? anydata -
- goalTargetDate? anydata - The goal target date in ISO format (e.g. 2016-12-01). Not supported for categories paired to a loan account
- goalTarget? anydata - The goal target amount in milliunits format. If value is specified and goal has not already been configured for category, a monthly goal will be created for the category with this target amount. If goal_type is not specified, it will default to 'NEED', or to 'MF' for Credit Card Payment categories and 'DEBT' for categories paired to a loan account. When updating a category, passing null removes any existing target
- goalFrequency? "monthly"|"weekly"|"yearly" - When specified, configures a recurring 'NEED' target of goal_target that repeats at this frequency, replacing any existing target. Requires goal_target. Cannot be combined with goal_target_date and is not supported for Credit Card Payment categories or categories paired to a loan account. Omit to leave an existing target's cadence unchanged
- categoryGroupId? string - The id of the category group to which this category belongs. An internal category group may not be specified
- goalNeedsWholeAmount? anydata - Whether the goal requires the full target amount each period. Only supported for 'NEED' goals, and not supported for Credit Card Payment categories or categories paired to a loan account. When true, the goal is configured as 'Set aside another...'. When false, the goal is configured as 'Refill up to...'
ynab: SaveCategoryGroup
Fields
- name string - The name of the category group. The name must be a maximum of 50 characters
ynab: SaveCategoryGroupResponse
Fields
ynab: SaveCategoryGroupResponseData
Fields
- serverKnowledge int - The knowledge of the server
- categoryGroup CategoryGroup -
ynab: SaveCategoryResponse
Fields
- data SaveCategoryResponseData -
ynab: SaveCategoryResponseData
Fields
- serverKnowledge int - The knowledge of the server
- category Category -
ynab: SaveMonthCategory
Fields
- budgeted int - Assigned (budgeted) amount in milliunits format
ynab: SavePayee
Fields
- name? string - The name of the payee
ynab: SavePayeeResponse
Fields
- data SavePayeeResponseData -
ynab: SavePayeeResponseData
Fields
- payee Payee -
- serverKnowledge int - The knowledge of the server
ynab: SaveScheduledTransaction
Fields
- date string - The scheduled transaction date in ISO format (e.g. 2016-12-01). This should be a future date no more than 5 years into the future
- amount? int - The scheduled transaction amount in milliunits format
- accountId string -
- categoryId? anydata - The category for the scheduled transaction. Credit Card Payment categories are not permitted. Creating a split scheduled transaction is not currently supported
- payeeName? anydata - The payee name for the the scheduled transaction. If a
payee_namevalue is provided andpayee_idhas a null value, thepayee_namevalue will be used to resolve the payee by either (1) a payee with the same name or (2) creation of a new payee
- memo? anydata -
- flagColor? TransactionFlagColor -
- payeeId? anydata - The payee for the scheduled 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_idon the account resource
- frequency? ScheduledTransactionFrequency - The scheduled transaction frequency
ynab: SaveSubTransaction
Fields
- amount int - The subtransaction amount in milliunits format
- categoryId? anydata - The category for the subtransaction. Credit Card Payment categories are not permitted and will be ignored if supplied
- payeeName? anydata - The payee name. If a
payee_namevalue is provided andpayee_idhas a null value, thepayee_namevalue 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
- memo? anydata -
- payeeId? anydata - The payee for the subtransaction
ynab: SaveTransactionsResponse
Fields
- data SaveTransactionsResponseData -
ynab: SaveTransactionsResponseData
Fields
- serverKnowledge int - The knowledge of the server
- transactionIds string[] - The transaction ids that were saved
- transactions? TransactionDetail[] - If multiple transactions were specified, the transactions that were saved
- duplicateImportIds? string[] - If multiple transactions were specified, a list of import_ids that were not created because of an existing
import_idfound on the same account
- 'transaction? TransactionDetail -
ynab: SaveTransactionWithIdOrImportId
Fields
- importId? anydata - If specified, this id will be used to lookup a transaction by its
import_idfor the purpose of updating the transaction itself. If not specified, anidshould be supplied. You may not provide both anidand animport_idand updating animport_idon an existing transaction is not allowed
- id? anydata - If specified, this id will be used to lookup a transaction by its
idfor the purpose of updating the transaction itself. If not specified, animport_idshould be supplied
- Fields Included from *SaveTransactionWithOptionalFields
- date string
- amount int
- approved boolean
- accountId string
- categoryId anydata
- payeeName anydata
- memo anydata
- flagColor TransactionFlagColor
- subtransactions SaveSubTransaction[]
- payeeId anydata
- cleared TransactionClearedStatus
- anydata...
ynab: SaveTransactionWithOptionalFields
Fields
- date? string - 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? int - The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored
- approved? boolean - Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default
- accountId? string -
- categoryId? anydata - The category for the transaction. To configure a split transaction, you can specify null for
category_idand provide asubtransactionsarray as part of the transaction object. If an existing transaction is a split, thecategory_idcannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied
- payeeName? anydata - The payee name. If a
payee_namevalue is provided andpayee_idhas a null value, thepayee_namevalue will be used to resolve the payee by either (1) a matching payee rename rule (only ifimport_idis also specified) or (2) a payee with the same name or (3) creation of a new payee
- memo? anydata -
- flagColor? TransactionFlagColor -
- subtransactions? SaveSubTransaction[] - An array of subtransactions to configure a transaction as a split. Updating
subtransactionson an existing split transaction is not supported and will return an error. Splits are not allowed on tracking accounts or on transfers between on-budget accounts; a transfer to a tracking account can be a split
- payeeId? anydata - 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_idon the account resource
- cleared? TransactionClearedStatus - The cleared status of the transaction
ynab: ScheduledSubTransaction
Fields
- Fields Included from *ScheduledSubTransactionBase
- amountCurrency? decimal - The scheduled subtransaction amount as a decimal currency amount
- amountFormatted? string - The scheduled subtransaction amount formatted in the plan's currency format
ynab: ScheduledSubTransactionBase
Fields
- amount int - The scheduled subtransaction amount in milliunits format
- categoryName? anydata -
- deleted boolean - Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests
- categoryId? anydata -
- payeeName? anydata -
- scheduledTransactionId string -
- memo? anydata -
- id string -
- payeeId? anydata -
- transferAccountId? anydata - If a transfer, the account_id which the scheduled subtransaction transfers to
ynab: ScheduledTransactionDetail
Fields
- Fields Included from *ScheduledTransactionSummary
- amountCurrency decimal
- amountFormatted string
- amount int
- dateNext string
- memo anydata
- flagColor TransactionFlagColor
- payeeId anydata
- flagName TransactionFlagName
- frequency "never"|"daily"|"weekly"|"everyOtherWeek"|"twiceAMonth"|"every4Weeks"|"monthly"|"everyOtherMonth"|"every3Months"|"every4Months"|"twiceAYear"|"yearly"|"everyOtherYear"
- transferAccountId anydata
- accountId string
- deleted boolean
- categoryId anydata
- dateFirst string
- id string
- anydata...
- categoryName? anydata - The name of the category. If a split scheduled transaction, this will be 'Split'
- accountName string -
- payeeName? anydata -
- subtransactions ScheduledSubTransaction[] - If a split scheduled transaction, the subtransactions
ynab: ScheduledTransactionResponse
Fields
ynab: ScheduledTransactionResponseData
Fields
- scheduledTransaction ScheduledTransactionDetail -
ynab: ScheduledTransactionsResponse
Fields
ynab: ScheduledTransactionsResponseData
Fields
- scheduledTransactions ScheduledTransactionDetail[] -
- serverKnowledge int - The knowledge of the server
ynab: ScheduledTransactionSummary
Fields
- Fields Included from *ScheduledTransactionSummaryBase
- amount int
- dateNext string
- memo anydata
- flagColor TransactionFlagColor
- payeeId anydata
- flagName TransactionFlagName
- frequency "never"|"daily"|"weekly"|"everyOtherWeek"|"twiceAMonth"|"every4Weeks"|"monthly"|"everyOtherMonth"|"every3Months"|"every4Months"|"twiceAYear"|"yearly"|"everyOtherYear"
- transferAccountId anydata
- accountId string
- deleted boolean
- categoryId anydata
- dateFirst string
- id string
- anydata...
- amountCurrency? decimal - The scheduled transaction amount as a decimal currency amount
- amountFormatted? string - The scheduled transaction amount formatted in the plan's currency format
ynab: ScheduledTransactionSummaryBase
Fields
- amount int - The scheduled transaction amount in milliunits format
- dateNext string - The next date for which the Scheduled Transaction is scheduled
- memo? anydata -
- flagColor? TransactionFlagColor -
- payeeId? anydata -
- flagName? TransactionFlagName -
- frequency "never"|"daily"|"weekly"|"everyOtherWeek"|"twiceAMonth"|"every4Weeks"|"monthly"|"everyOtherMonth"|"every3Months"|"every4Months"|"twiceAYear"|"yearly"|"everyOtherYear" -
- transferAccountId? anydata - If a transfer, the account_id which the scheduled transaction transfers to
- accountId string -
- deleted boolean - Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests
- categoryId? anydata -
- dateFirst string - The first date for which the Scheduled Transaction was scheduled
- id string -
ynab: SubTransaction
Fields
- Fields Included from *SubTransactionBase
- amountCurrency? decimal - The subtransaction amount as a decimal currency amount
- amountFormatted? string - The subtransaction amount formatted in the plan's currency format
ynab: SubTransactionBase
Fields
- transactionId string -
- transferTransactionId? anydata - If a transfer, the id of transaction on the other side of the transfer
- amount int - The subtransaction amount in milliunits format
- categoryName? anydata -
- deleted boolean - Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests
- categoryId? anydata -
- payeeName? anydata -
- memo? anydata -
- id string -
- payeeId? anydata -
- transferAccountId? anydata - If a transfer, the account_id which the subtransaction transfers to
ynab: TransactionDetail
Fields
- Fields Included from *TransactionSummary
- amountCurrency decimal
- amountFormatted string
- date string
- transferTransactionId anydata
- amount int
- importId anydata
- memo anydata
- flagColor TransactionFlagColor
- debtTransactionType "charge"|()|"payment"|"refund"|"fee"|"interest"|"escrow"|"balanceAdjustment"|"credit"
- payeeId anydata
- flagName TransactionFlagName
- transferAccountId anydata
- approved boolean
- accountId string
- deleted boolean
- categoryId anydata
- importPayeeNameOriginal anydata
- id string
- cleared TransactionClearedStatus
- matchedTransactionId anydata
- importPayeeName anydata
- anydata...
- categoryName? anydata - The name of the category. If a split transaction, this will be 'Split'
- accountName string -
- payeeName? anydata -
- subtransactions SubTransaction[] - If a split transaction, the subtransactions
ynab: TransactionResponse
Fields
- data TransactionResponseData -
ynab: TransactionResponseData
Fields
- serverKnowledge int - The knowledge of the server
- 'transaction TransactionDetail -
ynab: TransactionsImportResponse
Fields
ynab: TransactionsImportResponseData
Fields
- transactionIds string[] - The list of transaction ids that were imported
ynab: TransactionsResponse
Fields
- data TransactionsResponseData -
ynab: TransactionsResponseData
Fields
- serverKnowledge int - The knowledge of the server
- transactions TransactionDetail[] -
ynab: TransactionSummary
Fields
- Fields Included from *TransactionSummaryBase
- date string
- transferTransactionId anydata
- amount int
- importId anydata
- memo anydata
- flagColor TransactionFlagColor
- debtTransactionType "charge"|()|"payment"|"refund"|"fee"|"interest"|"escrow"|"balanceAdjustment"|"credit"
- payeeId anydata
- flagName TransactionFlagName
- transferAccountId anydata
- approved boolean
- accountId string
- deleted boolean
- categoryId anydata
- importPayeeNameOriginal anydata
- id string
- cleared TransactionClearedStatus
- matchedTransactionId anydata
- importPayeeName anydata
- anydata...
- amountCurrency? decimal - The transaction amount as a decimal currency amount
- amountFormatted? string - The transaction amount formatted in the plan's currency format
ynab: TransactionSummaryBase
Fields
- date string - The transaction date in ISO format (e.g. 2016-12-01)
- transferTransactionId? anydata - If a transfer transaction, the id of transaction on the other side of the transfer
- amount int - The transaction amount in milliunits format
- importId? anydata - 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'
- memo? anydata -
- flagColor? TransactionFlagColor -
- debtTransactionType? "payment"|"refund"|"fee"|"interest"|"escrow"|"balanceAdjustment"|"credit"|"charge"? - If the transaction is a debt/loan account transaction, the type of transaction
- payeeId? anydata -
- flagName? TransactionFlagName -
- transferAccountId? anydata - If a transfer transaction, the account to which it transfers
- approved boolean - Whether or not the transaction is approved
- accountId string -
- deleted boolean - Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests
- categoryId? anydata -
- importPayeeNameOriginal? anydata - If the transaction was imported, the original payee name as it appeared on the statement
- id string -
- cleared TransactionClearedStatus - The cleared status of the transaction
- matchedTransactionId? anydata - If transaction is matched, the id of the matched transaction
- importPayeeName? anydata - If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules
ynab: User
Fields
- id string -
ynab: UserResponse
Fields
- data UserResponseData -
ynab: UserResponseData
Fields
- user User -
Union types
ynab: TransactionFlagColor
TransactionFlagColor
The transaction flag
ynab: TransactionClearedStatus
TransactionClearedStatus
The cleared status of the transaction
ynab: ScheduledTransactionFrequency
ScheduledTransactionFrequency
The scheduled transaction frequency
ynab: SaveAccountType
SaveAccountType
The type of account to create or update
ynab: AccountType
AccountType
The type of account
Anydata types
ynab: TransactionFlagName
TransactionFlagName
The customized name of a transaction flag
Simple name reference types
ynab: NewCategory
NewCategory
Import
import ballerinax/ynab;Metadata
Released date: about 15 hours ago
Version: 2.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-20 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 35
Current verison: 1
Weekly downloads
Keywords
Vendor/YNAB
Area/Finance & Accounting
Type/Connector
YNAB
Contributors