@bisondesk/documents-sdk 1.0.545 → 1.0.547

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bisondesk/documents-sdk",
-  "version": "1.0.545",
+  "version": "1.0.547",
   "description": "",
   "type": "module",
   "scripts": {

package/src/schemas.ts

@@ -103,6 +103,15 @@ export const newFinanceDocV2Schema = Joi.object({
   reportingYear: Joi.number().min(0).cast('string'),
   reportingPeriod: Joi.number().min(0).cast('string'),
   accountingDescription: Joi.string().empty(''),
+  peppol: Joi.object({
+    extraAttachments: Joi.array()
+      .items(
+        attachmentValueSchema.keys({
+          contentType: Joi.string().valid('application/pdf').required(),
+        })
+      )
+      .max(9),
+  }),
 });
 
 export const newAdministrativedDocumentSchema = Joi.object({

package/src/types/documents.ts

@@ -125,6 +125,10 @@ export type FinanceDocumentV2 = BaseDocument & {
 
   externalQrCodeUrl?: string; // QR code data to be rendered on the document
   externalId?: string; // id used by external systems (e.g., accounting integration, storecove)
+
+  peppol?: {
+    extraAttachments?: AttachmentValue[];
+  };
 };
 
 export type NewFinanceDocumentV2 = Omit<

package/src/types/leasing.ts

@@ -23,6 +23,7 @@ export enum LeasingFinanceLineCode {
   Capital = 'LEASING_CAPITAL',
   Deposit = 'LEASING_DEPOSIT',
   Fees = 'LEASING_FEES',
+  LateFees = 'LEASING_LATE_FEES',
   Insurance = 'LEASING_INSURANCE',
   Interest = 'LEASING_INTEREST',
   Other = 'LEASING_OTHER',

package/src/types/prefill.ts

@@ -0,0 +1,59 @@
+import { BusinessEntityIds } from '@bisondesk/commons-sdk/constants';
+import { TransactionType } from '@bisondesk/commons-sdk/types';
+import { UserSummary } from '@bisondesk/core-sdk/types/users';
+import { FinanceDocumentSubtype, NewFinanceDocumentLine } from './documents.js';
+
+export enum ContractPrefillType {
+  Deposit = 'deposit',
+  FirstRent = 'firstRent',
+  Residual = 'residual',
+}
+
+export enum OpportunityPrefillType {
+  Client = 'client',
+  FinancingPartner = 'financingPartner',
+  SelfFinancing = 'selfFinancing',
+}
+
+export enum OrgPrefillType {
+  LateFees = 'lateFees',
+}
+
+export type FinanceDocumentPrefillRequest = {
+  branchId: string;
+  transactionType: TransactionType;
+  subtype: FinanceDocumentSubtype;
+  businessEntityId:
+    | BusinessEntityIds.Opportunities
+    | BusinessEntityIds.LeasingContracts
+    | BusinessEntityIds.FinanceDocuments
+    | BusinessEntityIds.Organizations;
+  recordId?: string;
+  opportunityOptions?: {
+    prefillType?: OpportunityPrefillType;
+  };
+  contractOptions?: {
+    prefillType?: ContractPrefillType;
+    period?: number;
+  };
+  relatedInvoiceOptions?: {
+    relatedInvoiceId?: string;
+  };
+  organizationOptions?: {
+    prefillType?: OrgPrefillType;
+  };
+};
+
+export type FinanceDocumentPrefillValues = {
+  branchId: string;
+  organizationId: string;
+  contactId: string;
+  category: string;
+  notes?: string;
+  salespersonId?: string;
+  salesperson?: UserSummary;
+  lines: NewFinanceDocumentLine[];
+  contractId?: string;
+  contractPeriod?: number;
+  contractPrefillType?: ContractPrefillType;
+};

package/src/utils/finance-legacy.ts

@@ -0,0 +1,130 @@
+import { BusinessEntityIds } from '@bisondesk/commons-sdk/constants';
+import {
+  Association,
+  FinanceDocumentLine,
+  FinanceDocumentSubtype,
+  NewFinanceDocumentLine,
+} from '../types/documents.js';
+import { FinanceLineV1 } from '../types/legacy.js';
+import { LeasingFinanceLineCode } from '../types/leasing.js';
+import { VatCode } from '../types/vat.js';
+import { getAssociationForBusinessEntity, SupportedAssociationEntity } from './associations.js';
+import { getLineAmounts } from './finance.js';
+import { getAccountingCodeForV1VatCode, getVatCodeLineData } from './vat.js';
+
+export type MappedFinanceLine = NewFinanceDocumentLine & {
+  invoiceLineId: string;
+};
+
+type FinanceLine = FinanceDocumentLine | FinanceLineV1;
+
+const isV1Line = (line: FinanceLine): line is FinanceLineV1 => 'lineCode' in line;
+
+const hasValidLeasingLineCode = (code: string) =>
+  Object.values(LeasingFinanceLineCode).includes(code as LeasingFinanceLineCode);
+
+const mapFinanceDocumentLineToMappedLine = (
+  subtype: FinanceDocumentSubtype,
+  line: FinanceDocumentLine,
+  vatCodes: VatCode[] = []
+): MappedFinanceLine => {
+  const vatCode = vatCodes.find((c) => c.code === line.vatCode);
+  const vatData = getVatCodeLineData(subtype, vatCode);
+  return {
+    ...line,
+    ...vatData,
+    ...getLineAmounts(line.unitPriceExcl, line.quantity, vatData.vatPercentage),
+    invoiceLineId: line.id,
+    category: line.category ?? '',
+  };
+};
+
+const mapFinanceLineV1ToMappedLine = (
+  subtype: FinanceDocumentSubtype,
+  line: FinanceLineV1,
+  vatCodes: VatCode[]
+): MappedFinanceLine => {
+  const v2Code = getAccountingCodeForV1VatCode(line.vatCode);
+  const vatCode = vatCodes.find((c) => c.code === v2Code);
+  const vatData = getVatCodeLineData(subtype, vatCode);
+  return {
+    ...vatData,
+    ...getLineAmounts(line.unitPriceExclusive, line.quantity, vatData.vatPercentage),
+    invoiceLineId: line.id,
+    description: line.description,
+    quantity: line.quantity,
+    category: hasValidLeasingLineCode(line.lineCode) ? line.lineCode : '',
+    associations: line.associations.sales.map<Association>((sale) => ({
+      businessEntityId: BusinessEntityIds.ExternalVehicleSale,
+      recordId: sale.id,
+      title: sale.label,
+      description: sale.label,
+      linkTo: {
+        businessEntityId: BusinessEntityIds.Vehicles,
+        recordId: sale.vehicleId,
+      },
+    })),
+  };
+};
+
+export const mapFinanceLine = (
+  subtype: FinanceDocumentSubtype,
+  line: FinanceLine,
+  vatCodes: VatCode[] = []
+): MappedFinanceLine => {
+  return isV1Line(line)
+    ? mapFinanceLineV1ToMappedLine(subtype, line, vatCodes)
+    : mapFinanceDocumentLineToMappedLine(subtype, line, vatCodes);
+};
+
+/**
+ * Returns the vehicle IDs that need to be fetched to enrich ExternalVehicleSale
+ * associations that are missing tags (produced by V1 line mapping).
+ */
+export const getExternalSaleVehicleIds = (lines: MappedFinanceLine[]): string[] =>
+  lines.reduce((acc, line) => {
+    return [
+      ...acc,
+      ...(line.associations
+        ?.filter(
+          ({ businessEntityId, tags }) =>
+            BusinessEntityIds.ExternalVehicleSale === businessEntityId && tags == null
+        )
+        .map(({ recordId, linkTo }) => linkTo?.recordId ?? recordId) ?? []),
+    ];
+  }, [] as string[]);
+
+/**
+ * Patches ExternalVehicleSale associations that are missing tags with the vehicle's
+ * title, description and tags fetched via `vehicleMap`.
+ */
+export const enrichLinesWithVehicleTags = <T extends MappedFinanceLine>(
+  lines: T[],
+  vehicleMap: Map<string, SupportedAssociationEntity>
+): T[] =>
+  lines.map((line) => ({
+    ...line,
+    associations: line.associations?.map((association) => {
+      if (
+        association.businessEntityId !== BusinessEntityIds.ExternalVehicleSale ||
+        association.tags != null
+      ) {
+        return association;
+      }
+      const vehicleId = association.linkTo?.recordId ?? association.recordId;
+      const vehicle = vehicleMap.get(vehicleId);
+      if (!vehicle) {
+        return association;
+      }
+      const vehicleAssociation = getAssociationForBusinessEntity(
+        BusinessEntityIds.Vehicles,
+        vehicle
+      );
+      return {
+        ...association,
+        title: vehicleAssociation.title,
+        description: vehicleAssociation.description,
+        tags: vehicleAssociation.tags,
+      };
+    }),
+  }));

package/src/utils/finance.ts

@@ -45,7 +45,7 @@ export const documentGoesToStorecove = (
   }
   const vatNumber = doc.organizationSummary.vatNumber;
   const isBeCountry = doc.organizationSummary.country === 'be';
-  const isBEVAT = (isBeCountry && vatNumber?.startsWith('BE')) || false;
+  const isBEVAT = (isBeCountry && vatNumber?.toLowerCase().startsWith('be')) || false;
   return isBEVAT && documentGoesToAccounting(doc);
 };
 

package/src/utils/vat.ts

@@ -1,3 +1,9 @@
+import { isEUCountry } from '@bisondesk/commons-sdk/locations';
+import {
+  SALE_EU_EXTRA_COMMUNITY_VAT_CODE_ID,
+  SALE_EU_INTRA_COMMUNITY_VAT_CODE_ID,
+  STANDARD_VAT_CODE_ID,
+} from '../constants/index.js';
 import { FinanceDocumentSubtype } from '../types/documents.js';
 import { VatCode } from '../types/vat.js';
 
@@ -15,3 +21,45 @@ export const getVatCodeLineData = (
     vatPercentage: vatCode?.rate ?? '0',
   };
 };
+
+const v1VatCodeMappings = {
+  EU_CLIENTS_GOODS: 'B',
+  EU_CLIENTS_SERVICES: 'F',
+  MARGIN_VAT: 'MAR',
+  BE_ORG_REDUCED_1: '3',
+  BE_ORG_0: '0%',
+  BE_ORG_1: '1',
+  BE_ORG_2: '5',
+  EXPORT_SALE: 'E',
+};
+
+export const getAccountingCodeForV1VatCode = (vatCode: string): string | undefined =>
+  v1VatCodeMappings[vatCode];
+
+export const getSaleVatCodeForCustomer = (
+  branchCountry: string,
+  customerCountry: string,
+  vatCodes: VatCode[]
+) => {
+  const isSameCountry = branchCountry.toUpperCase() === customerCountry.toUpperCase();
+  const isSaleInEU = isEUCountry(customerCountry);
+  const vatCodeId =
+    isSameCountry || !branchCountry
+      ? STANDARD_VAT_CODE_ID
+      : isSaleInEU
+      ? SALE_EU_INTRA_COMMUNITY_VAT_CODE_ID
+      : SALE_EU_EXTRA_COMMUNITY_VAT_CODE_ID;
+
+  const vatCode = vatCodes?.find((code) => code.id === vatCodeId);
+  return vatCode;
+};
+
+export const getSaleVatCodeDataForCustomer = (
+  subtype: FinanceDocumentSubtype,
+  branchCountry: string,
+  customerCountry: string,
+  vatCodes: VatCode[]
+) => {
+  const vatCode = getSaleVatCodeForCustomer(branchCountry, customerCountry, vatCodes);
+  return getVatCodeLineData(subtype, vatCode);
+};