@driveup/schema 0.1.0

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

@@ -0,0 +1,338 @@
+"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.CompanyBillEntity = void 0;
+const typeorm_1 = require("typeorm");
+const common_1 = require("@driveup/common");
+const company_entity_1 = require("../../company.entity");
+const transaction_entity_1 = require("./transaction.entity");
+const item_entity_1 = require("./item.entity");
+const utils_1 = require("../../../../utils");
+/**
+ * Entity representing a company's billing statement for a specific period.
+ *
+ * @extends TrackableEntity<Bill>
+ */
+let CompanyBillEntity = class CompanyBillEntity extends utils_1.TrackableEntity {
+    /**
+     * The ID of the company this bill belongs to
+     */
+    companyId;
+    /**
+     * Current status of the bill
+     * @type {BillStatus}
+     * @default BillStatus.Open
+     */
+    status;
+    /**
+     * Billing period start date
+     */
+    startDate;
+    /**
+     * Billing period end date
+     */
+    endDate;
+    /**
+     * - Total price of all items before promotion code discount, and taxes (excluded the free benefits)
+     *
+     * - If billItem.freeBenefit = true, then that item's price is not included in this subTotalPrice
+     */
+    subtotalPrice;
+    // TODO:
+    // what if the company submits a gift code
+    // he can submit a gift code inside the bill's period, or in the next month (in case the first payment attempt failed)
+    // either way, the amount that he should pay is reduced by the gift code amount
+    /**
+     * - Total price of all items after all discounts (from agent promotion code) and taxes
+     *
+     * - Steps:
+     * As default the totalPrice is equal to subTotalPrice, then we apply the following changes:
+     *
+     * - 1. get available amount from the credit, and store this in creditAmount.
+     * this.creditAmount = company.credit >= this.subTotalPrice ? this.subTotalPrice : company.credit
+     * // TODO: reduce company.credit by this.creditAmount
+     *
+     * - 2. reduce the totalPrice by creditAmount.
+     * this.totalPrice = this.subTotalPrice - this.creditAmount
+     *
+     * - 4. calculate agent payout amount.
+     * this.agentAmount = (this.totalPrice * agentCode.agentPercentage) / 100
+     *
+     * - 6. calculate taxAmount.
+     * this.taxAmount = (this.totalPrice * product.vat) / 100
+     *
+     * - 7. increase totalPrice by taxAmount.
+     * this.totalPrice = this.totalPrice + this.taxAmount
+     *
+     * - 8. if the amount is more than 0, go to stripe and submit the payment
+     */
+    totalPrice;
+    /**
+     * The total tax amount for this bill
+     */
+    taxAmount;
+    /**
+     * The amount that was taken from company's credit balance for this bill
+     */
+    creditAmount;
+    /**
+     * The product balance after this bill is calculated before sending the payment to the provider
+     * @type {number}
+     * @default 0
+     */
+    productBalance;
+    /**
+     * Total number of trainings that were covered by free benefits
+     * @type {number | null}
+     * @default null
+     */
+    freeBenefitItems;
+    /**
+     * Total amount of the trainings that was covered by free benefits
+     * @type {number | null}
+     * @default null
+     */
+    freeBenefitAmount;
+    /**
+     * Total amount that was reducted from credit or was covered by free benefits
+     * @type {number | null}
+     * @default null
+     */
+    fromCreditOrFreeBenefits;
+    /**
+     * The amount that goes to the agent for this bill
+     *
+     * - This number is updated after bill's payment is confirmed (25% of totalPrice goes to agent)
+     * @type {number}
+     * @default 0
+     */
+    agentProfit;
+    /**
+     * The company this bill belongs to
+     */
+    company;
+    /**
+     * Line items included in this bill
+     */
+    items;
+    /**
+     * Payment transactions associated with this bill
+     */
+    transactions;
+    /**
+     * Creates a new CompanyBillEntity instance
+     * @param {Partial<CompanyBillEntity>} [props] - Optional initial properties
+     */
+    constructor(props) {
+        super();
+        Object.assign(this, props);
+    }
+    /**
+     * Converts the entity to a Bill model
+     * @returns {Bill} The Bill model representation
+     */
+    toModel() {
+        return new common_1.Bill({
+            id: this.id,
+            status: this.status,
+            startDate: this.startDate,
+            endDate: this.endDate,
+            subtotalPrice: this.subtotalPrice,
+            totalPrice: this.totalPrice,
+            taxAmount: this.taxAmount,
+            creditAmount: this.creditAmount,
+            productBalance: this.productBalance,
+            agentProfit: this.agentProfit,
+            freeBenefitItems: this.freeBenefitItems,
+            freeBenefitAmount: this.freeBenefitAmount,
+        });
+    }
+    /**
+     * Converts the entity to a Bill model
+     * @returns {Bill} The Bill model representation
+     */
+    toSummary() {
+        return new common_1.Bill({
+            id: this.id,
+            status: this.status,
+            startDate: this.startDate,
+            endDate: this.endDate,
+            totalPrice: this.totalPrice,
+        });
+    }
+    /**
+     * Calculates the subtotal price by summing all non-free-benefit items
+     * @returns {Promise<number>} The subtotal price
+     */
+    async getSubtotalPrice() {
+        const items = await item_entity_1.CompanyBillItemEntity.findBy({
+            billId: this.id,
+            freeBenefit: false
+        });
+        if (!items?.length) {
+            return 0;
+        }
+        const sum = items.map(item => Number(item.price));
+        return common_1.ArrayHelper.getSum(sum);
+    }
+    /**
+     * Calculates the total tax amount for all non-free-benefit items
+     * Tax is calculated on the price after credit is applied
+     * @returns {Promise<number>} The total tax amount
+     */
+    async getTotalTaxAmount() {
+        const items = await item_entity_1.CompanyBillItemEntity.findBy({
+            billId: this.id,
+            freeBenefit: false
+        });
+        if (!items?.length) {
+            return 0;
+        }
+        const sum = items.map(item => {
+            const price = Number(item.price) - Number(item.fromCredit);
+            return (price * Number(item.vat)) / 100;
+        });
+        return common_1.ArrayHelper.getSum(sum);
+    }
+    /**
+     * Retrieves activity log entries for this bill
+     * Includes creation and update timestamps and user information
+     * @returns {Promise<Activity[]>} Array of activity entries (filtered to remove null values)
+     */
+    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.CompanyBillEntity = CompanyBillEntity;
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Number)
+], CompanyBillEntity.prototype, "companyId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'enum',
+        enum: common_1.BillStatus,
+        default: common_1.BillStatus.Open,
+        nullable: false
+    }),
+    __metadata("design:type", String)
+], CompanyBillEntity.prototype, "status", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Date)
+], CompanyBillEntity.prototype, "startDate", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Date)
+], CompanyBillEntity.prototype, "endDate", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'decimal',
+        precision: 10,
+        scale: 2,
+        nullable: false,
+        default: 0
+    }),
+    __metadata("design:type", Number)
+], CompanyBillEntity.prototype, "subtotalPrice", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'decimal',
+        precision: 10,
+        scale: 2,
+        nullable: false,
+        default: 0
+    }),
+    __metadata("design:type", Number)
+], CompanyBillEntity.prototype, "totalPrice", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'decimal',
+        precision: 10,
+        scale: 2,
+        nullable: false,
+        default: 0
+    }),
+    __metadata("design:type", Number)
+], CompanyBillEntity.prototype, "taxAmount", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'decimal',
+        precision: 10,
+        scale: 2,
+        nullable: false,
+        default: 0
+    }),
+    __metadata("design:type", Number)
+], CompanyBillEntity.prototype, "creditAmount", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'decimal',
+        precision: 12,
+        scale: 2,
+        nullable: false,
+        default: 0
+    }),
+    __metadata("design:type", Number)
+], CompanyBillEntity.prototype, "productBalance", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Number)
+], CompanyBillEntity.prototype, "freeBenefitItems", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Number)
+], CompanyBillEntity.prototype, "freeBenefitAmount", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Number)
+], CompanyBillEntity.prototype, "fromCreditOrFreeBenefits", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'decimal',
+        precision: 8,
+        scale: 2,
+        nullable: false,
+        default: 0
+    }),
+    __metadata("design:type", Number)
+], CompanyBillEntity.prototype, "agentProfit", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => company_entity_1.CompanyEntity, company => company.bills),
+    __metadata("design:type", Promise)
+], CompanyBillEntity.prototype, "company", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)(() => item_entity_1.CompanyBillItemEntity, item => item.bill),
+    __metadata("design:type", Promise)
+], CompanyBillEntity.prototype, "items", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)(() => transaction_entity_1.CompanyBillTransactionEntity, payment => payment.bill),
+    __metadata("design:type", Promise)
+], CompanyBillEntity.prototype, "transactions", void 0);
+exports.CompanyBillEntity = CompanyBillEntity = __decorate([
+    (0, typeorm_1.Entity)('companyBills'),
+    __metadata("design:paramtypes", [Object])
+], CompanyBillEntity);
+//# sourceMappingURL=bill.entity.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"bill.entity.js","sourceRoot":"","sources":["../../../../../src/profile/company/finances/billing/bill.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAA+D;AAC/D,4CAAwF;AACxF,yDAAqD;AACrD,6DAAoE;AACpE,+CAAsD;AACtD,6CAAgE;AAEhE;;;;GAIG;AAEI,IAAM,iBAAiB,GAAvB,MAAM,iBAAkB,SAAQ,uBAAqB;IAE3D;;OAEG;IAEH,SAAS,CAAS;IAElB;;;;OAIG;IAOH,MAAM,CAAa;IAEnB;;OAEG;IAEH,SAAS,CAAO;IAEhB;;OAEG;IAEH,OAAO,CAAO;IAEd;;;;OAIG;IAQH,aAAa,CAAS;IAEtB,QAAQ;IACR,0CAA0C;IAC1C,sHAAsH;IACtH,+EAA+E;IAE/E;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IAQH,UAAU,CAAS;IAEnB;;OAEG;IAQH,SAAS,CAAS;IAElB;;OAEG;IAQH,YAAY,CAAS;IAErB;;;;OAIG;IAQH,cAAc,CAAS;IAEvB;;;;OAIG;IAKH,gBAAgB,CAAS;IAEzB;;;;OAIG;IAKH,iBAAiB,CAAS;IAE1B;;;;OAIG;IAKH,wBAAwB,CAAS;IAEjC;;;;;;OAMG;IAQH,WAAW,CAAS;IAEpB;;OAEG;IAEH,OAAO,CAAyB;IAEhC;;OAEG;IAEH,KAAK,CAAmC;IAExC;;OAEG;IAEH,YAAY,CAA0C;IAEtD;;;OAGG;IACH,YAAY,KAAkC;QAC7C,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACH,OAAO;QACN,OAAO,IAAI,aAAI,CAAC;YACf,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,UAAU,EAAG,IAAI,CAAC,UAAU;YAC5B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;SACzC,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,SAAS;QACR,OAAO,IAAI,aAAI,CAAC;YACf,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,UAAU,EAAG,IAAI,CAAC,UAAU;SAC5B,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB;QACrB,MAAM,KAAK,GAAG,MAAM,mCAAqB,CAAC,MAAM,CAAC;YAChD,MAAM,EAAE,IAAI,CAAC,EAAE;YACf,WAAW,EAAE,KAAK;SAClB,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;YACpB,OAAO,CAAC,CAAC;QACV,CAAC;QAED,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAClD,OAAO,oBAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,iBAAiB;QACtB,MAAM,KAAK,GAAG,MAAM,mCAAqB,CAAC,MAAM,CAAC;YAChD,MAAM,EAAE,IAAI,CAAC,EAAE;YACf,WAAW,EAAE,KAAK;SAClB,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;YACpB,OAAO,CAAC,CAAC;QACV,CAAC;QAED,MAAM,GAAG,GAAI,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC3D,OAAO,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;QACzC,CAAC,CAAC,CAAC;QACH,OAAO,oBAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;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;AA9RY,8CAAiB;AAM7B;IADC,IAAA,gBAAM,GAAE;;oDACS;AAalB;IANC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,mBAAU;QAChB,OAAO,EAAE,mBAAU,CAAC,IAAI;QACxB,QAAQ,EAAE,KAAK;KACf,CAAC;;iDACiB;AAMnB;IADC,IAAA,gBAAM,GAAE;8BACE,IAAI;oDAAC;AAMhB;IADC,IAAA,gBAAM,GAAE;8BACA,IAAI;kDAAC;AAcd;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;;wDACoB;AAsCtB;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;;qDACiB;AAYnB;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;;oDACgB;AAYlB;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;;uDACmB;AAcrB;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;;yDACqB;AAWvB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;2DACuB;AAWzB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;4DACwB;AAW1B;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;mEAC+B;AAgBjC;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;;sDACkB;AAMpB;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,8BAAa,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;;kDACzB;AAMhC;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,mCAAqB,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;;gDAClB;AAMxC;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,iDAA4B,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;;uDACjB;4BA5L1C,iBAAiB;IAD7B,IAAA,gBAAM,EAAC,cAAc,CAAC;;GACV,iBAAiB,CA8R7B"}

package/lib/profile/company/finances/billing/item.entity.d.ts

@@ -0,0 +1,75 @@
+import { Activity, BillItem } from '@driveup/common';
+import { CompanyBillEntity } from './bill.entity';
+import { CompanyCourseEntity } from '../../course/course.entity';
+import { CompanyProductAddonEntity } from '../../product/addon.entity';
+import { TrackableEntity } from '../../../../utils';
+export declare class CompanyBillItemEntity extends TrackableEntity<BillItem> {
+    billId: number;
+    /**
+     * Company course, if applicable
+     */
+    courseId: number;
+    /**
+     * Company product addon, if applicable
+     */
+    addonId: number;
+    /**
+     * Bill item name
+     * Generic name based on the item type (e.g. "Enterprise Plan - Monthly Subscription")
+     * or specific name like student training John Doe - Category B
+     */
+    title: string;
+    /**
+     * Bill item description
+     */
+    description: string;
+    /**
+     * Price per unit before tax
+     */
+    price: number;
+    /**
+     * VAT percentage applied to this item
+     */
+    vat: number;
+    /**
+     * Price per unit after tax
+     * If a portion of the price is deducted from company credit,
+     * the tax is calculated only on the remaining amount,
+     * and is not calculated on the part that is taken from credit
+     * * totalPrice = (price - fromCredit) + ((price - fromCredit) * vat) / 100
+     */
+    totalPrice: number;
+    /**
+     * Wether or not this item is a free benefit
+     * (i.e. free training included in the free plan)
+     */
+    freeBenefit: boolean;
+    /**
+     * The amount that is deducted from product's credit
+     */
+    fromCredit: number;
+    /**
+     * Wether or not this item is out of enterprise plan's scope
+     * (new instructors with which the seats limit is exceeded)
+     */
+    outOfPlan: boolean;
+    /**
+     * A snapshot of the entity item at the time of billing
+     */
+    metadata: {
+        [key: string | number]: any;
+    };
+    bill: Promise<CompanyBillEntity>;
+    /**
+     * Company course, if applicable
+     */
+    course: Promise<CompanyCourseEntity>;
+    /**
+     * Company product addon, if applicable
+     */
+    addon: Promise<CompanyProductAddonEntity>;
+    constructor(props?: Partial<CompanyBillItemEntity>);
+    toModel(): BillItem;
+    toSummary(): BillItem;
+    getActivities(): Promise<Activity[]>;
+}

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

@@ -0,0 +1,219 @@
+"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.CompanyBillItemEntity = void 0;
+const typeorm_1 = require("typeorm");
+const common_1 = require("@driveup/common");
+const bill_entity_1 = require("./bill.entity");
+const course_entity_1 = require("../../course/course.entity");
+const addon_entity_1 = require("../../product/addon.entity");
+const utils_1 = require("../../../../utils");
+let CompanyBillItemEntity = class CompanyBillItemEntity extends utils_1.TrackableEntity {
+    billId;
+    /**
+     * Company course, if applicable
+     */
+    courseId;
+    /**
+     * Company product addon, if applicable
+     */
+    addonId;
+    /**
+     * Bill item name
+     * Generic name based on the item type (e.g. "Enterprise Plan - Monthly Subscription")
+     * or specific name like student training John Doe - Category B
+     */
+    title;
+    /**
+     * Bill item description
+     */
+    description;
+    /**
+     * Price per unit before tax
+     */
+    price;
+    /**
+     * VAT percentage applied to this item
+     */
+    vat;
+    /**
+     * Price per unit after tax
+     * If a portion of the price is deducted from company credit,
+     * the tax is calculated only on the remaining amount,
+     * and is not calculated on the part that is taken from credit
+     * * totalPrice = (price - fromCredit) + ((price - fromCredit) * vat) / 100
+     */
+    totalPrice;
+    /**
+     * Wether or not this item is a free benefit
+     * (i.e. free training included in the free plan)
+     */
+    freeBenefit;
+    /**
+     * The amount that is deducted from product's credit
+     */
+    fromCredit;
+    /**
+     * Wether or not this item is out of enterprise plan's scope
+     * (new instructors with which the seats limit is exceeded)
+     */
+    outOfPlan;
+    /**
+     * A snapshot of the entity item at the time of billing
+     */
+    metadata;
+    bill;
+    /**
+     * Company course, if applicable
+     */
+    course;
+    /**
+     * Company product addon, if applicable
+     */
+    addon;
+    constructor(props) {
+        super();
+        Object.assign(this, props);
+    }
+    toModel() {
+        return new common_1.BillItem({
+            id: this.id,
+            title: this.title,
+            description: this.description,
+            price: this.price,
+            vat: this.vat,
+            totalPrice: this.totalPrice,
+            freeBenefit: this.freeBenefit,
+            fromCredit: this.fromCredit,
+            outOfPlan: this.outOfPlan,
+        });
+    }
+    toSummary() {
+        return this.toModel();
+    }
+    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.CompanyBillItemEntity = CompanyBillItemEntity;
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Number)
+], CompanyBillItemEntity.prototype, "billId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Number)
+], CompanyBillItemEntity.prototype, "courseId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Number)
+], CompanyBillItemEntity.prototype, "addonId", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], CompanyBillItemEntity.prototype, "title", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", String)
+], CompanyBillItemEntity.prototype, "description", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'decimal',
+        precision: 10,
+        scale: 2,
+        nullable: false,
+        default: 0
+    }),
+    __metadata("design:type", Number)
+], CompanyBillItemEntity.prototype, "price", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'decimal',
+        precision: 8,
+        scale: 2,
+        nullable: false,
+        default: 0
+    }),
+    __metadata("design:type", Number)
+], CompanyBillItemEntity.prototype, "vat", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'decimal',
+        precision: 10,
+        scale: 2,
+        nullable: false,
+        default: 0
+    }),
+    __metadata("design:type", Number)
+], CompanyBillItemEntity.prototype, "totalPrice", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: false,
+        default: false
+    }),
+    __metadata("design:type", Boolean)
+], CompanyBillItemEntity.prototype, "freeBenefit", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'decimal',
+        precision: 8,
+        scale: 2,
+        nullable: false,
+        default: 0
+    }),
+    __metadata("design:type", Number)
+], CompanyBillItemEntity.prototype, "fromCredit", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: false,
+        default: false
+    }),
+    __metadata("design:type", Boolean)
+], CompanyBillItemEntity.prototype, "outOfPlan", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'simple-json',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Object)
+], CompanyBillItemEntity.prototype, "metadata", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => bill_entity_1.CompanyBillEntity, bill => bill.items),
+    __metadata("design:type", Promise)
+], CompanyBillItemEntity.prototype, "bill", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => course_entity_1.CompanyCourseEntity, course => course.billItems),
+    __metadata("design:type", Promise)
+], CompanyBillItemEntity.prototype, "course", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => addon_entity_1.CompanyProductAddonEntity, addon => addon.billItems),
+    __metadata("design:type", Promise)
+], CompanyBillItemEntity.prototype, "addon", void 0);
+exports.CompanyBillItemEntity = CompanyBillItemEntity = __decorate([
+    (0, typeorm_1.Entity)('companyBillItems'),
+    __metadata("design:paramtypes", [Object])
+], CompanyBillItemEntity);
+//# sourceMappingURL=item.entity.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"item.entity.js","sourceRoot":"","sources":["../../../../../src/profile/company/finances/billing/item.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAAoD;AACpD,4CAAmE;AACnE,+CAAkD;AAClD,8DAAiE;AACjE,6DAAuE;AACvE,6CAAgE;AAGzD,IAAM,qBAAqB,GAA3B,MAAM,qBAAsB,SAAQ,uBAAyB;IAGnE,MAAM,CAAS;IAEf;;OAEG;IAKH,QAAQ,CAAS;IAEjB;;OAEG;IAKH,OAAO,CAAS;IAEhB;;;;OAIG;IAEH,KAAK,CAAS;IAEd;;OAEG;IAKH,WAAW,CAAS;IAEpB;;OAEG;IAQH,KAAK,CAAS;IAEd;;OAEG;IAQH,GAAG,CAAS;IAEZ;;;;;;OAMG;IAQH,UAAU,CAAS;IAEnB;;;OAGG;IAKH,WAAW,CAAU;IAErB;;OAEG;IAQH,UAAU,CAAS;IAEnB;;;OAGG;IAKH,SAAS,CAAU;IAEnB;;OAEG;IAMH,QAAQ,CAAkC;IAG1C,IAAI,CAA6B;IAEjC;;OAEG;IAEH,MAAM,CAA+B;IAErC;;OAEG;IAEH,KAAK,CAAqC;IAE1C,YAAY,KAAsC;QACjD,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO;QACN,OAAO,IAAI,iBAAQ,CAAC;YACnB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,SAAS,EAAE,IAAI,CAAC,SAAS;SACzB,CAAC,CAAC;IACJ,CAAC;IAED,SAAS;QACR,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IACvB,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,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;CACD,CAAA;AAxKY,sDAAqB;AAGjC;IADC,IAAA,gBAAM,GAAE;;qDACM;AASf;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;uDACe;AASjB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;sDACc;AAQhB;IADC,IAAA,gBAAM,GAAE;;oDACK;AASd;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;0DACkB;AAYpB;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;;oDACY;AAYd;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;;kDACU;AAgBZ;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;;yDACiB;AAUnB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,KAAK;KACd,CAAC;;0DACmB;AAYrB;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;;yDACiB;AAUnB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,KAAK;KACd,CAAC;;wDACiB;AAUnB;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;uDACwC;AAG1C;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,+BAAiB,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;;mDACtB;AAMjC;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,mCAAmB,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC;;qDAC5B;AAMrC;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,wCAAyB,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;;oDAC3B;gCAvI9B,qBAAqB;IADjC,IAAA,gBAAM,EAAC,kBAAkB,CAAC;;GACd,qBAAqB,CAwKjC"}

package/lib/profile/company/finances/billing/transaction.entity.d.ts

@@ -0,0 +1,44 @@
+import { Activity, BillTransaction, PaymentProvider, StatusType } from '@driveup/common';
+import { AgentPayoutEntity } from '../../../agent/payout.entity';
+import { CompanyBillEntity } from './bill.entity';
+import { CompanyPaymentMethodEntity } from '../payment/method.entity';
+import { TrackableEntity } from '../../../../utils';
+export declare class CompanyBillTransactionEntity extends TrackableEntity<BillTransaction> {
+    billId: number;
+    paymentMethodId: number;
+    status: StatusType;
+    amount: number;
+    provider: PaymentProvider;
+    /**
+     * Provider payment method id
+     */
+    providerId: number;
+    providerResponse: any;
+    /**
+     * Payment confirmed by job task
+     */
+    paidOn: Date;
+    /**
+     * Payment failed on date
+     */
+    failedOn: Date;
+    /**
+     * Company bill associated with this transaction
+     */
+    bill: Promise<CompanyBillEntity>;
+    /**
+     * Payment method used for this transaction
+     */
+    paymentMethod: Promise<CompanyPaymentMethodEntity>;
+    /**
+     * 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: Promise<AgentPayoutEntity>;
+    constructor(props?: Partial<CompanyBillTransactionEntity>);
+    toModel(): Promise<BillTransaction>;
+    toSummary(): BillTransaction;
+    getActivities(): Promise<Activity[]>;
+}