@bisondesk/core-sdk 1.0.665 → 1.0.667

package/src/types/leasing.ts

@@ -415,164 +415,6 @@ export type AmortizationTableRequest = {
   startDate?: string; // should be filled in if you want an amortization table with expected period dates
 };
 
-export type AmortizationTableTemplateData = {
-  opportunity: {
-    id: string;
-  };
-  v: {
-    make: string;
-    model: string;
-    category: string;
-    type?: string;
-    vin: string;
-    year?: string | number;
-    stockNumber: string;
-  };
-  c: {
-    clientNumber: number;
-    company: string;
-    fullName: string;
-    vatNumber?: string;
-    email?: string;
-    phone?: string;
-    address?: string;
-  };
-  leasing: {
-    salesPrice: string;
-    salesPriceVat: string;
-    salesPriceExclVat: string;
-    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;
-    duration: number;
-    monthlyInsurance: string;
-    monthlyTax: string;
-    monthlyTaxesInsurance: string;
-    residual: string;
-    residualVat: string;
-    residualExclVat: string;
-    offerNumber: string;
-    contractNumber: string;
-    vatPercentage: string;
-    totalLeasingAmount: string;
-    totalLeasingAmountExclVat: string;
-    balance: string;
-    balanceExclVat: string;
-  };
-  amortization: {
-    period: number;
-    periodStartDate: string;
-    periodEndDate: string;
-    deposit: string;
-    startUpFee: string;
-    monthlyAmount: string;
-    capital: string;
-    balance: string;
-    interest: string;
-    insurance: string;
-    expirationDate: string;
-    total: string;
-  }[];
-};
-
-/**
- * Merge payload for the printable contract conditions documents (Conditions Particulières and
- * Conditions Générales share it; the Générales template consumes a subset). Country-agnostic —
- * first used by MrLease CI. Amounts are display-ready strings without a currency symbol; the
- * currency literals live in the per-branch DOCX templates.
- */
-export type ContractConditionsTemplateData = {
-  contractNumber: string;
-  currentDate: string;
-  c: {
-    company: string;
-    address: string;
-  };
-  v: {
-    make: string;
-    type: string;
-    year: string | number;
-    vin: string;
-    condition: string;
-  };
-  leasing: {
-    duration: number;
-    salesPriceExclVat: string;
-    depositExclVat: string;
-    depositPercentage: string;
-    installmentExclVat: string;
-    paymentMode: string;
-    guaranteeDeposit: string;
-    deliveryDate: string;
-    installationLocation: string;
-    maxKmPerYear: string;
-    startupFee: string;
-    residualExclVat: string;
-  };
-};
-
-/**
- * Merge payload for the delivery confirmation (procès-verbal de réception): the lessee's receipt
- * that the vehicle arrived complete and matching the contract.
- */
-export type LeasingDeliveryConfirmationTemplateData = {
-  contractNumber: string;
-  currentDate: string;
-  c: {
-    company: string;
-    street: string;
-    postalCode: string;
-    city: string;
-    /** ISO country code of the customer's legal address, as the CRM stores it. */
-    country: string;
-    phone: string;
-    email: string;
-    vatNumber: string;
-  };
-  v: {
-    make: string;
-    type: string;
-    year: string | number;
-    vin: string;
-  };
-  /** The customer's contact person, who signs the receipt. */
-  contact: {
-    name: string;
-  };
-};
-
-/** Merge payload for the cautionnement (personal surety) document. */
-export type CautionnementTemplateData = {
-  currentDate: string;
-  c: {
-    company: string;
-    address: string;
-    vatNumber: string;
-    shareCapital: string;
-  };
-  v: {
-    make: string;
-    type: string;
-    year: string | number;
-    vin: string;
-  };
-  p: {
-    name: string;
-    birthDate: string;
-    nationalId: string;
-    address: string;
-    role: string;
-    /** Cap of the guarantee: the whole lease incl. VAT. See `computeGuaranteedAmount`. */
-    maxGuaranteedAmount: string;
-    maxGuaranteedAmountWords: string;
-  };
-};
-
 export type CmrTemplateData = {
   contractId: string;
   date: string;

package/src/types/opportunities.ts

@@ -5,7 +5,7 @@ import { Contact, Organization } from './crm.js';
 import type { Interest, InterestBffMeta } from './interests.js';
 import { BaseEvent } from './internal-events.js';
 import { OpportunityPayment } from './opportunity-payments.js';
-import { Quote, QuoteStatus } from './quotes.js';
+import { Quote, QuoteRecordMeta, QuoteStatus } from './quotes.js';
 import { OpportunityReservation } from './reservations.js';
 import { BaseSearchRequest } from './search.js';
 import { Transport } from './transports.js';
@@ -325,8 +325,9 @@ export type OpportunityBFF = {
   vehicle?: DataRecord<Vehicle, VehicleBffMetadata>;
   interest?: DataRecord<Interest, InterestBffMeta>;
   bids: DataRecord<Bid>[];
-  quotes: DataRecord<Quote>[];
-  activeQuote?: DataRecord<Quote>;
+  /** Every quote the deal has ever had; the ones it has left carry `meta.archived`. */
+  quotes: DataRecord<Quote, QuoteRecordMeta>[];
+  activeQuote?: DataRecord<Quote, QuoteRecordMeta>;
   payments: OpportunityPaymentSummary | undefined;
   reservation?: DataRecord<OpportunityReservation>;
   tasks: DataRecord<Task>[];
@@ -442,198 +443,11 @@ export type OpportunityNotificationData = {
   snippet?: string;
 };
 
-export type LeasingQuoteTemplateData = {
-  opportunity: {
-    id: string;
-  };
-  currentDate: string;
-  expirationDate: string;
-  vehicle: {
-    make: string;
-    model: string;
-    type?: string;
-    km: string | number;
-    vin: string;
-    mainImage: string;
-    localLicensePlate: boolean;
-    description: string;
-    year?: string | number;
-    stockNumber?: string;
-  };
-  accountManager: {
-    fullName: string;
-    email: string;
-    phone: string;
-  };
-  customer: {
-    company: string;
-    fullName: string;
-    vatNumber?: string;
-    address?: string;
-  };
-  settingId: string;
-  leasing: {
-    deposit: string;
-    totalMonthlyAmount: string;
-    totalMonthlyAmountExclVat: string;
-    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;
-    totalBeforeDelivery: string;
-    installment: string;
-    installmentExclVat: string;
-    duration: number;
-    monthlyInsurance: string;
-    monthlyTax: string;
-    monthlyTaxesInsurance: string;
-    monthlyTaxesInsuranceExclVat: string;
-    residual: string;
-    residualExclVat: string;
-    offerNumber: string;
-    extras: { name: string }[];
-  };
-};
-
-export type LineItemPdfTemplate = {
-  description: string;
-  vat: string;
-  quantity: number;
-  unitPriceExclVat: string;
-  amount: string;
-  amountExclVat: string;
-};
-
-export type LeasingProformaTemplateData = {
-  opportunity: {
-    id: string;
-    offerNumber: string;
-  };
-  currentDate: string;
-  accountManager: {
-    fullName: string;
-    email: string;
-    phone: string;
-  };
-  vehicle: {
-    line1: string;
-    line2: string;
-    stockNumber: string;
-  };
-  c: {
-    organizationId?: string;
-    clientId: string;
-    company: string;
-    fullName: string;
-    vatNumber?: string;
-    email?: string;
-    phone?: string;
-    address?: string;
-  };
-  i: LineItemPdfTemplate[];
-  t: {
-    totalExclVat: string;
-    vatAmount: string;
-    displayVatMessage: boolean;
-    total: string;
-    /** Returnable guarantee deposit included in the totals; VAT-free. */
-    guaranteeDeposit?: string;
-    monthly: string;
-    monthlyExclVat: string;
-    residual: string;
-    residualExclVat: string;
-    duration: number;
-  };
-};
-
-export type SalesTemplateData = {
-  opportunity: {
-    id: string;
-    offerNumber: string;
-  };
-  currentDate: string;
-  expirationDate: string;
-  notes?: string;
-  accountManager: {
-    fullName: string;
-    email: string;
-    phone: string;
-  };
-  vehicle: {
-    line1: string;
-    line2: string;
-    stockNumber: string;
-    mainImage: string;
-    make: string;
-    model: string;
-    type?: string;
-    km: string | number;
-    vin: string;
-    year: string;
-    parkingLocation: string;
-  };
-  c: {
-    organizationId?: string;
-    clientId: string;
-    company: string;
-    fullName: string;
-    vatNumber?: string;
-    email?: string;
-    phone?: string;
-    address?: string;
-    country: string;
-  };
-  iExtended: LineItemPdfTemplate[];
-  i: LineItemPdfTemplate[];
-  t: {
-    totalExclVat: string;
-    vatAmount: string;
-    total: string;
-    displayVatMessage: boolean;
-    totalAlternativeCurrency?: string;
-    totalAlternativeCurrencyCode?: string;
-    totalAlternativeCurrencyExclVat?: string;
-  };
-  l?: {
-    advance: string;
-    residual: string;
-    duration: number; // in months
-    monthlyAmount: string;
-  };
-};
-
 export type KanbanOpportunityGroup = {
   representative: SearchOpportunity;
   items: SearchOpportunity[];
 };
 
-export type DeliveryConfirmationTemplateData = {
-  supplier: {
-    company: string;
-    contactPerson: string;
-    vatNumber?: string;
-  };
-  customer: {
-    company: string;
-    contactPerson: string;
-    phone?: string;
-  };
-  vehicle: {
-    makeAndModel: string;
-    vin: string;
-    licensePlate?: string;
-    stockNumber?: string;
-  };
-  opportunity: {
-    id: string;
-  };
-  currentDate: string;
-};
-
 export type OpportunitiesKanbanColumn = {
   status: string;
   results: SearchOpportunity[];

package/src/types/quotes.ts

@@ -310,6 +310,29 @@ export type NewQuote = BaseQuote & {
   active: true;
 };
 
+/**
+ * A field of the linkage a quote is written against — opportunity, vehicle, contact, type and
+ * branch. When one of them is edited on the deal, the deal moves to a new linkage and its
+ * earlier quotes stay behind on the old one rather than following.
+ */
+export enum QuoteLinkageField {
+  Vehicle = 'vehicle',
+  Contact = 'contact',
+  Type = 'type',
+  Branch = 'branch',
+}
+
+export type QuoteRecordMeta = {
+  /**
+   * The quote was computed for a linkage the deal has since left. Kept visible as history: its
+   * figures were right for the vehicle, customer and branch of the day, and are not right now,
+   * so the only thing left to do with it is read the PDF that was sent.
+   */
+  archived?: boolean;
+  /** Why: the linkage fields edited on the deal since this quote was written. */
+  archivedReason?: QuoteLinkageField[];
+};
+
 export type Quote = BaseQuote & {
   id: string;
   createdAt: string;

package/src/types/tenants.ts

@@ -115,6 +115,15 @@ export type Tenant = PublicTenant & {
   // E.164 Twilio caller ID used as a fallback when a user has no own number configured
   defaultTwilioPhoneNumber?: string;
   deliveryEmail?: string;
+  /**
+   * The tenant's brand, for printed material generated in code: the vehicle sticker takes its
+   * header colour from `primary` and its name from `name`, so one layout serves every tenant.
+   * Absent = the layout's neutral grey. Mirrors the brand registry of the websites.
+   */
+  brand?: {
+    /** `#rrggbb` */
+    primary: string;
+  };
 };
 
 export type ReservationExpiryPolicy =
@@ -163,25 +172,6 @@ export type Branch = {
   dropshipping?: boolean;
 };
 
-export type HdmsVehiclesSync = {
-  active: boolean;
-};
-
-export type HdmsCrmSync = {
-  active: boolean;
-};
-
-export type HdmsDocumentSync = {
-  active: boolean;
-};
-
-export type TenantSyncSettings = {
-  tenantId: string;
-  hdmsVehicles: HdmsVehiclesSync | undefined;
-  hdmsCrm: HdmsCrmSync | undefined;
-  hdmsDocuments: HdmsDocumentSync | undefined;
-};
-
 export type WhatsappStateResponse = {
   enabled: boolean;
 };