This command is used to fetch budget data using the YNAB api.

ynab_get_budget(
  budget,
  remove_deleted = TRUE,
  remove_closed = TRUE,
  remove_off_budget = TRUE
)

Arguments

budget

the name or id of an available budget. It can be determined by using the ynab_list_budgets() command.

remove_deleted

boolean indicating if deleted data should be removed from the returned budget object.

remove_closed

boolean indicating if closed account data should be removed from the returned budget object.

remove_off_budget

boolean indicating if off budget data should be removed from the budget object.

Value

a 'budget_data' object representing a list of the various data returned by the YNAB API, with only some convenient adjustments.