@driveup/schema 0.1.0

package/lib/profile/company/finances/billing/transaction.entity.js

@@ -0,0 +1,158 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompanyBillTransactionEntity = void 0;
+const typeorm_1 = require("typeorm");
+const common_1 = require("@driveup/common");
+const bill_entity_1 = require("./bill.entity");
+const method_entity_1 = require("../payment/method.entity");
+const promotion_entity_1 = require("../../../agent/promotion.entity");
+const utils_1 = require("../../../../utils");
+let CompanyBillTransactionEntity = class CompanyBillTransactionEntity extends utils_1.TrackableEntity {
+    billId;
+    paymentMethodId;
+    status;
+    amount;
+    provider;
+    /**
+     * Provider payment method id
+     */
+    providerId;
+    providerResponse;
+    /**
+     * Payment confirmed by job task
+     */
+    paidOn;
+    /**
+     * Payment failed on date
+     */
+    failedOn;
+    /**
+     * Company bill associated with this transaction
+     */
+    bill;
+    /**
+     * Payment method used for this transaction
+     */
+    paymentMethod;
+    /**
+     * Agent promotion associated with this transaction
+     * The agent earns profit from this transaction based on his percentage
+     * The earning period is limited to the promotion start (company created date)
+     * and driveup promotion requirements (12 months)
+     */
+    agentPromotion;
+    constructor(props) {
+        super();
+        Object.assign(this, props);
+    }
+    async toModel() {
+        return new common_1.BillTransaction({
+            id: this.id,
+            provider: this.provider,
+            status: this.status,
+            paymentMethod: (await this.paymentMethod).toModel(),
+            amount: this.amount,
+        });
+    }
+    toSummary() {
+        return new common_1.BillTransaction({
+            id: this.id,
+            status: this.status,
+            amount: this.amount,
+        });
+    }
+    async getActivities() {
+        const activities = [];
+        activities.push(await (0, utils_1.toActivity)(this.createdOn, common_1.ActivityType.createdOn));
+        activities.push(await (0, utils_1.toActivity)(this.paidOn, common_1.ActivityType.paidOn));
+        activities.push(await (0, utils_1.toActivity)(this.failedOn, common_1.ActivityType.failedOn));
+        return activities.filter(a => a);
+    }
+};
+exports.CompanyBillTransactionEntity = CompanyBillTransactionEntity;
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Number)
+], CompanyBillTransactionEntity.prototype, "billId", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Number)
+], CompanyBillTransactionEntity.prototype, "paymentMethodId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'enum',
+        enum: [
+            common_1.StatusType.Pending,
+            common_1.StatusType.Paid,
+            common_1.StatusType.Failed
+        ],
+        default: common_1.StatusType.Pending,
+        nullable: true
+    }),
+    __metadata("design:type", String)
+], CompanyBillTransactionEntity.prototype, "status", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'decimal',
+        precision: 12,
+        scale: 2,
+        nullable: false,
+        default: 0
+    }),
+    __metadata("design:type", Number)
+], CompanyBillTransactionEntity.prototype, "amount", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'enum',
+        enum: common_1.PaymentProvider,
+        default: common_1.PaymentProvider.Stripe,
+        nullable: false
+    }),
+    __metadata("design:type", String)
+], CompanyBillTransactionEntity.prototype, "provider", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Number)
+], CompanyBillTransactionEntity.prototype, "providerId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'simple-json',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Object)
+], CompanyBillTransactionEntity.prototype, "providerResponse", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Date)
+], CompanyBillTransactionEntity.prototype, "paidOn", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Date)
+], CompanyBillTransactionEntity.prototype, "failedOn", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => bill_entity_1.CompanyBillEntity, bill => bill.transactions),
+    __metadata("design:type", Promise)
+], CompanyBillTransactionEntity.prototype, "bill", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => method_entity_1.CompanyPaymentMethodEntity, paymentMethod => paymentMethod.transactions),
+    __metadata("design:type", Promise)
+], CompanyBillTransactionEntity.prototype, "paymentMethod", void 0);
+__decorate([
+    (0, typeorm_1.OneToOne)(() => promotion_entity_1.AgentPromotionEntity, payout => payout.transaction),
+    __metadata("design:type", Promise)
+], CompanyBillTransactionEntity.prototype, "agentPromotion", void 0);
+exports.CompanyBillTransactionEntity = CompanyBillTransactionEntity = __decorate([
+    (0, typeorm_1.Entity)('companyBillTransactions'),
+    __metadata("design:paramtypes", [Object])
+], CompanyBillTransactionEntity);
+//# sourceMappingURL=transaction.entity.js.map

package/lib/profile/company/finances/billing/transaction.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.entity.js","sourceRoot":"","sources":["../../../../../src/profile/company/finances/billing/transaction.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAA8D;AAC9D,4CAAuG;AAEvG,+CAAkD;AAClD,4DAAsE;AACtE,sEAAuE;AACvE,6CAAgE;AAGzD,IAAM,4BAA4B,GAAlC,MAAM,4BAA6B,SAAQ,uBAAgC;IAGjF,MAAM,CAAS;IAGf,eAAe,CAAS;IAYxB,MAAM,CAAa;IASnB,MAAM,CAAS;IAQf,QAAQ,CAAkB;IAE1B;;OAEG;IAEH,UAAU,CAAS;IAOnB,gBAAgB,CAAM;IAEtB;;OAEG;IAEH,MAAM,CAAO;IAEb;;OAEG;IAEH,QAAQ,CAAO;IAEf;;OAEG;IAEH,IAAI,CAA6B;IAEjC;;OAEG;IAEH,aAAa,CAAsC;IAEnD;;;;;OAKG;IAEH,cAAc,CAA6B;IAE3C,YAAY,KAA6C;QACxD,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,OAAO;QACZ,OAAO,IAAI,wBAAe,CAAC;YAC1B,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,aAAa,EAAE,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,CAAC,OAAO,EAAE;YACnD,MAAM,EAAE,IAAI,CAAC,MAAM;SACnB,CAAC,CAAC;IACJ,CAAC;IAED,SAAS;QACR,OAAO,IAAI,wBAAe,CAAC;YAC1B,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;SACnB,CAAC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa;QAClB,MAAM,UAAU,GAAe,EAAE,CAAC;QAClC,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,MAAM,EAAE,qBAAY,CAAC,MAAM,CAAC,CAAC,CAAC;QACpE,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,QAAQ,EAAE,qBAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;QACxE,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;CACD,CAAA;AAjHY,oEAA4B;AAGxC;IADC,IAAA,gBAAM,GAAE;;4DACM;AAGf;IADC,IAAA,gBAAM,GAAE;;qEACe;AAYxB;IAVC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE;YACL,mBAAU,CAAC,OAAO;YAClB,mBAAU,CAAC,IAAI;YACf,mBAAU,CAAC,MAAM;SACjB;QACD,OAAO,EAAE,mBAAU,CAAC,OAAO;QAC3B,QAAQ,EAAE,IAAI;KACd,CAAC;;4DACiB;AASnB;IAPC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,SAAS;QACf,SAAS,EAAE,EAAE;QACb,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,CAAC;KACV,CAAC;;4DACa;AAQf;IANC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,wBAAe;QACrB,OAAO,EAAE,wBAAe,CAAC,MAAM;QAC/B,QAAQ,EAAE,KAAK;KACf,CAAC;;8DACwB;AAM1B;IADC,IAAA,gBAAM,GAAE;;gEACU;AAOnB;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;sEACoB;AAMtB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;8BAClC,IAAI;4DAAC;AAMb;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;8BAChC,IAAI;8DAAC;AAMf;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,+BAAiB,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;;0DAC7B;AAMjC;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,0CAA0B,EAAE,aAAa,CAAC,EAAE,CAAC,aAAa,CAAC,YAAY,CAAC;;mEACtC;AASnD;IADC,IAAA,kBAAQ,EAAC,GAAG,EAAE,CAAC,uCAAoB,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC;;oEACxB;uCAjF/B,4BAA4B;IADxC,IAAA,gBAAM,EAAC,yBAAyB,CAAC;;GACrB,4BAA4B,CAiHxC"}

package/lib/profile/company/finances/expense/category.entity.d.ts

@@ -0,0 +1,55 @@
+import { Activity, Category } from '@driveup/common';
+import { CompanyEntity } from '../../company.entity';
+import { CompanyExpenseEntity } from './expense.entity';
+import { TrackableEntity } from '../../../../utils';
+/**
+ * Entity representing an expense category for company financial tracking.
+ * Each category organizes related expenses and provides visual identification through images.
+ * Categories can be sorted and are specific to individual companies.
+ */
+export declare class CompanyExpenseCategoryEntity extends TrackableEntity<Category> {
+    /**
+     * Foreign key reference to the company that owns this expense category.
+     */
+    companyId: number;
+    /**
+     * Display name for the expense category.
+     */
+    title: string;
+    /**
+     * URL to the icon or image representing this category.
+     */
+    imageUrl: string;
+    /**
+     * Sort order for displaying categories, defaults to 1.
+     */
+    sort: number;
+    /**
+     * Many-to-one relationship with the owning company.
+     */
+    company: Promise<CompanyEntity>;
+    /**
+     * One-to-many relationship with expenses belonging to this category.
+     */
+    expenses: Promise<CompanyExpenseEntity[]>;
+    /**
+     * Creates a new expense category instance.
+     * @param props - Partial properties to initialize the entity.
+     */
+    constructor(props?: Partial<CompanyExpenseCategoryEntity>);
+    /**
+     * Converts the entity to a Category model object.
+     * @returns Category model with basic information.
+     */
+    toModel(): Category;
+    /**
+     * Returns a summary of the expense category.
+     * @returns Category model (same as toModel for this entity).
+     */
+    toSummary(): Category;
+    /**
+     * Retrieves the activity history for this expense category.
+     * @returns Array of Activity objects showing creation and update information.
+     */
+    getActivities(): Promise<Activity[]>;
+}

package/lib/profile/company/finances/expense/category.entity.js

@@ -0,0 +1,117 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompanyExpenseCategoryEntity = void 0;
+const typeorm_1 = require("typeorm");
+const common_1 = require("@driveup/common");
+const company_entity_1 = require("../../company.entity");
+const expense_entity_1 = require("./expense.entity");
+const utils_1 = require("../../../../utils");
+/**
+ * Entity representing an expense category for company financial tracking.
+ * Each category organizes related expenses and provides visual identification through images.
+ * Categories can be sorted and are specific to individual companies.
+ */
+let CompanyExpenseCategoryEntity = class CompanyExpenseCategoryEntity extends utils_1.TrackableEntity {
+    /**
+     * Foreign key reference to the company that owns this expense category.
+     */
+    companyId;
+    /**
+     * Display name for the expense category.
+     */
+    title;
+    /**
+     * URL to the icon or image representing this category.
+     */
+    imageUrl;
+    /**
+     * Sort order for displaying categories, defaults to 1.
+     */
+    sort;
+    /**
+     * Many-to-one relationship with the owning company.
+     */
+    company;
+    /**
+     * One-to-many relationship with expenses belonging to this category.
+     */
+    expenses;
+    /**
+     * Creates a new expense category instance.
+     * @param props - Partial properties to initialize the entity.
+     */
+    constructor(props) {
+        super();
+        Object.assign(this, props);
+    }
+    /**
+     * Converts the entity to a Category model object.
+     * @returns Category model with basic information.
+     */
+    toModel() {
+        return new common_1.Category({
+            id: this.id,
+            title: this.title,
+            imageUrl: this.imageUrl,
+            sort: this.sort
+        });
+    }
+    /**
+     * Returns a summary of the expense category.
+     * @returns Category model (same as toModel for this entity).
+     */
+    toSummary() {
+        return this.toModel();
+    }
+    /**
+     * Retrieves the activity history for this expense category.
+     * @returns Array of Activity objects showing creation and update information.
+     */
+    async getActivities() {
+        const activities = [];
+        activities.push(await (0, utils_1.toActivity)(this.createdBy, common_1.ActivityType.createdBy));
+        activities.push(await (0, utils_1.toActivity)(this.createdOn, common_1.ActivityType.createdOn));
+        activities.push(await (0, utils_1.toActivity)(this.updatedBy, common_1.ActivityType.updatedBy));
+        activities.push(await (0, utils_1.toActivity)(this.updatedOn, common_1.ActivityType.updatedOn));
+        return activities.filter(a => a);
+    }
+};
+exports.CompanyExpenseCategoryEntity = CompanyExpenseCategoryEntity;
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Number)
+], CompanyExpenseCategoryEntity.prototype, "companyId", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], CompanyExpenseCategoryEntity.prototype, "title", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], CompanyExpenseCategoryEntity.prototype, "imageUrl", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ default: 1 }),
+    __metadata("design:type", Number)
+], CompanyExpenseCategoryEntity.prototype, "sort", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => company_entity_1.CompanyEntity, company => company.expenseCategories),
+    __metadata("design:type", Promise)
+], CompanyExpenseCategoryEntity.prototype, "company", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)(() => expense_entity_1.CompanyExpenseEntity, expense => expense.category),
+    __metadata("design:type", Promise)
+], CompanyExpenseCategoryEntity.prototype, "expenses", void 0);
+exports.CompanyExpenseCategoryEntity = CompanyExpenseCategoryEntity = __decorate([
+    (0, typeorm_1.Entity)('companyExpenseCategories'),
+    __metadata("design:paramtypes", [Object])
+], CompanyExpenseCategoryEntity);
+//# sourceMappingURL=category.entity.js.map

package/lib/profile/company/finances/expense/category.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"category.entity.js","sourceRoot":"","sources":["../../../../../src/profile/company/finances/expense/category.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAAgE;AAChE,4CAAmE;AACnE,yDAAqD;AACrD,qDAAwD;AACxD,6CAAgE;AAEhE;;;;GAIG;AAEI,IAAM,4BAA4B,GAAlC,MAAM,4BAA6B,SAAQ,uBAAyB;IAE1E;;OAEG;IAEH,SAAS,CAAS;IAElB;;OAEG;IAEH,KAAK,CAAS;IAEd;;OAEG;IAEH,QAAQ,CAAS;IAEjB;;OAEG;IAEH,IAAI,CAAS;IAEb;;OAEG;IAEH,OAAO,CAAyB;IAEhC;;OAEG;IAEH,QAAQ,CAAkC;IAE1C;;;OAGG;IACH,YAAY,KAA6C;QACxD,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACH,OAAO;QACN,OAAO,IAAI,iBAAQ,CAAC;YACnB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,IAAI;SACf,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,SAAS;QACR,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa;QAClB,MAAM,UAAU,GAAe,EAAE,CAAC;QAClC,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;CACD,CAAA;AAhFY,oEAA4B;AAMxC;IADC,IAAA,gBAAM,GAAE;;+DACS;AAMlB;IADC,IAAA,gBAAM,GAAE;;2DACK;AAMd;IADC,IAAA,gBAAM,GAAE;;8DACQ;AAMjB;IADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;;0DACV;AAMb;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,8BAAa,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC;;6DACrC;AAMhC;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,qCAAoB,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC;;8DACzB;uCApC9B,4BAA4B;IADxC,IAAA,gBAAM,EAAC,0BAA0B,CAAC;;GACtB,4BAA4B,CAgFxC"}

package/lib/profile/company/finances/expense/expense.entity.d.ts

@@ -0,0 +1,48 @@
+import { Activity, Expense, StatusType } from '@driveup/common';
+import { CompanyEntity } from '../../company.entity';
+import { CompanyExpenseCategoryEntity } from './category.entity';
+import { TrackableEntity } from '../../../../utils';
+/**
+ * Represents a company expense record.
+ * Tracks expenses incurred by the company, categorized and requiring approval.
+ * Used for financial reporting and expense management.
+ *
+ * @extends TrackableEntity<Expense>
+ */
+export declare class CompanyExpenseEntity extends TrackableEntity<Expense> {
+    /**
+     * Reference to the company that incurred this expense
+     */
+    companyId: number;
+    /**
+     * Reference to the expense category
+     * Null for uncategorized expenses
+     */
+    categoryId: number;
+    /**
+     * Approval status of the expense
+     * @default StatusType.Pending
+     */
+    status: StatusType;
+    /**
+     * Expense amount
+     * Precision: 8 digits, Scale: 2 decimal places
+     * @default 0
+     */
+    amount: number;
+    /**
+     * Detailed description of the expense
+     */
+    description: string;
+    receiptUrl: string;
+    approvedBy: number;
+    approvedOn: Date;
+    rejectedBy: number;
+    rejectedOn: Date;
+    company: Promise<CompanyEntity>;
+    category: Promise<CompanyExpenseCategoryEntity>;
+    constructor(props?: Partial<CompanyExpenseEntity>);
+    toModel(): Promise<Expense>;
+    toSummary(): Expense;
+    getActivities(): Promise<Activity[]>;
+}

package/lib/profile/company/finances/expense/expense.entity.js

@@ -0,0 +1,171 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompanyExpenseEntity = void 0;
+const typeorm_1 = require("typeorm");
+const common_1 = require("@driveup/common");
+const company_entity_1 = require("../../company.entity");
+const category_entity_1 = require("./category.entity");
+const utils_1 = require("../../../../utils");
+/**
+ * Represents a company expense record.
+ * Tracks expenses incurred by the company, categorized and requiring approval.
+ * Used for financial reporting and expense management.
+ *
+ * @extends TrackableEntity<Expense>
+ */
+let CompanyExpenseEntity = class CompanyExpenseEntity extends utils_1.TrackableEntity {
+    /**
+     * Reference to the company that incurred this expense
+     */
+    companyId;
+    /**
+     * Reference to the expense category
+     * Null for uncategorized expenses
+     */
+    categoryId;
+    /**
+     * Approval status of the expense
+     * @default StatusType.Pending
+     */
+    status;
+    /**
+     * Expense amount
+     * Precision: 8 digits, Scale: 2 decimal places
+     * @default 0
+     */
+    amount;
+    /**
+     * Detailed description of the expense
+     */
+    description;
+    receiptUrl;
+    approvedBy;
+    approvedOn;
+    rejectedBy;
+    rejectedOn;
+    company;
+    category;
+    constructor(props) {
+        super();
+        Object.assign(this, props);
+    }
+    async toModel() {
+        const category = await this.category;
+        return new common_1.Expense({
+            id: this.id,
+            category: category?.toModel(),
+            status: this.status,
+            amount: this.amount,
+            description: this.description,
+            receiptUrl: this.receiptUrl,
+        });
+    }
+    toSummary() {
+        return new common_1.Expense({
+            id: this.id,
+            status: this.status,
+            amount: this.amount,
+            receiptUrl: this.receiptUrl,
+        });
+    }
+    async getActivities() {
+        const activities = [];
+        activities.push(await (0, utils_1.toActivity)(this.createdBy, common_1.ActivityType.createdBy));
+        activities.push(await (0, utils_1.toActivity)(this.createdOn, common_1.ActivityType.createdOn));
+        activities.push(await (0, utils_1.toActivity)(this.updatedBy, common_1.ActivityType.updatedBy));
+        activities.push(await (0, utils_1.toActivity)(this.updatedOn, common_1.ActivityType.updatedOn));
+        activities.push(await (0, utils_1.toActivity)(this.approvedBy, common_1.ActivityType.approvedBy));
+        activities.push(await (0, utils_1.toActivity)(this.approvedOn, common_1.ActivityType.approvedOn));
+        activities.push(await (0, utils_1.toActivity)(this.rejectedBy, common_1.ActivityType.rejectedBy));
+        activities.push(await (0, utils_1.toActivity)(this.rejectedOn, common_1.ActivityType.rejectedOn));
+        return activities.filter(a => a);
+    }
+};
+exports.CompanyExpenseEntity = CompanyExpenseEntity;
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Number)
+], CompanyExpenseEntity.prototype, "companyId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Number)
+], CompanyExpenseEntity.prototype, "categoryId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'enum',
+        enum: [
+            common_1.StatusType.Pending,
+            common_1.StatusType.Approved,
+            common_1.StatusType.Rejected
+        ],
+        default: common_1.StatusType.Pending,
+        nullable: false
+    }),
+    __metadata("design:type", String)
+], CompanyExpenseEntity.prototype, "status", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'decimal',
+        precision: 8,
+        scale: 2,
+        nullable: false,
+        default: 0
+    }),
+    __metadata("design:type", Number)
+], CompanyExpenseEntity.prototype, "amount", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'mediumtext',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", String)
+], CompanyExpenseEntity.prototype, "description", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", String)
+], CompanyExpenseEntity.prototype, "receiptUrl", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Number)
+], CompanyExpenseEntity.prototype, "approvedBy", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Date)
+], CompanyExpenseEntity.prototype, "approvedOn", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Number)
+], CompanyExpenseEntity.prototype, "rejectedBy", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Date)
+], CompanyExpenseEntity.prototype, "rejectedOn", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => company_entity_1.CompanyEntity, company => company.expenses),
+    __metadata("design:type", Promise)
+], CompanyExpenseEntity.prototype, "company", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => category_entity_1.CompanyExpenseCategoryEntity, category => category.expenses),
+    __metadata("design:type", Promise)
+], CompanyExpenseEntity.prototype, "category", void 0);
+exports.CompanyExpenseEntity = CompanyExpenseEntity = __decorate([
+    (0, typeorm_1.Entity)('companyExpenses'),
+    __metadata("design:paramtypes", [Object])
+], CompanyExpenseEntity);
+//# sourceMappingURL=expense.entity.js.map

package/lib/profile/company/finances/expense/expense.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"expense.entity.js","sourceRoot":"","sources":["../../../../../src/profile/company/finances/expense/expense.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAAoD;AACpD,4CAA8E;AAC9E,yDAAqD;AACrD,uDAAiE;AACjE,6CAAgE;AAEhE;;;;;;GAMG;AAEI,IAAM,oBAAoB,GAA1B,MAAM,oBAAqB,SAAQ,uBAAwB;IAEjE;;OAEG;IAEH,SAAS,CAAS;IAElB;;;OAGG;IAKH,UAAU,CAAS;IAEnB;;;OAGG;IAWH,MAAM,CAAa;IAEnB;;;;OAIG;IAQH,MAAM,CAAS;IAEf;;OAEG;IAMH,WAAW,CAAS;IAMpB,UAAU,CAAS;IAGnB,UAAU,CAAS;IAGnB,UAAU,CAAO;IAGjB,UAAU,CAAS;IAGnB,UAAU,CAAO;IAGjB,OAAO,CAAyB;IAGhC,QAAQ,CAAwC;IAEhD,YAAY,KAAqC;QAChD,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,OAAO;QACZ,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC;QACrC,OAAO,IAAI,gBAAO,CAAC;YAClB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE;YAC7B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,UAAU,EAAE,IAAI,CAAC,UAAU;SAC3B,CAAC,CAAA;IACH,CAAC;IAED,SAAS;QACR,OAAO,IAAI,gBAAO,CAAC;YAClB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,UAAU,EAAE,IAAI,CAAC,UAAU;SAC3B,CAAC,CAAA;IACH,CAAC;IAED,KAAK,CAAC,aAAa;QAClB,MAAM,UAAU,GAAe,EAAE,CAAC;QAClC,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,UAAU,EAAE,qBAAY,CAAC,UAAU,CAAC,CAAC,CAAC;QAC5E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,UAAU,EAAE,qBAAY,CAAC,UAAU,CAAC,CAAC,CAAC;QAC5E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,UAAU,EAAE,qBAAY,CAAC,UAAU,CAAC,CAAC,CAAC;QAC5E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,UAAU,EAAE,qBAAY,CAAC,UAAU,CAAC,CAAC,CAAC;QAC5E,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;CACD,CAAA;AAxHY,oDAAoB;AAMhC;IADC,IAAA,gBAAM,GAAE;;uDACS;AAUlB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;wDACiB;AAgBnB;IAVC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE;YACL,mBAAU,CAAC,OAAO;YAClB,mBAAU,CAAC,QAAQ;YACnB,mBAAU,CAAC,QAAQ;SACnB;QACD,OAAO,EAAE,mBAAU,CAAC,OAAO;QAC3B,QAAQ,EAAE,KAAK;KACf,CAAC;;oDACiB;AAcnB;IAPC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,SAAS;QACf,SAAS,EAAE,CAAC;QACZ,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,CAAC;KACV,CAAC;;oDACa;AAUf;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,YAAY;QAClB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;yDACkB;AAMpB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;wDACiB;AAGnB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;wDACvB;AAGnB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;8BAC9B,IAAI;wDAAC;AAGjB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;wDACvB;AAGnB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;8BAC9B,IAAI;wDAAC;AAGjB;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,8BAAa,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC;;qDAC5B;AAGhC;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,8CAA4B,EAAE,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC;;sDAC7B;+BAhFpC,oBAAoB;IADhC,IAAA,gBAAM,EAAC,iBAAiB,CAAC;;GACb,oBAAoB,CAwHhC"}

package/lib/profile/company/finances/handover/handover.entity.d.ts

@@ -0,0 +1,44 @@
+import { Activity, Handover } from '@driveup/common';
+import { CompanyEntity } from '../../company.entity';
+import { CompanyExpenseEntity } from '../expense/expense.entity';
+import { StudentTrainingTransactionEntity } from '../../../student/program/training/transaction.entity';
+import { CompanyInstructorEntity } from '../../instructor/instructor.entity';
+import { TrackableEntity } from '../../../../utils';
+export declare class CompanyHandoverEntity extends TrackableEntity<Handover> {
+    companyId: number;
+    /**
+     * Manager who approved the handover
+     */
+    managerId: number;
+    /**
+     * Instructor who is receiving the handover
+     */
+    instructorId: number;
+    /**
+     * List of approved student transactions IDs
+     */
+    approvedPayments: number[];
+    /**
+     * List of approved instructor expense IDs
+     */
+    approvedExpenses: number[];
+    /**
+     * List of rejected instructor expense IDs
+     */
+    rejectedExpenses: number[];
+    /********************* for history purpose /*********************/
+    totalApprovedPayments: number;
+    totalApprovedExpenses: number;
+    totalRejectedExpenses: number;
+    company: Promise<CompanyEntity>;
+    instructor: Promise<CompanyInstructorEntity>;
+    constructor(props?: Partial<CompanyHandoverEntity>);
+    toModel(): Promise<Handover>;
+    toSummary(): Promise<Handover>;
+    getApprovedPayments(): Promise<StudentTrainingTransactionEntity[]>;
+    getApprovedExpenses(): Promise<CompanyExpenseEntity[]>;
+    getRejectedExpenses(): Promise<CompanyExpenseEntity[]>;
+    getManager(): Promise<CompanyInstructorEntity>;
+    getInstructor(): Promise<CompanyInstructorEntity>;
+    getActivities(): Promise<Activity[]>;
+}