@bisondesk/core-sdk 1.0.193 → 1.0.194

package/src/types/leasing.ts

@@ -54,6 +54,25 @@ export type LeasingContractClient = {
   becrisStartDate?: string;
 };
 
+export enum LeasingContractSource {
+  HYPERPORTAL = 'hyperportal',
+  BISONDESK = 'bisondesk',
+}
+
+export type LeasingContractHyperportal = {
+  source: LeasingContractSource.HYPERPORTAL;
+  /** oldest first **/
+  conditions: ConditionsRef[];
+  opportunities?: undefined;
+};
+
+export type LeasingContractBisondesk = {
+  source: LeasingContractSource.BISONDESK;
+  conditions?: undefined;
+  /** oldest first **/
+  opportunities: OpportunityRef[];
+};
+
 export type LeasingContract = {
   id: string;
   createdAt: string;
@@ -71,14 +90,21 @@ export type LeasingContract = {
     stockNumber: string;
     administrativeNumber?: string;
   };
-  conditions: ConditionsRef[];
-};
+} & (LeasingContractHyperportal | LeasingContractBisondesk);
 
 export type ConditionsRef = {
   id: string;
   validSince: string;
 };
 
+export type OpportunityRef = {
+  id: string;
+  createdAt: string;
+  leasingMonthlyAmount: string;
+  totalMonthlyAmount: string;
+  quoteId: string;
+};
+
 export type ListOverdueRemindersResponse = PaginatedList<OverdueDossier, ReferenceData>;
 export type ListOverdueRemindersRequest = {
   offset: number;
@@ -133,22 +159,14 @@ export type NewLeasingConditions = {
     leasingAmount: string;
     leasingProfit: string;
     vehicleProfit: string;
-    yearlyTaxCost: string;
-    monthlyTaxCost: string;
     oneTimeTaxCost: string;
     financingAmount: string;
     bankContractValue: string;
     bankLeasingAmount: string;
     totalMonthlyPayment: string;
-    yearlyInsuranceCost: string;
     leasingContractValue: string;
-    monthlyInsuranceCost: string;
-    yearlyTaxRetailPrice: string;
     monthlyTaxRetailPrice: string;
     allRisksInsuranceAmount: string;
-    yearlyInsuranceRetailPrice: string;
-    monthlyInsuranceRetailPrice: string;
-    monthlyInsuranceAndTaxesRetailPrice: string;
   };
 
   cashIn: Array<{
@@ -245,3 +263,12 @@ export enum LeasingRemindersSortableColumns {
   RemindersCount = 'reminders_count',
   Status = 'status',
 }
+
+export type AmortizationTableRequest = {
+  leasingAmount: string;
+  deposit: string;
+  salesPrice: string;
+  duration: number; // in months
+  residual: string;
+  monthlyInterestRate: string; // the annual interest rate divided by 12
+};

package/src/types/opportunities.ts

@@ -129,6 +129,7 @@ export type Opportunity = BaseOpportunity & {
   amount?: string;
   interest?: Interest;
   documents?: Document[];
+  leasingContractId?: string;
 };
 
 export type OpportunityUpdate = {
@@ -306,3 +307,160 @@ export type OpportunitiesKanbanColumn = {
   totalCount: number;
   totalValue: string;
 };
+
+export type HpLeasingDealRequest = {
+  tenantId: string;
+  initiatedBy: 'bisondesk';
+  processMetaId: string;
+  processRunData: {
+    entityOwner: string;
+    leasingContractOwner: string;
+    foreseenDeliveryDate?: string;
+    deliveryAddressLeasing?: string;
+    nameSalesPerson: string;
+    durationLeasingInMonths: number;
+    vanCourier: boolean;
+    newVehicle?: boolean;
+    newTrailer?: boolean;
+    registrationOnTtcoBe?: string;
+    yearOfConstruction?: number;
+    chassisnumber?: string;
+    vehicleModel?: string;
+    vehicleCategory2?: string;
+    licencePlate?: string;
+
+    company: string;
+    customerNumber?: number; //bisondesk external id
+    //MrLease fields
+    vehicle: string;
+    salesPriceEur: string;
+    depositFullAmountExclVat: string;
+    depositToBePrepaidExclVat: string;
+    vehicleMake3?: string;
+
+    //TTC fields
+    vehicleOriginalReference?: string;
+    salesPrice: string;
+    depositFullAmount: string;
+    depositAmountToBePrepaid: string;
+    make?: string;
+  };
+};
+
+export type HpLeasingDealResponse = {
+  entityId: string;
+  id: string;
+  status: string;
+  leasingContractNumber?: string;
+  definitionId: string;
+};
+
+export type HpLeasingContractRequest = {
+  tenantId: string;
+  initiatedBy: 'bisondesk';
+  processMetaId: string;
+  processRunData: {
+    entityOwner: string;
+    company: string;
+    vehicle: string;
+    ldNumber: number;
+    vanCourier: boolean;
+    startDate: number;
+    data: {
+      leasingParameter: {
+        allRisksPercentage: number;
+        allRisksTaxPercentage: number;
+        civilLiability: number;
+        entityId: string; //??
+        oneTimeRoadTax: number;
+        specialInsurance: number;
+        yearlyRoadTax: number;
+        countries: string[]; //is it array?
+        vehicleCategory: string;
+      };
+
+      calculatorRequest: {
+        bankDeposit: number;
+        bankDurationInMonths: number;
+        bankInterestRatePercentage: number;
+        bankResidualValue: number;
+        deposit: number;
+        durationInMonths: number;
+        includesAllRisks: boolean;
+        includesCivilLiability: boolean;
+        includesOneTimeRoadTax: boolean;
+        includesSpecialInsurance: boolean;
+        includesYearlyRoadTax: boolean;
+        insuranceAmount: number;
+        interestRatePercentage: number;
+        marginPercentage: number;
+        monthlyAdministrationFee: 0;
+        purchasePrice: number;
+        residualValue: number;
+        salesPrice: number;
+        startupFeePercentage: number;
+      };
+
+      calculatorResponse: {
+        ROI: number;
+        ROIDifference: number;
+        ROIPerYear: number;
+        ROITarget: number;
+        allRisksInsuranceAmount: number;
+        bankContractValue: number;
+        bankLeasingAmount: number;
+        cashDeficit: number;
+        financingAmount: number;
+        leasingAmount: number;
+        leasingContractValue: number;
+        leasingProfit: number;
+        monthlyTaxRetailPrice: number;
+        oneTimeTaxCost: number;
+        totalMonthlyPayment: number;
+        totalProfit: number;
+        vehicleProfit: number;
+      };
+
+      cashInValues: CashInRow[];
+
+      cashOutValues: CashOutRow[];
+    };
+  };
+};
+
+export type HpLeasingContractResponse = {
+  entityId: string;
+  id: string;
+  status: string;
+  createdAt: string;
+  updatedAt: string;
+  dateOfFinalSettlement: string;
+  startDate: string;
+  email: string;
+  contractNumber: string;
+  definitionId: string;
+};
+
+export type CashInRow = {
+  time: number;
+  deposit: number;
+  monthlyAdministrationFee: 0; //Legacy field - Should always be 0
+  residualValue: number;
+  startupFee: number;
+  leasingAmountWithoutAdminFee: number;
+  insurancePayment: number;
+  taxPayment: number;
+  cashIn: number;
+  cumulativeCash: number;
+};
+
+export type CashOutRow = {
+  time: number;
+  deposit: number;
+  residualValue: number;
+  leasingAmount: number;
+  insurancePayment: number;
+  taxPayment: number;
+  cashOut: number;
+  cumulativeCash: number;
+};

package/src/types/settings.ts

@@ -28,6 +28,7 @@ export type HyperportalSettings = {
   leasing: {
     contractTransferDefinitionId: string;
     contractDealDefinitionId: string;
+    contractOwner: { [countryCode: string]: string };
   };
 };