Struct Category

pub struct Category {

    pub id: Uuid,
    pub category_group_id: Uuid,
    pub category_group_name: Option<String>,
    pub name: String,
    pub hidden: bool,
    pub original_category_group_id: Option<Option<Uuid>>,
    pub note: Option<Option<String>>,
    pub budgeted: i64,
    pub activity: i64,
    pub balance: i64,
    pub goal_type: Option<Option<GoalType>>,
    pub goal_needs_whole_amount: Option<Option<bool>>,
    pub goal_day: Option<Option<i32>>,
    pub goal_cadence: Option<Option<i32>>,
    pub goal_cadence_frequency: Option<Option<i32>>,
    pub goal_creation_month: Option<Option<String>>,
    pub goal_target: Option<Option<i64>>,
    pub goal_target_month: Option<Option<String>>,
    pub goal_percentage_complete: Option<Option<i32>>,
    pub goal_months_to_budget: Option<Option<i32>>,
    pub goal_under_funded: Option<Option<i64>>,
    pub goal_overall_funded: Option<Option<i64>>,
    pub goal_overall_left: Option<Option<i64>>,
    pub deleted: bool,
}

Fields

id: Uuid

category_group_id: Uuid

category_group_name: Option<String>

name: String

hidden: bool

Whether or not the category is hidden

original_category_group_id: Option<Option<Uuid>>

DEPRECATED: No longer used. Value will always be null.

note: Option<Option<String>>

budgeted: i64

Budgeted amount in milliunits format

activity: i64

Activity amount in milliunits format

balance: i64

Balance in milliunits format

goal_type: Option<Option<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_needs_whole_amount: Option<Option<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.

goal_day: Option<Option<i32>>

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).

goal_cadence: Option<Option<i32>>

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.

goal_cadence_frequency: Option<Option<i32>>

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.

goal_creation_month: Option<Option<String>>

The month a goal was created

goal_target: Option<Option<i64>>

The goal target amount in milliunits

goal_target_month: Option<Option<String>>

The original target month for the goal to be completed. Only some goal types specify this date.

goal_percentage_complete: Option<Option<i32>>

The percentage completion of the goal

goal_months_to_budget: Option<Option<i32>>

The number of months, including the current month, left in the current goal period.

goal_under_funded: Option<Option<i64>>

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: Option<Option<i64>>

The total amount funded towards the goal within the current goal period.

goal_overall_left: Option<Option<i64>>

The amount of funding still needed to complete the goal within the current goal period.

deleted: bool

Whether or not the category has been deleted. Deleted categories will only be included in delta requests.

Implementations

impl Category

pub fn new( id: Uuid, category_group_id: Uuid, name: String, hidden: bool, budgeted: i64, activity: i64, balance: i64, deleted: bool, ) -> Category

Trait Implementations

impl Clone for Category

fn clone(&self) -> Category

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Category

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Category

fn default() -> Category

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Category

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Category

fn eq(&self, other: &Category) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Category

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Category