@bisondesk/core-sdk 1.0.21 → 1.0.23-B

package/src/types/leasing.ts

@@ -0,0 +1,360 @@
+import { EmailMessage } from '@bisondesk/commons-sdk/lib/messages';
+import {
+  AttachmentValue,
+  Document,
+  LinkValue,
+  PaginatedList,
+} from '@bisondesk/commons-sdk/lib/types';
+import { SortFilter } from './search';
+import { ReferenceData } from './utils';
+
+export type LeasingContractEvent = {
+  id: string;
+  action: 'create' | 'update' | 'delete';
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+  contract: LeasingContract;
+};
+
+export type LeasingContractImportEvent = {
+  tenantId: string;
+};
+
+export type LeasingConditionEvent = {
+  id: string;
+  action: 'create';
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+};
+
+export type OverdueDossier = {
+  id: string;
+  organizationId: string;
+  organizationName: string;
+  status: 'ONGOING' | 'ERROR' | 'SUCCESS' | 'EXPIRED';
+  emails: EmailMessage[];
+  createdAt: string;
+  modifiedAt: string;
+  completedAt?: string;
+  nextActionAt: string;
+  riskLevel: number;
+};
+
+export type LeasingContractClient = {
+  organizationId: string;
+  contactIds: string[];
+  email?: string;
+  since: string;
+  takeoverId?: string;
+  country: string;
+  beEntityType?: 'Legal Person' | 'Natural Person';
+  beForeignEntity?: boolean;
+
+  /**
+   * Used to overwrite the startDate in the context of a Becris declaration. This might be necessary
+   * when due to some data-quality issue we do not report the contract at the right period and it is no
+   * longer possible to resend the declaration for the corresponding month.
+   */
+  becrisStartDate?: string;
+};
+
+export enum LeasingContractSource {
+  HYPERPORTAL = 'hyperportal',
+  BISONDESK = 'bisondesk',
+}
+
+export enum LeasingContractStatus {
+  DRAFT = 'draft',
+  DISCARDED = 'discarded',
+  PAUSED = 'paused',
+  ACTIVE = 'active',
+  ENDED = 'ended',
+}
+
+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<T = LeasingContractHyperportal | LeasingContractBisondesk> = {
+  id: string;
+  createdAt: string;
+  updatedAt: string;
+  contractNumber?: string;
+  startDate: string;
+  deliveryDate?: string;
+  endDate?: string;
+  slbPartner?: string;
+  links?: LinkValue[];
+  accountManager?: string;
+  clients: LeasingContractClient[];
+  vehicle: {
+    id: string;
+    stockNumber: string;
+    administrativeNumber?: string;
+  };
+  status: LeasingContractStatus;
+  documents: Document[];
+} & T;
+
+type BaseRef = {
+  id: string;
+  depositAmount: string;
+  durationInMonths: number;
+  saleAmount: string; // includes the extras
+  interestRate: string;
+  residualAmount: string;
+  leasingMonthlyAmount: string; //Value excluding VAT
+  otherMonthlyAmounts: string; //Value excluding VAT
+  totalMonthlyAmount: string; //Value excluding VAT
+};
+
+export type ConditionsRef = BaseRef & {
+  validSince: string;
+};
+
+export type OpportunityRef = BaseRef & {
+  createdAt: string;
+  quoteId: string;
+  //Since VAT is client specific and contracts can be transferred between clients, we always handle values without VAT
+};
+
+export type ListOverdueRemindersResponse = PaginatedList<OverdueDossier, ReferenceData>;
+export type ListOverdueRemindersRequest = {
+  offset: number;
+  limit: number;
+  sortBy: SortFilter;
+};
+
+export type ListBecrisDeclarationsRequest = {
+  offset: number;
+  limit: number;
+};
+
+export type NewLeasingConditions = {
+  parameters: {
+    yearlyRoadTax: string;
+    civilLiability: string;
+    oneTimeRoadTax: string;
+    specialInsurance: string;
+    allRisksPercentage: string;
+    allRisksTaxPercentage: string;
+  };
+
+  inputs: {
+    deposit: string;
+    salesPrice: string;
+    bankDeposit: string;
+    purchasePrice: string;
+    residualValue: string;
+    insuranceAmount: string;
+    durationInMonths: number;
+    includesAllRisks: boolean;
+    marginPercentage: string;
+    bankResidualValue: string;
+    bankDurationInMonths: number;
+    startupFeePercentage: string;
+    includesYearlyRoadTax: boolean;
+    includesCivilLiability: boolean;
+    includesOneTimeRoadTax: boolean;
+    interestRatePercentage: string;
+    includesSpecialInsurance: boolean;
+    monthlyAdministrationFee: string;
+    bankInterestRatePercentage: string;
+  };
+
+  outputs: {
+    ROI: string;
+    ROITarget: string;
+    ROIPerYear: string;
+    cashDeficit: string;
+    totalProfit: string;
+    ROIDifference: string;
+    leasingAmount: string;
+    leasingProfit: string;
+    vehicleProfit: string;
+    oneTimeTaxCost: string;
+    financingAmount: string;
+    bankContractValue: string;
+    bankLeasingAmount: string;
+    totalMonthlyPayment: string;
+    leasingContractValue: string;
+    monthlyTaxRetailPrice: string;
+    allRisksInsuranceAmount: string;
+  };
+
+  cashIn: Array<{
+    time: string;
+    cashIn: string;
+    deposit: string;
+    startupFee: string;
+    taxPayment: string;
+    residualValue: string;
+    cumulativeCash: string;
+    insurancePayment: string;
+    monthlyAdministrationFee: string;
+    leasingAmountWithoutAdminFee: string;
+  }>;
+
+  cashOut: Array<{
+    time: string;
+    cashOut: string;
+    deposit: string;
+    taxPayment: string;
+    leasingAmount: string;
+    residualValue: string;
+    cumulativeCash: string;
+    insurancePayment: string;
+  }>;
+};
+
+export type LeasingConditions = NewLeasingConditions & {
+  id: string;
+  createdAt: string;
+  createdBy: string;
+  amortization: AmortizationTable;
+};
+
+export type AmortizationRow = {
+  period: number;
+  /* An estimate of the date in which the period will happen
+     based on the contract start date. Empty for period zero. */
+  expectedPeriodDate?: string;
+  buyOff: string;
+  payment: string;
+  capital: string;
+  interest: string;
+  totalInterest: string;
+  balance: string;
+};
+
+export type AmortizationTable = {
+  annualInterestRate?: string;
+  monthlyInterestRate?: string;
+  rows: AmortizationRow[];
+};
+
+export type AmortizationDocsEvent = {
+  contractId: string;
+  changedDocumentIds: string[];
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+};
+
+export type AmortizationDocs = {
+  contractId: string;
+  period: number;
+  documents: AmortizationDoc[];
+};
+
+export type AmortizationDoc = {
+  amount: string;
+  bookingNumber: string;
+  branchId: string;
+  documentId: string;
+  issueDate: string;
+  subtype: 'Invoice' | 'Credit Note';
+  clientExternalId: number;
+};
+
+export type BecrisDeclaration = {
+  createdAt: string;
+  endDate: string;
+  endingInstruments: number;
+  existingInstruments: number;
+  file: AttachmentValue;
+  id: string;
+  newInstruments: number;
+  startDate: string;
+};
+
+export type LeasingReportingSettings = {
+  active: boolean;
+  branchId: string;
+  tenantId: string;
+};
+
+export enum LeasingRemindersSortableColumns {
+  NextActionAt = 'next_action_at',
+  OrganizationName = 'organization_name',
+  RemindersCount = 'reminders_count',
+  Status = 'status',
+}
+
+export type AmortizationTableRequest = {
+  leasingAmount: string; // monthly amount
+  deposit: string;
+  salesPrice: string;
+  duration: number; // in months
+  residual: string;
+  monthlyInterestRate: string; // the annual interest rate divided by 12
+  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;
+    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;
+  };
+  amortization: {
+    period: number;
+    periodStartDate: string;
+    periodEndDate: string;
+    deposit: string;
+    startUpFee: string;
+    monthlyAmount: string;
+    insurance: string;
+    expirationDate: string;
+    total: string;
+  }[];
+};

package/src/types/machines.ts

@@ -0,0 +1,40 @@
+export type Machine = {
+  axlesConfiguration?: string;
+  bodywork?: string;
+  category: string;
+  vin?: string;
+  cocPvg?: string;
+  emptyWeightKg?: number;
+  euronorm?: string;
+  firstRegistration?: string;
+  gearbox?: string;
+  kilometers?: number;
+  make?: string;
+  makeModel?: string;
+  makeModelText?: string;
+  makeModelType?: string;
+  makeModelTypeText?: string;
+  powerHp?: number;
+  productionYear?: number;
+  suspension?: string;
+  totalWeightKg?: number;
+  wheelbaseCm?: number;
+
+  references: MachineReference[];
+  id: string;
+};
+
+export type MachineReference = {
+  administrativeNumber?: string;
+  metaId: string;
+  stockNumber: string;
+  tenantId: string;
+  vehicleId: string;
+};
+
+export type MachineEvent = {
+  machine: Machine;
+  action: 'upsert' | 'delete';
+  actionAt: string;
+  namespace: string;
+};