taxtank-core 0.0.2 → 0.1.2

package/lib/models/chart-accounts/chart-accounts-depreciation.d.ts

@@ -0,0 +1,7 @@
+import { ChartAccountsDepreciation as ChartAccountsDepreciationBase } from '../../db/Models/chart-accounts-depreciation';
+import { ChartAccounts } from './chart-accounts';
+export declare class ChartAccountsDepreciation extends ChartAccountsDepreciationBase {
+    chartAccounts: ChartAccounts;
+    limit: number;
+    effectiveLife: number;
+}

package/lib/models/chart-accounts/chart-accounts-heading.d.ts

@@ -0,0 +1,5 @@
+import { ChartAccountsHeading as ChartAccountsHeadingBase } from '../../db/Models/chart-accounts-heading';
+import { ChartAccounts } from './chart-accounts';
+export declare class ChartAccountsHeading extends ChartAccountsHeadingBase {
+    chartAccounts: ChartAccounts[];
+}

package/lib/models/chart-accounts/chart-accounts-metadata.d.ts

@@ -0,0 +1,8 @@
+import { ChartAccountsMetadata as ChartAccountsMetadataBase } from '../../db/Models/chart-accounts-metadata';
+export declare class ChartAccountsMetadata extends ChartAccountsMetadataBase {
+    /**
+     * Check if metadata id is related to SHARE_PERCENTAGE value
+     */
+    isSharePercentage(): boolean;
+    isHours(): boolean;
+}

package/lib/models/chart-accounts/chart-accounts-tax-labels.enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum ChartAccountsTaxLabelsEnum {
+    TAX_WITHHELD = "Tax withheld",
+    TAX_PAID = "Tax Paid",
+    TAX_DEDUCTED = "Tax Deducted"
+}

package/lib/models/chart-accounts/chart-accounts.d.ts

@@ -0,0 +1,66 @@
+import { ChartAccounts as ChartAccountsBase } from '../../db/Models/chart-accounts';
+import { ChartAccountsHeading } from './chart-accounts-heading';
+import { ChartAccountsMetadata } from './chart-accounts-metadata';
+export declare class ChartAccounts extends ChartAccountsBase {
+    heading: ChartAccountsHeading;
+    metadata: ChartAccountsMetadata[];
+    /**
+     * Return name as string
+     */
+    toString(): string;
+    /**
+     * Check if chart accounts id is related for 'Klms travelled for work' category
+     */
+    isKlmsForWork(): boolean;
+    /**
+     * Check if chart accounts id is related for 'NRAS Tax Offset' category
+     */
+    isNRAS(): boolean;
+    /**
+     * Check if chart accounts id is related for 'Interest on Loan' category
+     */
+    isInterestOnLoan(): boolean;
+    /**
+     * Check if chart accounts id is related for 'Motor Vehicles' category
+     */
+    isVehicles(): boolean;
+    /**
+     * Check if chart accounts id is related for 'Interest Earned' category
+     */
+    isInterestEarned(): boolean;
+    /**
+     * Check if chart accounts id is related for 'Trust Income' category
+     */
+    isTrustIncome(): boolean;
+    /**
+     * Check if chart accounts id is related for 'Motor vehicles (commercial cars)' category
+     */
+    isCommercialVehicles(): boolean;
+    /**
+     * Check if chart accounts is work income
+     */
+    isWorkIncome(): boolean;
+    isVehicleExpense(): boolean;
+    /**
+     * Check if chart accounts is other income
+     */
+    isOtherIncome(): boolean;
+    isIncome(): boolean;
+    isProperty(): boolean;
+    isWorkExpense(): boolean;
+    /**
+     * Check if chart accounts is property expense
+     */
+    isPropertyExpense(): boolean;
+    isPersonal(): boolean;
+    isPersonalExpense(): boolean;
+    isPropertyDepreciation(): boolean;
+    /**
+     * Check if chart accounts category is depreciation
+     */
+    isDepreciation(): boolean;
+    /**
+     * Check if transaction chart account is work related car expenses
+     */
+    isVehicleLoanExpense(): boolean;
+}

package/lib/models/chat/chat-view-type.enum.d.ts

@@ -0,0 +1,4 @@
+export declare enum ChatViewTypeEnum {
+    MESSAGES = 0,
+    ATTACHMENTS = 1
+}

package/lib/models/chat/chat.d.ts

@@ -0,0 +1,10 @@
+import { Chat as ChatBase } from '../../db/Models/chat';
+import { User } from '../user/user';
+export declare class Chat extends ChatBase {
+    employee: User;
+    client: User;
+    /**
+     * Check if chat is active
+     */
+    isActive(): boolean;
+}

package/lib/models/chat/message-document.d.ts

@@ -0,0 +1,11 @@
+import { MessageDocument as MessageDocumentBase } from '../../db/Models/message-document';
+import { IAsset } from '../../interfaces/asset.interface';
+import { AssetEntityTypeEnum } from '../../interfaces/asset-entity-type.enum';
+import { AssetTypeEnum } from '../../interfaces/asset-type.enum';
+import { User } from '../user/user';
+export declare class MessageDocument extends MessageDocumentBase implements IAsset {
+    entityType: AssetEntityTypeEnum;
+    type: AssetTypeEnum;
+    user: User;
+    file: File;
+}

package/lib/models/chat/message.d.ts

@@ -0,0 +1,20 @@
+import { Message as MessageBase } from '../../db/Models/message';
+import { User } from '../user/user';
+import { MessageDocument } from './message-document';
+export declare class Message extends MessageBase {
+    createdAt: Date;
+    employee: User;
+    documents: MessageDocument[];
+    /**
+     * Check if message created today or not
+     */
+    isToday(): boolean;
+    /**
+     * Check if message sent from firm
+     */
+    isFromEmployee(): boolean;
+    /**
+     * Check if message read
+     */
+    isRead(): boolean;
+}

package/lib/models/client/client-details.d.ts

@@ -0,0 +1,3 @@
+import { ClientDetails as ClientDetailsBase } from '../../db/Models/client-details';
+export declare class ClientDetails extends ClientDetailsBase {
+}

package/lib/models/client/client-invite.d.ts

@@ -0,0 +1,34 @@
+import { ClientInvite as ClientInviteBase } from '../../db/Models/client-invite';
+import { RegistrationInvite } from '../registration-invite/registration-invite';
+import { Firm } from '../firm/firm';
+import { User } from '../user/user';
+export declare class ClientInvite extends ClientInviteBase {
+    sentOn: Date;
+    updatedAt: Date;
+    firm: Firm;
+    client: User;
+    employee: User;
+    registrationInvite: RegistrationInvite;
+    /**
+     * Check if client invite status is pending
+     */
+    isPending(): boolean;
+    /**
+     * Check if client invite status is accepted
+     */
+    isAccepted(): boolean;
+    /**
+     * Check if client invite status is rejected
+     */
+    isRejected(): boolean;
+    /**
+     * Check if client invite initiated by firm
+     */
+    isFromEmployee(): boolean;
+    /**
+     * Check if client invite initiated by client
+     */
+    isFromClient(): boolean;
+    get firstName(): string;
+    get email(): string;
+}

package/lib/models/client/client-movement.d.ts

@@ -0,0 +1,12 @@
+import { ClientMovement as ClientMovementBase } from '../../db/Models/client-movement';
+import { ServiceSubscription } from '../service-subscription/service-subscription';
+import { Firm } from '../firm/firm';
+import { User } from '../user/user';
+export declare class ClientMovement extends ClientMovementBase {
+    firm: Firm;
+    client: User;
+    employee: User;
+    subscription: ServiceSubscription;
+    dateFrom: Date;
+    dateTo: Date;
+}

package/lib/models/client/client-portfolio-chart-data.d.ts

@@ -0,0 +1,11 @@
+import { ClientPortfolioReportCollection } from '../../collections/client-portfolio-report.collection';
+import { ChartData } from '../chart/chart-data';
+/**
+ * Client portfolio charts data based on ClientPortfolioReportCollection
+ */
+export declare class ClientPortfolioChartData {
+    private clientsPortfolioReportCollection;
+    constructor(clientsPortfolioReportCollection: ClientPortfolioReportCollection);
+    getPieChartData(): ChartData[];
+    getBarChartData(): ChartData[];
+}

package/lib/models/client/client-portfolio-report.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Class describes client's portfolio report information
+ */
+export declare class ClientPortfolioReport {
+    category: string;
+    count: number;
+    marketValue: number;
+    loanBalance: number;
+    equityPosition: number;
+}

package/lib/models/depreciation/depreciation-capital-project.d.ts

@@ -0,0 +1,5 @@
+import { DepreciationCapitalProject as DepreciationCapitalProjectBase } from '../../db/Models/depreciation-capital-project';
+export declare class DepreciationCapitalProject extends DepreciationCapitalProjectBase {
+    propertyId: number;
+    effectiveDate: Date;
+}

package/lib/models/depreciation/depreciation-forecast.d.ts

@@ -0,0 +1,8 @@
+import { DepreciationForecast as DepreciationForecastBase } from '../../db/Models/depreciation-forecast';
+export declare class DepreciationForecast extends DepreciationForecastBase {
+    isLVP: boolean;
+    get dailyClaimAmount(): number;
+    get daysApplied(): number;
+    getDaysByMonth(month: number): number;
+    getClaimAmountByMonth(month: number): number;
+}

package/lib/models/depreciation/depreciation-group-item.d.ts

@@ -0,0 +1,10 @@
+import { DepreciationGroup } from './depreciation-group';
+import { Depreciation } from './depreciation';
+/**
+ * Depreciation Tree node with depreciation details
+ */
+export declare class DepreciationGroupItem extends DepreciationGroup {
+    depreciation: Depreciation;
+    constructor(depreciation: Depreciation);
+    getClaimAmount(): number;
+}

package/lib/models/depreciation/depreciation-group.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Depreciation Nested Tree node with depreciations group
+ */
+export declare class DepreciationGroup {
+    label: string;
+    description: string;
+    icon: string;
+    children: DepreciationGroup[];
+    constructor(label: string, description?: string, icon?: string, children?: DepreciationGroup[]);
+    getClaimAmount(): number;
+}

package/lib/models/depreciation/depreciation-group.enum.d.ts

@@ -0,0 +1,7 @@
+export declare enum DepreciationGroupEnum {
+    BUILDING_IMPROVEMENTS = 0,
+    PLANT_EQUIPMENT = 1,
+    LOW_VALUE_POOL = 2,
+    WRITTEN_OFF_ITEMS = 3,
+    BORROWING_EXPENSES = 4
+}

package/lib/models/depreciation/depreciation-groups.const.d.ts

@@ -0,0 +1,9 @@
+interface DepreciationGroup {
+    label: string;
+    description: string;
+    icon: string;
+}
+export declare const DEPRECIATION_GROUPS: {
+    [key: number]: DepreciationGroup;
+};
+export {};

package/lib/models/depreciation/depreciation-receipt.d.ts

@@ -0,0 +1,8 @@
+import { DepreciationReceipt as DepreciationReceiptBase } from '../../db/Models/depreciation-receipt';
+import { IAsset } from '../../interfaces/asset.interface';
+import { AssetTypeEnum } from '../../interfaces/asset-type.enum';
+import { AssetEntityTypeEnum } from '../../interfaces/asset-entity-type.enum';
+export declare class DepreciationReceipt extends DepreciationReceiptBase implements IAsset {
+    type: AssetTypeEnum;
+    entityType: AssetEntityTypeEnum;
+}

package/lib/models/depreciation/depreciation.d.ts

@@ -0,0 +1,69 @@
+import { Depreciation as DepreciationBase } from '../../db/Models/depreciation';
+import { DepreciationTypeEnum } from '../../db/Enums/depreciation-type.enum';
+import { DepreciationCapitalProject } from './depreciation-capital-project';
+import { DepreciationForecast } from './depreciation-forecast';
+import { ChartAccounts } from '../chart-accounts/chart-accounts';
+import { BankTransaction } from '../bank/bank-transaction';
+import { ITank } from '../../interfaces/tank.interface';
+import { IReceipt } from '../../interfaces/receipt.interface';
+import { IAsset } from '../../interfaces/asset.interface';
+export declare class Depreciation extends DepreciationBase implements ITank, IReceipt {
+    static WRITTEN_OFF_THRESHOLD: number;
+    static LOW_VALUE_POOL_THRESHOLD: number;
+    purchaseDate: Date;
+    date: Date;
+    writeOffManualDate: Date;
+    writeOffDate: Date;
+    depreciationCapitalProject: DepreciationCapitalProject;
+    forecasts: DepreciationForecast[];
+    chartAccounts: ChartAccounts;
+    bankTransaction: BankTransaction;
+    type: DepreciationTypeEnum;
+    receipt: IAsset;
+    isCapital(): boolean;
+    isBorrowingExpense(): boolean;
+    isAsset(): boolean;
+    /**
+     * check if depreciation should be displayed in written off category
+     * details in project documentation
+     * @TODO new FinancialYear(this.writeOffDate) === new FinancialYear()
+     */
+    isWrittenOff(): boolean;
+    /**
+     * Check if depreciation is Plant & Equipment
+     */
+    isPlantEquipment(): boolean;
+    /**
+     * check if depreciation should be displayed in low value pool
+     * details in project documentation
+     * @TODO new FinancialYear(this.writeOffDate) === new FinancialYear()
+     */
+    isLowValuePool(): boolean;
+    isPropertyTank(): boolean;
+    isWorkTank(): boolean;
+    isPrimeCost(): boolean;
+    isDiminishing(): boolean;
+    /**
+     * Check if depreciation chart accounts heading related to vehicles category
+     */
+    isVehicleDepreciation(): boolean;
+    /**
+     * Get depreciation purchase date
+     */
+    getDate(): Date;
+    /**
+     * @TODO wrong year, use current financial year, check everywhere
+     */
+    get currentYearForecast(): DepreciationForecast;
+    getForecastByYear(year: number): DepreciationForecast;
+    /**
+     * get depreciation's closing balance for current financial year
+     * open balance here because closing balance in POST actually saves to previous financial year forecast
+     */
+    getCloseBalance(): number;
+    get claimAmount(): number;
+    getClaimAmountByYear(year: number): number;
+    get assetValue(): number;
+    getClaimPercent(): number;
+    isBuildingAtCost(): boolean;
+}

package/lib/models/document/document-api-url-prefix.enum.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Enum with document types which used to API url prefix
+ */
+export declare enum DocumentApiUrlPrefixEnum {
+    FOLDERS = "folders",
+    PROPERTIES = "properties"
+}

package/lib/models/document/document-file-types.const.d.ts

@@ -0,0 +1,3 @@
+export declare const DOCUMENT_FILE_TYPES: {
+    [key: string]: string[];
+};

package/lib/models/document/document-folder.d.ts

@@ -0,0 +1,7 @@
+import { DocumentFolder as DocumentFolderBase } from '../../db/Models/document-folder';
+import { Documentable } from '../../interfaces/documentable.interface';
+import { Document } from './document';
+export declare class DocumentFolder extends DocumentFolderBase implements Documentable {
+    documentFile: File;
+    documents: Document[];
+}

package/lib/models/document/document.d.ts

@@ -0,0 +1,21 @@
+import { Document as DocumentBase } from '../../db/Models/document';
+import { IAsset } from '../../interfaces/asset.interface';
+import { AssetTypeEnum } from '../../interfaces/asset-type.enum';
+import { AssetEntityTypeEnum } from '../../interfaces/asset-entity-type.enum';
+import { DocumentFolder } from './document-folder';
+import { IDocument } from '../../interfaces/document.interface';
+import { Documentable } from '../../interfaces/documentable.interface';
+export declare class Document extends DocumentBase implements IAsset, IDocument {
+    file: File;
+    type: AssetTypeEnum;
+    entityType: AssetEntityTypeEnum;
+    folder: DocumentFolder;
+    /**
+     * Get folder as document parent entity
+     */
+    getEntity(): Documentable;
+    /**
+     * Get API url prefix
+     */
+    getApiUrlPrefix(): string;
+}

package/lib/models/employee/employee-details.d.ts

@@ -0,0 +1,5 @@
+import { EmployeeDetails as EmployeeDetailsBase } from '../../db/Models/employee-details';
+import { Firm } from '../firm/firm';
+export declare class EmployeeDetails extends EmployeeDetailsBase {
+    firm: Firm;
+}

package/lib/models/employee/employee-invite.d.ts

@@ -0,0 +1,7 @@
+import { EmployeeInvite as EmployeeInviteBase } from '../../db/Models/employee-invite';
+import { RegistrationInvite } from '../registration-invite/registration-invite';
+import { User } from '../user/user';
+export declare class EmployeeInvite extends EmployeeInviteBase {
+    registrationInvite: RegistrationInvite;
+    employee: User;
+}

package/lib/models/endpoint/endpoint.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Available request methods
+ */
+declare type RequestMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+/**
+ * Backend endpoint class
+ */
+export declare class Endpoint {
+    method: RequestMethod;
+    pattern: string;
+    constructor(method: RequestMethod, pattern: string);
+    /**
+     * check url with regexp
+     * @param url
+     */
+    test(url: string): boolean;
+    /**
+     * Get regexp for endpoint
+     */
+    get regexp(): RegExp;
+}
+export {};

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

@@ -0,0 +1,7 @@
+import { Endpoint } from './endpoint';
+/**
+ * List of all app endpoints
+ */
+export declare const ENDPOINTS: {
+    [key: string]: Endpoint;
+};

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

@@ -0,0 +1,37 @@
+export declare enum AppEventTypeEnum {
+    CLIENT_MOVEMENT_CLOSED = 0,
+    BANK_CONNECTION_ADDED = 1,
+    BANK_ACCOUNT_CREATED = 2,
+    BANK_ACCOUNT_UPDATED = 3,
+    BANK_TRANSACTION_ALLOCATED = 4,
+    CLIENT_INVITE_ACCEPTED = 5,
+    CLIENT_OPEN_CHAT = 6,
+    CLIENT_TRANSFER_TO_OTHER_EMPLOYEE = 7,
+    DEPRECIATION_DELETED = 8,
+    DEPRECIATIONS_CREATED = 9,
+    INCOME_SOURCES_CREATED = 10,
+    INCOME_SOURCES_UPDATED = 11,
+    INCOME_SOURCES_FORECASTS_CREATED = 12,
+    INCOME_SOURCES_FORECASTS_UPDATED = 13,
+    LOAN_UPDATED = 14,
+    LOAN_PAYOUT_UPDATED = 15,
+    MESSAGE_CREATED = 16,
+    MESSAGE_FILE_CREATED = 17,
+    MESSAGE_FILE_DELETED = 18,
+    NOTIFICATION_ADDED = 19,
+    PROPERTY_UPDATED_WITH_DOCUMENT = 20,
+    PROPERTY_DOCUMENT_ADDED = 21,
+    PROPERTY_OWNER_UPDATED = 22,
+    PROPERTY_SUBSCRIPTION_ADDED = 23,
+    PROPERTY_SUBSCRIPTION_DELETED = 24,
+    PROPERTY_VALUATION_DOCUMENT_CREATED = 25,
+    SERVICE_SUBSCRIPTION_UPDATED = 26,
+    TAX_REVIEW_UPDATED = 27,
+    TRANSACTION_CREATED = 28,
+    TRANSACTION_DELETED = 29,
+    TRANSACTION_UPDATED = 30,
+    TRANSACTIONS_CREATED = 31,
+    USER_UPDATED = 32,
+    VEHICLE_CLAIM_UPDATED = 33,
+    VEHICLE_CLAIM_CREATED = 34
+}

package/lib/models/event/app-event.d.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 declare class AppEvent<T> {
+    type: AppEventTypeEnum;
+    payload: T;
+    constructor(type: AppEventTypeEnum, payload: T);
+}

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

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

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

@@ -0,0 +1,19 @@
+export declare class FinancialYear {
+    constructor(date?: Date);
+    static startMonthIndex: number;
+    year: number;
+    startDate: Date;
+    endDate: Date;
+    private yearStartDate;
+    private yearEndDate;
+    includes(date: Date): boolean;
+    static toFinYear(date: Date): number;
+    get prevFinYear(): FinancialYear;
+    /**
+     * Get date by desired month
+     */
+    getMonthDate(monthIndex: number): Date;
+    private setStartDate;
+    private setEndDate;
+    getPastMonths(): number[];
+}

package/lib/models/financial-year/month-name-short.enum.d.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 declare 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/lib/models/financial-year/month-number.enum.d.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 declare 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/lib/models/financial-year/months.const.d.ts

@@ -0,0 +1 @@
+export declare const MONTHS: string[];

package/lib/models/firm/firm.d.ts

@@ -0,0 +1,18 @@
+import { Firm as FirmBase } from '../../db/Models/firm';
+import { Phone } from '../phone/phone';
+import { Address } from '../address/address';
+import { User } from '../user/user';
+import { Photoable } from '../../interfaces/photoable';
+export declare class Firm extends FirmBase implements Photoable {
+    owner: User;
+    address: Address;
+    phone: Phone;
+    /**
+     * get firm photo link
+     */
+    getPhoto(): string;
+    /**
+     * get firm initials
+     */
+    getInitials(): string;
+}

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

@@ -0,0 +1,9 @@
+export declare class IncomePosition {
+    date: Date;
+    income: number;
+    expenses: number;
+    otherIncome: number;
+    otherDeductions: number;
+    incomeForecast: number;
+    incomeSourceForecast: number;
+}

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

@@ -0,0 +1,14 @@
+import { TransactionCollection } from '../../collections/transaction.collection';
+import { IChartData } from '../../interfaces/chart-data.interface';
+/**
+ * Income sources chart data
+ */
+export declare class IncomeSourceChartData {
+    private forecastedIncomeAmount;
+    private transactions;
+    constructor(forecastedIncomeAmount: number, transactions: TransactionCollection);
+    /**
+     * Get prepared data for income sources chart
+     */
+    get(): IChartData[];
+}

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

@@ -0,0 +1,22 @@
+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 { ISalaryForecast } from '../../interfaces/salary-forecast.interface';
+import { IncomeSourceType } from './income-source-type';
+import { IncomeSource } from './income-source';
+export declare class IncomeSourceForecast extends IncomeSourceForecastBase implements IIncomeSourceForecast, ISalaryForecast {
+    id: number;
+    incomeSourceType: IncomeSourceType;
+    tax: number;
+    paygIncome: number;
+    financialYear: number;
+    frequency: SalaryForecastFrequencyEnum;
+    isTaxFree: boolean;
+    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;
+    get grossAmount(): number;
+}