taxtank-core 0.1.0 → 0.1.1

package/src/lib/models/endpoint/endpoints.const.ts

@@ -0,0 +1,157 @@
+import { Endpoint } from './endpoint';
+
+/**
+ * List of all app endpoints
+ */
+export const ENDPOINTS: {[key: string]: Endpoint} = {
+  ASSETS_GET: new Endpoint('GET', '\\/assets\\/\.\*\\/\\d+'),
+
+  BANK_ACCOUNTS_GET: new Endpoint('GET', '\\/bank-accounts'),
+  BANK_ACCOUNTS_POST: new Endpoint('POST', '\\/bank-accounts'),
+  BANK_ACCOUNTS_PUT: new Endpoint('PUT', '\\/bank-accounts\\/\\d+'),
+  BANK_CONNECTION_POST: new Endpoint('POST', '\\/bank-connections'),
+  BANK_TRANSACTIONS_GET: new Endpoint('GET', '\\/bank-transactions'),
+  BANK_TRANSACTIONS_DELETE: new Endpoint('DELETE', '\\/bank-transactions\\/\\d+'),
+  BANK_TRANSACTIONS_IMPORT_POST: new Endpoint('POST', '\\/bank-transactions\\/\\d+\\/import'),
+  BASIQ_ACCOUNTS_GET: new Endpoint('GET', '\\/basiq\\/\\accounts'),
+
+  CAPITAL_COSTS_GET: new Endpoint('GET', '\\/capital-costs'),
+  CHARTS_INCOME_GET: new Endpoint('GET', '\\/charts\\/\\incomes'),
+  CHARTS_EXPENSES_GET: new Endpoint('GET', '\\/charts\\/\\expenses'),
+  CHART_ACCOUNTS_GET: new Endpoint('GET', '\\/chart-accounts'),
+  CLIENTS_GET: new Endpoint('GET', '\\/clients'),
+  CLIENTS_PUT: new Endpoint('PUT', '\\/clients'),
+  CLIENTS_EXCLUDE_PUT: new Endpoint('PUT', '\\/clients\\/\\d+\\/exclude'),
+  CLIENTS_INVITES_GET: new Endpoint('GET', '\\/clients\\/\\invites'),
+  CLIENTS_INVITES_POST: new Endpoint('POST', '\\/clients\\/\\invites'),
+  CLIENTS_INVITES_DELETE: new Endpoint('DELETE', '\\/clients\\/\\invites\\/\\d+'),
+  CLIENTS_INVITES_ACCEPT_POST: new Endpoint('POST', '\\/clients\\/\\invites\\/\\d+\\/accept'),
+  CLIENTS_INVITES_REJECT_POST: new Endpoint('POST', '\\/clients\\/\\invites\\/\\d+\\/reject'),
+  CLIENTS_INVITES_RESEND_POST: new Endpoint('POST', '\\/clients\\/\\invites\\/\\d+\\/resend'),
+  CLIENT_MOVEMENTS_GET: new Endpoint('GET', '\\/client-movements'),
+  CLIENT_MOVEMENTS_POST: new Endpoint('POST', '\\/client-movements'),
+  COUNTRIES_GET: new Endpoint('GET', '\\/countries'),
+
+  DEPRECIATIONS_CLOSING_GET: new Endpoint('GET', '\\/depreciations\\/\\closing-balance\.\*'),
+  DEPRECIATIONS_GET: new Endpoint('GET', '\\/depreciations'),
+  DEPRECIATIONS_POST: new Endpoint('POST', '\\/depreciations'),
+  DEPRECIATIONS_PUT: new Endpoint('PUT', '\\/depreciations\\/\\d+'),
+
+  EMPLOYEES_GET: new Endpoint('GET', '\\/employees'),
+  EMPLOYEES_INVITES_GET: new Endpoint('GET', '\\/employees\\/\\invites'),
+  EMPLOYEES_INVITES_DELETE: new Endpoint('DELETE', '\\/employees\\/\\invites\\/\\d+'),
+  EMPLOYEES_INVITE_POST: new Endpoint('POST', '\\/employees\\/\\invites'),
+  EMPLOYEES_INVITES_REJECT_POST: new Endpoint('POST', '\\/employees\\/\\invites\\/\\d+\\/\\reject'),
+  EMPLOYEES_INVITES_RESEND_POST: new Endpoint('POST', '\\/employees\\/\\invites\\/\\d+\\/\\resend'),
+
+  FIRM_GET: new Endpoint('GET', '\\/firms'),
+  FIRM_CURRENT_GET: new Endpoint('GET', '\\/firms\\/current'),
+  FIRM_CURRENT_PUT: new Endpoint('PUT', '\\/firms\\/current\.\*'),
+  FIRM_INVITE_POST: new Endpoint('POST', '\\/firms\\/invite'),
+  FIRM_REGISTRATION_POST: new Endpoint('POST', '\\/firms\\/registration'),
+  FIRM_UPDATE_PHOTO_POST: new Endpoint('POST', '\\/firms\\/photo\.\*'),
+  FOLDERS_GET: new Endpoint('GET', '\\/folders'),
+  FOLDERS_POST: new Endpoint('POST', '\\/folders'),
+  FOLDERS_PUT: new Endpoint('PUT', '\\/folders\\/\\d+'),
+  FOLDERS_DOCUMENTS_POST: new Endpoint('POST', '\\/folders\\/\\d+\\/documents'),
+  FOLDERS_DOCUMENTS_PUT: new Endpoint('PUT', '\\/folders\\/\\d+\\/documents\\/\\d+'),
+
+  INCOME_SOURCES_GET: new Endpoint('GET', '\\/income-sources'),
+  INCOME_SOURCES_POST: new Endpoint('POST', '\\/income-sources'),
+  INCOME_SOURCES_PUT: new Endpoint('PUT', '\\/income-sources'),
+  INCOME_SOURCES_DELETE: new Endpoint('DELETE', '\\/income-sources\\/\\d+'),
+  INCOME_SOURCE_FORECAST_GET: new Endpoint('GET', '\\/income-source-forecasts'),
+  INCOME_SOURCE_FORECAST_POST: new Endpoint('POST', '\\/income-source-forecasts'),
+  INCOME_SOURCE_FORECAST_PUT: new Endpoint('PUT', '\\/income-source-forecasts'),
+  INCOME_SOURCE_FORECAST_DELETE: new Endpoint('DELETE', '\\/income-source-forecasts\\/\\d+'),
+  INCOME_SOURCE_TYPES_GET: new Endpoint('GET', '\\/income-source-types'),
+
+  LOANS_GET: new Endpoint('GET', '\\/bank-accounts\\/loans'),
+  LOANS_POST: new Endpoint('POST', '\\/bank-accounts\\/loans'),
+  LOANS_PUT: new Endpoint('PUT', '\\/bank-accounts\\/loans/\\d+'),
+  LOANS_PAYOUT_POST: new Endpoint('POST', '\\/loans\\/\\d+\\/payout'),
+  LOANS_PAYOUT_PUT: new Endpoint('PUT', '\\/loans\\/\\d+\\/payout\\/\\d+'),
+  LOANS_PAYOUT_DELETE: new Endpoint('DELETE', '\\/loans\\/\\d+\\/payout\\/\\d+'),
+  LOANS_CALCULATION_POST: new Endpoint('POST', '\\/bank-accounts\\/loans\\/calculation'),
+  LOGIN_CHECK_POST: new Endpoint('POST', '\\/login_check'),
+
+  NOTIFICATIONS_GET: new Endpoint('GET', '\\/service-notifications'),
+
+  OCCUPATIONS_GET: new Endpoint('GET', '\\/occupations'),
+
+  PROPERTIES_GET: new Endpoint('GET', '\\/properties'),
+  PROPERTIES_POST: new Endpoint('POST', '\\/properties'),
+  PROPERTY_PUT: new Endpoint('PUT', '\\/properties/\\d+'),
+  PROPERTIES_PUT: new Endpoint('PUT', '\\/properties'),
+  PROPERTIES_CATEGORIES_EQUITY_GET: new Endpoint('GET', '\\/properties\\/categories\\/equity'),
+  PROPERTIES_CATEGORIES_GET: new Endpoint('GET', '\\/properties\\/categories'),
+  PROPERTIES_CATEGORIES_PUT: new Endpoint('PUT', '\\/properties\\/categories\\/\\d+'),
+  PROPERTIES_CATEGORIES_POST: new Endpoint('POST', '\\/properties\\/categories'),
+  PROPERTIES_CATEGORY_MOVEMENTS_POST: new Endpoint('POST', '\\/properties\\/\\d+\\/category-movements'),
+  PROPERTIES_CATEGORY_MOVEMENTS_PUT: new Endpoint('PUT', '\\/properties\\/\\d+\\/category-movements\\/\\d+'),
+  PROPERTIES_CO_OWNERS_PUT: new Endpoint('PUT', '\\/properties\\/co-owners\\/\\d+'),
+  PROPERTIES_CO_OWNERS_GET: new Endpoint('GET', '\\/properties\\/co-owners'),
+  PROPERTIES_CO_OWNERS_POST: new Endpoint('POST', '\\/properties\\/co-owners'),
+  PROPERTIES_DEACTIVATE_PUT: new Endpoint('PUT', '\\/properties\\/\\d+\\/deactivate'),
+  PROPERTIES_DEPRECIATION_CAPITAL_PROJECT_GET: new Endpoint('GET', '\\/properties\\/\\d+\\/depreciation-capital-projects'),
+  PROPERTIES_DEPRECIATION_CAPITAL_PROJECT_POST: new Endpoint('POST', '\\/properties\\/\\d+\\/depreciation-capital-projects'),
+  PROPERTIES_DEPRECIATION_CAPITAL_PROJECT_PUT: new Endpoint('PUT', '\\/properties\\/\\d+\\/depreciation-capital-projects\\/\\d+'),
+  PROPERTIES_DEPRECIATION_CAPITAL_PROJECT_DELETE: new Endpoint('DELETE', '\\/properties\\/\\d+\\/depreciation-capital-projects\\/\\d+'),
+  PROPERTIES_DOCUMENTS_GET: new Endpoint('GET', '\\/properties\\/documents'),
+  PROPERTIES_DOCUMENTS_POST: new Endpoint('POST', '\\/properties\\/\\d+\\/documents'),
+  PROPERTIES_DOCUMENTS_PUT: new Endpoint('PUT', '\\/properties\\/documents\\/\\d+'),
+  PROPERTIES_DOCUMENTS_DELETE: new Endpoint('DELETE', '\\/properties\\/documents\\/\\d+'),
+  PROPERTIES_PHOTO_POST: new Endpoint('POST', '\\/properties\\/\\d+\\/photo\.\*'),
+  PROPERTIES_SUGGESTIONS_GET: new Endpoint('GET', '/property\\/\\w+\\/v2\\/.*$'),
+  PROPERTIES_VALUATIONS_DOCUMENTS_POST: new Endpoint('POST', '\\/properties\\/\\d+\\/valuations\\/\\d+\\/documents'),
+
+  PRORATION_COST_POST: new Endpoint('POST', '\\/subscriptions\\/proration-cost'),
+
+  SALARY_FORECAST_GET: new Endpoint('GET', '\\/salary-forecasts'),
+  SALARY_FORECAST_POST: new Endpoint('POST', '\\/salary-forecasts'),
+  SALARY_FORECAST_PUT: new Endpoint('PUT', '\\/salary-forecasts'),
+  SERVICE_PRICES_GET: new Endpoint('GET', '\\/service-prices'),
+  SERVICE_PAYMENTS_GET: new Endpoint('GET', '\\/service-payments'),
+  STRIPE_BILLING_PORTAL_GET: new Endpoint('GET', '\\/stripe\\/billing-portal-session'),
+  STRIPE_CHECKOUT_SESSION_POST: new Endpoint('POST', '\\/stripe\\/checkout-session'),
+  SUBSCRIPTION_LAST_GET: new Endpoint('GET', '\\/subscriptions\\/last'),
+  SUBSCRIPTION_ITEMS_PUT: new Endpoint('PUT', '\\/subscriptions\\/items'),
+
+  TAX_CALCULATION_POST: new Endpoint('POST', '\\/tax-calculation'),
+  TAX_REVIEWS_GET: new Endpoint('GET', '\\/tax-reviews'),
+  TAX_REVIEWS_DELETE: new Endpoint('DELETE', '\\/tax-reviews\\/\\d+'),
+  TAX_REVIEWS_POST: new Endpoint('POST', '\\/tax-reviews'),
+  TAX_REVIEWS_PUT: new Endpoint('PUT', '\\/tax-reviews\\/\\d+'),
+  TAX_SUMMARY_ACTUAL_GET: new Endpoint('GET', '\\/tax-summary\\/actuals'),
+  TAX_SUMMARY_FORECAST_GET: new Endpoint('GET', '\\/tax-summary\\/forecasts'),
+  TRANSACTION_DELETE: new Endpoint('DELETE', '\\/transactions\\/\\d+'),
+  TRANSACTION_PUT: new Endpoint('PUT', '\\/transactions\\/\\d+'),
+  TRANSACTIONS_GET: new Endpoint('GET', '\\/transactions'),
+  TRANSACTIONS_POST: new Endpoint('POST', '\\/transactions'),
+  TRANSACTIONS_PUT: new Endpoint('PUT', '\\/transactions'),
+  TRANSACTIONS_ALLOCATIONS_GET: new Endpoint('GET', '\\/transactions-allocations'),
+  TRANSACTIONS_ALLOCATIONS_POST: new Endpoint('POST', '\\/transactions-allocations'),
+  TRANSACTIONS_ALLOCATIONS_DELETE: new Endpoint('DELETE', '\\/transactions-allocations\\/\\d+'),
+
+  USER_CONFIRMATION_POST: new Endpoint('POST', '\\/users\\/confirmation'),
+  USER_CURRENT_GET: new Endpoint('GET', '\\/users\\/current'),
+  USER_CURRENT_PASSWORD_PUT: new Endpoint('PUT', '\\/users\\/current\\/password\.\*'),
+  USER_EVENT_SETTINGS_GET: new Endpoint('GET', '\\/user-event-settings'),
+  USER_EVENT_TYPES_GET: new Endpoint('GET', '\\/user-event-types'),
+  USER_INVITE_DELETE: new Endpoint('DELETE', '\\/users\\/invite\\/\\d+'),
+  USER_INVITE_POST: new Endpoint('POST', '\\/users\\/invite'),
+  USER_INVITE_RESEND_POST: new Endpoint('POST', '\\/users\\/invite/\\d+\\/resend'),
+  USER_PUT: new Endpoint('PUT', '\\/users\\/\\d+'),
+  USER_REGISTRATION_POST: new Endpoint('POST', '\\/users\\/registration'),
+  USER_RESET_PASSWORD_PUT: new Endpoint('PUT', '\\/users\\/reset-password'),
+  USER_SEARCH_GET: new Endpoint('GET', '\\/users\\/search\.\*'),
+  USER_UPDATE_PHOTO_POST: new Endpoint('POST', '\\/users\\/photo\.\*'),
+  USER_STATUS_PUT: new Endpoint('PUT', '\\/users\\/status'),
+
+  VEHICLES_GET: new Endpoint('GET', '\\/vehicles'),
+  VEHICLE_CLAIMS_GET: new Endpoint('GET', '\\/vehicle-claims'),
+  VEHICLE_CLAIMS_POST: new Endpoint('POST', '\\/vehicle-claims'),
+  VEHICLE_LOGBOOK_POST: new Endpoint('POST', '\\/vehicles\\/\\d+\\/logbooks'),
+  VEHICLE_LOGBOOK_PUT: new Endpoint('PUT', '\\/vehicles\\/\\d+\\/logbooks\\/\\d+'),
+  VEHICLE_CLAIMS_PUT: new Endpoint('PUT', '\\/vehicle-claims\\/\\d+')
+};

package/src/lib/models/event/app-event-type.enum.ts

@@ -0,0 +1,37 @@
+export enum AppEventTypeEnum {
+  CLIENT_MOVEMENT_CLOSED,
+  BANK_CONNECTION_ADDED,
+  BANK_ACCOUNT_CREATED,
+  BANK_ACCOUNT_UPDATED,
+  BANK_TRANSACTION_ALLOCATED,
+  CLIENT_INVITE_ACCEPTED,
+  CLIENT_OPEN_CHAT,
+  CLIENT_TRANSFER_TO_OTHER_EMPLOYEE,
+  DEPRECIATION_DELETED,
+  DEPRECIATIONS_CREATED,
+  INCOME_SOURCES_CREATED,
+  INCOME_SOURCES_UPDATED,
+  INCOME_SOURCES_FORECASTS_CREATED,
+  INCOME_SOURCES_FORECASTS_UPDATED,
+  LOAN_UPDATED,
+  LOAN_PAYOUT_UPDATED,
+  MESSAGE_CREATED,
+  MESSAGE_FILE_CREATED,
+  MESSAGE_FILE_DELETED,
+  NOTIFICATION_ADDED,
+  PROPERTY_UPDATED_WITH_DOCUMENT,
+  PROPERTY_DOCUMENT_ADDED,
+  PROPERTY_OWNER_UPDATED,
+  PROPERTY_SUBSCRIPTION_ADDED,
+  PROPERTY_SUBSCRIPTION_DELETED,
+  PROPERTY_VALUATION_DOCUMENT_CREATED,
+  SERVICE_SUBSCRIPTION_UPDATED,
+  TAX_REVIEW_UPDATED,
+  TRANSACTION_CREATED,
+  TRANSACTION_DELETED,
+  TRANSACTION_UPDATED,
+  TRANSACTIONS_CREATED,
+  USER_UPDATED,
+  VEHICLE_CLAIM_UPDATED,
+  VEHICLE_CLAIM_CREATED
+}

package/src/lib/models/event/app-event.ts

@@ -0,0 +1,9 @@
+import { AppEventTypeEnum } from './app-event-type.enum';
+
+/**
+ * any event happened in the app, which needs to be handled somehow (distributed to other part of the app)
+ */
+export class AppEvent<T> {
+  constructor(public type: AppEventTypeEnum, public payload: T) {
+  }
+}

package/src/lib/models/file/icons-file.enum.ts

@@ -0,0 +1,5 @@
+export enum IconsFileEnum {
+  JPG = 'icon-image-jpg',
+  PDF = 'icon-doc-pdf',
+  DOC = 'icon-doc'
+}

package/src/lib/models/financial-year/financial-year.ts

@@ -0,0 +1,57 @@
+export class FinancialYear {
+  constructor(date?: Date) {
+    this.year = date ? FinancialYear.toFinYear(date) : +localStorage.getItem('financialYear') || FinancialYear.toFinYear(new Date());
+
+    this.setStartDate(this.year);
+    this.setEndDate(this.year);
+  }
+
+  static startMonthIndex: number = 6;
+  year: number;
+  startDate: Date;
+  endDate: Date;
+
+  private yearStartDate: string = '-07-01';
+  private yearEndDate: string = '-06-30';
+
+  includes(date: Date): boolean {
+    return this.year === new FinancialYear(date).year;
+  }
+
+  static toFinYear(date: Date): number {
+    return date.getFullYear() + (date.getMonth() >= this.startMonthIndex ? 1 : 0);
+  }
+
+  get prevFinYear(): FinancialYear {
+    return new FinancialYear(new Date(`${new Date().getFullYear() - 1}${this.yearStartDate}`));
+  }
+
+  /**
+   * Get date by desired month
+   */
+  getMonthDate(monthIndex: number): Date {
+    if (monthIndex >= FinancialYear.startMonthIndex) {
+      return new Date(`${this.year - 1}-${monthIndex + 1}-01`);
+    }
+    return new Date(`${this.year}-${monthIndex + 1}-01`);
+  }
+
+  private setStartDate(year: number): void {
+    this.startDate = new Date(`${year - 1}${this.yearStartDate}`);
+  }
+
+  private setEndDate(year: number): void {
+    this.endDate = new Date(`${year}${this.yearEndDate}`);
+  }
+
+  getPastMonths(): number[] {
+    const months: number[] = [];
+    const now: Date = new Date();
+    const endDate: Date = this.endDate < now ? this.endDate : now;
+    for (const d: Date = this.startDate; d <= endDate; d.setMonth(d.getMonth() + 1)) {
+      months.push(d.getMonth());
+    }
+
+    return months;
+  }
+}

package/src/lib/models/financial-year/month-name-short.enum.ts

@@ -0,0 +1,19 @@
+/**
+ * @TODO move to pipe/translation
+ * enum with months short names.
+ * Order of items match with financial year months order
+ */
+export enum MonthNameShortEnum {
+  JULY = 'Jul',
+  AUGUST = 'Aug',
+  SEPTEMBER = 'Sep',
+  OCTOBER = 'Oct',
+  NOVEMBER = 'Nov',
+  DECEMBER = 'Dec',
+  JANUARY = 'Jan',
+  FEBRUARY = 'Feb',
+  MARCH = 'Mar',
+  APRIL = 'Apr',
+  MAY = 'May',
+  JUNE = 'Jun'
+}

package/src/lib/models/financial-year/month-number.enum.ts

@@ -0,0 +1,19 @@
+/**
+ * enum with months indexes.
+ * item value match with js Date month index from 0 to 11
+ * Order of items match with financial year months order
+ */
+export enum MonthNumberEnum {
+  JULY = 6,
+  AUGUST = 7,
+  SEPTEMBER = 8,
+  OCTOBER = 9,
+  NOVEMBER = 10,
+  DECEMBER = 11,
+  JANUARY = 0,
+  FEBRUARY = 1,
+  MARCH = 2,
+  APRIL = 3,
+  MAY = 4,
+  JUNE = 5
+}

package/src/lib/models/financial-year/months.const.ts

@@ -0,0 +1 @@
+export const MONTHS: string[] = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec', 'Jan'];

package/src/lib/models/firm/firm.ts

@@ -0,0 +1,31 @@
+import { Firm as FirmBase } from '../../db/Models/firm';
+import { Phone } from '../phone/phone';
+import { Address } from '../address/address';
+import { User } from '../user/user';
+import { Type } from 'class-transformer';
+import { Photoable } from '../../interfaces/photoable';
+
+export class Firm extends FirmBase implements Photoable {
+  @Type(() => User)
+  owner: User;
+
+  @Type(() => Address)
+  address: Address;
+
+  @Type(() => Phone)
+  phone: Phone;
+
+  /**
+   * get firm photo link
+   */
+  getPhoto(): string {
+    return this.photo;
+  }
+
+  /**
+   * get firm initials
+   */
+  getInitials(): string {
+    return `${this.name[0].toUpperCase()}${this.name[1]}`;
+  }
+}

package/src/lib/models/income-position/income-position.ts

@@ -0,0 +1,13 @@
+import { Type } from 'class-transformer';
+
+// Todo extend from the base model when the backend is ready TT-555
+export class IncomePosition {
+  @Type(() => Date)
+  date: Date;
+  income: number;
+  expenses: number;
+  otherIncome: number;
+  otherDeductions: number;
+  incomeForecast: number;
+  incomeSourceForecast: number;
+}

package/src/lib/models/income-source/income-source-chart-data.ts

@@ -0,0 +1,57 @@
+import { TransactionCollection } from '../../collections/transaction.collection';
+import { IChartData } from '../../interfaces/chart-data.interface';
+import { FinancialYear } from '../financial-year/financial-year';
+import { MonthNameShortEnum } from '../financial-year/month-name-short.enum';
+import { MonthNumberEnum } from '../financial-year/month-number.enum';
+
+/**
+ * Income sources chart data
+ */
+export class IncomeSourceChartData {
+  private forecastedIncomeAmount: number;
+  private transactions: TransactionCollection;
+
+  constructor(
+    forecastedIncomeAmount: number,
+    transactions: TransactionCollection,
+  ) {
+    this.forecastedIncomeAmount = forecastedIncomeAmount;
+    this.transactions = transactions;
+  }
+
+  /**
+   * Get prepared data for income sources chart
+   */
+  get(): IChartData[] {
+    const chartData: IChartData[] = [{
+      id: 'actualIncome',
+      name: 'Actual Income',
+      data: [],
+      // display future actual incomes with dash line and past actual incomes with solid line
+      zones: [{
+        // line style after current month
+        value: new FinancialYear().getMonthDate(new Date().getMonth()).getTime(),
+        dashStyle: 'Solid'
+      }, {
+        // default line style
+        dashStyle: 'Dash'
+      }]
+    }, {
+      id: 'forecastedIncome',
+      name: 'Forecasted Income',
+      data: [],
+    }];
+
+    for (const key in MonthNameShortEnum) {
+      if (MonthNameShortEnum.hasOwnProperty(key)) {
+        // transaction collection for provided month
+        const monthTransactionCollection: TransactionCollection = this.transactions.getByMonth(+MonthNumberEnum[key]);
+
+        chartData[0].data.push([new FinancialYear().getMonthDate(+MonthNumberEnum[key]).getTime(), monthTransactionCollection.amount]);
+        chartData[1].data.push([new FinancialYear().getMonthDate(+MonthNumberEnum[key]).getTime(), this.forecastedIncomeAmount / 12]);
+      }
+    }
+
+    return chartData;
+  }
+}

package/src/lib/models/income-source/income-source-forecast.ts

@@ -0,0 +1,35 @@
+import { IncomeSourceForecast as IncomeSourceForecastBase } from '../../db/Models/income-source-forecast';
+import { SalaryForecastFrequencyEnum } from '../../db/Enums/salary-forecast-frequency.enum';
+import { IIncomeSourceForecast } from '../../interfaces/income-source-forecast.interface';
+import { Type } from 'class-transformer';
+import { ISalaryForecast } from '../../interfaces/salary-forecast.interface';
+import { IncomeSourceType } from './income-source-type';
+import { IncomeSource } from './income-source';
+
+export class IncomeSourceForecast extends IncomeSourceForecastBase implements IIncomeSourceForecast, ISalaryForecast {
+  id: number;
+
+  @Type(() => IncomeSourceType)
+  incomeSourceType: IncomeSourceType;
+
+  tax: number;
+  paygIncome: number = 0;
+  financialYear: number;
+  frequency: SalaryForecastFrequencyEnum = SalaryForecastFrequencyEnum.ANNUAL;
+  isTaxFree: boolean = false;
+
+  @Type(() => IncomeSource)
+  incomeSource: IncomeSource;
+
+  /**
+   * Sometimes Income source has Salary & Income source forecasts,
+   * and we need these fields to work with Income source forecasts like with Salary Forecasts
+   */
+  get netPay(): number {
+    return this.amount;
+  }
+
+  get grossAmount(): number {
+    return this.amount + this.tax + this.taxInstalments + this.frankingCredits;
+  }
+}

package/src/lib/models/income-source/income-source-type.ts

@@ -0,0 +1,30 @@
+import { IncomeSourceType as IncomeSourceTypeBase } from '../../db/Models/income-source-type';
+import { IncomeSourceTypeListSalaryEnum } from '../../db/Enums/income-source-type-list-salary.enum';
+import { IncomeSourceTypeListWorkEnum } from '../../db/Enums/income-source-type-list-work.enum';
+import { IncomeSourceTypeListOtherEnum } from '../../db/Enums/income-source-type-list-other.enum';
+import { IncomeSourceTypeEnum } from '../../db/Enums/income-source-type.enum';
+
+export class IncomeSourceType extends IncomeSourceTypeBase {
+  isSalary(): boolean {
+    return !!IncomeSourceTypeListSalaryEnum[this.id];
+  }
+
+  isWork(): boolean {
+    return !!IncomeSourceTypeListWorkEnum[this.id];
+  }
+
+  isOther(): boolean {
+    return !!IncomeSourceTypeListOtherEnum[this.id];
+  }
+
+  get type(): IncomeSourceTypeEnum {
+    switch (true) {
+      case this.isSalary():
+        return IncomeSourceTypeEnum.SALARY;
+      case this.isWork():
+        return IncomeSourceTypeEnum.WORK;
+      default:
+        return IncomeSourceTypeEnum.OTHER;
+    }
+  }
+}

package/src/lib/models/income-source/income-source.ts

@@ -0,0 +1,57 @@
+import { IncomeSource as IncomeSourceBase } from '../../db/Models/income-source';
+import { IncomeSourceTypeEnum } from '../../db/Enums/income-source-type.enum';
+import { ISalaryForecast } from '../../interfaces/salary-forecast.interface';
+import { IIncomeSourceForecast } from '../../interfaces/income-source-forecast.interface';
+import { Type } from 'class-transformer';
+import { SalaryForecast } from './salary-forecast';
+import { IncomeSourceForecast } from './income-source-forecast';
+import { FinancialYear } from '../financial-year/financial-year';
+
+export class IncomeSource extends IncomeSourceBase {
+  @Type(() => SalaryForecast)
+  salaryForecasts: SalaryForecast[];
+
+  @Type(() => IncomeSourceForecast)
+  incomeSourceForecasts: IncomeSourceForecast[];
+
+  @Type(() => Date)
+  dateFrom: Date;
+
+  @Type(() => Date)
+  dateTo: Date;
+
+  isSalaryIncome(): boolean {
+    return this.type === IncomeSourceTypeEnum.SALARY;
+  }
+
+  isWorkIncome(): boolean {
+    return this.type === IncomeSourceTypeEnum.WORK;
+  }
+
+  isOtherIncome(): boolean {
+    return this.type === IncomeSourceTypeEnum.OTHER;
+  }
+
+  /**
+   * Get salary and other income forecasts
+   */
+  get forecasts(): ISalaryForecast[] {
+    return [...this.salaryForecasts, ...this.incomeSourceForecasts];
+  }
+
+  /**
+   * Get actual (1st from the list) forecast
+   */
+  get actualForecast(): IIncomeSourceForecast {
+    return this.forecasts[0];
+  }
+
+  /**
+   * Check if user was working in month taken by the index
+   * @param monthIndex by which month should be taken
+   */
+  isWorkedInMonth(monthIndex: number): boolean {
+    const monthDate: Date = new FinancialYear().getMonthDate(monthIndex);
+    return (!this.dateFrom || monthDate >= this.dateFrom) && (!this.dateTo || monthDate < this.dateTo);
+  }
+}

package/src/lib/models/income-source/salary-forecast.ts

@@ -0,0 +1,23 @@
+import { SalaryForecast as SalaryForecastBase } from '../../db/Models/salary-forecast';
+import { ISalaryForecast } from '../../interfaces/salary-forecast.interface';
+import { SalaryForecastFrequencyEnum } from '../../db/Enums/salary-forecast-frequency.enum';
+import { IncomeSource } from './income-source';
+import { IIncomeSourceForecast } from '../../interfaces/income-source-forecast.interface';
+import { Expose, Transform, Type } from 'class-transformer';
+
+export class SalaryForecast extends SalaryForecastBase implements IIncomeSourceForecast, ISalaryForecast {
+  id: number;
+
+  @Transform(({obj}) => obj.netPay + obj.tax)
+  @Expose() grossAmount: number;
+
+  tax: number;
+  netPay: number;
+  paygIncome: number;
+  financialYear: number;
+  frequency: SalaryForecastFrequencyEnum;
+  isTaxFree: boolean;
+
+  @Type(() => IncomeSource)
+  incomeSource: IncomeSource;
+}

package/src/lib/models/loan/loan-max-number-of-payments.enum.ts

@@ -0,0 +1,8 @@
+/**
+ * Enum with maximum number of payments, depending on the frequency
+ */
+export enum LoanMaxNumberOfPaymentsEnum {
+  WEEKLY = 260,
+  FORTNIGHTLY = 130,
+  MONTHLY = 60,
+}

package/src/lib/models/loan/loan-payment.ts

@@ -0,0 +1,17 @@
+import { Type } from 'class-transformer';
+
+// @Todo no base model from backend list
+/**
+ * Loan payment class
+ */
+export class LoanPayment {
+  @Type(() => Date)
+  date: Date;
+  interestAccrued: number;
+  interestBalance: number;
+  number: number;
+  paymentDue: number;
+  principalBalance: number;
+  principalPaid: number;
+  totalOwed: number;
+}

package/src/lib/models/loan/loan-payout.ts

@@ -0,0 +1,13 @@
+import { LoanPayout as LoanPayoutBase } from '../../db/Models/loan-payout';
+import { LoanPayoutTypeEnum } from '../../db/Enums/loan-payout-type.enum';
+
+export class LoanPayout extends LoanPayoutBase {
+  type: LoanPayoutTypeEnum;
+
+  /**
+   * Check if payout type is refinance
+   */
+  isRefinance(): boolean {
+    return this.type === LoanPayoutTypeEnum.REFINANCE;
+  }
+}

package/src/lib/models/loan/loan.ts

@@ -0,0 +1,38 @@
+import { Loan as LoanBase } from '../../db/Models/loan';
+import { LoanRepaymentTypeEnum } from '../../db/Enums/loan-repayment-type.enum';
+import { LoanVehicleTypeEnum } from '../../db/Enums/loan-vehicle-type.enum';
+import { Type } from 'class-transformer';
+import { LoanPayment } from './loan-payment';
+import { LoanPayout } from './loan-payout';
+import { FinancialYear } from '../financial-year/financial-year';
+import last from 'lodash/last';
+
+export class Loan extends LoanBase {
+  @Type(() => LoanPayment)
+  payments: LoanPayment[];
+
+  @Type(() => Date)
+  commencementDate: Date;
+
+  @Type(() => LoanPayout)
+  payout: LoanPayout;
+
+  repaymentType: LoanRepaymentTypeEnum = LoanRepaymentTypeEnum.PRINCIPAL_AND_INTEREST;
+  currentBalance: number;
+
+  /**
+   * Check if loan type is related to LoanVehicleTypeEnum
+   */
+  isVehicle(): boolean {
+    return this.type in LoanVehicleTypeEnum;
+  }
+
+  /**
+   * Get the last payment for passed financial year
+   * @param year financial year for filter
+   */
+  getLastPaymentByYear(year: number): LoanPayment {
+    const finYear: FinancialYear = new FinancialYear(new Date(year.toString()));
+    return last(this.payments.filter((payment: LoanPayment): boolean => payment.date > finYear.startDate && payment.date < finYear.endDate));
+  }
+}