@bisondesk/core-sdk 1.0.623 → 1.0.624

package/lib/types/quotes.js.map

@@ -1 +1 @@
-{"version":3,"file":"quotes.js","sourceRoot":"/","sources":["types/quotes.ts"],"names":[],"mappings":"AAYA,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,+CAA+B,CAAA;IAC/B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAED,MAAM,CAAN,IAAY,WASX;AATD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,sCAAuB,CAAA;IACvB,0CAA2B,CAAA;IAC3B,oCAAqB,CAAA;IACrB,oCAAqB,CAAA;IACrB,sCAAuB,CAAA;IACvB,mDAAoC,CAAA;IACpC,mDAAoC,CAAA;AACtC,CAAC,EATW,WAAW,KAAX,WAAW,QAStB;AAED,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,sCAAiB,CAAA;IACjB,wCAAmB,CAAA;IACnB,kCAAa,CAAA;AACf,CAAC,EAJW,iBAAiB,KAAjB,iBAAiB,QAI5B;AACD,MAAM,CAAN,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,mCAAkB,CAAA;IAClB,oCAAmB,CAAA;IACnB,8BAAa,CAAA;IACb,8CAA6B,CAAA;AAC/B,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB;AAED,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,8BAAe,CAAA;IACf,kCAAmB,CAAA;IACnB,qCAAsB,CAAA;AACxB,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AAED,MAAM,CAAN,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,wCAAkB,CAAA;IAClB,6CAAuB,CAAA;AACzB,CAAC,EAHW,kBAAkB,KAAlB,kBAAkB,QAG7B;AAED,MAAM,CAAN,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,oDAA+B,CAAA;IAC/B,0DAAqC,CAAA;AACvC,CAAC,EAHW,iBAAiB,KAAjB,iBAAiB,QAG5B","sourcesContent":["import { AttachmentValue, LocationValue } from '@bisondesk/commons-sdk/types';\nimport { OpportunityType } from '../constants.js';\nimport {\n  CustomLeasingQuoteExtraInput,\n  CustomSalesQuoteExtraInput,\n  LeasingDeliveryPackageInput,\n  LeasingQuoteExtraInput,\n  SalesQuoteExtraInput,\n} from './leasing-settings.js';\nimport { MatchingRuleValue } from './roi-ratings.js';\nimport { PricePercentageMode } from './utils.js';\n\nexport enum QuoteActions {\n  ACCEPT = 'accept',\n  VALIDATE = 'validate',\n  DONWLOAD_PDFS = 'download-pdfs',\n  CANCEL = 'cancel',\n}\n\nexport enum QuoteStatus {\n  CREATED = 'created',\n  VALIDATED = 'validated',\n  INVALIDATED = 'invalidated',\n  ACCEPTED = 'accepted',\n  REJECTED = 'rejected',\n  CANCELLED = 'cancelled',\n  MANAGER_REJECTED = 'managerRejected',\n  MANAGER_ACCEPTED = 'managerAccepted',\n}\n\nexport enum QuoteMetricsScore {\n  DANGER = 'danger',\n  NEUTRAL = 'neutral',\n  GOOD = 'good',\n}\nexport enum DeliveryTypes {\n  PICK_UP = 'pickUp',\n  ADDRESS = 'address',\n  PORT = 'port',\n  PORT_AND_SHIP = 'portAndShip',\n}\n\nexport enum SpoilerInfo {\n  MOUNT = 'mount',\n  UNMOUNT = 'unmount',\n  NO_ACTION = 'noAction',\n}\n\nexport enum TransportationMode {\n  BY_ROAD = 'byRoad',\n  ON_LOW_BED = 'onLowBed',\n}\n\nexport enum SelfFinancingType {\n  OWN_FINANCING = 'own_financing',\n  ALREADY_FINANCED = 'already_financed',\n}\n\ntype BaseQuoteCalculatorInput = {\n  branchId: string;\n  branchCountry: string;\n  customerCountry: string;\n  customerVatNumber?: string;\n  currency: string;\n  alternativeCurrency?: string;\n  exchangeRate?: string;\n  vehicle: {\n    id: string;\n    category: string;\n    bodywork?: string;\n    agreedPriceExclVat: string;\n    technicalNotes?: string;\n    vatRate: string;\n  };\n\n  allRisksCost?: string;\n};\n\n// Sent by the Frontend to bootstrap the calculator\nexport type LeasingCalculatorDefaultInput = Omit<BaseQuoteCalculatorInput, 'vehicle'> & {\n  vehicle: Omit<BaseQuoteCalculatorInput['vehicle'], 'vatRate'>;\n  deliveryPackage?: LeasingQuoteExtraInput;\n  settingsId: string;\n};\n\nexport type LeasingCalculatorInput = BaseQuoteCalculatorInput & {\n  localLicensePlate: boolean;\n  externalDelivery: boolean;\n  settingsId: string;\n  isRefinancingDebt?: boolean; // if true, the insurance amounts might not be the same as the leasing amount + and other costs like track and trace\n  vehicle: BaseQuoteCalculatorInput['vehicle'] & {\n    purchasePriceExclVat: string;\n    agreedPrice: string;\n    purchasePrice: string;\n  };\n  leasing: {\n    deposit: string;\n    depositMode: PricePercentageMode;\n    depositPercentage: string;\n    residual: string;\n    residualMode: PricePercentageMode;\n    residualPercentage: string;\n    startupFee: string;\n    startupFeeMode: PricePercentageMode;\n    startupFeePercentage: string;\n    interestRate: string;\n    duration: number;\n    contractStartDate: string;\n  };\n  bank: {\n    interestRate: string;\n    deposit: string;\n    depositMode: PricePercentageMode;\n    depositPercentage: string;\n    residual: string;\n    residualMode: PricePercentageMode;\n    residualPercentage: string;\n    duration: number;\n    salesPrice: string;\n    internalDealBranchId?: string;\n  } & (\n    | { selfFinancing: true; selfFinancingType?: SelfFinancingType; financing?: undefined }\n    | {\n        selfFinancing: false;\n        selfFinancingType?: undefined;\n        financing?: { bankAccountOrganizationId: string; amount: string };\n      }\n  );\n  taxes: {\n    yearlyRoadTax: boolean;\n    yearlyRoadTaxCustomAmount: string;\n    oneTimeRoadTax: boolean;\n    margin: string; //Non Editable, copies the value insurance > margin\n  };\n  insurance: {\n    margin: string;\n    civilLiabilities: boolean;\n    allRisks: boolean;\n    specialTechnicalInsurance: boolean;\n    roadAssistance: boolean;\n    initialFractionPercentage: string;\n    insuredAmount?: string;\n  };\n  deliveryPackage?: LeasingDeliveryPackageInput;\n  extras: LeasingQuoteExtraInput[];\n  customRequests: CustomLeasingQuoteExtraInput[];\n};\n\ntype BaseDeliveryType = {\n  agreedPrice: string;\n  spoiler?: SpoilerInfo;\n  stackingVehicleNeeded?: boolean;\n  detailsStacking?: string;\n};\n\nexport type PickUpDeliveryType = BaseDeliveryType & {\n  type: DeliveryTypes.PICK_UP;\n  urgent: boolean;\n  transportationMode?: TransportationMode;\n  detailsBorderCrossing?: string;\n  technicalControlNeeded: boolean;\n  insuranceNeeded: boolean;\n  transitPlateBelgiumNeeded: boolean;\n  transitPlateAustriaNeeded: boolean;\n  licensePlateNeeded: boolean;\n  dateOfPickUpByCustomer?: string;\n};\n\nexport type AddressDeliveryType = BaseDeliveryType & {\n  type: DeliveryTypes.ADDRESS;\n  address: LocationValue;\n  distanceKm: string;\n  technicalControlNeeded: boolean;\n};\n\nexport type PortDeliverytype = BaseDeliveryType & {\n  type: DeliveryTypes.PORT | DeliveryTypes.PORT_AND_SHIP;\n  portOriginId: string;\n  portDestination?: string;\n  shippingCompany?: string;\n  portToPortCostPrice: string;\n  portToPortMargin: string;\n};\n\n// Sent by the Frontend to bootstrap the calculator\nexport type SalesCalculatorDefaultInput = Omit<BaseQuoteCalculatorInput, 'vehicle'> & {\n  vehicle: Omit<BaseQuoteCalculatorInput['vehicle'], 'vatRate'>;\n  extras: SalesQuoteExtraInput[];\n  customRequests: CustomSalesQuoteExtraInput[];\n};\n\nexport type SalesCalculatorInput = BaseQuoteCalculatorInput & {\n  vehicle: BaseQuoteCalculatorInput['vehicle'] & {\n    purchasePriceExclVat: string;\n    premiumPrice?: string;\n    minimumPrice: string;\n    internetPrice?: string;\n    comissionCost: string;\n  };\n  delivery?: PickUpDeliveryType | AddressDeliveryType | PortDeliverytype;\n  extras: SalesQuoteExtraInput[];\n  customRequests: CustomSalesQuoteExtraInput[];\n  financing?: {\n    organizationId: string;\n  };\n};\n\nexport type SalesQuoteRuleInput = {\n  minimumPrice?: number;\n  internetPrice?: number;\n  premiumPrice?: number;\n  agreedPrice: number;\n  stockAge: number;\n};\n\nexport type LeasingCalculatorOutput = {\n  installment: string;\n  installmentPrintable: string;\n  totalMonthlyAmount: string;\n  monthlyTaxesInsurance: string;\n  beforeDeliveryExclVat: string;\n  beforeDelivery: string;\n  financingAmount: string;\n  settingId: string;\n  totalRetailAmountExclVat: string;\n  totalRetailAmount: string;\n  totalRetailAmountAlternativeCurrency?: string;\n  totalRetailAmountExclVatAlternativeCurrency?: string;\n  finalSalesPrice: string;\n  roi: {\n    value: string;\n    target: string;\n    perYear: string;\n    difference: string;\n    score?: QuoteMetricsScore;\n  };\n  cashflow: {\n    deficit: string;\n    balanced: boolean;\n    score: QuoteMetricsScore;\n  };\n  profitability: {\n    leasing: string;\n    vehicle: string;\n    total: string;\n    score: QuoteMetricsScore;\n  };\n  taxes: {\n    yearlyRetailPrice: string;\n    monthlyRetailPrice: string;\n    yearlyRoadTax: string;\n    oneTimeRoadTax: string;\n    profit: string;\n  };\n  insurance: {\n    beforeDelivery: string;\n    yearlyRetailPrice: string;\n    monthlyRetailPrice: string;\n    civilLiabilities: string;\n    allRisks: string;\n    specialTechnicalInsurance: string;\n    roadAssistance: string;\n    profit: string;\n  };\n  trackAndTrace: {\n    beforeDelivery: string;\n    monthlyCost: string;\n    installationCost: string; // currently this cost is being included as part of monthlyCost. In future, this will be a separate cost\n    deviceCost: string; // same as above\n    profit: string;\n  };\n  costs: {\n    financingAmount: string;\n    finalCostPrice: string;\n    monhtly: string;\n  };\n};\n\nexport type SalesCalculatorOutput = {\n  totalRetailAmount: string;\n  totalRetailAmountExclVat: string;\n  totalRetailAmountAlternativeCurrency?: string;\n  totalRetailAmountExclVatAlternativeCurrency?: string;\n  retailAmounts: {\n    vehicle: string;\n    delivery: string;\n    extras: string;\n  };\n  vehicle: {\n    purchasePrice: string; //incl vat\n    agreedPrice: string; // incl vat\n  };\n  roi: { value: string; score?: QuoteMetricsScore };\n  profit: {\n    value: string;\n    percentage: string;\n    score: QuoteMetricsScore;\n  };\n  profitOverMin?: {\n    // deprecated\n    value: string;\n    percentage: string;\n    score: QuoteMetricsScore;\n  };\n  delivery?: {\n    retailPrice?: string;\n    costPrice?: string;\n    cleaningNeeded: boolean;\n    cleaningNeededRetailPrice: string;\n    transportationToPortRetailPrice?: string;\n  };\n  costs: {\n    finalCostPrice: string;\n    extras: string;\n    delivery: string;\n  };\n};\n\ntype BaseQuote = {\n  opportunityId: string;\n  preferredLanguage: string;\n  clientNotes?: string;\n  publicNotes?: string;\n} & (\n  | {\n      type: OpportunityType.LEASING;\n      calculatorInput: LeasingCalculatorInput;\n      calculatorOutput: LeasingCalculatorOutput;\n      rating?: MatchingRuleValue;\n    }\n  | {\n      type: OpportunityType.SALES;\n      calculatorInput: SalesCalculatorInput;\n      calculatorOutput: SalesCalculatorOutput;\n      rating?: MatchingRuleValue;\n    }\n  | {\n      type: OpportunityType.NEW_TRAILER | OpportunityType.NEW_TRAILER_NEW_PRODUCTION;\n      calculatorInput: SalesCalculatorInput;\n      calculatorOutput: SalesCalculatorOutput;\n      rating?: MatchingRuleValue;\n    }\n  | {\n      type:\n        | OpportunityType.CUSTOMMADE_CONSTRUCTION_OUTSOURCING\n        | OpportunityType.CUSTOMMADE_CONSTRUCTION_INSOURCING;\n      calculatorInput: SalesCalculatorInput;\n      calculatorOutput: SalesCalculatorOutput;\n      rating?: MatchingRuleValue;\n    }\n);\n\nexport type NewQuote = BaseQuote & {\n  id?: undefined;\n  createdAt?: undefined;\n  createdBy?: undefined;\n  modifiedAt?: undefined;\n  modifiedBy?: undefined;\n  active: true;\n};\n\nexport type Quote = BaseQuote & {\n  id: string;\n  createdAt: string;\n  createdBy: string;\n  modifiedAt: string;\n  modifiedBy: string;\n  validationBy?: string;\n  validationAt?: string;\n  cancelledBy?: string;\n  cancelledAt?: string;\n  customerFeedbackAt?: string;\n  customerFeedbackBy?: string;\n  managerFeedbackAt?: string;\n  managerFeedbackBy?: string;\n  version: number;\n  status: QuoteStatus;\n  proformaPdf?: AttachmentValue;\n  quotePdf?: AttachmentValue;\n  salesAgreementPdf?: AttachmentValue;\n  active: boolean;\n  contactId: string;\n  vehicleId: string;\n  organizationId: string;\n  technicalNotesUpdated: boolean;\n  technicalNotesValidated: boolean;\n  technicalNotesValidatedAt?: string;\n  technicalNotesValidatedBy?: string;\n  externalQuote?: boolean;\n};\n\nexport type QuoteUpdate = {\n  status?: QuoteStatus;\n  active?: boolean;\n  technicalNotesValidated?: boolean;\n};\n\nexport type CalculatorLeasingIO = {\n  output: LeasingCalculatorOutput;\n  input: LeasingCalculatorInput;\n  rating?: MatchingRuleValue;\n};\nexport type CalculatorSalesIO = {\n  output: SalesCalculatorOutput;\n  input: SalesCalculatorInput;\n  rating?: MatchingRuleValue;\n};\nexport type CalculatorQuoteIO = CalculatorLeasingIO | CalculatorSalesIO;\n\nexport type DeliveryLocationValue = Omit<LocationValue, 'addressLine1' | 'city'> & {\n  addressLine1: string;\n  city: string;\n};\n\nexport type DeliveryRoutesRequest = {\n  origin: DeliveryLocationValue;\n  destination: DeliveryLocationValue;\n};\n\nexport type NewQuoteValidator = {\n  userId: string;\n  countryCode: string;\n  type: OpportunityType;\n  canValidateOwn?: boolean;\n};\n\nexport type QuoteValidator = NewQuoteValidator & {\n  createdAt: string;\n};\n\nexport type QuoteValidatorUpdate = {\n  canValidateOwn: boolean;\n};\n"]}
+{"version":3,"file":"quotes.js","sourceRoot":"/","sources":["types/quotes.ts"],"names":[],"mappings":"AAYA,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,+CAA+B,CAAA;IAC/B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAED,MAAM,CAAN,IAAY,WASX;AATD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,sCAAuB,CAAA;IACvB,0CAA2B,CAAA;IAC3B,oCAAqB,CAAA;IACrB,oCAAqB,CAAA;IACrB,sCAAuB,CAAA;IACvB,mDAAoC,CAAA;IACpC,mDAAoC,CAAA;AACtC,CAAC,EATW,WAAW,KAAX,WAAW,QAStB;AAED,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,sCAAiB,CAAA;IACjB,wCAAmB,CAAA;IACnB,kCAAa,CAAA;AACf,CAAC,EAJW,iBAAiB,KAAjB,iBAAiB,QAI5B;AACD,MAAM,CAAN,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,mCAAkB,CAAA;IAClB,oCAAmB,CAAA;IACnB,8BAAa,CAAA;IACb,8CAA6B,CAAA;AAC/B,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB;AAED,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,8BAAe,CAAA;IACf,kCAAmB,CAAA;IACnB,qCAAsB,CAAA;AACxB,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AAED,MAAM,CAAN,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,wCAAkB,CAAA;IAClB,6CAAuB,CAAA;AACzB,CAAC,EAHW,kBAAkB,KAAlB,kBAAkB,QAG7B;AAED,MAAM,CAAN,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,oDAA+B,CAAA;IAC/B,0DAAqC,CAAA;AACvC,CAAC,EAHW,iBAAiB,KAAjB,iBAAiB,QAG5B","sourcesContent":["import { AttachmentValue, LocationValue } from '@bisondesk/commons-sdk/types';\nimport { OpportunityType } from '../constants.js';\nimport {\n  CustomLeasingQuoteExtraInput,\n  CustomSalesQuoteExtraInput,\n  LeasingDeliveryPackageInput,\n  LeasingQuoteExtraInput,\n  SalesQuoteExtraInput,\n} from './leasing-settings.js';\nimport { MatchingRuleValue } from './roi-ratings.js';\nimport { PricePercentageMode } from './utils.js';\n\nexport enum QuoteActions {\n  ACCEPT = 'accept',\n  VALIDATE = 'validate',\n  DONWLOAD_PDFS = 'download-pdfs',\n  CANCEL = 'cancel',\n}\n\nexport enum QuoteStatus {\n  CREATED = 'created',\n  VALIDATED = 'validated',\n  INVALIDATED = 'invalidated',\n  ACCEPTED = 'accepted',\n  REJECTED = 'rejected',\n  CANCELLED = 'cancelled',\n  MANAGER_REJECTED = 'managerRejected',\n  MANAGER_ACCEPTED = 'managerAccepted',\n}\n\nexport enum QuoteMetricsScore {\n  DANGER = 'danger',\n  NEUTRAL = 'neutral',\n  GOOD = 'good',\n}\nexport enum DeliveryTypes {\n  PICK_UP = 'pickUp',\n  ADDRESS = 'address',\n  PORT = 'port',\n  PORT_AND_SHIP = 'portAndShip',\n}\n\nexport enum SpoilerInfo {\n  MOUNT = 'mount',\n  UNMOUNT = 'unmount',\n  NO_ACTION = 'noAction',\n}\n\nexport enum TransportationMode {\n  BY_ROAD = 'byRoad',\n  ON_LOW_BED = 'onLowBed',\n}\n\nexport enum SelfFinancingType {\n  OWN_FINANCING = 'own_financing',\n  ALREADY_FINANCED = 'already_financed',\n}\n\ntype BaseQuoteCalculatorInput = {\n  branchId: string;\n  branchCountry: string;\n  customerCountry: string;\n  customerVatNumber?: string;\n  currency: string;\n  alternativeCurrency?: string;\n  exchangeRate?: string;\n  vehicle: {\n    id: string;\n    category: string;\n    bodywork?: string;\n    agreedPriceExclVat: string;\n    technicalNotes?: string;\n    vatRate: string;\n  };\n\n  allRisksCost?: string;\n};\n\n// Sent by the Frontend to bootstrap the calculator\nexport type LeasingCalculatorDefaultInput = Omit<BaseQuoteCalculatorInput, 'vehicle'> & {\n  vehicle: Omit<BaseQuoteCalculatorInput['vehicle'], 'vatRate'>;\n  deliveryPackage?: LeasingQuoteExtraInput;\n  settingsId: string;\n};\n\nexport type LeasingCalculatorInput = BaseQuoteCalculatorInput & {\n  localLicensePlate: boolean;\n  externalDelivery: boolean;\n  settingsId: string;\n  isRefinancingDebt?: boolean; // if true, the insurance amounts might not be the same as the leasing amount + and other costs like track and trace\n  vehicle: BaseQuoteCalculatorInput['vehicle'] & {\n    purchasePriceExclVat: string;\n    agreedPrice: string;\n    purchasePrice: string;\n  };\n  leasing: {\n    deposit: string;\n    depositMode: PricePercentageMode;\n    depositPercentage: string;\n    residual: string;\n    residualMode: PricePercentageMode;\n    residualPercentage: string;\n    startupFee: string;\n    startupFeeMode: PricePercentageMode;\n    startupFeePercentage: string;\n    /** Returnable security deposit (dépôt de garantie): VAT-free, never financed. Not the advance (`deposit`). */\n    guaranteeDeposit?: string;\n    interestRate: string;\n    duration: number;\n    contractStartDate: string;\n  };\n  bank: {\n    interestRate: string;\n    deposit: string;\n    depositMode: PricePercentageMode;\n    depositPercentage: string;\n    residual: string;\n    residualMode: PricePercentageMode;\n    residualPercentage: string;\n    duration: number;\n    salesPrice: string;\n    internalDealBranchId?: string;\n  } & (\n    | { selfFinancing: true; selfFinancingType?: SelfFinancingType; financing?: undefined }\n    | {\n        selfFinancing: false;\n        selfFinancingType?: undefined;\n        financing?: { bankAccountOrganizationId: string; amount: string };\n      }\n  );\n  taxes: {\n    yearlyRoadTax: boolean;\n    yearlyRoadTaxCustomAmount: string;\n    oneTimeRoadTax: boolean;\n    margin: string; //Non Editable, copies the value insurance > margin\n  };\n  insurance: {\n    margin: string;\n    civilLiabilities: boolean;\n    allRisks: boolean;\n    specialTechnicalInsurance: boolean;\n    roadAssistance: boolean;\n    initialFractionPercentage: string;\n    insuredAmount?: string;\n  };\n  deliveryPackage?: LeasingDeliveryPackageInput;\n  extras: LeasingQuoteExtraInput[];\n  customRequests: CustomLeasingQuoteExtraInput[];\n};\n\ntype BaseDeliveryType = {\n  agreedPrice: string;\n  spoiler?: SpoilerInfo;\n  stackingVehicleNeeded?: boolean;\n  detailsStacking?: string;\n};\n\nexport type PickUpDeliveryType = BaseDeliveryType & {\n  type: DeliveryTypes.PICK_UP;\n  urgent: boolean;\n  transportationMode?: TransportationMode;\n  detailsBorderCrossing?: string;\n  technicalControlNeeded: boolean;\n  insuranceNeeded: boolean;\n  transitPlateBelgiumNeeded: boolean;\n  transitPlateAustriaNeeded: boolean;\n  licensePlateNeeded: boolean;\n  dateOfPickUpByCustomer?: string;\n};\n\nexport type AddressDeliveryType = BaseDeliveryType & {\n  type: DeliveryTypes.ADDRESS;\n  address: LocationValue;\n  distanceKm: string;\n  technicalControlNeeded: boolean;\n};\n\nexport type PortDeliverytype = BaseDeliveryType & {\n  type: DeliveryTypes.PORT | DeliveryTypes.PORT_AND_SHIP;\n  portOriginId: string;\n  portDestination?: string;\n  shippingCompany?: string;\n  portToPortCostPrice: string;\n  portToPortMargin: string;\n};\n\n// Sent by the Frontend to bootstrap the calculator\nexport type SalesCalculatorDefaultInput = Omit<BaseQuoteCalculatorInput, 'vehicle'> & {\n  vehicle: Omit<BaseQuoteCalculatorInput['vehicle'], 'vatRate'>;\n  extras: SalesQuoteExtraInput[];\n  customRequests: CustomSalesQuoteExtraInput[];\n};\n\nexport type SalesCalculatorInput = BaseQuoteCalculatorInput & {\n  vehicle: BaseQuoteCalculatorInput['vehicle'] & {\n    purchasePriceExclVat: string;\n    premiumPrice?: string;\n    minimumPrice: string;\n    internetPrice?: string;\n    comissionCost: string;\n  };\n  delivery?: PickUpDeliveryType | AddressDeliveryType | PortDeliverytype;\n  extras: SalesQuoteExtraInput[];\n  customRequests: CustomSalesQuoteExtraInput[];\n  financing?: {\n    organizationId: string;\n  };\n};\n\nexport type SalesQuoteRuleInput = {\n  minimumPrice?: number;\n  internetPrice?: number;\n  premiumPrice?: number;\n  agreedPrice: number;\n  stockAge: number;\n};\n\nexport type LeasingCalculatorOutput = {\n  installment: string;\n  installmentPrintable: string;\n  totalMonthlyAmount: string;\n  monthlyTaxesInsurance: string;\n  beforeDeliveryExclVat: string;\n  beforeDelivery: string;\n  /** Portion of beforeDelivery that is the returnable guarantee deposit (VAT-free, not financed). */\n  guaranteeDeposit?: string;\n  financingAmount: string;\n  settingId: string;\n  totalRetailAmountExclVat: string;\n  totalRetailAmount: string;\n  totalRetailAmountAlternativeCurrency?: string;\n  totalRetailAmountExclVatAlternativeCurrency?: string;\n  finalSalesPrice: string;\n  roi: {\n    value: string;\n    target: string;\n    perYear: string;\n    difference: string;\n    score?: QuoteMetricsScore;\n  };\n  cashflow: {\n    deficit: string;\n    balanced: boolean;\n    score: QuoteMetricsScore;\n  };\n  profitability: {\n    leasing: string;\n    vehicle: string;\n    total: string;\n    score: QuoteMetricsScore;\n  };\n  taxes: {\n    yearlyRetailPrice: string;\n    monthlyRetailPrice: string;\n    yearlyRoadTax: string;\n    oneTimeRoadTax: string;\n    profit: string;\n  };\n  insurance: {\n    beforeDelivery: string;\n    yearlyRetailPrice: string;\n    monthlyRetailPrice: string;\n    civilLiabilities: string;\n    allRisks: string;\n    specialTechnicalInsurance: string;\n    roadAssistance: string;\n    profit: string;\n  };\n  trackAndTrace: {\n    beforeDelivery: string;\n    monthlyCost: string;\n    installationCost: string; // currently this cost is being included as part of monthlyCost. In future, this will be a separate cost\n    deviceCost: string; // same as above\n    profit: string;\n  };\n  costs: {\n    financingAmount: string;\n    finalCostPrice: string;\n    monhtly: string;\n  };\n};\n\nexport type SalesCalculatorOutput = {\n  totalRetailAmount: string;\n  totalRetailAmountExclVat: string;\n  totalRetailAmountAlternativeCurrency?: string;\n  totalRetailAmountExclVatAlternativeCurrency?: string;\n  retailAmounts: {\n    vehicle: string;\n    delivery: string;\n    extras: string;\n  };\n  vehicle: {\n    purchasePrice: string; //incl vat\n    agreedPrice: string; // incl vat\n  };\n  roi: { value: string; score?: QuoteMetricsScore };\n  profit: {\n    value: string;\n    percentage: string;\n    score: QuoteMetricsScore;\n  };\n  profitOverMin?: {\n    // deprecated\n    value: string;\n    percentage: string;\n    score: QuoteMetricsScore;\n  };\n  delivery?: {\n    retailPrice?: string;\n    costPrice?: string;\n    cleaningNeeded: boolean;\n    cleaningNeededRetailPrice: string;\n    transportationToPortRetailPrice?: string;\n  };\n  costs: {\n    finalCostPrice: string;\n    extras: string;\n    delivery: string;\n  };\n};\n\ntype BaseQuote = {\n  opportunityId: string;\n  preferredLanguage: string;\n  clientNotes?: string;\n  publicNotes?: string;\n} & (\n  | {\n      type: OpportunityType.LEASING;\n      calculatorInput: LeasingCalculatorInput;\n      calculatorOutput: LeasingCalculatorOutput;\n      rating?: MatchingRuleValue;\n    }\n  | {\n      type: OpportunityType.SALES;\n      calculatorInput: SalesCalculatorInput;\n      calculatorOutput: SalesCalculatorOutput;\n      rating?: MatchingRuleValue;\n    }\n  | {\n      type: OpportunityType.NEW_TRAILER | OpportunityType.NEW_TRAILER_NEW_PRODUCTION;\n      calculatorInput: SalesCalculatorInput;\n      calculatorOutput: SalesCalculatorOutput;\n      rating?: MatchingRuleValue;\n    }\n  | {\n      type:\n        | OpportunityType.CUSTOMMADE_CONSTRUCTION_OUTSOURCING\n        | OpportunityType.CUSTOMMADE_CONSTRUCTION_INSOURCING;\n      calculatorInput: SalesCalculatorInput;\n      calculatorOutput: SalesCalculatorOutput;\n      rating?: MatchingRuleValue;\n    }\n);\n\nexport type NewQuote = BaseQuote & {\n  id?: undefined;\n  createdAt?: undefined;\n  createdBy?: undefined;\n  modifiedAt?: undefined;\n  modifiedBy?: undefined;\n  active: true;\n};\n\nexport type Quote = BaseQuote & {\n  id: string;\n  createdAt: string;\n  createdBy: string;\n  modifiedAt: string;\n  modifiedBy: string;\n  validationBy?: string;\n  validationAt?: string;\n  cancelledBy?: string;\n  cancelledAt?: string;\n  customerFeedbackAt?: string;\n  customerFeedbackBy?: string;\n  managerFeedbackAt?: string;\n  managerFeedbackBy?: string;\n  version: number;\n  status: QuoteStatus;\n  proformaPdf?: AttachmentValue;\n  quotePdf?: AttachmentValue;\n  salesAgreementPdf?: AttachmentValue;\n  active: boolean;\n  contactId: string;\n  vehicleId: string;\n  organizationId: string;\n  technicalNotesUpdated: boolean;\n  technicalNotesValidated: boolean;\n  technicalNotesValidatedAt?: string;\n  technicalNotesValidatedBy?: string;\n  externalQuote?: boolean;\n};\n\nexport type QuoteUpdate = {\n  status?: QuoteStatus;\n  active?: boolean;\n  technicalNotesValidated?: boolean;\n};\n\nexport type CalculatorLeasingIO = {\n  output: LeasingCalculatorOutput;\n  input: LeasingCalculatorInput;\n  rating?: MatchingRuleValue;\n};\nexport type CalculatorSalesIO = {\n  output: SalesCalculatorOutput;\n  input: SalesCalculatorInput;\n  rating?: MatchingRuleValue;\n};\nexport type CalculatorQuoteIO = CalculatorLeasingIO | CalculatorSalesIO;\n\nexport type DeliveryLocationValue = Omit<LocationValue, 'addressLine1' | 'city'> & {\n  addressLine1: string;\n  city: string;\n};\n\nexport type DeliveryRoutesRequest = {\n  origin: DeliveryLocationValue;\n  destination: DeliveryLocationValue;\n};\n\nexport type NewQuoteValidator = {\n  userId: string;\n  countryCode: string;\n  type: OpportunityType;\n  canValidateOwn?: boolean;\n};\n\nexport type QuoteValidator = NewQuoteValidator & {\n  createdAt: string;\n};\n\nexport type QuoteValidatorUpdate = {\n  canValidateOwn: boolean;\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bisondesk/core-sdk",
-  "version": "1.0.623",
+  "version": "1.0.624",
   "description": "",
   "type": "module",
   "author": "TheTruckCompany",

package/src/types/leasing.ts

@@ -171,6 +171,8 @@ export type NextLeasingRentRowResponse = {
 type BaseRef = {
   id: string;
   depositAmount: string;
+  /** Returnable guarantee deposit (dépôt de garantie) collected before delivery; VAT-free, restituted at contract end. */
+  guaranteeDepositAmount?: string;
   durationInMonths: number;
   taxesAmount?: string;
   insuranceAmount?: string;
@@ -389,6 +391,8 @@ export type AmortizationTableTemplateData = {
     deposit: string;
     depositExclVat: string;
     depositVat: string;
+    /** Returnable guarantee deposit; VAT-free, so incl and excl VAT are the same amount. */
+    guaranteeDeposit?: string;
     installment: string;
     installmentVat: string;
     installmentExclVat: string;

package/src/types/opportunities.ts

@@ -427,6 +427,8 @@ export type LeasingQuoteTemplateData = {
     depositExclVat: string;
     startupFee: string;
     startupFeeExclVat: string;
+    /** Returnable guarantee deposit; VAT-free, so incl and excl VAT are the same amount. */
+    guaranteeDeposit?: string;
     totalExtras: string;
     totalExtrasExclVat: string;
     totalBeforeDeliveryExclVat: string;
@@ -486,6 +488,8 @@ export type LeasingProformaTemplateData = {
     vatAmount: string;
     displayVatMessage: boolean;
     total: string;
+    /** Returnable guarantee deposit included in the totals; VAT-free. */
+    guaranteeDeposit?: string;
     monthly: string;
     monthlyExclVat: string;
     residual: string;
@@ -591,64 +595,84 @@ export type MSearchOpportunitiesKanbanColumn = {
   nextToken?: string;
 };
 
+type HpLeasingDealRunDataBase = {
+  bisondeskTenantId: string;
+  entityOwner: string;
+  opportunityId: string;
+};
+
+// Field ids match the hpaci (Mr Lease CI) leasing-deal process definition: the LD is the only
+// Hyperportal process for that tenant (no C flow) and the contract document lives in BisonDesk.
+export type HpLeasingDealRunDataCi = HpLeasingDealRunDataBase & {
+  client?: string;
+  vendeur?: string;
+  vehicule?: string;
+  plaqueDimmatriculation?: string;
+  numeroDeContratLeasing: string;
+  prixDeVenteHorsTvaXof: string;
+  montantDavanceTtcXof: string;
+  dueeDuLeasingEnMois: number;
+  travauxHorsNormesNecessaire: boolean;
+  descriptionDesTravauxHorsNormes: string;
+};
+
 export type HpLeasingDealRequest = {
   tenantId: string;
   initiatedBy: 'bisondesk';
   processMetaId: string;
-  processRunData: {
-    bisondeskTenantId: string;
-    entityOwner: string;
-    leasingContractOwner?: string;
-    foreseenDeliveryDate?: string;
-    deliveryAddressLeasing?: string;
-    nameSalesPerson: string;
-    durationLeasingInMonths: number;
-    vanCourier: boolean;
-    newVehicle?: boolean;
-    newTrailer?: boolean;
-    registrationOnTtcoBe?: boolean;
-    externalDelivery?: boolean;
-    civilLiabilities?: boolean;
-    specialTechnicalInsurance?: boolean;
-    allRisks?: boolean;
-    roadAssistance?: boolean;
-    vabAssistanceVan?: boolean;
-    yearOfConstruction?: number;
-    chassisnumber?: string;
-    vehicleModel?: string;
-    vehicleCategory2?: string;
-    licencePlate?: string;
-    vatPercentage?: number;
-
-    opportunityContractId: string;
-    opportunityId: string;
-
-    company?: string;
-    customerNumber?: number; //bisondesk external id
-    slbPartner?: string;
-    //MrLease fields
-    vehicle?: string;
-    vehicleNewReferenceMl?: string;
-    referencePurchaserTtcoKleyn?: string;
-    salesPriceEur: string;
-    depositFullAmountExclVat: string;
-    depositToBePrepaidExclVat: string;
-    vehicleMake3?: string;
-
-    //TTC fields
-    vehicleOriginalReference?: string;
-    salesPrice: string;
-    depositFullAmount: string;
-    depositAmountToBePrepaid: string;
-    make?: string;
-
-    //Extras
-    garageExtrasCodes: string[];
-    allExtrasDescriptions: string[];
-    administrationExtrasCodes: string[];
-    logisticExtrasCodes: string[];
-    customRequestDescriptions: string[];
-  };
+  processRunData: HpLeasingDealRunDataDefault | HpLeasingDealRunDataCi;
+};
+
+export type HpLeasingDealRunDataDefault = HpLeasingDealRunDataBase & {
+  leasingContractOwner?: string;
+  foreseenDeliveryDate?: string;
+  deliveryAddressLeasing?: string;
+  nameSalesPerson: string;
+  durationLeasingInMonths: number;
+  vanCourier: boolean;
+  newVehicle?: boolean;
+  newTrailer?: boolean;
+  registrationOnTtcoBe?: boolean;
+  externalDelivery?: boolean;
+  civilLiabilities?: boolean;
+  specialTechnicalInsurance?: boolean;
+  allRisks?: boolean;
+  roadAssistance?: boolean;
+  vabAssistanceVan?: boolean;
+  yearOfConstruction?: number;
+  chassisnumber?: string;
+  vehicleModel?: string;
+  vehicleCategory2?: string;
+  licencePlate?: string;
+  vatPercentage?: number;
+
+  opportunityContractId: string;
+
+  company?: string;
+  customerNumber?: number; //bisondesk external id
+  slbPartner?: string;
+  //MrLease fields
+  vehicle?: string;
+  vehicleNewReferenceMl?: string;
+  referencePurchaserTtcoKleyn?: string;
+  salesPriceEur: string;
+  depositFullAmountExclVat: string;
+  depositToBePrepaidExclVat: string;
+  vehicleMake3?: string;
+
+  //TTC fields
+  vehicleOriginalReference?: string;
+  salesPrice: string;
+  depositFullAmount: string;
+  depositAmountToBePrepaid: string;
+  make?: string;
+
+  //Extras
+  garageExtrasCodes: string[];
+  allExtrasDescriptions: string[];
+  administrationExtrasCodes: string[];
+  logisticExtrasCodes: string[];
+  customRequestDescriptions: string[];
 };
 
 export type HpLeasingDealResponse = {

package/src/types/quotes.ts

@@ -103,6 +103,8 @@ export type LeasingCalculatorInput = BaseQuoteCalculatorInput & {
     startupFee: string;
     startupFeeMode: PricePercentageMode;
     startupFeePercentage: string;
+    /** Returnable security deposit (dépôt de garantie): VAT-free, never financed. Not the advance (`deposit`). */
+    guaranteeDeposit?: string;
     interestRate: string;
     duration: number;
     contractStartDate: string;
@@ -220,6 +222,8 @@ export type LeasingCalculatorOutput = {
   monthlyTaxesInsurance: string;
   beforeDeliveryExclVat: string;
   beforeDelivery: string;
+  /** Portion of beforeDelivery that is the returnable guarantee deposit (VAT-free, not financed). */
+  guaranteeDeposit?: string;
   financingAmount: string;
   settingId: string;
   totalRetailAmountExclVat: string;