@fin.cx/einvoice 8.1.0 → 8.2.0

package/ts/formats/utils/preceding.invoice.ts

@@ -0,0 +1,74 @@
+import type {
+  TAccountingDoc,
+  TAccountingDocType,
+  TCorrectedInvoiceReference,
+  TRelatedDocument,
+} from '../../interfaces/common.js';
+
+/**
+ * One preceding invoice reference (BG-3): the number of the preceding invoice
+ * (BT-25) and, when the document states it, its issue date (BT-26).
+ */
+export type TPrecedingInvoiceReference = TCorrectedInvoiceReference;
+
+/**
+ * The preceding invoice references (BG-3) an encoder writes for a document,
+ * taken only from what the document states:
+ * - a corrected invoice: the invoice it corrects (`correctedInvoice`);
+ * - a corrected invoice or a credit note: every related document with the
+ *   relation `'corrects'`.
+ * Other documents and other relations write none.
+ */
+export const getPrecedingInvoiceReferences = (
+  accountingDoc: TAccountingDoc,
+): TPrecedingInvoiceReference[] => {
+  const references: TPrecedingInvoiceReference[] = [];
+  if (accountingDoc.accountingDocType === 'corrected-invoice' && accountingDoc.correctedInvoice) {
+    references.push(accountingDoc.correctedInvoice);
+  }
+  if (
+    accountingDoc.accountingDocType === 'corrected-invoice' ||
+    accountingDoc.accountingDocType === 'creditnote'
+  ) {
+    for (const relatedDocument of accountingDoc.relatedDocuments ?? []) {
+      if (relatedDocument.relationType === 'corrects') {
+        references.push(
+          relatedDocument.issueDate === undefined
+            ? { documentId: relatedDocument.documentId }
+            : { documentId: relatedDocument.documentId, issueDate: relatedDocument.issueDate },
+        );
+      }
+    }
+  }
+  return references;
+};
+
+/**
+ * The envelope fields for the preceding invoice references a decoder read, the
+ * inverse of {@link getPrecedingInvoiceReferences}: on a corrected invoice the
+ * first reference is the invoice it corrects and further ones are related
+ * documents it corrects; on a credit note every reference is a related
+ * document it corrects. Other documents keep no reference, as before.
+ */
+export const getPrecedingInvoiceFields = (
+  accountingDocType: TAccountingDocType,
+  references: TPrecedingInvoiceReference[],
+): { correctedInvoice?: TCorrectedInvoiceReference; relatedDocuments?: TRelatedDocument[] } => {
+  const asRelated = (reference: TPrecedingInvoiceReference): TRelatedDocument => ({
+    relationType: 'corrects',
+    ...reference,
+  });
+  if (references.length === 0) {
+    return {};
+  }
+  if (accountingDocType === 'corrected-invoice') {
+    const [correctedInvoice, ...furtherReferences] = references;
+    return furtherReferences.length === 0
+      ? { correctedInvoice }
+      : { correctedInvoice, relatedDocuments: furtherReferences.map(asRelated) };
+  }
+  if (accountingDocType === 'creditnote') {
+    return { relatedDocuments: references.map(asRelated) };
+  }
+  return {};
+};

package/ts/index.ts

@@ -74,6 +74,9 @@ import { ZUGFeRDV1Decoder } from './formats/cii/zugferd/zugferd.v1.decoder.js';
 export type {
   // Common interfaces
   TInvoice,
+  TCorrectedInvoice,
+  TCorrectedInvoiceReference,
+  TInvoiceCorrection,
   TCreditNote,
   TDebitNote,
   TSelfBilledInvoice,

package/ts/interfaces/common.ts

@@ -83,11 +83,16 @@ export interface IPdf {
 // Re-export types from tsclass for convenience
 import type {
   TInvoice,
+  TCorrectedInvoice,
   TDebitNote,
   TSelfBilledInvoice,
 } from '@tsclass/tsclass/dist_ts/finance/index.js';
 
 export type { TInvoice } from '@tsclass/tsclass/dist_ts/finance/index.js';
+export type { TCorrectedInvoice } from '@tsclass/tsclass/dist_ts/finance/index.js';
+export type { TCorrectedInvoiceReference } from '@tsclass/tsclass/dist_ts/finance/index.js';
+export type { TInvoiceCorrection } from '@tsclass/tsclass/dist_ts/finance/index.js';
+export type { TRelatedDocument } from '@tsclass/tsclass/dist_ts/finance/index.js';
 export type { TCreditNote } from '@tsclass/tsclass/dist_ts/finance/index.js';
 export type { TDebitNote } from '@tsclass/tsclass/dist_ts/finance/index.js';
 export type { TSelfBilledInvoice } from '@tsclass/tsclass/dist_ts/finance/index.js';
@@ -100,7 +105,7 @@ export type { TAccountingDocEnvelope } from '@tsclass/tsclass/dist_ts/finance/in
  * `Invoice` root and the CII type codes of the invoice family. Only a credit
  * note has a document shape of its own.
  */
-export type TInvoiceDocument = TInvoice | TDebitNote | TSelfBilledInvoice;
+export type TInvoiceDocument = TInvoice | TCorrectedInvoice | TDebitNote | TSelfBilledInvoice;
 export type { TContact } from '@tsclass/tsclass/dist_ts/business/index.js';
 export type { TLetterEnvelope } from '@tsclass/tsclass/dist_ts/business/index.js';
 export type { TDocumentEnvelope } from '@tsclass/tsclass/dist_ts/business/index.js';