taxtank-core 2.0.92 → 2.0.94

package/index.d.ts

@@ -791,7 +791,10 @@ declare enum SetupItemTypeEnum {
     HOLDING = 5,
     BANK_ACCOUNTS = 6,
     BANK_ACCOUNT = 7,
-    BUSINESS = 8
+    BUSINESS = 8,
+    MONEY = 9,
+    MONEY_BUDGET = 10,
+    MONEY_CALENDAR = 11
 }
 
 declare enum BudgetTypeEnum {
@@ -3632,6 +3635,30 @@ declare class SoleInvoiceCollection extends Collection<SoleInvoice> {
     allocate(bankTransaction: BankTransaction, amount?: number): Transaction[];
 }
 
+declare class BudgetCollection extends Collection<Budget> {
+}
+
+declare class CalendarEventCollection<T extends CalendarEvent = CalendarEvent> extends Collection<T> {
+}
+
+declare class MoneyCalendarEventCollection extends CalendarEventCollection<MoneyCalendarEvent> {
+    constructor(items: MoneyCalendarEvent[]);
+    get amount(): number;
+    get expenses(): MoneyCalendarEventCollection;
+    get incomes(): MoneyCalendarEventCollection;
+    filterByDate(dateFrom?: Date, dateTo?: Date): MoneyCalendarEventCollection;
+    getByMonth(index: number): CalendarEventCollection;
+}
+
+declare class BudgetRuleCollection extends Collection<BudgetRule> implements CalendarEventProvider {
+    get expenses(): BudgetRuleCollection;
+    get incomes(): BudgetRuleCollection;
+    filterByProperties(properties: Property$1[]): BudgetRuleCollection;
+    get calendarEvents(): MoneyCalendarEventCollection;
+    getByMonth(index: number): BudgetRuleCollection;
+    getByChartAccountsName(name: string): BudgetRuleCollection;
+}
+
 /**
  * Collection of transactions
  */
@@ -3724,6 +3751,7 @@ declare class TransactionCollection extends TransactionBaseCollection<Transactio
      */
     getBusinessClaimAmount(businessId?: number): number;
     getTaxable(): this;
+    filterByBudget(rules: BudgetRuleCollection): TransactionCollection;
 }
 
 /**
@@ -4235,6 +4263,87 @@ declare enum DepreciationLvpRateEnum {
     DEFAULT = 0.375
 }
 
+declare class BudgetRule$1 extends ObservableModel {
+    static className: string;
+    amount?: number;
+    budget?: Budget$1;
+    chartAccounts?: ChartAccounts$1;
+    startDate?: Date;
+    endDate?: Date;
+    inCalendar?: boolean;
+    frequency?: number;
+    description?: string;
+    bankAccount?: BankAccount$1;
+    property?: Property$1;
+    business?: SoleBusiness;
+    incomeSource?: IncomeSource;
+}
+
+declare class Budget$1 extends AbstractModel {
+    user?: User;
+    financialYear?: number;
+    rules?: BudgetRule$1[];
+}
+
+declare class BudgetRule extends BudgetRule$1 implements CalendarEventProvider {
+    budget: Budget;
+    chartAccounts: ChartAccounts;
+    startDate: Date;
+    endDate?: Date;
+    inCalendar: boolean;
+    bankAccount?: BankAccount$1;
+    property: Property$1;
+    business: SoleBusiness;
+    incomeSource?: IncomeSource;
+    frequency?: DailyFrequencyEnum;
+    /**
+     * creates recurring calendar events based on frequency
+     */
+    get calendarEvents(): MoneyCalendarEventCollection;
+    inMonth(month: number): boolean;
+}
+
+declare enum YoutubeVideosEnum {
+    WELCOME = "350YhMRBnNE",
+    HOLDING_ONBOARDING = "r3RhObELk-E",
+    MONEY_ONBOARDING = "E9NU14ndjhc",
+    PROPERTY_ONBOARDING = "llUV98-EMdI",
+    SOLE_ONBOARDING = "rqfTQFGwkUM",
+    WORK_ONBOARDING = "QEKolzS1B0U",
+    PROPERTY_RENTAL = "MPkB0NBd-9E",
+    PROPERTY_DEPRECIATION = "_34lK9ooFzc",
+    VEHICLE_CLAIM = "4-6WaM83cw0",
+    SOLE_DEPRECIATION = "Bw3tx4miFF8",
+    SOLE_HOME_OFFICE = "fF8_kJHEKRE",
+    WORK_DEPRECIATION = "gNa9M4xovuI",
+    WORK_HOME_OFFICE = "qrQu4Yl72bU",
+    BANK_FEEDS = "meQmpw7ZY7c",
+    BANK_ACCOUNT_TRANSACTION = "meQmpw7ZY7c",
+    ALLOCATE_TRANSACTION = "meQmpw7ZY7c",
+    BUDGET_EXPENSE = "350YhMRBnNE",
+    BUDGET_INCOME = "350YhMRBnNE"
+}
+
+declare class BudgetMetadataInterface {
+    name: string;
+    description: string;
+    thumbnail: string;
+    videoId: YoutubeVideosEnum;
+    categories: Record<TankTypeEnum, ChartAccountsCategoryEnum[]>;
+}
+
+declare class Budget extends Budget$1 {
+    rules: BudgetRule[];
+    user: User$1;
+    financialYear: number;
+    static getMetadata(isIncome: boolean): BudgetMetadataInterface;
+    /**
+     * @TODO TT-4522 remove after release
+     */
+    get rulesCollection(): BudgetRuleCollection;
+    get amount(): number;
+}
+
 declare class Transaction extends Transaction$1 implements Expense {
     static className: string;
     /**
@@ -4324,6 +4433,7 @@ declare class Transaction extends Transaction$1 implements Expense {
     isEditable(): boolean;
     get claimableTax(): number;
     get month(): number;
+    inBudget(rule: BudgetRule): boolean;
 }
 
 declare class AllocationRule extends AllocationRule$1 {
@@ -5452,87 +5562,6 @@ declare enum SharesightPortfolioMessages {
     PUT = "We\u2019re syncing your Sharesight trades, which might take a few minutes. We\u2019ll let you know when they\u2019re ready."
 }
 
-declare class BudgetRule$1 extends ObservableModel {
-    static className: string;
-    amount?: number;
-    budget?: Budget$1;
-    chartAccounts?: ChartAccounts$1;
-    startDate?: Date;
-    endDate?: Date;
-    inCalendar?: boolean;
-    frequency?: number;
-    description?: string;
-    bankAccount?: BankAccount$1;
-    property?: Property$1;
-    business?: SoleBusiness;
-    incomeSource?: IncomeSource;
-}
-
-declare class Budget$1 extends AbstractModel {
-    user?: User;
-    financialYear?: number;
-    rules?: BudgetRule$1[];
-}
-
-declare class BudgetRule extends BudgetRule$1 implements CalendarEventProvider {
-    budget: Budget;
-    chartAccounts: ChartAccounts;
-    startDate: Date;
-    endDate?: Date;
-    inCalendar: boolean;
-    bankAccount?: BankAccount$1;
-    property: Property$1;
-    business: SoleBusiness;
-    incomeSource?: IncomeSource;
-    frequency?: DailyFrequencyEnum;
-    /**
-     * creates recurring calendar events based on frequency
-     */
-    get calendarEvents(): MoneyCalendarEventCollection;
-    inMonth(month: number): boolean;
-}
-
-declare enum YoutubeVideosEnum {
-    WELCOME = "350YhMRBnNE",
-    HOLDING_ONBOARDING = "r3RhObELk-E",
-    MONEY_ONBOARDING = "E9NU14ndjhc",
-    PROPERTY_ONBOARDING = "llUV98-EMdI",
-    SOLE_ONBOARDING = "rqfTQFGwkUM",
-    WORK_ONBOARDING = "QEKolzS1B0U",
-    PROPERTY_RENTAL = "MPkB0NBd-9E",
-    PROPERTY_DEPRECIATION = "_34lK9ooFzc",
-    VEHICLE_CLAIM = "4-6WaM83cw0",
-    SOLE_DEPRECIATION = "Bw3tx4miFF8",
-    SOLE_HOME_OFFICE = "fF8_kJHEKRE",
-    WORK_DEPRECIATION = "gNa9M4xovuI",
-    WORK_HOME_OFFICE = "qrQu4Yl72bU",
-    BANK_FEEDS = "meQmpw7ZY7c",
-    BANK_ACCOUNT_TRANSACTION = "meQmpw7ZY7c",
-    ALLOCATE_TRANSACTION = "meQmpw7ZY7c",
-    BUDGET_EXPENSE = "350YhMRBnNE",
-    BUDGET_INCOME = "350YhMRBnNE"
-}
-
-declare class BudgetMetadataInterface {
-    name: string;
-    description: string;
-    thumbnail: string;
-    videoId: YoutubeVideosEnum;
-    categories: Record<TankTypeEnum, ChartAccountsCategoryEnum[]>;
-}
-
-declare class Budget extends Budget$1 {
-    rules: BudgetRule[];
-    user: User$1;
-    financialYear: number;
-    static getMetadata(isIncome: boolean): BudgetMetadataInterface;
-    /**
-     * @TODO TT-4522 remove after release
-     */
-    get rulesCollection(): BudgetRuleCollection;
-    get amount(): number;
-}
-
 declare enum FinancialGoalStatusEnum {
     ACTIVE = 1,
     PAUSE = 2,
@@ -10121,7 +10150,6 @@ declare class TransactionReportItem {
 
 declare class BudgetReportItem {
     id: number;
-    category: string;
     chartAccounts: string;
     forecast: number;
     net: number;
@@ -10136,7 +10164,7 @@ declare class BudgetReportItem {
 declare class BudgetRuleItem {
     rule: BudgetRule;
     chartAccounts: string;
-    tankType: string;
+    tankType: TankTypeEnum;
     frequency: string;
     actual: number;
     forecast: number;
@@ -10622,6 +10650,7 @@ declare class TransactionBaseFilterForm extends FormGroup<ITransactionBaseFilter
     constructor(model?: TransactionBaseFilter);
     listenEvents(): void;
     filter<ModelClass extends TransactionBase, CollectionClass extends Collection<ModelClass>>(collection: CollectionClass): CollectionClass;
+    filterBudgetRules(rules: BudgetRuleCollection): BudgetRuleCollection;
 }
 
 declare class DepreciationForm extends TransactionBaseForm<Depreciation> {
@@ -11165,18 +11194,6 @@ declare class MessageCollection extends Collection<Message> {
     hasUnread(): boolean;
 }
 
-declare class CalendarEventCollection<T extends CalendarEvent = CalendarEvent> extends Collection<T> {
-}
-
-declare class MoneyCalendarEventCollection extends CalendarEventCollection<MoneyCalendarEvent> {
-    constructor(items: MoneyCalendarEvent[]);
-    get amount(): number;
-    get expenses(): MoneyCalendarEventCollection;
-    get incomes(): MoneyCalendarEventCollection;
-    filterByDate(dateFrom?: Date, dateTo?: Date): MoneyCalendarEventCollection;
-    getByMonth(index: number): CalendarEventCollection;
-}
-
 declare class PropertySaleCollection extends Collection<PropertySale$1> {
     /**
      * Property sales are CGT applicable unless it has "Principle place of residence" exemption type
@@ -11379,18 +11396,6 @@ declare class TransactionReportItemCollection extends Collection<TransactionRepo
     sumBy(path: string, abs?: boolean): number;
 }
 
-declare class BudgetCollection extends Collection<Budget> {
-}
-
-declare class BudgetRuleCollection extends Collection<BudgetRule> implements CalendarEventProvider {
-    get expenses(): BudgetRuleCollection;
-    get incomes(): BudgetRuleCollection;
-    filterByProperties(properties: Property$1[]): BudgetRuleCollection;
-    get calendarEvents(): MoneyCalendarEventCollection;
-    getByMonth(index: number): BudgetRuleCollection;
-    getByChartAccountsName(name: string): BudgetRuleCollection;
-}
-
 declare class BudgetReportItemCollection extends Collection<BudgetReportItem> {
     static create(rules: BudgetRuleCollection, transactions: TransactionCollection): BudgetReportItemCollection;
     onTrack(): boolean;
@@ -11398,6 +11403,8 @@ declare class BudgetReportItemCollection extends Collection<BudgetReportItem> {
 
 declare class BudgetRuleItemCollection extends Collection<BudgetRuleItem> {
     static create(rules: BudgetRuleCollection, transactions: TransactionCollection): BudgetRuleItemCollection;
+    get incomes(): BudgetRuleItemCollection;
+    get expenses(): BudgetRuleItemCollection;
 }
 
 declare class ServiceProductCollection extends Collection<ServiceProduct> {