Class MonthSummary

java.lang.Object
cm.xd.genapi.ynab.model.MonthSummary

@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 MonthSummary extends Object
MonthSummary
  • Field Details

  • Constructor Details

    • MonthSummary

      public MonthSummary()
  • Method Details

    • month

      public MonthSummary month(@Nonnull LocalDate month)
    • getMonth

      @Nonnull public LocalDate getMonth()
      Get month
      Returns:
      month
    • setMonth

      public void setMonth(@Nonnull LocalDate month)
    • note

      public MonthSummary note(@Nullable String note)
    • getNote

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

      public void setNote(@Nullable String note)
    • income

      public MonthSummary income(@Nonnull Long income)
    • getIncome

      @Nonnull public Long getIncome()
      The total amount of transactions categorized to 'Inflow: Ready to Assign' in the month
      Returns:
      income
    • setIncome

      public void setIncome(@Nonnull Long income)
    • budgeted

      public MonthSummary budgeted(@Nonnull Long budgeted)
    • getBudgeted

      @Nonnull public Long getBudgeted()
      The total amount assigned (budgeted) in the month
      Returns:
      budgeted
    • setBudgeted

      public void setBudgeted(@Nonnull Long budgeted)
    • activity

      public MonthSummary activity(@Nonnull Long activity)
    • getActivity

      @Nonnull public Long getActivity()
      The total amount of transactions in the month, excluding those categorized to 'Inflow: Ready to Assign'
      Returns:
      activity
    • setActivity

      public void setActivity(@Nonnull Long activity)
    • toBeBudgeted

      public MonthSummary toBeBudgeted(@Nonnull Long toBeBudgeted)
    • getToBeBudgeted

      @Nonnull public Long getToBeBudgeted()
      The available amount for 'Ready to Assign'
      Returns:
      toBeBudgeted
    • setToBeBudgeted

      public void setToBeBudgeted(@Nonnull Long toBeBudgeted)
    • ageOfMoney

      public MonthSummary ageOfMoney(@Nullable Integer ageOfMoney)
    • getAgeOfMoney

      @Nullable public Integer getAgeOfMoney()
      The Age of Money as of the month
      Returns:
      ageOfMoney
    • setAgeOfMoney

      public void setAgeOfMoney(@Nullable Integer ageOfMoney)
    • deleted

      public MonthSummary deleted(@Nonnull Boolean deleted)
    • getDeleted

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

      public void setDeleted(@Nonnull Boolean deleted)
    • incomeFormatted

      public MonthSummary incomeFormatted(@Nullable String incomeFormatted)
    • getIncomeFormatted

      @Nullable public String getIncomeFormatted()
      The total income formatted in the plan's currency format
      Returns:
      incomeFormatted
    • setIncomeFormatted

      public void setIncomeFormatted(@Nullable String incomeFormatted)
    • incomeCurrency

      public MonthSummary incomeCurrency(@Nullable Double incomeCurrency)
    • getIncomeCurrency

      @Nullable public Double getIncomeCurrency()
      The total income as a decimal currency amount
      Returns:
      incomeCurrency
    • setIncomeCurrency

      public void setIncomeCurrency(@Nullable Double incomeCurrency)
    • budgetedFormatted

      public MonthSummary budgetedFormatted(@Nullable String budgetedFormatted)
    • getBudgetedFormatted

      @Nullable public String getBudgetedFormatted()
      The total amount assigned formatted in the plan's currency format
      Returns:
      budgetedFormatted
    • setBudgetedFormatted

      public void setBudgetedFormatted(@Nullable String budgetedFormatted)
    • budgetedCurrency

      public MonthSummary budgetedCurrency(@Nullable Double budgetedCurrency)
    • getBudgetedCurrency

      @Nullable public Double getBudgetedCurrency()
      The total amount assigned as a decimal currency amount
      Returns:
      budgetedCurrency
    • setBudgetedCurrency

      public void setBudgetedCurrency(@Nullable Double budgetedCurrency)
    • activityFormatted

      public MonthSummary activityFormatted(@Nullable String activityFormatted)
    • getActivityFormatted

      @Nullable public String getActivityFormatted()
      The total activity amount formatted in the plan's currency format
      Returns:
      activityFormatted
    • setActivityFormatted

      public void setActivityFormatted(@Nullable String activityFormatted)
    • activityCurrency

      public MonthSummary activityCurrency(@Nullable Double activityCurrency)
    • getActivityCurrency

      @Nullable public Double getActivityCurrency()
      The total activity amount as a decimal currency amount
      Returns:
      activityCurrency
    • setActivityCurrency

      public void setActivityCurrency(@Nullable Double activityCurrency)
    • toBeBudgetedFormatted

      public MonthSummary toBeBudgetedFormatted(@Nullable String toBeBudgetedFormatted)
    • getToBeBudgetedFormatted

      @Nullable public String getToBeBudgetedFormatted()
      The available amount for 'Ready to Assign' formatted in the plan's currency format
      Returns:
      toBeBudgetedFormatted
    • setToBeBudgetedFormatted

      public void setToBeBudgetedFormatted(@Nullable String toBeBudgetedFormatted)
    • toBeBudgetedCurrency

      public MonthSummary toBeBudgetedCurrency(@Nullable Double toBeBudgetedCurrency)
    • getToBeBudgetedCurrency

      @Nullable public Double getToBeBudgetedCurrency()
      The available amount for 'Ready to Assign' as a decimal currency amount
      Returns:
      toBeBudgetedCurrency
    • setToBeBudgetedCurrency

      public void setToBeBudgetedCurrency(@Nullable Double toBeBudgetedCurrency)
    • 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 MonthSummary
    • fromJson

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

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