@bisondesk/core-sdk 1.0.239 → 1.0.242

package/src/types/opportunities.ts

@@ -3,7 +3,7 @@ import { OpportunityType } from '../constants';
 import { Contact, Organization } from './crm';
 import { Interest } from './leads';
 import { Payment } from './payments';
-import { LeasingQuote, QuoteStatus } from './quotes';
+import { Quote, QuoteStatus } from './quotes';
 import { DataRecord, ReferenceData } from './utils';
 import { Vehicle } from './vehicles';
 
@@ -163,15 +163,17 @@ export type PaymentSummary = {
   entries: DataRecord<Payment>[];
 };
 
+export type VehicleBffMetadata = {
+  openOpportunities: number;
+  latestAcceptedOpportunity?: { id: string; status: OpportunityStatus; accountManager?: string };
+};
+
 export type OpportunityBFF = {
-  related: {
-    sameVehicleOpenOpportunities?: number;
-  };
   opportunity: DataRecord<Opportunity, ReferenceData>;
-  vehicle?: DataRecord<Vehicle>;
+  vehicle?: DataRecord<Vehicle, VehicleBffMetadata>;
   bids: DataRecord<Bid>[];
-  quotes: DataRecord<LeasingQuote>[];
-  activeQuote?: DataRecord<LeasingQuote>;
+  quotes: DataRecord<Quote>[];
+  activeQuote?: DataRecord<Quote>;
   payments: PaymentSummary | undefined;
   customer?: {
     contact: DataRecord<Contact>;
@@ -188,7 +190,7 @@ export type OpportunityEvent = {
 };
 
 export type QuoteEvent = {
-  quote: LeasingQuote;
+  quote: Quote;
   opportunity: Opportunity;
   action: 'create' | 'update' | 'delete';
   actionAt: string;
@@ -316,6 +318,88 @@ export type LeasingProformaTemplateData = {
   };
 };
 
+export type SalesProformaTemplateData = {
+  opportunity: {
+    id: string;
+    offerNumber: string;
+  };
+  currentDate: string;
+  accountManager: {
+    fullName: string;
+    email: string;
+    phone: string;
+  };
+  vehicle: {
+    line1: string;
+    line2: string;
+    stockNumber: string;
+  };
+  c: {
+    organizationId?: string;
+    clientNumber: number;
+    company: string;
+    fullName: string;
+    vatNumber?: string;
+    email?: string;
+    phone?: string;
+    address?: string;
+  };
+  i: {
+    description: string;
+    vat: string;
+    quantity: number;
+    unitPriceExclVat: string;
+    amount: string;
+    amountExclVat: string;
+  }[];
+  t: {
+    totalExclVat: string;
+    vatAmount: string;
+    total: string;
+  };
+};
+
+export type SalesAgreementTemplateData = {
+  opportunity: {
+    id: string;
+    offerNumber: string;
+  };
+  currentDate: string;
+  accountManager: {
+    fullName: string;
+    email: string;
+    phone: string;
+  };
+  vehicle: {
+    line1: string;
+    line2: string;
+    stockNumber: string;
+  };
+  c: {
+    organizationId?: string;
+    clientNumber: number;
+    company: string;
+    fullName: string;
+    vatNumber?: string;
+    email?: string;
+    phone?: string;
+    address?: string;
+  };
+  i: {
+    description: string;
+    vat: string;
+    quantity: number;
+    unitPriceExclVat: string;
+    amount: string;
+    amountExclVat: string;
+  }[];
+  t: {
+    totalExclVat: string;
+    vatAmount: string;
+    total: string;
+  };
+};
+
 export type OpportunitiesKanbanColumn = {
   status: string;
   results: SearchOpportunity[];
@@ -490,6 +574,64 @@ export type CashOutRow = {
   cumulativeCash: number;
 };
 
+export type HpIsaProcessRequest = {
+  tenantId: string;
+  initiatedBy: 'bisondesk';
+  processMetaId: string;
+  processRunData: {
+    entityOwner: string;
+
+    company?: string; //entityId
+    proofOfSaleCustomerAgreement?: string; //entityId
+
+    vehicle?: string; //entityId
+    bodywork?: string; //entityId
+    vehicleCategory: string; //entityId
+
+    amountOfCommissionPaid: number;
+    dealValidated: boolean;
+    dealCancelled: boolean;
+    opportunityId: string;
+    typeOfDelivery: string; //entity Id
+
+    //PickUP Delivery
+    urgentDelivery?: boolean;
+    dateOfPickUpByCustomer?: number;
+    modeOfTransportPickUpByCustomer?: string; //entity Id
+    detailsOfStacking?: string; //entity Id
+    detailsOfBorderCrossing?: string;
+    technicalControlNeeded?: boolean;
+    insuranceNeeded?: boolean;
+    licensePlateNeeded?: boolean;
+    transitPlateNeeded?: boolean;
+
+    //Address Delivery
+    addressOfDelivery?: string;
+    kmToAddressOfDelivery?: number;
+
+    //To Port Delivery
+    portOfDelivery?: string; //entity Id
+    shippingCompany?: string; //string Id
+    destinationPort?: string;
+    cleaningDegassingNeeded?: boolean;
+    agreedPrice?: string;
+
+    //Extras
+    garageExtrasCodes: string[];
+    logisticsExtrasCodes: string[];
+    administrationExtrasCodes: string[];
+    allExtrasDescriptions: string[];
+    customRequestDescriptions: string[];
+    infoSpoiler: string; // entity Id
+  };
+};
+
+export type HpIsaProcessResponse = {
+  entityId: string;
+  id: string;
+  status: string;
+};
+
 export type SwitchOpportunityVehicleRequest = {
   opportunityId: string;
   newVehicleId: string;

package/src/types/quotes.ts

@@ -1,9 +1,13 @@
-import { AttachmentValue } from '@bisondesk/commons-sdk/types';
+import { AttachmentValue, LocationValue } from '@bisondesk/commons-sdk/types';
 import { OpportunityType } from '../constants';
+import { DeliveryParams } from './delivery-settings';
 import {
   CustomLeasingQuoteExtraInput,
+  CustomSalesQuoteExtraInput,
   LeasingDeliveryPackageInput,
   LeasingQuoteExtraInput,
+  LeasingQuoteParams,
+  SalesQuoteExtraInput,
 } from './leasing-settings';
 import { PricePercentageMode } from './utils';
 
@@ -12,6 +16,7 @@ export enum QuoteActions {
   VALIDATE = 'validate',
   DONWLOAD_PDFS = 'download-pdfs',
   CANCEL = 'cancel',
+  COMMERCIAL_REVIEW = 'commercial-review',
 }
 
 export enum QuoteStatus {
@@ -21,30 +26,48 @@ export enum QuoteStatus {
   ACCEPTED = 'accepted',
   REJECTED = 'rejected',
   CANCELLED = 'cancelled',
+  MANAGER_REJECTED = 'commercialReviewRejected',
+  MANAGER_ACCEPTED = 'commercialReviewAccepted',
 }
 
-export enum LeasingQuoteMetricsScore {
+export enum QuoteMetricsScore {
   DANGER = 'danger',
   NEUTRAL = 'neutral',
   GOOD = 'good',
 }
+export enum DeliveryTypes {
+  PICK_UP = 'pickUp',
+  ADDRESS = 'address',
+  PORT = 'port',
+}
+
+export enum SpoilerInfo {
+  MOUNT = 'mount',
+  UNMOUNT = 'unmount',
+  NO_ACTION = 'noAction',
+}
 
-type BaseLeasingCalculatorInput = {
+export enum TransportationMode {
+  BY_ROAD = 'byRoad',
+  ON_LOW_BED = 'onLowBed',
+}
+
+type BaseQuoteCalculatorInput = {
   branch: string;
   branchCountry: string;
   customerCountry: string;
   vehicleCategory: string;
+  currency: string;
+  bodywork?: string;
 };
 
-export type LeasingCalculatorDefaultInput = BaseLeasingCalculatorInput & {
+export type LeasingCalculatorDefaultInput = BaseQuoteCalculatorInput & {
   salesPrice: string;
   purchasePrice: string;
   deliveryPackage?: LeasingQuoteExtraInput;
-  extras?: LeasingQuoteExtraInput[];
-  customRequests?: CustomLeasingQuoteExtraInput[];
 };
 
-export type LeasingCalculatorInput = BaseLeasingCalculatorInput & {
+export type LeasingCalculatorInput = BaseQuoteCalculatorInput & {
   localLicensePlate: boolean;
   vanCourier: boolean;
   leasing: {
@@ -90,6 +113,60 @@ export type LeasingCalculatorInput = BaseLeasingCalculatorInput & {
   customRequests: CustomLeasingQuoteExtraInput[];
 };
 
+type BaseDeliveryType = {
+  agreedPrice: string;
+  spoiler?: SpoilerInfo;
+};
+
+export type PickUpDeliveryType = BaseDeliveryType & {
+  type: DeliveryTypes.PICK_UP;
+  urgent: boolean;
+  transportationMode?: TransportationMode;
+  detailsBorderCrossing?: string;
+  detailsStacking?: string;
+  technicalControlNeeded: boolean;
+  insuranceNeeded: boolean;
+  licensePlateNeeded: boolean;
+  transitPlateNeeded: boolean;
+};
+
+export type AddressDeliveryType = BaseDeliveryType & {
+  type: DeliveryTypes.ADDRESS;
+  address: LocationValue;
+  distanceKm: string;
+};
+
+export type PortDeliverytype = BaseDeliveryType & {
+  type: DeliveryTypes.PORT;
+  portOriginId: string;
+  portDestinationId?: string;
+  shippingCompany?: string;
+  portToPortCostPrice: string;
+  portToPortMargin: string;
+};
+
+export type SalesCalculatorDefaultInput = BaseQuoteCalculatorInput & {
+  vehicle: {
+    agreedPrice: string;
+    purchasePrice: string;
+    comissionCost: string;
+  };
+  extras: SalesQuoteExtraInput[];
+  customRequests: CustomSalesQuoteExtraInput[];
+};
+
+export type SalesCalculatorInput = BaseQuoteCalculatorInput & {
+  vehicle: {
+    vatRate: string;
+    purchasePrice: string;
+    agreedPrice: string;
+    comissionCost: string;
+  };
+  delivery?: PickUpDeliveryType | AddressDeliveryType | PortDeliverytype;
+  extras: SalesQuoteExtraInput[];
+  customRequests: CustomSalesQuoteExtraInput[];
+};
+
 export type LeasingCalculatorOutput = {
   vatApplicable: boolean;
   installment: string;
@@ -106,18 +183,18 @@ export type LeasingCalculatorOutput = {
     target: string;
     perYear: string;
     difference: string;
-    score: LeasingQuoteMetricsScore;
+    score: QuoteMetricsScore;
   };
   cashflow: {
     deficit: string;
     balanced: boolean;
-    score: LeasingQuoteMetricsScore;
+    score: QuoteMetricsScore;
   };
   profitability: {
     leasing: string;
     vehicle: string;
     total: string;
-    score: LeasingQuoteMetricsScore;
+    score: QuoteMetricsScore;
   };
   taxes: {
     yearlyRetailPrice: string;
@@ -141,15 +218,50 @@ export type LeasingCalculatorOutput = {
   };
 };
 
-type BaseLeasingQuote = {
+export type SalesCalculatorOutput = {
+  totalRetailAmount: string;
+  totalRetailAmountExclVat: string;
+  retailAmounts: {
+    vehicle: string;
+    delivery: string;
+    extras: string;
+  };
+  roi: { value: string; score: QuoteMetricsScore };
+  profit: { value: string; score: QuoteMetricsScore };
+  delivery: {
+    retailPrice?: string;
+    costPrice?: string;
+    cleaningNeeded: boolean;
+    cleaningNeededRetailPrice: string;
+    transportationToPortRetailPrice?: string;
+  };
+  costs: {
+    vehicle: string;
+    finalCostPrice: string;
+    extras: string;
+    delivery: string;
+  };
+};
+
+type BaseQuote = {
   opportunityId: string;
-  calculatorInput: LeasingCalculatorInput;
-  calculatorOutput: LeasingCalculatorOutput;
-  type: OpportunityType;
   preferredLanguage: string;
-};
+  clientNotes?: string;
+  publicNotes?: string;
+} & (
+  | {
+      type: OpportunityType.LEASING;
+      calculatorInput: LeasingCalculatorInput;
+      calculatorOutput: LeasingCalculatorOutput;
+    }
+  | {
+      type: OpportunityType.SALES;
+      calculatorInput: SalesCalculatorInput;
+      calculatorOutput: SalesCalculatorOutput;
+    }
+);
 
-export type NewLeasingQuote = BaseLeasingQuote & {
+export type NewQuote = BaseQuote & {
   id?: undefined;
   createdAt?: undefined;
   createdBy?: undefined;
@@ -158,7 +270,7 @@ export type NewLeasingQuote = BaseLeasingQuote & {
   active: true;
 };
 
-export type LeasingQuote = BaseLeasingQuote & {
+export type Quote = BaseQuote & {
   id: string;
   createdAt: string;
   createdBy: string;
@@ -170,10 +282,13 @@ export type LeasingQuote = BaseLeasingQuote & {
   cancelledAt?: string;
   customerFeedbackAt?: string;
   customerFeedbackBy?: string;
+  managerFeedbackAt?: string;
+  managerFeedbackBy?: string;
   version: number;
   status: QuoteStatus;
   proformaPdf?: AttachmentValue;
   quotePdf?: AttachmentValue;
+  salesAgreementPdf?: AttachmentValue;
   active: boolean;
   contactId: string;
   vehicleId: string;
@@ -184,3 +299,34 @@ export type QuoteUpdate = {
   status?: QuoteStatus;
   active?: boolean;
 };
+
+export type CalculatorLeasingIO = {
+  output: LeasingCalculatorOutput;
+  input: LeasingCalculatorInput;
+};
+export type CalculatorSalesIO = { output: SalesCalculatorOutput; input: SalesCalculatorInput };
+export type CalculatorQuoteIO = CalculatorLeasingIO | CalculatorSalesIO;
+
+export type UsedVehiclesSalesParams = {
+  id: string;
+  modifiedAt: string;
+  modifiedBy: string;
+  countryCode: 'be';
+  name: string;
+  profitabilityDealGap: string;
+  conglomerateProfitabilityDealGap: string;
+  exaDocumentCosts: string;
+  delivery?: DeliveryParams;
+};
+
+export type QuoteSettings = LeasingQuoteParams | UsedVehiclesSalesParams;
+
+export type DeliveryLocationValue = Omit<LocationValue, 'addressLine1' | 'city'> & {
+  addressLine1: string;
+  city: string;
+};
+
+export type DeliveryRoutesRequest = {
+  origin: DeliveryLocationValue;
+  destination: DeliveryLocationValue;
+};

package/src/types/settings.ts

@@ -31,6 +31,10 @@ export type HyperportalSettings = {
     contractDealDefinitionId: string;
     contractOwner: { [countryCode: string]: string };
   };
+  sales: {
+    active: boolean;
+    isaProcessDefinitionId: string;
+  };
 };
 
 export type HyperportalMachinesSettings = {

package/src/types/templates.ts

@@ -1,25 +1,15 @@
-export enum TemplateType {
-  Email = 'email',
-  Sms = 'sms',
-}
-
-export type TemplateContent =
-  | {
-      type: TemplateType.Email;
-      subject: string;
-      content: {
-        html: string;
-        design: any;
-      };
-    }
-  | {
-      type: TemplateType.Sms;
-      content: string;
-    };
+export type TemplateContent = {
+  subject: string;
+  content: {
+    html: string;
+    design: any;
+  };
+};
 
 export type NewTemplateRequest = {
   id?: string;
   country: string;
+  tags?: any;
   name: string;
 } & TemplateContent;
 
@@ -27,6 +17,8 @@ export type Template = {
   id: string;
   modifiedAt: string;
   modifiedBy: string;
+  tags?: any;
+
   country: string;
   name: string;
 } & TemplateContent;
@@ -36,5 +28,10 @@ export type TemplateInfo = {
   countries: string[];
   modifiedAt: string;
   name: string;
-  type: TemplateType;
+  tags?: any;
+};
+
+export type UpdateTemplateInfoRequest = {
+  name: string;
+  tags?: any;
 };

package/src/types/tenants.ts

@@ -1,4 +1,4 @@
-import { Region } from '@bisondesk/commons-sdk/types';
+import { LocationValue, Region } from '@bisondesk/commons-sdk/types';
 
 export type PublicTenant = {
   defaultCountry: string;
@@ -42,6 +42,10 @@ export type Branch = {
   currency: string;
   adminNumberPrefix: string;
   stockNumberPrefix: string;
+  vatRates: {
+    standard: string; //percentage value (e.g. 21)
+  };
+  location: LocationValue;
 };
 
 export type HdmsVehiclesSync = {

package/src/types/vehicles.ts

@@ -1,3 +1,4 @@
+import { EmailDestination } from '@bisondesk/commons-sdk/messages';
 import {
   AttachmentValue,
   Document,
@@ -594,3 +595,10 @@ export enum VehicleActions {
   ViewLeads = 'view_leads',
   ViewSimilarOnline = 'view_similar_online',
 }
+
+export type VehicleShareEmailRequest = {
+  country: string; // Lowercase ISO 3166-1 alpha-2 code, e.g. 'be'
+  to: EmailDestination[];
+  message: string;
+  pictures: AttachmentValue[];
+};

package/src/utils/tenants.ts

@@ -12,3 +12,8 @@ export const getBranch = (tenant: Tenant, branchId: string): Branch => {
 };
 
 export const getDefaultBranch = (tenant: Tenant): Branch => first(tenant.branches)!;
+
+export const getBranchStandardVatRate = (tenant: Tenant, branchId: string): string => {
+  const branch: Branch = getBranch(tenant, branchId);
+  return branch.vatRates.standard;
+};