Package cm.xd.genapi.ynab.model

Class CategoryBase

java.lang.Object
cm.xd.genapi.ynab.model.CategoryBase
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2026-04-13T16:11:17.024752+02:00[Europe/Stockholm]", comments="Generator version: 7.21.0") public class CategoryBase extends Object
CategoryBase

  • Field Details

  • Constructor Details

    • CategoryBase

      public CategoryBase()

  • Method Details

    • id

      public CategoryBase id(@Nonnull UUID id)

    • getId

      @Nonnull public UUID getId()
      Get id
      Returns:
      id

    • setId

      public void setId(@Nonnull UUID id)

    • categoryGroupId

      public CategoryBase categoryGroupId(@Nonnull UUID categoryGroupId)

    • getCategoryGroupId

      @Nonnull public UUID getCategoryGroupId()
      Get categoryGroupId
      Returns:
      categoryGroupId

    • setCategoryGroupId

      public void setCategoryGroupId(@Nonnull UUID categoryGroupId)

    • categoryGroupName

      public CategoryBase categoryGroupName(@Nullable String categoryGroupName)

    • getCategoryGroupName

      @Nullable public String getCategoryGroupName()
      Get categoryGroupName
      Returns:
      categoryGroupName

    • setCategoryGroupName

      public void setCategoryGroupName(@Nullable String categoryGroupName)

    • name

      public CategoryBase name(@Nonnull String name)

    • getName

      @Nonnull public String getName()
      Get name
      Returns:
      name

    • setName

      public void setName(@Nonnull String name)

    • hidden

      public CategoryBase hidden(@Nonnull Boolean hidden)

    • getHidden

      @Nonnull public Boolean getHidden()
      Whether or not the category is hidden
      Returns:
      hidden

    • setHidden

      public void setHidden(@Nonnull Boolean hidden)

    • originalCategoryGroupId

      public CategoryBase originalCategoryGroupId(@Nullable UUID originalCategoryGroupId)

    • getOriginalCategoryGroupId

      @Nullable public UUID getOriginalCategoryGroupId()
      DEPRECATED: No longer used. Value will always be null.
      Returns:
      originalCategoryGroupId

    • setOriginalCategoryGroupId

      public void setOriginalCategoryGroupId(@Nullable UUID originalCategoryGroupId)

    • note

      public CategoryBase note(@Nullable String note)

    • getNote

      @Nullable public String getNote()
      Get note
      Returns:
      note

    • setNote

      public void setNote(@Nullable String note)

    • budgeted

      public CategoryBase budgeted(@Nonnull Long budgeted)

    • getBudgeted

      @Nonnull public Long getBudgeted()
      Assigned (budgeted) amount in milliunits format
      Returns:
      budgeted

    • setBudgeted

      public void setBudgeted(@Nonnull Long budgeted)

    • activity

      public CategoryBase activity(@Nonnull Long activity)

    • getActivity

      @Nonnull public Long getActivity()
      Activity amount in milliunits format
      Returns:
      activity

    • setActivity

      public void setActivity(@Nonnull Long activity)

    • balance

      public CategoryBase balance(@Nonnull Long balance)

    • getBalance

      @Nonnull public Long getBalance()
      Available balance in milliunits format
      Returns:
      balance

    • setBalance

      public void setBalance(@Nonnull Long balance)

    • goalType

      public CategoryBase goalType(@Nullable CategoryBase.GoalTypeEnum goalType)

    • getGoalType

      @Nullable public CategoryBase.GoalTypeEnum getGoalType()
      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')
      Returns:
      goalType

    • setGoalType

      public void setGoalType(@Nullable CategoryBase.GoalTypeEnum goalType)

    • goalNeedsWholeAmount

      public CategoryBase goalNeedsWholeAmount(@Nullable Boolean goalNeedsWholeAmount)

    • getGoalNeedsWholeAmount

      @Nullable public Boolean getGoalNeedsWholeAmount()
      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.
      Returns:
      goalNeedsWholeAmount

    • setGoalNeedsWholeAmount

      public void setGoalNeedsWholeAmount(@Nullable Boolean goalNeedsWholeAmount)

    • goalDay

      public CategoryBase goalDay(@Nullable Integer goalDay)

    • getGoalDay

      @Nullable public Integer getGoalDay()
      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).
      Returns:
      goalDay

    • setGoalDay

      public void setGoalDay(@Nullable Integer goalDay)

    • goalCadence

      public CategoryBase goalCadence(@Nullable Integer goalCadence)

    • getGoalCadence

      @Nullable public Integer getGoalCadence()
      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.
      Returns:
      goalCadence

    • setGoalCadence

      public void setGoalCadence(@Nullable Integer goalCadence)

    • goalCadenceFrequency

      public CategoryBase goalCadenceFrequency(@Nullable Integer goalCadenceFrequency)

    • getGoalCadenceFrequency

      @Nullable public Integer getGoalCadenceFrequency()
      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.
      Returns:
      goalCadenceFrequency

    • setGoalCadenceFrequency

      public void setGoalCadenceFrequency(@Nullable Integer goalCadenceFrequency)

    • goalCreationMonth

      public CategoryBase goalCreationMonth(@Nullable LocalDate goalCreationMonth)

    • getGoalCreationMonth

      @Nullable public LocalDate getGoalCreationMonth()
      The month a goal was created
      Returns:
      goalCreationMonth

    • setGoalCreationMonth

      public void setGoalCreationMonth(@Nullable LocalDate goalCreationMonth)

    • goalTarget

      public CategoryBase goalTarget(@Nullable Long goalTarget)

    • getGoalTarget

      @Nullable public Long getGoalTarget()
      The goal target amount in milliunits
      Returns:
      goalTarget

    • setGoalTarget

      public void setGoalTarget(@Nullable Long goalTarget)

    • goalTargetMonth

      public CategoryBase goalTargetMonth(@Nullable LocalDate goalTargetMonth)

    • getGoalTargetMonth

      @Nullable public LocalDate getGoalTargetMonth()
      DEPRECATED: No longer used. Use `goal_target_date` instead.
      Returns:
      goalTargetMonth

    • setGoalTargetMonth

      public void setGoalTargetMonth(@Nullable LocalDate goalTargetMonth)

    • goalTargetDate

      public CategoryBase goalTargetDate(@Nullable LocalDate goalTargetDate)

    • getGoalTargetDate

      @Nullable public LocalDate getGoalTargetDate()
      The target date for the goal to be completed. Only some goal types specify this date.
      Returns:
      goalTargetDate

    • setGoalTargetDate

      public void setGoalTargetDate(@Nullable LocalDate goalTargetDate)

    • goalPercentageComplete

      public CategoryBase goalPercentageComplete(@Nullable Integer goalPercentageComplete)

    • getGoalPercentageComplete

      @Nullable public Integer getGoalPercentageComplete()
      The percentage completion of the goal
      Returns:
      goalPercentageComplete

    • setGoalPercentageComplete

      public void setGoalPercentageComplete(@Nullable Integer goalPercentageComplete)

    • goalMonthsToBudget

      public CategoryBase goalMonthsToBudget(@Nullable Integer goalMonthsToBudget)

    • getGoalMonthsToBudget

      @Nullable public Integer getGoalMonthsToBudget()
      The number of months, including the current month, left in the current goal period.
      Returns:
      goalMonthsToBudget

    • setGoalMonthsToBudget

      public void setGoalMonthsToBudget(@Nullable Integer goalMonthsToBudget)

    • goalUnderFunded

      public CategoryBase goalUnderFunded(@Nullable Long goalUnderFunded)

    • getGoalUnderFunded

      @Nullable public Long getGoalUnderFunded()
      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.
      Returns:
      goalUnderFunded

    • setGoalUnderFunded

      public void setGoalUnderFunded(@Nullable Long goalUnderFunded)

    • goalOverallFunded

      public CategoryBase goalOverallFunded(@Nullable Long goalOverallFunded)

    • getGoalOverallFunded

      @Nullable public Long getGoalOverallFunded()
      The total amount funded towards the goal within the current goal period.
      Returns:
      goalOverallFunded

    • setGoalOverallFunded

      public void setGoalOverallFunded(@Nullable Long goalOverallFunded)

    • goalOverallLeft

      public CategoryBase goalOverallLeft(@Nullable Long goalOverallLeft)

    • getGoalOverallLeft

      @Nullable public Long getGoalOverallLeft()
      The amount of funding still needed to complete the goal within the current goal period.
      Returns:
      goalOverallLeft

    • setGoalOverallLeft

      public void setGoalOverallLeft(@Nullable Long goalOverallLeft)

    • goalSnoozedAt

      public CategoryBase goalSnoozedAt(@Nullable OffsetDateTime goalSnoozedAt)

    • getGoalSnoozedAt

      @Nullable public OffsetDateTime getGoalSnoozedAt()
      The date/time the goal was snoozed. If the goal is not snoozed, this will be null.
      Returns:
      goalSnoozedAt

    • setGoalSnoozedAt

      public void setGoalSnoozedAt(@Nullable OffsetDateTime goalSnoozedAt)

    • deleted

      public CategoryBase deleted(@Nonnull Boolean deleted)

    • getDeleted

      @Nonnull public Boolean getDeleted()
      Whether or not the category has been deleted. Deleted categories will only be included in delta requests.
      Returns:
      deleted

    • setDeleted

      public void setDeleted(@Nonnull Boolean deleted)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to CategoryBase

    • fromJson

      public static CategoryBase fromJson(String jsonString) throws IOException
      Create an instance of CategoryBase given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of CategoryBase
      Throws:
      IOException - if the JSON string is invalid with respect to CategoryBase

    • toJson

      public String toJson()
      Convert an instance of CategoryBase to an JSON string
      Returns:
      JSON string