Skip to content

Category.md

Latest commit

 

History

History
53 lines (44 loc) · 4.77 KB

Category.md

File metadata and controls

53 lines (44 loc) · 4.77 KB

Category

Properties

Name Type Description Notes
id str
category_group_id str
category_group_name str [optional]
name str
hidden bool Whether or not the category is hidden
original_category_group_id str DEPRECATED: No longer used. Value will always be null. [optional]
note str [optional]
budgeted int Budgeted amount in milliunits format
activity int Activity amount in milliunits format
balance int Balance in milliunits format
goal_type str 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') [optional]
goal_needs_whole_amount bool 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. [optional]
goal_day int 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). [optional]
goal_cadence int 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. [optional]
goal_cadence_frequency int 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. [optional]
goal_creation_month date The month a goal was created [optional]
goal_target int The goal target amount in milliunits [optional]
goal_target_month date The original target month for the goal to be completed. Only some goal types specify this date. [optional]
goal_percentage_complete int The percentage completion of the goal [optional]
goal_months_to_budget int The number of months, including the current month, left in the current goal period. [optional]
goal_under_funded int 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. [optional]
goal_overall_funded int The total amount funded towards the goal within the current goal period. [optional]
goal_overall_left int The amount of funding still needed to complete the goal within the current goal period. [optional]
goal_snoozed_at datetime The date/time the goal was snoozed. If the goal is not snoozed, this will be null. [optional]
deleted bool Whether or not the category has been deleted. Deleted categories will only be included in delta requests.

Example

from ynab.models.category import Category

# TODO update the JSON string below
json = "{}"
# create an instance of Category from a JSON string
category_instance = Category.from_json(json)
# print the JSON string representation of the object
print(Category.to_json())

# convert the object into a dict
category_dict = category_instance.to_dict()
# create an instance of Category from a dict
category_from_dict = Category.from_dict(category_dict)

[Back to Model list] [Back to API list] [Back to README]